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-08-17 12:19+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 #: ../examples/guestfs-examples.pod:3 ../examples/guestfs-recipes.pod:14
25 #: ../fish/guestfish.pod:3 ../fish/virt-copy-in.pod:3
26 #: ../fish/virt-copy-out.pod:3 ../fish/virt-tar-in.pod:3
27 #: ../fish/virt-tar-out.pod:3 ../fuse/guestmount.pod:3
28 #: ../inspector/virt-inspector.pod:3 ../java/examples/guestfs-java.pod:3
29 #: ../ocaml/examples/guestfs-ocaml.pod:3 ../perl/examples/guestfs-perl.pod:3
30 #: ../python/examples/guestfs-python.pod:3 ../rescue/virt-rescue.pod:3
31 #: ../resize/virt-resize.pod:3 ../ruby/examples/guestfs-ruby.pod:3
32 #: ../src/guestfs.pod:3 ../test-tool/libguestfs-test-tool.pod:3
33 #: ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30
34 #: ../tools/virt-make-fs.pl:35 ../tools/virt-tar.pl:31
35 #: ../tools/virt-win-reg.pl:35
40 #: ../cat/virt-cat.pod:5
41 msgid "virt-cat - Display files in a virtual machine"
45 #: ../cat/virt-cat.pod:7 ../cat/virt-filesystems.pod:7 ../cat/virt-ls.pod:7
46 #: ../df/virt-df.pod:7 ../edit/virt-edit.pod:7
47 #: ../examples/guestfs-examples.pod:7 ../fish/guestfish.pod:7
48 #: ../fish/virt-copy-in.pod:7 ../fish/virt-copy-out.pod:7
49 #: ../fish/virt-tar-in.pod:7 ../fish/virt-tar-out.pod:7
50 #: ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pod:7
51 #: ../java/examples/guestfs-java.pod:7 ../ocaml/examples/guestfs-ocaml.pod:7
52 #: ../perl/examples/guestfs-perl.pod:7 ../python/examples/guestfs-python.pod:7
53 #: ../rescue/virt-rescue.pod:7 ../resize/virt-resize.pod:7
54 #: ../ruby/examples/guestfs-ruby.pod:7 ../src/guestfs.pod:7
55 #: ../test-tool/libguestfs-test-tool.pod:7
56 #: ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34
57 #: ../tools/virt-make-fs.pl:39 ../tools/virt-tar.pl:35
58 #: ../tools/virt-win-reg.pl:39
63 #: ../cat/virt-cat.pod:9
66 " virt-cat [--options] -d domname file [file ...]\n"
71 #: ../cat/virt-cat.pod:11
74 " virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
79 #: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15
80 #: ../inspector/virt-inspector.pod:13
85 #: ../cat/virt-cat.pod:15
88 " virt-cat domname file\n"
93 #: ../cat/virt-cat.pod:17
96 " virt-cat disk.img file\n"
101 #: ../cat/virt-cat.pod:19 ../cat/virt-filesystems.pod:13 ../cat/virt-ls.pod:19
102 #: ../df/virt-df.pod:21 ../edit/virt-edit.pod:27
103 #: ../examples/guestfs-examples.pod:19 ../examples/guestfs-recipes.pod:18
104 #: ../fish/guestfish.pod:30 ../fish/virt-copy-in.pod:19
105 #: ../fish/virt-copy-out.pod:13 ../fish/virt-tar-in.pod:21
106 #: ../fish/virt-tar-out.pod:15 ../fuse/guestmount.pod:20
107 #: ../inspector/virt-inspector.pod:19 ../java/examples/guestfs-java.pod:15
108 #: ../ocaml/examples/guestfs-ocaml.pod:25 ../perl/examples/guestfs-perl.pod:18
109 #: ../python/examples/guestfs-python.pod:14 ../rescue/virt-rescue.pod:29
110 #: ../resize/virt-resize.pod:13 ../ruby/examples/guestfs-ruby.pod:15
111 #: ../src/guestfs.pod:23 ../test-tool/libguestfs-test-tool.pod:11
112 #: ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40
113 #: ../tools/virt-make-fs.pl:47 ../tools/virt-tar.pl:77
114 #: ../tools/virt-win-reg.pl:63
119 #: ../cat/virt-cat.pod:21
121 "C<virt-cat> is a command line tool to display the contents of C<file> where "
122 "C<file> exists in the named virtual machine (or disk image)."
126 #: ../cat/virt-cat.pod:24
128 "Multiple filenames can be given, in which case they are concatenated "
129 "together. Each filename must be a full path, starting at the root directory "
130 "(starting with '/')."
134 #: ../cat/virt-cat.pod:28
136 "C<virt-cat> can be used to quickly view a file. To edit a file, use C<virt-"
137 "edit>. For more complex cases you should look at the L<guestfish(1)> tool "
138 "(see L</USING GUESTFISH> below)."
142 #: ../cat/virt-cat.pod:32 ../cat/virt-ls.pod:35 ../df/virt-df.pod:43
143 #: ../edit/virt-edit.pod:44 ../fish/guestfish.pod:41
144 #: ../fish/guestfish.pod:1018 ../fish/virt-copy-in.pod:29
145 #: ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30
146 #: ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39
147 #: ../resize/virt-resize.pod:27 ../tools/virt-tar.pl:50
152 #: ../cat/virt-cat.pod:34
154 "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
158 #: ../cat/virt-cat.pod:37
161 " virt-cat -d mydomain /etc/fstab\n"
166 #: ../cat/virt-cat.pod:39
167 msgid "List syslog messages from a VM disk image file:"
171 #: ../cat/virt-cat.pod:41
174 " virt-cat -a disk.img /var/log/messages | tail\n"
179 #: ../cat/virt-cat.pod:43
180 msgid "Find out what DHCP IP address a VM acquired:"
184 #: ../cat/virt-cat.pod:45
187 " virt-cat -d mydomain /var/log/messages | \\\n"
188 " grep 'dhclient: bound to' | tail\n"
193 #: ../cat/virt-cat.pod:48
194 msgid "Find out what packages were recently installed:"
198 #: ../cat/virt-cat.pod:50
201 " virt-cat -d mydomain /var/log/yum.log | tail\n"
206 #: ../cat/virt-cat.pod:52
207 msgid "Find out who is logged on inside a virtual machine:"
211 #: ../cat/virt-cat.pod:54
214 " virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
220 #: ../cat/virt-cat.pod:57
221 msgid "or who was logged on:"
225 #: ../cat/virt-cat.pod:59
228 " virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
229 " last -f /tmp/wtmp\n"
234 #: ../cat/virt-cat.pod:62 ../cat/virt-filesystems.pod:91
235 #: ../cat/virt-ls.pod:261 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62
236 #: ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45
237 #: ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42
238 #: ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:83
239 #: ../inspector/virt-inspector.pod:55 ../rescue/virt-rescue.pod:84
240 #: ../resize/virt-resize.pod:241 ../test-tool/libguestfs-test-tool.pod:37
241 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-list-partitions.pl:54
242 #: ../tools/virt-make-fs.pl:153 ../tools/virt-tar.pl:103
243 #: ../tools/virt-win-reg.pl:96
248 #: ../cat/virt-cat.pod:66 ../cat/virt-filesystems.pod:95
249 #: ../cat/virt-ls.pod:265 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66
250 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:151
251 #: ../inspector/virt-inspector.pod:59 ../rescue/virt-rescue.pod:88
252 #: ../resize/virt-resize.pod:245 ../tools/virt-list-filesystems.pl:61
253 #: ../tools/virt-list-partitions.pl:62 ../tools/virt-make-fs.pl:161
254 #: ../tools/virt-tar.pl:111 ../tools/virt-win-reg.pl:104
259 #: ../cat/virt-cat.pod:68 ../cat/virt-filesystems.pod:97
260 #: ../cat/virt-ls.pod:267 ../df/virt-df.pod:65 ../edit/virt-edit.pod:68
261 #: ../inspector/virt-inspector.pod:61 ../rescue/virt-rescue.pod:90
262 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-list-partitions.pl:64
263 #: ../tools/virt-make-fs.pl:163 ../tools/virt-tar.pl:113
264 #: ../tools/virt-win-reg.pl:106
265 msgid "Display brief help."
269 #: ../cat/virt-cat.pod:70 ../cat/virt-filesystems.pod:99
270 #: ../cat/virt-ls.pod:269 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70
271 #: ../inspector/virt-inspector.pod:63 ../rescue/virt-rescue.pod:92
276 #: ../cat/virt-cat.pod:72 ../cat/virt-filesystems.pod:101
277 #: ../cat/virt-ls.pod:271 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72
278 #: ../inspector/virt-inspector.pod:65 ../rescue/virt-rescue.pod:94
279 msgid "B<--add> file"
283 #: ../cat/virt-cat.pod:74 ../cat/virt-filesystems.pod:103
284 #: ../cat/virt-ls.pod:273 ../df/virt-df.pod:71 ../edit/virt-edit.pod:74
285 #: ../inspector/virt-inspector.pod:67 ../rescue/virt-rescue.pod:96
287 "Add I<file> which should be a disk image from a virtual machine. If the "
288 "virtual machine has multiple block devices, you must supply all of them with "
289 "separate I<-a> options."
293 #: ../cat/virt-cat.pod:78 ../cat/virt-filesystems.pod:107
294 #: ../cat/virt-ls.pod:277 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78
295 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:93
296 #: ../inspector/virt-inspector.pod:71 ../rescue/virt-rescue.pod:100
298 "The format of the disk image is auto-detected. To override this and force a "
299 "particular format use the I<--format=..> option."
303 #: ../cat/virt-cat.pod:81 ../cat/virt-filesystems.pod:125
304 #: ../cat/virt-ls.pod:291 ../df/virt-df.pod:78 ../rescue/virt-rescue.pod:107
309 #: ../cat/virt-cat.pod:83 ../cat/virt-filesystems.pod:127
310 #: ../cat/virt-ls.pod:293 ../df/virt-df.pod:80 ../rescue/virt-rescue.pod:109
311 msgid "B<--connect> URI"
315 #: ../cat/virt-cat.pod:85 ../cat/virt-filesystems.pod:129
316 #: ../cat/virt-ls.pod:295 ../df/virt-df.pod:82 ../edit/virt-edit.pod:99
317 #: ../inspector/virt-inspector.pod:78 ../rescue/virt-rescue.pod:111
318 #: ../tools/virt-list-filesystems.pl:81 ../tools/virt-list-partitions.pl:82
319 #: ../tools/virt-tar.pl:131 ../tools/virt-win-reg.pl:132
321 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
322 "to the default libvirt hypervisor."
326 #: ../cat/virt-cat.pod:88 ../cat/virt-filesystems.pod:132
327 #: ../cat/virt-ls.pod:298 ../df/virt-df.pod:85 ../rescue/virt-rescue.pod:114
329 "If you specify guest block devices directly (I<-a>), then libvirt is not "
334 #: ../cat/virt-cat.pod:91 ../cat/virt-filesystems.pod:141
335 #: ../cat/virt-ls.pod:307 ../df/virt-df.pod:94 ../edit/virt-edit.pod:105
336 #: ../inspector/virt-inspector.pod:85 ../rescue/virt-rescue.pod:117
341 #: ../cat/virt-cat.pod:93 ../cat/virt-filesystems.pod:143
342 #: ../cat/virt-ls.pod:309 ../df/virt-df.pod:96 ../edit/virt-edit.pod:107
343 #: ../inspector/virt-inspector.pod:87 ../rescue/virt-rescue.pod:119
344 msgid "B<--domain> guest"
348 #: ../cat/virt-cat.pod:95 ../cat/virt-filesystems.pod:145
349 #: ../cat/virt-ls.pod:311 ../df/virt-df.pod:98 ../edit/virt-edit.pod:109
350 #: ../inspector/virt-inspector.pod:89 ../rescue/virt-rescue.pod:121
352 "Add all the disks from the named libvirt guest. Domain UUIDs can be used "
357 #: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148
358 #: ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217
359 #: ../fuse/guestmount.pod:126 ../inspector/virt-inspector.pod:92
360 msgid "B<--echo-keys>"
364 #: ../cat/virt-cat.pod:100
366 "When prompting for keys and passphrases, virt-cat normally turns echoing off "
367 "so you cannot see what you are typing. If you are not worried about Tempest "
368 "attacks and there is no one else in the room you can specify this flag to "
369 "see what you are typing."
373 #: ../cat/virt-cat.pod:105 ../cat/virt-filesystems.pod:170
374 #: ../cat/virt-ls.pod:328 ../df/virt-df.pod:101 ../fish/guestfish.pod:233
375 #: ../fuse/guestmount.pod:133 ../inspector/virt-inspector.pod:99
376 #: ../rescue/virt-rescue.pod:124
377 msgid "B<--format=raw|qcow2|..>"
381 #: ../cat/virt-cat.pod:107 ../cat/virt-filesystems.pod:172
382 #: ../cat/virt-ls.pod:330 ../df/virt-df.pod:103 ../edit/virt-edit.pod:134
383 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:135
384 #: ../inspector/virt-inspector.pod:101 ../rescue/virt-rescue.pod:126
389 #: ../cat/virt-cat.pod:109 ../cat/virt-filesystems.pod:174
390 #: ../cat/virt-ls.pod:332 ../df/virt-df.pod:105 ../edit/virt-edit.pod:136
391 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:137
392 #: ../rescue/virt-rescue.pod:128
394 "The default for the I<-a> option is to auto-detect the format of the disk "
395 "image. Using this forces the disk format for I<-a> options which follow on "
396 "the command line. Using I<--format> with no argument switches back to auto-"
397 "detection for subsequent I<-a> options."
401 #: ../cat/virt-cat.pod:114 ../cat/virt-filesystems.pod:179
402 #: ../cat/virt-ls.pod:337 ../df/virt-df.pod:110 ../edit/virt-edit.pod:141
403 #: ../fish/guestfish.pod:242 ../fish/guestfish.pod:673
404 #: ../inspector/virt-inspector.pod:335 ../rescue/virt-rescue.pod:133
405 #: ../src/guestfs.pod:2653
410 #: ../cat/virt-cat.pod:116
413 " virt-cat --format=raw -a disk.img file\n"
418 #: ../cat/virt-cat.pod:118 ../cat/virt-filesystems.pod:183
419 #: ../cat/virt-ls.pod:341 ../df/virt-df.pod:114 ../edit/virt-edit.pod:145
420 #: ../fish/guestfish.pod:246 ../rescue/virt-rescue.pod:137
421 msgid "forces raw format (no auto-detection) for C<disk.img>."
425 #: ../cat/virt-cat.pod:120
428 " virt-cat --format=raw -a disk.img --format -a another.img file\n"
433 #: ../cat/virt-cat.pod:122 ../cat/virt-filesystems.pod:187
434 #: ../cat/virt-ls.pod:345 ../df/virt-df.pod:118 ../edit/virt-edit.pod:149
435 #: ../fish/guestfish.pod:250 ../rescue/virt-rescue.pod:141
437 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
438 "detection for C<another.img>."
442 #: ../cat/virt-cat.pod:125 ../cat/virt-filesystems.pod:190
443 #: ../cat/virt-ls.pod:348 ../df/virt-df.pod:121 ../edit/virt-edit.pod:152
444 #: ../rescue/virt-rescue.pod:144
446 "If you have untrusted raw-format guest disk images, you should use this "
447 "option to specify the disk format. This avoids a possible security problem "
448 "with malicious guests (CVE-2010-3851)."
452 #: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200
453 #: ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289
454 #: ../fuse/guestmount.pod:163 ../inspector/virt-inspector.pod:114
455 msgid "B<--keys-from-stdin>"
459 #: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202
460 #: ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291
461 #: ../fuse/guestmount.pod:165 ../inspector/virt-inspector.pod:116
463 "Read key or passphrase parameters from stdin. The default is to try to read "
464 "passphrases from the user by opening C</dev/tty>."
468 #: ../cat/virt-cat.pod:134 ../cat/virt-filesystems.pod:261
469 #: ../cat/virt-ls.pod:425 ../df/virt-df.pod:173 ../edit/virt-edit.pod:161
470 #: ../fish/guestfish.pod:390 ../fuse/guestmount.pod:257
471 #: ../inspector/virt-inspector.pod:119 ../rescue/virt-rescue.pod:178
476 #: ../cat/virt-cat.pod:136 ../cat/virt-filesystems.pod:263
477 #: ../cat/virt-ls.pod:427 ../df/virt-df.pod:175 ../edit/virt-edit.pod:163
478 #: ../fish/guestfish.pod:392 ../fuse/guestmount.pod:259
479 #: ../inspector/virt-inspector.pod:121 ../rescue/virt-rescue.pod:180
484 #: ../cat/virt-cat.pod:138 ../cat/virt-filesystems.pod:265
485 #: ../cat/virt-ls.pod:429 ../df/virt-df.pod:177 ../edit/virt-edit.pod:165
486 #: ../inspector/virt-inspector.pod:123 ../rescue/virt-rescue.pod:182
487 msgid "Enable verbose messages for debugging."
491 #: ../cat/virt-cat.pod:140 ../cat/virt-filesystems.pod:267
492 #: ../cat/virt-ls.pod:431 ../df/virt-df.pod:179 ../edit/virt-edit.pod:167
493 #: ../fish/guestfish.pod:397 ../fuse/guestmount.pod:263
494 #: ../inspector/virt-inspector.pod:125 ../rescue/virt-rescue.pod:184
495 #: ../resize/virt-resize.pod:478
500 #: ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269
501 #: ../cat/virt-ls.pod:433 ../df/virt-df.pod:181 ../edit/virt-edit.pod:169
502 #: ../fish/guestfish.pod:399 ../fuse/guestmount.pod:265
503 #: ../inspector/virt-inspector.pod:127 ../rescue/virt-rescue.pod:186
504 #: ../resize/virt-resize.pod:480 ../tools/virt-list-filesystems.pl:69
505 #: ../tools/virt-list-partitions.pl:70 ../tools/virt-make-fs.pl:169
506 #: ../tools/virt-tar.pl:119 ../tools/virt-win-reg.pl:112
511 #: ../cat/virt-cat.pod:144 ../cat/virt-filesystems.pod:271
512 #: ../cat/virt-ls.pod:435 ../df/virt-df.pod:183 ../edit/virt-edit.pod:171
513 #: ../inspector/virt-inspector.pod:129 ../rescue/virt-rescue.pod:188
514 #: ../resize/virt-resize.pod:482 ../tools/virt-list-filesystems.pl:71
515 #: ../tools/virt-list-partitions.pl:72 ../tools/virt-make-fs.pl:171
516 #: ../tools/virt-tar.pl:121 ../tools/virt-win-reg.pl:114
517 msgid "Display version number and exit."
521 #: ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281
522 #: ../cat/virt-ls.pod:437 ../df/virt-df.pod:185 ../edit/virt-edit.pod:173
523 #: ../fish/guestfish.pod:412 ../fuse/guestmount.pod:278
524 #: ../inspector/virt-inspector.pod:131 ../rescue/virt-rescue.pod:199
525 #: ../tools/virt-tar.pl:158
530 #: ../cat/virt-cat.pod:148 ../cat/virt-filesystems.pod:283
531 #: ../cat/virt-ls.pod:439 ../df/virt-df.pod:187 ../edit/virt-edit.pod:175
532 #: ../inspector/virt-inspector.pod:133 ../rescue/virt-rescue.pod:201
533 msgid "Enable tracing of libguestfs API calls."
537 #: ../cat/virt-cat.pod:152 ../cat/virt-ls.pod:443 ../edit/virt-edit.pod:179
538 #: ../inspector/virt-inspector.pod:137 ../rescue/virt-rescue.pod:205
539 msgid "OLD-STYLE COMMAND LINE ARGUMENTS"
543 #: ../cat/virt-cat.pod:154
544 msgid "Previous versions of virt-cat allowed you to write either:"
548 #: ../cat/virt-cat.pod:156
551 " virt-cat disk.img [disk.img ...] file\n"
556 #: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185
557 #: ../inspector/virt-inspector.pod:143 ../rescue/virt-rescue.pod:211
562 #: ../cat/virt-cat.pod:160
565 " virt-cat guestname file\n"
570 #: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189
571 #: ../inspector/virt-inspector.pod:147 ../rescue/virt-rescue.pod:215
573 "whereas in this version you should use I<-a> or I<-d> respectively to avoid "
574 "the confusing case where a disk image might have the same name as a guest."
578 #: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193
579 #: ../inspector/virt-inspector.pod:151 ../rescue/virt-rescue.pod:219
580 msgid "For compatibility the old style is still supported."
584 #: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:297
585 msgid "USING GUESTFISH"
589 #: ../cat/virt-cat.pod:170
591 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
592 "C<virt-cat> doesn't work."
596 #: ../cat/virt-cat.pod:173
597 msgid "Using C<virt-cat> is approximately equivalent to doing:"
601 #: ../cat/virt-cat.pod:175
604 " guestfish --ro -i -d domname download file -\n"
609 #: ../cat/virt-cat.pod:177
611 "where C<domname> is the name of the libvirt guest, and C<file> is the full "
612 "path to the file. Note the final C<-> (meaning \"output to stdout\")."
616 #: ../cat/virt-cat.pod:181
618 "The command above uses libguestfs's guest inspection feature and so does not "
619 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
620 "disk images that don't contain guests. To display a file from a disk image "
625 #: ../cat/virt-cat.pod:186
628 " guestfish --ro -a disk.img -m /dev/sda1 download file -\n"
633 #: ../cat/virt-cat.pod:188
635 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
636 "the disk image to edit, and C<file> is the full path to the file."
640 #: ../cat/virt-cat.pod:192 ../cat/virt-filesystems.pod:365
641 #: ../cat/virt-ls.pod:483 ../df/virt-df.pod:215 ../edit/virt-edit.pod:342
642 #: ../inspector/virt-inspector.pod:349 ../rescue/virt-rescue.pod:262
643 #: ../resize/virt-resize.pod:543 ../tools/virt-list-filesystems.pl:188
644 #: ../tools/virt-list-partitions.pl:258 ../tools/virt-make-fs.pl:532
645 #: ../tools/virt-tar.pl:289 ../tools/virt-win-reg.pl:733
646 msgid "SHELL QUOTING"
650 #: ../cat/virt-cat.pod:194 ../cat/virt-filesystems.pod:367
651 #: ../cat/virt-ls.pod:485 ../df/virt-df.pod:217 ../edit/virt-edit.pod:344
652 #: ../inspector/virt-inspector.pod:351 ../rescue/virt-rescue.pod:264
653 #: ../resize/virt-resize.pod:545 ../tools/virt-list-filesystems.pl:190
654 #: ../tools/virt-list-partitions.pl:260 ../tools/virt-make-fs.pl:534
655 #: ../tools/virt-tar.pl:291 ../tools/virt-win-reg.pl:741
657 "Libvirt guest names can contain arbitrary characters, some of which have "
658 "meaning to the shell such as C<#> and space. You may need to quote or "
659 "escape these characters on the command line. See the shell manual page L<sh"
664 #: ../cat/virt-cat.pod:199 ../cat/virt-filesystems.pod:372
665 #: ../cat/virt-ls.pod:490 ../df/virt-df.pod:222 ../edit/virt-edit.pod:349
666 #: ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384
667 #: ../fish/guestfish.pod:1235 ../fish/virt-copy-in.pod:50
668 #: ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47
669 #: ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:303
670 #: ../inspector/virt-inspector.pod:372 ../java/examples/guestfs-java.pod:45
671 #: ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39
672 #: ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:284
673 #: ../resize/virt-resize.pod:550 ../ruby/examples/guestfs-ruby.pod:36
674 #: ../src/guestfs.pod:3027 ../test-tool/libguestfs-test-tool.pod:87
675 #: ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265
676 #: ../tools/virt-make-fs.pl:539 ../tools/virt-tar.pl:296
677 #: ../tools/virt-win-reg.pl:746
682 #: ../cat/virt-cat.pod:201
684 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, L<virt-"
685 "tar-out(1)>, L<http://libguestfs.org/>."
689 #: ../cat/virt-cat.pod:208 ../cat/virt-filesystems.pod:383
690 #: ../cat/virt-ls.pod:502 ../df/virt-df.pod:230 ../edit/virt-edit.pod:363
691 #: ../rescue/virt-rescue.pod:292 ../resize/virt-resize.pod:571
692 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277
693 #: ../tools/virt-make-fs.pl:564 ../tools/virt-tar.pl:311
694 #: ../tools/virt-win-reg.pl:772
699 #: ../cat/virt-cat.pod:210 ../cat/virt-filesystems.pod:385
700 #: ../cat/virt-ls.pod:504 ../df/virt-df.pod:232 ../edit/virt-edit.pod:365
701 #: ../inspector/virt-inspector.pod:386 ../rescue/virt-rescue.pod:294
702 #: ../resize/virt-resize.pod:573 ../tools/virt-list-filesystems.pl:210
703 #: ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:566
704 #: ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:774
705 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
709 #: ../cat/virt-cat.pod:212 ../cat/virt-filesystems.pod:387
710 #: ../cat/virt-ls.pod:506 ../df/virt-df.pod:234 ../edit/virt-edit.pod:367
711 #: ../examples/guestfs-examples.pod:48 ../examples/guestfs-recipes.pod:400
712 #: ../fish/guestfish.pod:1264 ../fish/virt-copy-in.pod:64
713 #: ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62
714 #: ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:318
715 #: ../inspector/virt-inspector.pod:394 ../java/examples/guestfs-java.pod:61
716 #: ../ocaml/examples/guestfs-ocaml.pod:94 ../perl/examples/guestfs-perl.pod:55
717 #: ../python/examples/guestfs-python.pod:57 ../rescue/virt-rescue.pod:296
718 #: ../resize/virt-resize.pod:575 ../ruby/examples/guestfs-ruby.pod:51
719 #: ../src/guestfs.pod:3103 ../test-tool/libguestfs-test-tool.pod:97
720 #: ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281
721 #: ../tools/virt-make-fs.pl:568 ../tools/virt-tar.pl:315
722 #: ../tools/virt-win-reg.pl:776
727 #: ../cat/virt-cat.pod:214 ../inspector/virt-inspector.pod:396
728 #: ../resize/virt-resize.pod:577
729 msgid "Copyright (C) 2010-2011 Red Hat Inc."
733 #: ../cat/virt-cat.pod:216 ../cat/virt-filesystems.pod:391
734 #: ../cat/virt-ls.pod:510 ../df/virt-df.pod:238 ../edit/virt-edit.pod:371
735 #: ../fish/guestfish.pod:1269 ../fish/virt-copy-in.pod:69
736 #: ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67
737 #: ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:323
738 #: ../inspector/virt-inspector.pod:398 ../rescue/virt-rescue.pod:300
739 #: ../resize/virt-resize.pod:579 ../test-tool/libguestfs-test-tool.pod:102
740 #: ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285
741 #: ../tools/virt-make-fs.pl:572 ../tools/virt-tar.pl:319
742 #: ../tools/virt-win-reg.pl:780
744 "This program is free software; you can redistribute it and/or modify it "
745 "under the terms of the GNU General Public License as published by the Free "
746 "Software Foundation; either version 2 of the License, or (at your option) "
751 #: ../cat/virt-cat.pod:221 ../cat/virt-filesystems.pod:396
752 #: ../cat/virt-ls.pod:515 ../df/virt-df.pod:243 ../edit/virt-edit.pod:376
753 #: ../fish/guestfish.pod:1274 ../fish/virt-copy-in.pod:74
754 #: ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72
755 #: ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:328
756 #: ../inspector/virt-inspector.pod:403 ../rescue/virt-rescue.pod:305
757 #: ../resize/virt-resize.pod:584 ../test-tool/libguestfs-test-tool.pod:107
758 #: ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290
759 #: ../tools/virt-make-fs.pl:577 ../tools/virt-tar.pl:324
760 #: ../tools/virt-win-reg.pl:785
762 "This program is distributed in the hope that it will be useful, but WITHOUT "
763 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
764 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
769 #: ../cat/virt-cat.pod:226 ../cat/virt-filesystems.pod:401
770 #: ../cat/virt-ls.pod:520 ../df/virt-df.pod:248 ../edit/virt-edit.pod:381
771 #: ../fish/guestfish.pod:1279 ../fish/virt-copy-in.pod:79
772 #: ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77
773 #: ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:333
774 #: ../inspector/virt-inspector.pod:408 ../rescue/virt-rescue.pod:310
775 #: ../resize/virt-resize.pod:589 ../test-tool/libguestfs-test-tool.pod:112
776 #: ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295
777 #: ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:329
778 #: ../tools/virt-win-reg.pl:790
780 "You should have received a copy of the GNU General Public License along with "
781 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
782 "Ave, Cambridge, MA 02139, USA."
786 #: ../cat/virt-filesystems.pod:5
788 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
789 "virtual machine or disk image"
793 #: ../cat/virt-filesystems.pod:9
796 " virt-filesystems [--options] -d domname\n"
801 #: ../cat/virt-filesystems.pod:11
804 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
809 #: ../cat/virt-filesystems.pod:15
811 "This tool allows you to discover filesystems, partitions, logical volumes, "
812 "and their sizes in a disk image or virtual machine. It is a replacement for "
813 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
817 #: ../cat/virt-filesystems.pod:20
819 "One use for this tool is from shell scripts to iterate over all filesystems "
824 #: ../cat/virt-filesystems.pod:23
827 " for fs in $(virt-filesystems -a disk.img); do\n"
834 #: ../cat/virt-filesystems.pod:27
836 "Another use is to list partitions before using another tool to modify those "
837 "partitions (such as L<virt-resize(1)>). If you are curious about what an "
838 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
842 #: ../cat/virt-filesystems.pod:32
844 "Various command line options control what this program displays. You need "
845 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
846 "guest respectively. If you just specify that then the program shows "
847 "filesystems found, one per line, like this:"
851 #: ../cat/virt-filesystems.pod:37
854 " $ virt-filesystems -a disk.img\n"
856 " /dev/vg_guest/lv_root\n"
861 #: ../cat/virt-filesystems.pod:41
863 "If you add I<-l> or I<--long> then the output includes extra information:"
867 #: ../cat/virt-filesystems.pod:44
870 " $ virt-filesystems -a disk.img -l\n"
871 " Name Type VFS Label Size\n"
872 " /dev/sda1 filesystem ext4 boot 524288000\n"
873 " /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
878 #: ../cat/virt-filesystems.pod:49
880 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
885 #: ../cat/virt-filesystems.pod:52
888 " $ virt-filesystems -a disk.img --extra\n"
890 " /dev/vg_guest/lv_root\n"
891 " /dev/vg_guest/lv_swap\n"
892 " /dev/vg_guest/lv_data\n"
897 #: ../cat/virt-filesystems.pod:58
899 "If you add I<--partitions> then partitions are shown instead of filesystems:"
903 #: ../cat/virt-filesystems.pod:60
906 " $ virt-filesystems -a disk.img --partitions\n"
913 #: ../cat/virt-filesystems.pod:64
915 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, I<--physical-"
916 "volumes>, I<--block-devices> to list those items."
920 #: ../cat/virt-filesystems.pod:67
922 "You can use these options in combination as well (if you want a combination "
923 "including filesystems, you have to add I<--filesystems>). Notice that some "
924 "items fall into several categories (eg. C</dev/sda1> might be both a "
925 "partition and a filesystem). These items are listed several times. To get "
926 "a list which includes absolutely everything that virt-filesystems knows "
927 "about, use the I<--all> option."
931 #: ../cat/virt-filesystems.pod:74
933 "UUIDs (because they are quite long) are not shown by default. Add the I<--"
934 "uuid> option to display device and filesystem UUIDs in the long output."
938 #: ../cat/virt-filesystems.pod:78
940 "I<--all --long --uuid> is a useful combination to display all possible "
941 "information about everything."
945 #: ../cat/virt-filesystems.pod:81
948 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
949 " Name Type VFS Label Size Parent UUID\n"
950 " /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
951 " /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
952 " /dev/sda1 partition - - 100M /dev/sda -\n"
953 " /dev/sda2 partition - - 20G /dev/sda -\n"
954 " /dev/sda device - - 20G - -\n"
959 #: ../cat/virt-filesystems.pod:89
961 "For machine-readable output, use I<--csv> to get Comma-Separated Values."
965 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
970 #: ../cat/virt-filesystems.pod:112
972 "Display everything. This is currently the same as specifying these options: "
973 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, I<--"
974 "logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may be "
975 "added to this list in future)."
979 #: ../cat/virt-filesystems.pod:117
980 msgid "See also I<--long>."
984 #: ../cat/virt-filesystems.pod:119
989 #: ../cat/virt-filesystems.pod:121
990 msgid "B<--block-devices>"
994 #: ../cat/virt-filesystems.pod:123
995 msgid "Display block devices."
999 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88
1004 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90
1006 "Write out the results in CSV format (comma-separated values). This format "
1007 "can be imported easily into databases and spreadsheets, but read L</NOTE "
1008 "ABOUT CSV FORMAT> below."
1012 #: ../cat/virt-filesystems.pod:150
1014 "When prompting for keys and passphrases, virt-filesystems normally turns "
1015 "echoing off so you cannot see what you are typing. If you are not worried "
1016 "about Tempest attacks and there is no one else in the room you can specify "
1017 "this flag to see what you are typing."
1021 #: ../cat/virt-filesystems.pod:155
1026 #: ../cat/virt-filesystems.pod:157
1028 "This causes filesystems that are not ordinary, mountable filesystems to be "
1029 "displayed. This category includes swapspace, and filesystems that are empty "
1030 "or contain unknown data."
1034 #: ../cat/virt-filesystems.pod:161
1035 msgid "This option implies I<--filesystems>."
1039 #: ../cat/virt-filesystems.pod:163
1040 msgid "B<--filesystems>"
1044 #: ../cat/virt-filesystems.pod:165
1046 "Display mountable filesystems. If no display option was selected then this "
1047 "option is implied."
1051 #: ../cat/virt-filesystems.pod:168
1052 msgid "With I<--extra>, non-mountable filesystems are shown too."
1056 #: ../cat/virt-filesystems.pod:181
1059 " virt-filesystems --format=raw -a disk.img\n"
1064 #: ../cat/virt-filesystems.pod:185
1067 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
1072 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352
1073 #: ../df/virt-df.pod:125 ../fish/guestfish.pod:156
1074 #: ../tools/virt-list-partitions.pl:109
1079 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354
1080 #: ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111
1081 msgid "B<--human-readable>"
1085 #: ../cat/virt-filesystems.pod:198
1086 msgid "In I<--long> mode, display sizes in human-readable format."
1090 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366
1091 #: ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
1096 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368
1097 #: ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
1102 #: ../cat/virt-filesystems.pod:209
1103 msgid "Display extra columns of data (\"long format\")."
1107 #: ../cat/virt-filesystems.pod:211
1108 msgid "A title row is added unless you also specify I<--no-title>."
1112 #: ../cat/virt-filesystems.pod:213
1114 "The extra columns displayed depend on what output you select, and the "
1115 "ordering of columns may change in future versions. Use the title row, I<--"
1116 "csv> output and/or L<csvtool(1)> to match columns to data in external "
1121 #: ../cat/virt-filesystems.pod:218
1123 "Use I<-h> if you want sizes to be displayed in human-readable format. The "
1124 "default is to show raw numbers of I<bytes>."
1128 #: ../cat/virt-filesystems.pod:221
1129 msgid "Use I<--uuid> to display UUIDs too."
1133 #: ../cat/virt-filesystems.pod:223
1138 #: ../cat/virt-filesystems.pod:225
1139 msgid "B<--logvols>"
1143 #: ../cat/virt-filesystems.pod:227
1144 msgid "B<--logical-volumes>"
1148 #: ../cat/virt-filesystems.pod:229
1150 "Display LVM logical volumes. In this mode, these are displayed irrespective "
1151 "of whether the LVs contain filesystems."
1155 #: ../cat/virt-filesystems.pod:232
1156 msgid "B<--no-title>"
1160 #: ../cat/virt-filesystems.pod:234
1161 msgid "In I<--long> mode, don't add a title row."
1165 #: ../cat/virt-filesystems.pod:236
1167 "Note that the order of the columns is not fixed, and may change in future "
1168 "versions of virt-filesystems, so using this option may give you unexpected "
1173 #: ../cat/virt-filesystems.pod:240
1178 #: ../cat/virt-filesystems.pod:242
1179 msgid "B<--partitions>"
1183 #: ../cat/virt-filesystems.pod:244
1185 "Display partitions. In this mode, these are displayed irrespective of "
1186 "whether the partitions contain filesystems."
1190 #: ../cat/virt-filesystems.pod:247
1195 #: ../cat/virt-filesystems.pod:249
1196 msgid "B<--physvols>"
1200 #: ../cat/virt-filesystems.pod:251
1201 msgid "B<--physical-volumes>"
1205 #: ../cat/virt-filesystems.pod:253
1206 msgid "Display LVM physical volumes."
1210 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163
1215 #: ../cat/virt-filesystems.pod:257
1220 #: ../cat/virt-filesystems.pod:259
1221 msgid "In I<--long> mode, display UUIDs as well."
1225 #: ../cat/virt-filesystems.pod:273
1230 #: ../cat/virt-filesystems.pod:275
1231 msgid "B<--volgroups>"
1235 #: ../cat/virt-filesystems.pod:277
1236 msgid "B<--volume-groups>"
1240 #: ../cat/virt-filesystems.pod:279
1241 msgid "Display LVM volume groups."
1245 #: ../cat/virt-filesystems.pod:287
1250 #: ../cat/virt-filesystems.pod:289
1252 "Note that columns in the output are subject to reordering and change in "
1253 "future versions of this tool."
1257 #: ../cat/virt-filesystems.pod:294
1262 #: ../cat/virt-filesystems.pod:296
1263 msgid "The filesystem, partition, block device or LVM name."
1267 #: ../cat/virt-filesystems.pod:298
1269 "For device and partition names these are displayed as canonical libguestfs "
1270 "names, so that for example C</dev/sda2> is the second partition on the first "
1275 #: ../cat/virt-filesystems.pod:302
1277 "If the I<--long> option is B<not> specified, then only the name column is "
1278 "shown in the output."
1282 #: ../cat/virt-filesystems.pod:305
1287 #: ../cat/virt-filesystems.pod:307
1288 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1292 #: ../cat/virt-filesystems.pod:309
1297 #: ../cat/virt-filesystems.pod:311
1299 "If there is a filesystem, then this column displays the filesystem type if "
1300 "one could be detected, eg. C<ext4>."
1304 #: ../cat/virt-filesystems.pod:314
1309 #: ../cat/virt-filesystems.pod:316
1311 "If the object has a label (used for identifying and mounting filesystems) "
1312 "then this column contains the label."
1316 #: ../cat/virt-filesystems.pod:319
1321 #: ../cat/virt-filesystems.pod:321
1323 "The size of the object in bytes. If the I<--human> option is used then the "
1324 "size is displayed in a human-readable form."
1328 #: ../cat/virt-filesystems.pod:324
1333 #: ../cat/virt-filesystems.pod:326
1335 "The parent column records the parent relationship between objects. For "
1336 "example, if the object is a partition, then this column contains the name of "
1337 "the containing device. If the object is a logical volume, then this column "
1338 "is the name of the volume group."
1342 #: ../cat/virt-filesystems.pod:331
1347 #: ../cat/virt-filesystems.pod:333
1349 "If the object has a UUID (used for identifying and mounting filesystems and "
1350 "block devices) then this column contains the UUID as a string."
1354 #: ../cat/virt-filesystems.pod:337
1355 msgid "The UUID is only displayed if the I<--uuid> option is given."
1359 #: ../cat/virt-filesystems.pod:341 ../cat/virt-ls.pod:459
1360 #: ../df/virt-df.pod:191
1361 msgid "NOTE ABOUT CSV FORMAT"
1365 #: ../cat/virt-filesystems.pod:343 ../cat/virt-ls.pod:461
1366 #: ../df/virt-df.pod:193
1368 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
1369 "should be easy to parse, but it is definitely not easy to parse."
1373 #: ../cat/virt-filesystems.pod:346 ../cat/virt-ls.pod:464
1374 #: ../df/virt-df.pod:196
1376 "Myth: Just split fields at commas. Reality: This does I<not> work "
1377 "reliably. This example has two columns:"
1381 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:467
1382 #: ../df/virt-df.pod:199
1385 " \"foo,bar\",baz\n"
1390 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:469
1391 #: ../df/virt-df.pod:201
1393 "Myth: Read the file one line at a time. Reality: This does I<not> work "
1394 "reliably. This example has one row:"
1398 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472
1399 #: ../df/virt-df.pod:204
1408 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475
1409 #: ../df/virt-df.pod:207
1411 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
1412 "packaged in major Linux distributions)."
1416 #: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478
1417 #: ../df/virt-df.pod:210
1419 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
1420 "or Python's built-in csv library)."
1424 #: ../cat/virt-filesystems.pod:363 ../cat/virt-ls.pod:481
1425 #: ../df/virt-df.pod:213
1426 msgid "Most spreadsheets and databases can import CSV directly."
1430 #: ../cat/virt-filesystems.pod:374
1432 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-list-"
1433 "filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, L<http://"
1438 #: ../cat/virt-filesystems.pod:389 ../tools/virt-make-fs.pl:570
1439 #: ../tools/virt-win-reg.pl:778
1440 msgid "Copyright (C) 2010 Red Hat Inc."
1444 #: ../cat/virt-ls.pod:5
1445 msgid "virt-ls - List files in a virtual machine"
1449 #: ../cat/virt-ls.pod:9
1452 " virt-ls [--options] -d domname directory [directory ...]\n"
1457 #: ../cat/virt-ls.pod:11
1460 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory ...]\n"
1465 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13
1470 #: ../cat/virt-ls.pod:15
1473 " virt-ls [--options] domname directory\n"
1478 #: ../cat/virt-ls.pod:17
1481 " virt-ls [--options] disk.img [disk.img ...] directory\n"
1486 #: ../cat/virt-ls.pod:21
1488 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
1489 "more from a virtual machine or disk image."
1493 #: ../cat/virt-ls.pod:24
1495 "Multiple directory names can be given, in which case the output from each is "
1500 #: ../cat/virt-ls.pod:27
1502 "To list directories from a libvirt guest use the I<-d> option to specify the "
1503 "name of the guest. For a disk image, use the I<-a> option."
1507 #: ../cat/virt-ls.pod:31
1509 "C<virt-ls> can do many simple file listings. For more complicated cases you "
1510 "may need to use L<guestfish(1)>, or write a program directly to the L<guestfs"
1515 #: ../cat/virt-ls.pod:37
1516 msgid "Get a list of all files and directories in a virtual machine:"
1520 #: ../cat/virt-ls.pod:39
1523 " virt-ls -R -d guest /\n"
1528 #: ../cat/virt-ls.pod:41
1529 msgid "List all setuid or setgid programs in a Linux virtual machine:"
1533 #: ../cat/virt-ls.pod:43
1536 " virt-ls -lR -d guest / | grep '^- [42]'\n"
1541 #: ../cat/virt-ls.pod:45
1542 msgid "List all public-writable directories in a Linux virtual machine:"
1546 #: ../cat/virt-ls.pod:47
1549 " virt-ls -lR -d guest / | grep '^d ...7'\n"
1554 #: ../cat/virt-ls.pod:49
1555 msgid "List all Unix domain sockets in a Linux virtual machine:"
1559 #: ../cat/virt-ls.pod:51
1562 " virt-ls -lR -d guest / | grep '^s'\n"
1567 #: ../cat/virt-ls.pod:53
1568 msgid "List all regular files with filenames ending in '.png':"
1572 #: ../cat/virt-ls.pod:55
1575 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
1580 #: ../cat/virt-ls.pod:57
1581 msgid "To display files larger than 10MB in home directories:"
1585 #: ../cat/virt-ls.pod:59
1588 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
1593 #: ../cat/virt-ls.pod:61
1594 msgid "Find everything modified in the last 7 days:"
1598 #: ../cat/virt-ls.pod:63
1601 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
1606 #: ../cat/virt-ls.pod:65
1607 msgid "Find regular files modified in the last 24 hours:"
1611 #: ../cat/virt-ls.pod:67
1614 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
1619 #: ../cat/virt-ls.pod:69
1620 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
1624 #: ../cat/virt-ls.pod:71
1626 "Find the differences between files in a guest and an earlier snapshot of the "
1631 #: ../cat/virt-ls.pod:74
1634 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
1635 " virt-ls -lR -a current.img / --uids --time-t > new\n"
1636 " diff -u old new | less\n"
1641 #: ../cat/virt-ls.pod:78
1643 "The commands above won't find files where the content has changed but the "
1644 "metadata (eg. file size and modification date) is the same. To do that, you "
1645 "need to add the I<--checksum> parameter to both C<virt-ls> commands. I<--"
1646 "checksum> can be quite slow since it has to read and compute a checksum of "
1647 "every regular file in the virtual machine."
1651 #: ../cat/virt-ls.pod:84
1652 msgid "OUTPUT MODES"
1656 #: ../cat/virt-ls.pod:86
1658 "C<virt-ls> has four output modes, controlled by different combinations of "
1659 "the I<-l> and I<-R> options."
1663 #: ../cat/virt-ls.pod:89
1664 msgid "SIMPLE LISTING"
1668 #: ../cat/virt-ls.pod:91
1669 msgid "A simple listing is like the ordinary L<ls(1)> command:"
1673 #: ../cat/virt-ls.pod:93
1676 " $ virt-ls -d guest /\n"
1684 #: ../cat/virt-ls.pod:98
1685 msgid "LONG LISTING"
1689 #: ../cat/virt-ls.pod:100
1691 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
1692 "(more specifically, like the C<guestfs_ll> function)."
1696 #: ../cat/virt-ls.pod:103
1699 " $ virt-ls -l -d guest /\n"
1701 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
1702 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
1708 #: ../cat/virt-ls.pod:109
1710 "Note that while this is useful for displaying a directory, do not try "
1711 "parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
1716 #: ../cat/virt-ls.pod:113
1717 msgid "RECURSIVE LISTING"
1721 #: ../cat/virt-ls.pod:115
1723 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
1724 "and directories recursively:"
1728 #: ../cat/virt-ls.pod:118
1731 " $ virt-ls -R -d guest /tmp\n"
1739 #: ../cat/virt-ls.pod:123
1741 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
1742 "converts C<\\0> characters to C<\\n>."
1746 #: ../cat/virt-ls.pod:126
1747 msgid "RECURSIVE LONG LISTING"
1751 #: ../cat/virt-ls.pod:128
1753 "Using I<-lR> options together changes the output to display directories "
1754 "recursively, with file stats, and optionally other features such as "
1755 "checksums and extended attributes."
1759 #: ../cat/virt-ls.pod:132
1761 "Most of the interesting features of C<virt-ls> are only available when using "
1766 #: ../cat/virt-ls.pod:135
1768 "The fields are normally space-separated. Filenames are B<not> quoted, so "
1769 "you cannot use the output in another program (because filenames can contain "
1770 "spaces and other unsafe characters). If the guest was untrusted and someone "
1771 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
1772 "on you by creating filenames with embedded newline characters. To B<safely> "
1773 "parse the output in another program, use the I<--csv> (Comma-Separated "
1778 #: ../cat/virt-ls.pod:143
1780 "Note that this output format is completely unrelated to the C<ls -lR> "
1785 #: ../cat/virt-ls.pod:146
1788 " $ virt-ls -lR -d guest /bin\n"
1789 " d 0555 4096 /bin\n"
1790 " - 0755 123 /bin/alsaunmute\n"
1791 " - 0755 28328 /bin/arch\n"
1792 " l 0777 4 /bin/awk -> gawk\n"
1793 " - 0755 27216 /bin/basename\n"
1794 " - 0755 943360 /bin/bash\n"
1800 #: ../cat/virt-ls.pod:155
1801 msgid "These basic fields are always shown:"
1805 #: ../cat/virt-ls.pod:159
1810 #: ../cat/virt-ls.pod:161
1812 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
1813 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
1814 "link), C<s> (socket) or C<u> (unknown)."
1818 #: ../cat/virt-ls.pod:171
1823 #: ../cat/virt-ls.pod:173
1824 msgid "The Unix permissions, displayed as a 4 digit octal number."
1828 #: ../cat/virt-ls.pod:175
1833 #: ../cat/virt-ls.pod:177
1835 "The size of the file. This is shown in bytes unless I<-h> or I<--human-"
1836 "readable> option is given, in which case this is shown as a human-readable "
1841 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4188
1846 #: ../cat/virt-ls.pod:183
1847 msgid "The full path of the file or directory."
1851 #: ../cat/virt-ls.pod:185
1856 #: ../cat/virt-ls.pod:187
1857 msgid "For symbolic links only, the link target."
1861 #: ../cat/virt-ls.pod:191
1863 "In I<-lR> mode, additional command line options enable the display of more "
1868 #: ../cat/virt-ls.pod:194
1870 "With the I<--uids> flag, these additional fields are displayed before the "
1875 #: ../cat/virt-ls.pod:199
1880 #: ../cat/virt-ls.pod:201
1885 #: ../cat/virt-ls.pod:203
1887 "The UID and GID of the owner of the file (displayed numerically). Note "
1888 "these only make sense in the context of a Unix-like guest."
1892 #: ../cat/virt-ls.pod:208
1893 msgid "With the I<--times> flag, these additional fields are displayed:"
1897 #: ../cat/virt-ls.pod:212
1902 #: ../cat/virt-ls.pod:214
1903 msgid "The time of last access."
1907 #: ../cat/virt-ls.pod:216
1912 #: ../cat/virt-ls.pod:218
1913 msgid "The time of last modification."
1917 #: ../cat/virt-ls.pod:220
1922 #: ../cat/virt-ls.pod:222
1923 msgid "The time of last status change."
1927 #: ../cat/virt-ls.pod:226
1929 "The time fields are displayed as string dates and times, unless one of the "
1930 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
1934 #: ../cat/virt-ls.pod:229
1935 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
1939 #: ../cat/virt-ls.pod:233
1944 #: ../cat/virt-ls.pod:235
1946 "The device containing the file (displayed as major:minor). This may not "
1947 "match devices as known to the guest."
1951 #: ../cat/virt-ls.pod:238
1956 #: ../cat/virt-ls.pod:240
1957 msgid "The inode number."
1961 #: ../cat/virt-ls.pod:242
1966 #: ../cat/virt-ls.pod:244
1967 msgid "The number of hard links."
1971 #: ../cat/virt-ls.pod:246
1976 #: ../cat/virt-ls.pod:248
1978 "For block and char special files, the device (displayed as major:minor)."
1982 #: ../cat/virt-ls.pod:251
1987 #: ../cat/virt-ls.pod:253
1988 msgid "The number of 512 byte blocks allocated to the file."
1992 #: ../cat/virt-ls.pod:257
1994 "With the I<--checksum> flag, the checksum of the file contents is shown "
1995 "(only for regular files). Computing file checksums can take a considerable "
2000 #: ../cat/virt-ls.pod:280
2001 msgid "B<--checksum>"
2005 #: ../cat/virt-ls.pod:282
2006 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
2010 #: ../cat/virt-ls.pod:284
2012 "Display checksum over file contents for regular files. With no argument, "
2013 "this defaults to using I<md5>. Using an argument, you can select the "
2014 "checksum type to use."
2018 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358
2019 #: ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408
2020 #: ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
2022 "This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
2027 #: ../cat/virt-ls.pod:316
2029 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
2030 "so you cannot see what you are typing. If you are not worried about Tempest "
2031 "attacks and there is no one else in the room you can specify this flag to "
2032 "see what you are typing."
2036 #: ../cat/virt-ls.pod:321
2037 msgid "B<--extra-stats>"
2041 #: ../cat/virt-ls.pod:323
2042 msgid "Display extra stats."
2046 #: ../cat/virt-ls.pod:339
2049 " virt-ls --format=raw -a disk.img /dir\n"
2054 #: ../cat/virt-ls.pod:343
2057 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
2062 #: ../cat/virt-ls.pod:356
2063 msgid "Display file sizes in human-readable format."
2067 #: ../cat/virt-ls.pod:370
2072 #: ../cat/virt-ls.pod:372
2073 msgid "B<--recursive>"
2077 #: ../cat/virt-ls.pod:374
2079 "Select the mode. With neither of these options, C<virt-ls> produces a "
2080 "simple, flat list of the files in the named directory. See L</SIMPLE "
2085 #: ../cat/virt-ls.pod:378
2087 "C<virt-ls -l> produces a \"long listing\", which shows more detail. See L</"
2092 #: ../cat/virt-ls.pod:381
2094 "C<virt-ls -R> produces a recursive list of files starting at the named "
2095 "directory. See L</RECURSIVE LISTING>."
2099 #: ../cat/virt-ls.pod:384
2101 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
2102 "parsed. See L</RECURSIVE LONG LISTING>."
2106 #: ../cat/virt-ls.pod:387
2111 #: ../cat/virt-ls.pod:389
2112 msgid "Display time fields."
2116 #: ../cat/virt-ls.pod:394
2117 msgid "B<--time-days>"
2121 #: ../cat/virt-ls.pod:396
2122 msgid "Display time fields as days before now (negative if in the future)."
2126 #: ../cat/virt-ls.pod:398
2128 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
2129 "of the file is between 0 and 86399 seconds."
2133 #: ../cat/virt-ls.pod:404
2134 msgid "B<--time-relative>"
2138 #: ../cat/virt-ls.pod:406
2139 msgid "Display time fields as seconds before now (negative if in the future)."
2143 #: ../cat/virt-ls.pod:411
2148 #: ../cat/virt-ls.pod:413
2149 msgid "Display time fields as seconds since the Unix epoch."
2153 #: ../cat/virt-ls.pod:418
2158 #: ../cat/virt-ls.pod:420
2159 msgid "Display UID and GID fields."
2163 #: ../cat/virt-ls.pod:445
2164 msgid "Previous versions of virt-ls allowed you to write either:"
2168 #: ../cat/virt-ls.pod:447
2171 " virt-ls disk.img [disk.img ...] /dir\n"
2176 #: ../cat/virt-ls.pod:451
2179 " virt-ls guestname /dir\n"
2184 #: ../cat/virt-ls.pod:492
2186 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-"
2187 "tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
2188 "L<http://libguestfs.org/>."
2192 #: ../cat/virt-ls.pod:508 ../df/virt-df.pod:236 ../edit/virt-edit.pod:369
2193 #: ../rescue/virt-rescue.pod:298
2194 msgid "Copyright (C) 2009-2011 Red Hat Inc."
2198 #: ../df/virt-df.pod:5
2199 msgid "virt-df - Display free space on virtual filesystems"
2203 #: ../df/virt-df.pod:9
2206 " virt-df [--options]\n"
2211 #: ../df/virt-df.pod:11
2214 " virt-df [--options] -d domname\n"
2219 #: ../df/virt-df.pod:13
2222 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
2227 #: ../df/virt-df.pod:17
2230 " virt-df [--options] domname\n"
2235 #: ../df/virt-df.pod:19
2238 " virt-df [--options] disk.img [disk.img ...]\n"
2243 #: ../df/virt-df.pod:23
2245 "C<virt-df> is a command line tool to display free space on virtual machine "
2246 "filesystems. Unlike other tools, it doesn't just display the size of disk "
2247 "allocated to a virtual machine, but can look inside disk images to see how "
2248 "much space is really being used."
2252 #: ../df/virt-df.pod:28
2254 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
2255 "to get a list of all active and inactive guests, and performs a C<df>-type "
2256 "operation on each one in turn, printing out the results."
2260 #: ../df/virt-df.pod:32
2262 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a C<df>-"
2263 "type operation on either the single named libvirt domain, or on the disk "
2264 "image(s) listed on the command line (which must all belong to a single VM). "
2265 "In this mode (with arguments), C<virt-df> will I<only work for a single "
2266 "guest>. If you want to run on multiple guests, then you have to invoke "
2267 "C<virt-df> multiple times."
2271 #: ../df/virt-df.pod:39
2273 "Use the I<--csv> option to get a format which can be easily parsed by other "
2274 "programs. Other options are similar to the standard L<df(1)> command."
2278 #: ../df/virt-df.pod:45
2280 "Show disk usage for a single libvirt guest called C<F14x64>. Make the "
2281 "output human-readable:"
2285 #: ../df/virt-df.pod:48
2288 " # virt-df -d F14x64 -h\n"
2289 " Filesystem Size Used Available Use%\n"
2290 " F14x64:/dev/sda1 484M 66M 393M 14%\n"
2291 " F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
2296 #: ../df/virt-df.pod:53
2297 msgid "Show disk usage for a disk image file called C<test.img>:"
2301 #: ../df/virt-df.pod:55
2304 " $ virt-df -a test1.img\n"
2305 " Filesystem 1K-blocks Used Available Use%\n"
2306 " test1.img:/dev/sda1 99099 1551 92432 2%\n"
2311 #: ../df/virt-df.pod:112
2314 " virt-df --format=raw -a disk.img\n"
2319 #: ../df/virt-df.pod:116
2322 " virt-df --format=raw -a disk.img --format -a another.img\n"
2327 #: ../df/virt-df.pod:129
2328 msgid "Print sizes in human-readable format."
2332 #: ../df/virt-df.pod:131
2333 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
2337 #: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155
2342 #: ../df/virt-df.pod:135
2347 #: ../df/virt-df.pod:137
2348 msgid "Print inodes instead of blocks."
2352 #: ../df/virt-df.pod:139
2353 msgid "B<--one-per-guest>"
2357 #: ../df/virt-df.pod:141
2359 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
2360 "disks from several guests to a single libguestfs appliance."
2364 #: ../df/virt-df.pod:144
2365 msgid "You might use this option in the following circumstances:"
2369 #: ../df/virt-df.pod:148 ../df/virt-df.pod:154 ../edit/virt-edit.pod:266
2370 #: ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276
2371 #: ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291
2372 #: ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102
2373 #: ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132
2374 #: ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227
2375 #: ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235
2376 #: ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243
2377 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
2378 #: ../fish/guestfish-actions.pod:390 ../fish/guestfish-actions.pod:398
2379 #: ../fish/guestfish-actions.pod:405 ../fish/guestfish-actions.pod:412
2380 #: ../fish/guestfish-actions.pod:1104 ../fish/guestfish-actions.pod:1108
2381 #: ../fish/guestfish-actions.pod:1112 ../fish/guestfish-actions.pod:1116
2382 #: ../fish/guestfish-actions.pod:1124 ../fish/guestfish-actions.pod:1128
2383 #: ../fish/guestfish-actions.pod:1132 ../fish/guestfish-actions.pod:1142
2384 #: ../fish/guestfish-actions.pod:1146 ../fish/guestfish-actions.pod:1150
2385 #: ../fish/guestfish-actions.pod:1240 ../fish/guestfish-actions.pod:1244
2386 #: ../fish/guestfish-actions.pod:1249 ../fish/guestfish-actions.pod:1254
2387 #: ../fish/guestfish-actions.pod:1296 ../fish/guestfish-actions.pod:1300
2388 #: ../fish/guestfish-actions.pod:1305 ../fish/guestfish-actions.pod:1938
2389 #: ../fish/guestfish-actions.pod:1944 ../fish/guestfish-actions.pod:1952
2390 #: ../fish/guestfish-actions.pod:1959 ../fish/guestfish-actions.pod:1966
2391 #: ../fish/guestfish.pod:445 ../fish/guestfish.pod:449
2392 #: ../fish/guestfish.pod:453 ../fish/guestfish.pod:457
2393 #: ../inspector/virt-inspector.pod:384 ../inspector/virt-inspector.pod:388
2394 #: ../resize/virt-resize.pod:282 ../resize/virt-resize.pod:286
2395 #: ../resize/virt-resize.pod:295 ../resize/virt-resize.pod:301
2396 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:29
2397 #: ../src/guestfs-actions.pod:588 ../src/guestfs-actions.pod:596
2398 #: ../src/guestfs-actions.pod:603 ../src/guestfs-actions.pod:610
2399 #: ../src/guestfs-actions.pod:1667 ../src/guestfs-actions.pod:1671
2400 #: ../src/guestfs-actions.pod:1675 ../src/guestfs-actions.pod:1679
2401 #: ../src/guestfs-actions.pod:1687 ../src/guestfs-actions.pod:1691
2402 #: ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1705
2403 #: ../src/guestfs-actions.pod:1709 ../src/guestfs-actions.pod:1713
2404 #: ../src/guestfs-actions.pod:1851 ../src/guestfs-actions.pod:1855
2405 #: ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1865
2406 #: ../src/guestfs-actions.pod:1926 ../src/guestfs-actions.pod:1930
2407 #: ../src/guestfs-actions.pod:1935 ../src/guestfs-actions.pod:2864
2408 #: ../src/guestfs-actions.pod:2870 ../src/guestfs-actions.pod:2878
2409 #: ../src/guestfs-actions.pod:2885 ../src/guestfs-actions.pod:2892
2410 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
2411 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
2412 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
2413 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
2414 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
2415 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
2416 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
2417 #: ../src/guestfs.pod:1644 ../src/guestfs.pod:1649 ../src/guestfs.pod:1653
2418 #: ../src/guestfs.pod:1755 ../src/guestfs.pod:1760 ../src/guestfs.pod:1764
2419 #: ../src/guestfs.pod:1774 ../src/guestfs.pod:2048 ../src/guestfs.pod:2053
2420 #: ../src/guestfs.pod:2059 ../src/guestfs.pod:2067 ../src/guestfs.pod:2421
2421 #: ../src/guestfs.pod:2427 ../src/guestfs.pod:2432 ../src/guestfs.pod:2438
2422 #: ../src/guestfs.pod:2819 ../src/guestfs.pod:2824 ../src/guestfs.pod:2828
2423 #: ../src/guestfs.pod:2832 ../src/guestfs.pod:2836 ../src/guestfs.pod:2850
2424 #: ../src/guestfs.pod:2855 ../src/guestfs.pod:3080 ../src/guestfs.pod:3084
2425 #: ../src/guestfs.pod:3088 ../src/guestfs.pod:3092
2426 #: ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202
2427 #: ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:710
2428 #: ../tools/virt-win-reg.pl:716 ../tools/virt-win-reg.pl:722
2433 #: ../df/virt-df.pod:150
2435 "If you think an untrusted guest might actively try to exploit the libguestfs "
2436 "appliance kernel, then this prevents one guest from interfering with the "
2437 "stats printed for another guest."
2441 #: ../df/virt-df.pod:156
2443 "If the kernel has a bug which stops it from accessing a filesystem in one "
2444 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
2445 "and report stats for further guests."
2449 #: ../df/virt-df.pod:165
2451 "Print UUIDs instead of names. This is useful for following a guest even "
2452 "when the guest is migrated or renamed, or when two guests happen to have the "
2457 #: ../df/virt-df.pod:169
2459 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
2460 "images, we still print the disk image name even when this option is "
2465 #: ../df/virt-df.pod:224
2467 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<http://"
2472 #: ../edit/virt-edit.pod:5
2473 msgid "virt-edit - Edit a file in a virtual machine"
2477 #: ../edit/virt-edit.pod:9
2480 " virt-edit [--options] -d domname file [file ...]\n"
2485 #: ../edit/virt-edit.pod:11
2488 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
2493 #: ../edit/virt-edit.pod:13
2496 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
2501 #: ../edit/virt-edit.pod:17
2504 " virt-edit domname file\n"
2509 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
2512 " virt-edit disk.img [disk.img ...] file\n"
2517 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23
2518 #: ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15
2519 #: ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:19
2520 #: ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51
2525 #: ../edit/virt-edit.pod:23
2527 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
2528 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
2529 "doing this, but doesn't catch all cases."
2533 #: ../edit/virt-edit.pod:29
2535 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
2536 "exists in the named virtual machine (or disk image)."
2540 #: ../edit/virt-edit.pod:32
2542 "Multiple filenames can be given, in which case they are each edited in "
2543 "turn. Each filename must be a full path, starting at the root directory "
2544 "(starting with '/')."
2548 #: ../edit/virt-edit.pod:36
2549 msgid "If you want to just view a file, use L<virt-cat(1)>."
2553 #: ../edit/virt-edit.pod:38
2555 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
2556 "USING GUESTFISH> below)."
2560 #: ../edit/virt-edit.pod:41
2562 "C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
2563 "that and much more."
2567 #: ../edit/virt-edit.pod:46
2568 msgid "Edit the named files interactively:"
2572 #: ../edit/virt-edit.pod:48
2575 " virt-edit -d mydomain /boot/grub/grub.conf\n"
2580 #: ../edit/virt-edit.pod:50
2583 " virt-edit -d mydomain /etc/passwd\n"
2588 #: ../edit/virt-edit.pod:52
2589 msgid "For Windows guests, some Windows paths are understood:"
2593 #: ../edit/virt-edit.pod:54
2596 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
2601 #: ../edit/virt-edit.pod:56
2603 "If Perl is installed, you can also edit files non-interactively (see L</NON-"
2604 "INTERACTIVE EDITING> below). To change the init default level to 5:"
2608 #: ../edit/virt-edit.pod:60
2611 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
2616 #: ../edit/virt-edit.pod:81
2617 msgid "B<-b> extension"
2621 #: ../edit/virt-edit.pod:83
2622 msgid "B<--backup> extension"
2626 #: ../edit/virt-edit.pod:85
2628 "Create a backup of the original file I<in the guest disk image>. The backup "
2629 "has the original filename with C<extension> added."
2633 #: ../edit/virt-edit.pod:88
2635 "Usually the first character of C<extension> would be a dot C<.> so you would "
2640 #: ../edit/virt-edit.pod:91
2643 " virt-edit -b .orig [etc]\n"
2648 #: ../edit/virt-edit.pod:93
2649 msgid "By default, no backup file is made."
2653 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181
2654 #: ../fuse/guestmount.pod:96 ../inspector/virt-inspector.pod:74
2655 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78
2656 #: ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
2661 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183
2662 #: ../fuse/guestmount.pod:98 ../inspector/virt-inspector.pod:76
2663 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80
2664 #: ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
2665 msgid "B<--connect URI>"
2669 #: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84
2670 #: ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134
2671 #: ../tools/virt-win-reg.pl:135
2673 "If you specify guest block devices directly, then libvirt is not used at all."
2677 #: ../edit/virt-edit.pod:114
2679 "When prompting for keys and passphrases, virt-edit normally turns echoing "
2680 "off so you cannot see what you are typing. If you are not worried about "
2681 "Tempest attacks and there is no one else in the room you can specify this "
2682 "flag to see what you are typing."
2686 #: ../edit/virt-edit.pod:119
2691 #: ../edit/virt-edit.pod:121
2692 msgid "B<--expr> EXPR"
2696 #: ../edit/virt-edit.pod:123
2698 "Instead of launching the external editor, non-interactively apply the Perl "
2699 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
2704 #: ../edit/virt-edit.pod:127
2706 "Be careful to properly quote the expression to prevent it from being altered "
2711 #: ../edit/virt-edit.pod:130
2712 msgid "Note that this option is only available when Perl 5 is installed."
2716 #: ../edit/virt-edit.pod:132
2717 msgid "B<--format> raw|qcow2|..."
2721 #: ../edit/virt-edit.pod:143
2724 " virt-edit --format=raw -a disk.img file\n"
2729 #: ../edit/virt-edit.pod:147
2732 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
2737 #: ../edit/virt-edit.pod:181
2738 msgid "Previous versions of virt-edit allowed you to write either:"
2742 #: ../edit/virt-edit.pod:187
2745 " virt-edit guestname file\n"
2750 #: ../edit/virt-edit.pod:195
2751 msgid "NON-INTERACTIVE EDITING"
2755 #: ../edit/virt-edit.pod:197
2757 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
2758 "administrator can interactively edit the file."
2762 #: ../edit/virt-edit.pod:200
2764 "There are two ways also to use C<virt-edit> from scripts in order to make "
2765 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
2766 "like this, it's less error-prone to write scripts directly using the "
2767 "libguestfs API and Augeas for configuration file editing.)"
2771 #: ../edit/virt-edit.pod:206
2773 "The first method is to temporarily set C<$EDITOR> to any script or program "
2774 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
2775 "update C<tmpfile> in place however it likes."
2779 #: ../edit/virt-edit.pod:210
2781 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
2782 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
2783 "instances of C<foo> with C<bar> in a file:"
2787 #: ../edit/virt-edit.pod:214
2790 " virt-edit -d domname filename -e 's/foo/bar/'\n"
2795 #: ../edit/virt-edit.pod:216
2797 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
2798 "For example to delete root's password you could do:"
2802 #: ../edit/virt-edit.pod:219
2805 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
2810 #: ../edit/virt-edit.pod:221
2812 "What really happens is that the snippet is evaluated as a Perl expression "
2813 "for each line of the file. The line, including the final C<\\n>, is passed "
2814 "in C<$_> and the expression should update C<$_> or leave it unchanged."
2818 #: ../edit/virt-edit.pod:226
2820 "To delete a line, set C<$_> to the empty string. For example, to delete the "
2821 "C<apache> user account from the password file you can do:"
2825 #: ../edit/virt-edit.pod:229
2828 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
2833 #: ../edit/virt-edit.pod:231
2835 "To insert a line, prepend or append it to C<$_>. However appending lines to "
2836 "the end of the file is rather difficult this way since there is no concept "
2837 "of \"last line of the file\" - your expression just doesn't get called "
2838 "again. You might want to use the first method (setting C<$EDITOR>) if you "
2843 #: ../edit/virt-edit.pod:237
2845 "The variable C<$lineno> contains the current line number. As is "
2846 "traditional, the first line in the file is number C<1>."
2850 #: ../edit/virt-edit.pod:240
2852 "The return value from the expression is ignored, but the expression may call "
2853 "C<die> in order to abort the whole program, leaving the original file "
2858 #: ../edit/virt-edit.pod:244
2860 "Remember when matching the end of a line that C<$_> may contain the final C<"
2861 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
2862 "newline then neither of these. Thus to match or substitute some text at the "
2863 "end of a line, use this regular expression:"
2867 #: ../edit/virt-edit.pod:249
2870 " /some text(\\r?\\n)?$/\n"
2875 #: ../edit/virt-edit.pod:251
2877 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
2878 "$_> itself (since that would remove all newlines from the file):"
2882 #: ../edit/virt-edit.pod:255
2885 " my $m = $_; chomp $m; $m =~ /some text$/\n"
2890 #: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
2891 msgid "WINDOWS PATHS"
2895 #: ../edit/virt-edit.pod:259
2897 "C<virt-edit> has a limited ability to understand Windows drive letters and "
2898 "paths (eg. C<E:\\foo\\bar.txt>)."
2902 #: ../edit/virt-edit.pod:262
2903 msgid "If and only if the guest is running Windows then:"
2907 #: ../edit/virt-edit.pod:268
2909 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
2910 "to the correct filesystem."
2914 #: ../edit/virt-edit.pod:273
2916 "Any backslash (C<\\>) characters in the path are replaced with forward "
2917 "slashes so that libguestfs can process it."
2921 #: ../edit/virt-edit.pod:278
2923 "The path is resolved case insensitively to locate the file that should be "
2928 #: ../edit/virt-edit.pod:283
2929 msgid "There are some known shortcomings:"
2933 #: ../edit/virt-edit.pod:289
2934 msgid "Some NTFS symbolic links may not be followed correctly."
2938 #: ../edit/virt-edit.pod:293
2939 msgid "NTFS junction points that cross filesystems are not followed."
2943 #: ../edit/virt-edit.pod:299
2945 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
2946 "C<virt-edit> doesn't work."
2950 #: ../edit/virt-edit.pod:302
2951 msgid "Using C<virt-edit> is approximately equivalent to doing:"
2955 #: ../edit/virt-edit.pod:304
2958 " guestfish --rw -i -d domname edit /file\n"
2963 #: ../edit/virt-edit.pod:306
2965 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
2970 #: ../edit/virt-edit.pod:309
2972 "The command above uses libguestfs's guest inspection feature and so does not "
2973 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
2974 "disk images that don't contain guests. To edit a file on a disk image "
2979 #: ../edit/virt-edit.pod:314
2982 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
2987 #: ../edit/virt-edit.pod:316
2989 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
2990 "the disk image to edit, and C</file> is the full path to the file."
2994 #: ../edit/virt-edit.pod:320
2996 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
2997 "C<write> or C<upload> instead:"
3001 #: ../edit/virt-edit.pod:323
3004 " guestfish --rw -i -d domname touch /newfile\n"
3009 #: ../edit/virt-edit.pod:325
3012 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
3017 #: ../edit/virt-edit.pod:327
3020 " guestfish --rw -i -d domname upload localfile /newfile\n"
3025 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1086
3026 #: ../rescue/virt-rescue.pod:257 ../src/guestfs.pod:2966
3027 #: ../test-tool/libguestfs-test-tool.pod:82
3028 msgid "ENVIRONMENT VARIABLES"
3032 #: ../edit/virt-edit.pod:333
3037 #: ../edit/virt-edit.pod:335
3039 "If set, this string is used as the editor. It may contain arguments, eg. C<"
3044 #: ../edit/virt-edit.pod:338
3045 msgid "If not set, C<vi> is used."
3049 #: ../edit/virt-edit.pod:351
3051 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
3052 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
3053 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
3057 #: ../examples/guestfs-examples.pod:5
3058 msgid "guestfs-examples - Examples of using libguestfs from C"
3062 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
3065 " #include <guestfs.h>\n"
3070 #: ../examples/guestfs-examples.pod:11
3073 " guestfs_h *g = guestfs_create ();\n"
3074 " guestfs_add_drive_ro (g, \"disk.img\");\n"
3075 " guestfs_launch (g);\n"
3080 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
3083 " cc prog.c -o prog -lguestfs\n"
3085 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
3090 #: ../examples/guestfs-examples.pod:21
3092 "This manual page contains examples of calling libguestfs from the C "
3093 "programming language. If you are not familiar with using libguestfs, you "
3094 "also need to read L<guestfs(3)>."
3098 #: ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37
3099 #: ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31
3100 #: ../python/examples/guestfs-python.pod:34
3101 #: ../ruby/examples/guestfs-ruby.pod:28
3102 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
3106 #: ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39
3107 #: ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33
3108 #: ../python/examples/guestfs-python.pod:36
3109 #: ../ruby/examples/guestfs-ruby.pod:30
3114 #: ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41
3115 #: ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35
3116 #: ../python/examples/guestfs-python.pod:38
3117 #: ../ruby/examples/guestfs-ruby.pod:32
3118 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
3122 #: ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43
3123 #: ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37
3124 #: ../python/examples/guestfs-python.pod:40
3125 #: ../ruby/examples/guestfs-ruby.pod:34
3130 #: ../examples/guestfs-examples.pod:35
3132 "L<guestfs(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
3133 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
3138 #: ../examples/guestfs-examples.pod:44 ../examples/guestfs-recipes.pod:396
3139 #: ../fish/guestfish.pod:1260 ../fish/virt-copy-in.pod:60
3140 #: ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58
3141 #: ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:314
3142 #: ../inspector/virt-inspector.pod:380 ../java/examples/guestfs-java.pod:57
3143 #: ../ocaml/examples/guestfs-ocaml.pod:90 ../perl/examples/guestfs-perl.pod:51
3144 #: ../python/examples/guestfs-python.pod:53
3145 #: ../ruby/examples/guestfs-ruby.pod:47 ../src/guestfs.pod:3099
3146 #: ../test-tool/libguestfs-test-tool.pod:93
3151 #: ../examples/guestfs-examples.pod:46 ../examples/guestfs-recipes.pod:398
3152 #: ../fish/guestfish.pod:1262 ../fish/virt-copy-in.pod:62
3153 #: ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60
3154 #: ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:316
3155 #: ../java/examples/guestfs-java.pod:59 ../ocaml/examples/guestfs-ocaml.pod:92
3156 #: ../perl/examples/guestfs-perl.pod:53
3157 #: ../python/examples/guestfs-python.pod:55
3158 #: ../ruby/examples/guestfs-ruby.pod:49 ../src/guestfs.pod:3101
3159 #: ../test-tool/libguestfs-test-tool.pod:95
3160 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3164 #: ../examples/guestfs-examples.pod:50 ../ocaml/examples/guestfs-ocaml.pod:96
3165 #: ../python/examples/guestfs-python.pod:59
3166 #: ../ruby/examples/guestfs-ruby.pod:53
3167 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
3171 #: ../examples/guestfs-examples.pod:52 ../examples/guestfs-recipes.pod:404
3172 #: ../java/examples/guestfs-java.pod:65 ../ocaml/examples/guestfs-ocaml.pod:98
3173 #: ../perl/examples/guestfs-perl.pod:59
3174 #: ../python/examples/guestfs-python.pod:61
3175 #: ../ruby/examples/guestfs-ruby.pod:55
3177 "The examples in this manual page may be freely copied, modified and "
3178 "distributed without any restrictions."
3182 #: ../examples/guestfs-examples.pod:55 ../examples/guestfs-recipes.pod:407
3183 #: ../java/examples/guestfs-java.pod:68
3184 #: ../ocaml/examples/guestfs-ocaml.pod:101
3185 #: ../perl/examples/guestfs-perl.pod:62
3186 #: ../python/examples/guestfs-python.pod:64
3187 #: ../ruby/examples/guestfs-ruby.pod:58 ../src/guestfs.pod:3108
3189 "This library is free software; you can redistribute it and/or modify it "
3190 "under the terms of the GNU Lesser General Public License as published by the "
3191 "Free Software Foundation; either version 2 of the License, or (at your "
3192 "option) any later version."
3196 #: ../examples/guestfs-examples.pod:60 ../examples/guestfs-recipes.pod:412
3197 #: ../java/examples/guestfs-java.pod:73
3198 #: ../ocaml/examples/guestfs-ocaml.pod:106
3199 #: ../perl/examples/guestfs-perl.pod:67
3200 #: ../python/examples/guestfs-python.pod:69
3201 #: ../ruby/examples/guestfs-ruby.pod:63 ../src/guestfs.pod:3113
3203 "This library is distributed in the hope that it will be useful, but WITHOUT "
3204 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3205 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3210 #: ../examples/guestfs-examples.pod:65 ../examples/guestfs-recipes.pod:417
3211 #: ../java/examples/guestfs-java.pod:78
3212 #: ../ocaml/examples/guestfs-ocaml.pod:111
3213 #: ../perl/examples/guestfs-perl.pod:72
3214 #: ../python/examples/guestfs-python.pod:74
3215 #: ../ruby/examples/guestfs-ruby.pod:68 ../src/guestfs.pod:3118
3217 "You should have received a copy of the GNU Lesser General Public License "
3218 "along with this library; if not, write to the Free Software Foundation, "
3219 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3223 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
3228 #: ../examples/guestfs-recipes.pod:5
3230 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
3231 "here. The only way which works for both sorts of output is to just write "
3232 "the URL directly. Do NOT use L<...> for URLs."
3236 #: ../examples/guestfs-recipes.pod:9
3238 "We break with tradition here and don't use ALL CAPS for the section "
3239 "headings, as this makes them much easier to read."
3243 #: ../examples/guestfs-recipes.pod:16
3244 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
3248 #: ../examples/guestfs-recipes.pod:20
3250 "This page contains recipes for and links to things you can do using "
3251 "libguestfs, L<guestfish(1)> and the virt tools."
3255 #: ../examples/guestfs-recipes.pod:23
3256 msgid "Audit a virtual machine for setuid files"
3260 #: ../examples/guestfs-recipes.pod:25
3262 "The link below contains a small program which can be used to audit a Linux "
3263 "virtual machine to see what setuid and setgid files it contains."
3267 #: ../examples/guestfs-recipes.pod:28
3269 "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-"
3274 #: ../examples/guestfs-recipes.pod:30
3275 msgid "Change the background image in a Windows XP VM"
3279 #: ../examples/guestfs-recipes.pod:32
3281 "The links below explain how to use L<guestfish(1)> to change the background "
3282 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
3283 "be substantially different for each version of Windows."
3287 #: ../examples/guestfs-recipes.pod:37
3289 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html https://"
3290 "lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
3294 #: ../examples/guestfs-recipes.pod:40
3295 msgid "Cloning a virtual machine (Linux)"
3299 #: ../examples/guestfs-recipes.pod:42
3301 "The guestfish technique described in the link below works well for most "
3302 "Linux VMs. Depending on the Linux distro you may need to change the paths "
3307 #: ../examples/guestfs-recipes.pod:46
3309 "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-"
3314 #: ../examples/guestfs-recipes.pod:48
3316 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
3321 #: ../examples/guestfs-recipes.pod:51
3322 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
3326 #: ../examples/guestfs-recipes.pod:53
3327 msgid "Cloning a virtual machine (Windows)"
3331 #: ../examples/guestfs-recipes.pod:55
3333 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
3334 "straightforward. Currently there is code in the Aeolus Oz project which "
3335 "does this (using libguestfs). As part of our review of the virt-clone tool, "
3336 "we may add sysprepping ability."
3340 #: ../examples/guestfs-recipes.pod:60
3342 "https://github.com/clalancette/oz https://www.redhat.com/archives/virt-tools-"
3343 "list/2011-May/msg00019.html"
3347 #: ../examples/guestfs-recipes.pod:63
3348 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
3352 #: ../examples/guestfs-recipes.pod:65
3353 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
3357 #: ../examples/guestfs-recipes.pod:67
3360 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
3365 #: ../examples/guestfs-recipes.pod:69
3366 msgid "To export just a subdirectory, eg. C</files>, do:"
3370 #: ../examples/guestfs-recipes.pod:71
3373 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
3378 #: ../examples/guestfs-recipes.pod:73
3379 msgid "Create empty disk images"
3383 #: ../examples/guestfs-recipes.pod:75
3385 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
3386 "The useful guide below explains the options available."
3390 #: ../examples/guestfs-recipes.pod:78
3392 "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/"
3397 #: ../examples/guestfs-recipes.pod:80
3398 msgid "Dump raw filesystem content from inside a disk image or VM"
3402 #: ../examples/guestfs-recipes.pod:82
3404 "You can use the L<guestfish(1)> C<download> command to extract the raw "
3405 "filesystem content from any filesystem in a disk image or a VM (even one "
3406 "which is encrypted or buried inside an LV):"
3410 #: ../examples/guestfs-recipes.pod:86
3413 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
3418 #: ../examples/guestfs-recipes.pod:88
3421 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
3426 #: ../examples/guestfs-recipes.pod:90
3427 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
3431 #: ../examples/guestfs-recipes.pod:92
3432 msgid "Edit grub configuration in a VM"
3436 #: ../examples/guestfs-recipes.pod:94
3437 msgid "You can use this to:"
3441 #: ../examples/guestfs-recipes.pod:100
3442 msgid "Fix a virtual machine that does not boot."
3446 #: ../examples/guestfs-recipes.pod:104
3447 msgid "Change which kernel is used to boot the VM."
3451 #: ../examples/guestfs-recipes.pod:108
3452 msgid "Change kernel command line options."
3456 #: ../examples/guestfs-recipes.pod:112
3457 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
3461 #: ../examples/guestfs-recipes.pod:114
3464 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
3469 #: ../examples/guestfs-recipes.pod:116
3471 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
3476 #: ../examples/guestfs-recipes.pod:119
3479 " virt-rescue -d BrokenGuest\n"
3484 #: ../examples/guestfs-recipes.pod:121
3485 msgid "Export any directory from a VM"
3489 #: ../examples/guestfs-recipes.pod:123
3491 "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
3495 #: ../examples/guestfs-recipes.pod:126
3498 " virt-copy-out -d Guest /home .\n"
3503 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9
3504 #: ../fish/guestfish-actions.pod:1292 ../fish/guestfish-actions.pod:1934
3505 #: ../src/guestfs-actions.pod:18 ../src/guestfs-actions.pod:1922
3506 #: ../src/guestfs-actions.pod:2860 ../src/guestfs.pod:1640
3507 #: ../tools/virt-win-reg.pl:706
3512 #: ../examples/guestfs-recipes.pod:134
3514 "The final dot of the command is not a printing error. It means we want to "
3515 "copy out to the current directory."
3519 #: ../examples/guestfs-recipes.pod:139
3520 msgid "This creates a directory called C<home> under the current directory."
3524 #: ../examples/guestfs-recipes.pod:143
3526 "If the guest is a Windows guest then you can use drive letters and "
3527 "backslashes, but you must prefix the path with C<win:> and quote it to "
3528 "protect it from the shell, like this:"
3532 #: ../examples/guestfs-recipes.pod:147
3535 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
3540 #: ../examples/guestfs-recipes.pod:149
3541 msgid "To get the output as a compressed tarball, do:"
3545 #: ../examples/guestfs-recipes.pod:151
3548 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
3553 #: ../examples/guestfs-recipes.pod:153
3555 "Although it sounds tempting, this is usually not a reliable way to get a "
3556 "backup from a running guest. See the entry in the FAQ: http://libguestfs."
3557 "org/FAQ.html#backup"
3561 #: ../examples/guestfs-recipes.pod:157
3562 msgid "Find out which user is using the most space"
3566 #: ../examples/guestfs-recipes.pod:159
3568 "This simple script examines a Linux guest to find out which user is using "
3569 "the most space in their home directory:"
3573 #: ../examples/guestfs-recipes.pod:162
3581 #: ../examples/guestfs-recipes.pod:164
3589 #: ../examples/guestfs-recipes.pod:166
3598 #: ../examples/guestfs-recipes.pod:169
3601 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
3606 #: ../examples/guestfs-recipes.pod:171
3609 " for d in $(guestfish --remote ls \"$dir\"); do\n"
3610 " echo -n \"$dir/$d\"\n"
3612 " guestfish --remote du \"$dir/$d\";\n"
3613 " done | sort -nr -k 2\n"
3618 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
3621 " guestfish --remote exit\n"
3626 #: ../examples/guestfs-recipes.pod:179
3627 msgid "Get DHCP address from a VM"
3631 #: ../examples/guestfs-recipes.pod:181
3633 "The link below explains the many different possible techniques for getting "
3634 "the last assigned DHCP address of a virtual machine."
3638 #: ../examples/guestfs-recipes.pod:184
3640 "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-"
3641 "a-virtual-machine-disk-image/#content"
3645 #: ../examples/guestfs-recipes.pod:186
3647 "In the libguestfs source examples directory you will find the latest version "
3648 "of the C<virt-dhcp-address.c> program."
3652 #: ../examples/guestfs-recipes.pod:189
3653 msgid "Get the operating system product name string"
3657 #: ../examples/guestfs-recipes.pod:191
3658 msgid "Save the following script into a file called C<product-name.sh>:"
3662 #: ../examples/guestfs-recipes.pod:193
3667 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3668 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3669 " guestfish --remote inspect-get-product-name \"$root\"\n"
3670 " guestfish --remote exit\n"
3675 #: ../examples/guestfs-recipes.pod:200
3676 msgid "Make the script executable and run it on a named guest:"
3680 #: ../examples/guestfs-recipes.pod:202
3683 " # product-name.sh RHEL60x64\n"
3684 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
3689 #: ../examples/guestfs-recipes.pod:205
3691 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
3692 "C<xpath> command line tool or from your favourite programming language:"
3696 #: ../examples/guestfs-recipes.pod:209
3699 " # virt-inspector RHEL60x64 > xml\n"
3700 " # xpath '//product_name' < xml\n"
3703 " <product_name>Red Hat Enterprise Linux Server release 6.0 (Santiago)</product_name>\n"
3708 #: ../examples/guestfs-recipes.pod:215
3709 msgid "Get the default boot kernel for a Linux VM"
3713 #: ../examples/guestfs-recipes.pod:217
3715 "The link below contains a program to print the default boot kernel for a "
3720 #: ../examples/guestfs-recipes.pod:220
3722 "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-"
3723 "kernel-for-a-vm/#content"
3727 #: ../examples/guestfs-recipes.pod:222
3729 "It uses Augeas, and the technique is generally applicable for many different "
3734 #: ../examples/guestfs-recipes.pod:229
3735 msgid "listing the user accounts in the guest"
3739 #: ../examples/guestfs-recipes.pod:233
3740 msgid "what repositories is it configured to use"
3744 #: ../examples/guestfs-recipes.pod:237
3745 msgid "what NTP servers does it connect to"
3749 #: ../examples/guestfs-recipes.pod:241
3750 msgid "what were the boot messages last time it booted"
3754 #: ../examples/guestfs-recipes.pod:245
3755 msgid "listing who was logged in recently"
3759 #: ../examples/guestfs-recipes.pod:249
3760 msgid "http://augeas.net/"
3764 #: ../examples/guestfs-recipes.pod:251
3765 msgid "Install RPMs in a guest"
3769 #: ../examples/guestfs-recipes.pod:253
3771 "The link below contains a method to install RPMs in a guest. In fact the "
3772 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
3773 "installs them next time the guest is booted. You could use this technique "
3774 "to install vital security updates in an offline guest."
3778 #: ../examples/guestfs-recipes.pod:259
3780 "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
3784 #: ../examples/guestfs-recipes.pod:261
3785 msgid "List applications installed in a VM"
3789 #: ../examples/guestfs-recipes.pod:263
3790 msgid "Save the following to a file C<list-apps.sh>:"
3794 #: ../examples/guestfs-recipes.pod:265
3799 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3800 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3801 " guestfish --remote inspect-list-applications \"$root\"\n"
3802 " guestfish --remote exit\n"
3807 #: ../examples/guestfs-recipes.pod:272
3809 "Make the file executable and then you can run it on any named virtual "
3814 #: ../examples/guestfs-recipes.pod:275
3817 " # list-apps.sh WinGuest\n"
3819 " app_name: Mozilla Firefox (3.6.12)\n"
3820 " app_display_name: Mozilla Firefox (3.6.12)\n"
3822 " app_version: 3.6.12 (en-GB)\n"
3824 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
3825 " app_trans_path:\n"
3826 " app_publisher: Mozilla\n"
3827 " app_url: http://www.mozilla.com/en-GB/\n"
3828 " app_source_package:\n"
3830 " app_description: Mozilla Firefox\n"
3833 " app_name: VLC media player\n"
3834 " app_display_name: VLC media player 1.1.5\n"
3836 " app_version: 1.1.5\n"
3838 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
3839 " app_trans_path:\n"
3840 " app_publisher: VideoLAN\n"
3841 " app_url: http://www.videolan.org/\n"
3842 " app_source_package:\n"
3844 " app_description:\n"
3850 #: ../examples/guestfs-recipes.pod:305
3852 "If you want to run the script on disk images (instead of libvirt virtual "
3853 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also L<virt-inspector(1)"
3858 #: ../examples/guestfs-recipes.pod:309
3859 msgid "List files and directories in a VM"
3863 #: ../examples/guestfs-recipes.pod:311
3864 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
3868 #: ../examples/guestfs-recipes.pod:313
3871 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
3876 #: ../examples/guestfs-recipes.pod:315
3877 msgid "List services in a Windows VM"
3881 #: ../examples/guestfs-recipes.pod:317
3883 "The link below contains a script that can be used to list out the services "
3884 "from a Windows VM, and whether those services run at boot time or are loaded "
3889 #: ../examples/guestfs-recipes.pod:321
3891 "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/"
3896 #: ../examples/guestfs-recipes.pod:323
3897 msgid "Make a disk image sparse"
3901 #: ../examples/guestfs-recipes.pod:325
3903 "The link below contains some guides for making a disk image sparse (or "
3904 "reintroducing sparseness)."
3908 #: ../examples/guestfs-recipes.pod:328
3910 "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
3914 #: ../examples/guestfs-recipes.pod:330
3915 msgid "Monitor disk usage over time"
3919 #: ../examples/guestfs-recipes.pod:332
3921 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
3922 "The link below contains a guide."
3926 #: ../examples/guestfs-recipes.pod:335
3927 msgid "http://virt-tools.org/learning/advanced-virt-df/"
3931 #: ../examples/guestfs-recipes.pod:337
3932 msgid "Reading the Windows Event Log from Windows Vista (or later)"
3936 #: ../examples/guestfs-recipes.pod:339
3938 "L<guestfish(1)> plus the tools described in the link below can be used to "
3939 "read out the Windows Event Log from any virtual machine running Windows "
3940 "Vista or a later version."
3944 #: ../examples/guestfs-recipes.pod:343
3946 "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-"
3947 "guestfish/#content"
3951 #: ../examples/guestfs-recipes.pod:345
3952 msgid "Remove root password (Linux)"
3956 #: ../examples/guestfs-recipes.pod:347
3958 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
3959 "files. One use is to remove the root password from a Linux guest:"
3963 #: ../examples/guestfs-recipes.pod:350
3966 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3971 #: ../examples/guestfs-recipes.pod:352
3972 msgid "Remove Administrator password (Windows)"
3976 #: ../examples/guestfs-recipes.pod:354
3978 "The link below contains one technique for removing the Administrator "
3979 "password from a Windows VM, or to be more precise, it gives you a command "
3980 "prompt the next time you log in which you can use to bypass any security:"
3984 #: ../examples/guestfs-recipes.pod:359
3986 "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-"
3987 "administrator-password-with-guestfish/"
3991 #: ../examples/guestfs-recipes.pod:361
3992 msgid "Unpack a live CD"
3996 #: ../examples/guestfs-recipes.pod:363
3998 "Linux live CDs often contain multiple layers of disk images wrapped like a "
3999 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
4000 "layers, as outlined in the guide below."
4004 #: ../examples/guestfs-recipes.pod:367
4006 "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-"
4011 #: ../examples/guestfs-recipes.pod:369
4012 msgid "Uploading and downloading files"
4016 #: ../examples/guestfs-recipes.pod:371
4018 "The link below contains general tips on uploading (copying in) and "
4019 "downloading (copying out) files from VMs."
4023 #: ../examples/guestfs-recipes.pod:374
4025 "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
4029 #: ../examples/guestfs-recipes.pod:376
4030 msgid "Use libguestfs tools on VMware ESX guests"
4034 #: ../examples/guestfs-recipes.pod:378
4036 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
4037 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
4041 #: ../examples/guestfs-recipes.pod:382
4043 "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-"
4048 #: ../examples/guestfs-recipes.pod:386
4050 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
4051 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby"
4052 "(3)>, L<http://libguestfs.org/>."
4056 #: ../examples/guestfs-recipes.pod:402
4057 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
4061 #: ../fish/guestfish-actions.pod:1
4066 #: ../fish/guestfish-actions.pod:3
4069 " add-cdrom filename\n"
4074 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:14
4075 msgid "This function adds a virtual CD-ROM disk image to the guest."
4079 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:16
4080 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
4084 #: ../fish/guestfish-actions.pod:15
4086 "This call checks for the existence of C<filename>. This stops you from "
4087 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4088 "and C<http:> URLs. To specify those, use the general L</config> call "
4093 #: ../fish/guestfish-actions.pod:22
4095 "If you just want to add an ISO file (often you use this as an efficient way "
4096 "to transfer large files into the guest), then you should probably use L</add-"
4097 "drive-ro> instead."
4101 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163
4102 #: ../fish/guestfish-actions.pod:177
4104 "I<This function is deprecated.> In new code, use the L</add_drive_opts> call "
4109 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166
4110 #: ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:991
4111 #: ../fish/guestfish-actions.pod:1351 ../fish/guestfish-actions.pod:1365
4112 #: ../fish/guestfish-actions.pod:3090 ../fish/guestfish-actions.pod:3297
4113 #: ../fish/guestfish-actions.pod:3411 ../fish/guestfish-actions.pod:3459
4114 #: ../fish/guestfish-actions.pod:4360 ../fish/guestfish-actions.pod:4383
4115 #: ../fish/guestfish-actions.pod:4405 ../fish/guestfish-actions.pod:4443
4116 #: ../fish/guestfish-actions.pod:5092 ../fish/guestfish-actions.pod:5198
4117 #: ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:252
4118 #: ../src/guestfs-actions.pod:273 ../src/guestfs-actions.pod:1508
4119 #: ../src/guestfs-actions.pod:2007 ../src/guestfs-actions.pod:2028
4120 #: ../src/guestfs-actions.pod:4623 ../src/guestfs-actions.pod:4926
4121 #: ../src/guestfs-actions.pod:5155 ../src/guestfs-actions.pod:5255
4122 #: ../src/guestfs-actions.pod:6521 ../src/guestfs-actions.pod:6565
4123 #: ../src/guestfs-actions.pod:6599 ../src/guestfs-actions.pod:6662
4124 #: ../src/guestfs-actions.pod:7594 ../src/guestfs-actions.pod:7703
4125 #: ../src/guestfs-actions.pod:7886
4127 "Deprecated functions will not be removed from the API, but the fact that "
4128 "they are deprecated indicates that there are problems with correct use of "
4133 #: ../fish/guestfish-actions.pod:35
4138 #: ../fish/guestfish-actions.pod:37
4143 #: ../fish/guestfish-actions.pod:39
4146 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
4151 #: ../fish/guestfish-actions.pod:41
4153 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4154 "It works by connecting to libvirt, requesting the domain and domain XML from "
4155 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
4159 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:64
4161 "The number of disks added is returned. This operation is atomic: if an "
4162 "error is returned, then no disks are added."
4166 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:67
4168 "This function does some minimal checks to make sure the libvirt domain is "
4169 "not running (unless C<readonly> is true). In a future version we will try "
4170 "to acquire the libvirt lock on each disk."
4174 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:71
4176 "Disks must be accessible locally. This often means that adding disks from a "
4177 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4178 "unless those disks are accessible via the same device path locally too."
4182 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:76
4184 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
4185 "libvirt.org/uri.html>). If this is not set then we connect to the default "
4186 "libvirt URI (or one set through an environment variable, see the libvirt "
4187 "documentation for full details)."
4191 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:82
4193 "The optional C<live> flag controls whether this call will try to connect to "
4194 "a running virtual machine C<guestfsd> process if it sees a suitable "
4195 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
4196 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
4197 "DAEMONS> for more information."
4201 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:89
4203 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
4204 "passed instead of the domain name. The C<dom> string is treated as a UUID "
4205 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
4210 #: ../fish/guestfish-actions.pod:76
4212 "The other optional parameters are passed directly through to L</add-drive-"
4217 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
4218 #: ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:1973
4219 #: ../fish/guestfish-actions.pod:3139 ../fish/guestfish-actions.pod:3312
4220 #: ../fish/guestfish-actions.pod:3447
4222 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
4226 #: ../fish/guestfish-actions.pod:81
4231 #: ../fish/guestfish-actions.pod:83
4234 " add-drive filename\n"
4239 #: ../fish/guestfish-actions.pod:85
4241 "This function is the equivalent of calling L</add-drive-opts> with no "
4242 "optional parameters, so the disk is added writable, with the format being "
4243 "detected automatically."
4247 #: ../fish/guestfish-actions.pod:89
4249 "Automatic detection of the format opens you up to a potential security hole "
4250 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4251 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4252 "you should think about replacing calls to this function with calls to L</add-"
4253 "drive-opts>, and specifying the format."
4257 #: ../fish/guestfish-actions.pod:96
4258 msgid "add-drive-opts"
4262 #: ../fish/guestfish-actions.pod:98
4267 #: ../fish/guestfish-actions.pod:100
4270 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
4275 #: ../fish/guestfish-actions.pod:102 ../src/guestfs-actions.pod:160
4277 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4278 "The first time you call this function, the disk appears as C</dev/sda>, the "
4279 "second time as C</dev/sdb>, and so on."
4283 #: ../fish/guestfish-actions.pod:107 ../src/guestfs-actions.pod:165
4285 "You don't necessarily need to be root when using libguestfs. However you "
4286 "obviously do need sufficient permissions to access the filename for whatever "
4287 "operations you want to perform (ie. read access if you just want to read the "
4288 "image or write access if you want to modify the image)."
4292 #: ../fish/guestfish-actions.pod:113 ../src/guestfs-actions.pod:171
4293 msgid "This call checks that C<filename> exists."
4297 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3101
4298 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4660
4299 msgid "The optional arguments are:"
4303 #: ../fish/guestfish-actions.pod:119 ../src/guestfs-actions.pod:177
4308 #: ../fish/guestfish-actions.pod:121 ../src/guestfs-actions.pod:179
4310 "If true then the image is treated as read-only. Writes are still allowed, "
4311 "but they are stored in a temporary snapshot overlay which is discarded at "
4312 "the end. The disk that you add is not modified."
4316 #: ../fish/guestfish-actions.pod:125 ../src/guestfs-actions.pod:183
4321 #: ../fish/guestfish-actions.pod:127
4323 "This forces the image format. If you omit this (or use L</add-drive> or L</"
4324 "add-drive-ro>) then the format is automatically detected. Possible formats "
4325 "include C<raw> and C<qcow2>."
4329 #: ../fish/guestfish-actions.pod:131 ../src/guestfs-actions.pod:189
4331 "Automatic detection of the format opens you up to a potential security hole "
4332 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4333 "RHBZ#642934. Specifying the format closes this security hole."
4337 #: ../fish/guestfish-actions.pod:136 ../src/guestfs-actions.pod:194
4342 #: ../fish/guestfish-actions.pod:138
4344 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
4345 "add-drive-with-if> call (q.v.)"
4349 #: ../fish/guestfish-actions.pod:145
4350 msgid "add-drive-ro"
4354 #: ../fish/guestfish-actions.pod:147
4359 #: ../fish/guestfish-actions.pod:149
4362 " add-drive-ro filename\n"
4367 #: ../fish/guestfish-actions.pod:151
4369 "This function is the equivalent of calling L</add-drive-opts> with the "
4370 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
4371 "is added read-only, with the format being detected automatically."
4375 #: ../fish/guestfish-actions.pod:156
4376 msgid "add-drive-ro-with-if"
4380 #: ../fish/guestfish-actions.pod:158
4383 " add-drive-ro-with-if filename iface\n"
4388 #: ../fish/guestfish-actions.pod:160
4390 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
4391 "interface emulation to use at run time."
4395 #: ../fish/guestfish-actions.pod:170
4396 msgid "add-drive-with-if"
4400 #: ../fish/guestfish-actions.pod:172
4403 " add-drive-with-if filename iface\n"
4408 #: ../fish/guestfish-actions.pod:174
4410 "This is the same as L</add-drive> but it allows you to specify the QEMU "
4411 "interface emulation to use at run time."
4415 #: ../fish/guestfish-actions.pod:184
4420 #: ../fish/guestfish-actions.pod:186
4423 " aug-clear augpath\n"
4428 #: ../fish/guestfish-actions.pod:188 ../src/guestfs-actions.pod:290
4430 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4431 "L<augtool(1)> C<clear> command."
4435 #: ../fish/guestfish-actions.pod:191
4440 #: ../fish/guestfish-actions.pod:193
4448 #: ../fish/guestfish-actions.pod:195
4450 "Close the current Augeas handle and free up any resources used by it. After "
4451 "calling this, you have to call L</aug-init> again before you can use any "
4452 "other Augeas functions."
4456 #: ../fish/guestfish-actions.pod:200
4461 #: ../fish/guestfish-actions.pod:202
4464 " aug-defnode name expr val\n"
4469 #: ../fish/guestfish-actions.pod:204 ../src/guestfs-actions.pod:319
4471 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4475 #: ../fish/guestfish-actions.pod:207
4477 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4478 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
4479 "containing that single node."
4483 #: ../fish/guestfish-actions.pod:211 ../src/guestfs-actions.pod:326
4485 "On success this returns a pair containing the number of nodes in the "
4486 "nodeset, and a boolean flag if a node was created."
4490 #: ../fish/guestfish-actions.pod:215
4495 #: ../fish/guestfish-actions.pod:217
4498 " aug-defvar name expr\n"
4503 #: ../fish/guestfish-actions.pod:219 ../src/guestfs-actions.pod:343
4505 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4506 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4510 #: ../fish/guestfish-actions.pod:223 ../src/guestfs-actions.pod:347
4512 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4513 "evaluates to something which is not a nodeset."
4517 #: ../fish/guestfish-actions.pod:226
4522 #: ../fish/guestfish-actions.pod:228
4525 " aug-get augpath\n"
4530 #: ../fish/guestfish-actions.pod:230 ../src/guestfs-actions.pod:360
4532 "Look up the value associated with C<path>. If C<path> matches exactly one "
4533 "node, the C<value> is returned."
4537 #: ../fish/guestfish-actions.pod:233
4542 #: ../fish/guestfish-actions.pod:235
4545 " aug-init root flags\n"
4550 #: ../fish/guestfish-actions.pod:237 ../src/guestfs-actions.pod:375
4552 "Create a new Augeas handle for editing configuration files. If there was "
4553 "any previous Augeas handle associated with this guestfs session, then it is "
4558 #: ../fish/guestfish-actions.pod:241
4559 msgid "You must call this before using any other L</aug-*> commands."
4563 #: ../fish/guestfish-actions.pod:244 ../src/guestfs-actions.pod:382
4565 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4569 #: ../fish/guestfish-actions.pod:247 ../src/guestfs-actions.pod:385
4571 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4572 "logical I<or> of the following integers:"
4576 #: ../fish/guestfish-actions.pod:253 ../src/guestfs-actions.pod:391
4577 msgid "C<AUG_SAVE_BACKUP> = 1"
4581 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:393
4582 msgid "Keep the original file with a C<.augsave> extension."
4586 #: ../fish/guestfish-actions.pod:257 ../src/guestfs-actions.pod:395
4587 msgid "C<AUG_SAVE_NEWFILE> = 2"
4591 #: ../fish/guestfish-actions.pod:259 ../src/guestfs-actions.pod:397
4593 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4594 "original. Overrides C<AUG_SAVE_BACKUP>."
4598 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:400
4599 msgid "C<AUG_TYPE_CHECK> = 4"
4603 #: ../fish/guestfish-actions.pod:264 ../src/guestfs-actions.pod:402
4604 msgid "Typecheck lenses."
4608 #: ../fish/guestfish-actions.pod:266
4610 "This option is only useful when debugging Augeas lenses. Use of this option "
4611 "may require additional memory for the libguestfs appliance. You may need to "
4612 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
4616 #: ../fish/guestfish-actions.pod:271 ../src/guestfs-actions.pod:409
4617 msgid "C<AUG_NO_STDINC> = 8"
4621 #: ../fish/guestfish-actions.pod:273 ../src/guestfs-actions.pod:411
4622 msgid "Do not use standard load path for modules."
4626 #: ../fish/guestfish-actions.pod:275 ../src/guestfs-actions.pod:413
4627 msgid "C<AUG_SAVE_NOOP> = 16"
4631 #: ../fish/guestfish-actions.pod:277 ../src/guestfs-actions.pod:415
4632 msgid "Make save a no-op, just record what would have been changed."
4636 #: ../fish/guestfish-actions.pod:279 ../src/guestfs-actions.pod:417
4637 msgid "C<AUG_NO_LOAD> = 32"
4641 #: ../fish/guestfish-actions.pod:281
4642 msgid "Do not load the tree in L</aug-init>."
4646 #: ../fish/guestfish-actions.pod:285
4647 msgid "To close the handle, you can call L</aug-close>."
4651 #: ../fish/guestfish-actions.pod:287 ../src/guestfs-actions.pod:425
4652 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4656 #: ../fish/guestfish-actions.pod:289
4661 #: ../fish/guestfish-actions.pod:291
4664 " aug-insert augpath label true|false\n"
4669 #: ../fish/guestfish-actions.pod:293 ../src/guestfs-actions.pod:439
4671 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4672 "or after C<path> (depending on the boolean flag C<before>)."
4676 #: ../fish/guestfish-actions.pod:297 ../src/guestfs-actions.pod:443
4678 "C<path> must match exactly one existing node in the tree, and C<label> must "
4679 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4683 #: ../fish/guestfish-actions.pod:301
4688 #: ../fish/guestfish-actions.pod:303
4696 #: ../fish/guestfish-actions.pod:305 ../src/guestfs-actions.pod:456
4697 msgid "Load files into the tree."
4701 #: ../fish/guestfish-actions.pod:307 ../src/guestfs-actions.pod:458
4702 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4706 #: ../fish/guestfish-actions.pod:310
4711 #: ../fish/guestfish-actions.pod:312
4719 #: ../fish/guestfish-actions.pod:314
4721 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
4722 "resulting nodes into alphabetical order."
4726 #: ../fish/guestfish-actions.pod:317
4731 #: ../fish/guestfish-actions.pod:319
4734 " aug-match augpath\n"
4739 #: ../fish/guestfish-actions.pod:321 ../src/guestfs-actions.pod:486
4741 "Returns a list of paths which match the path expression C<path>. The "
4742 "returned paths are sufficiently qualified so that they match exactly one "
4743 "node in the current tree."
4747 #: ../fish/guestfish-actions.pod:325
4752 #: ../fish/guestfish-actions.pod:327
4755 " aug-mv src dest\n"
4760 #: ../fish/guestfish-actions.pod:329 ../src/guestfs-actions.pod:503
4762 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4763 "C<dest> is overwritten if it exists."
4767 #: ../fish/guestfish-actions.pod:332
4772 #: ../fish/guestfish-actions.pod:334
4780 #: ../fish/guestfish-actions.pod:336 ../src/guestfs-actions.pod:516
4781 msgid "Remove C<path> and all of its children."
4785 #: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:518
4786 msgid "On success this returns the number of entries which were removed."
4790 #: ../fish/guestfish-actions.pod:340
4795 #: ../fish/guestfish-actions.pod:342
4803 #: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:529
4804 msgid "This writes all pending changes to disk."
4808 #: ../fish/guestfish-actions.pod:346
4810 "The flags which were passed to L</aug-init> affect exactly how files are "
4815 #: ../fish/guestfish-actions.pod:349
4820 #: ../fish/guestfish-actions.pod:351
4823 " aug-set augpath val\n"
4828 #: ../fish/guestfish-actions.pod:353 ../src/guestfs-actions.pod:545
4829 msgid "Set the value associated with C<path> to C<val>."
4833 #: ../fish/guestfish-actions.pod:355
4835 "In the Augeas API, it is possible to clear a node by setting the value to "
4836 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4837 "this call. Instead you must use the L</aug-clear> call."
4841 #: ../fish/guestfish-actions.pod:360
4846 #: ../fish/guestfish-actions.pod:362
4849 " available 'groups ...'\n"
4854 #: ../fish/guestfish-actions.pod:364 ../src/guestfs-actions.pod:562
4856 "This command is used to check the availability of some groups of "
4857 "functionality in the appliance, which not all builds of the libguestfs "
4858 "appliance will be able to provide."
4862 #: ../fish/guestfish-actions.pod:368
4864 "The libguestfs groups, and the functions that those groups correspond to, "
4865 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4866 "runtime by calling L</available-all-groups>."
4870 #: ../fish/guestfish-actions.pod:373 ../src/guestfs-actions.pod:571
4872 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
4873 "\"]> would check for the availability of the Linux inotify functions and "
4874 "Augeas (configuration file editing) functions."
4878 #: ../fish/guestfish-actions.pod:378 ../src/guestfs-actions.pod:576
4879 msgid "The command returns no error if I<all> requested groups are available."
4883 #: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:578
4885 "It fails with an error if one or more of the requested groups is unavailable "
4890 #: ../fish/guestfish-actions.pod:383 ../src/guestfs-actions.pod:581
4892 "If an unknown group name is included in the list of groups then an error is "
4897 #: ../fish/guestfish-actions.pod:386 ../src/guestfs-actions.pod:584
4902 #: ../fish/guestfish-actions.pod:392
4903 msgid "You must call L</launch> before calling this function."
4907 #: ../fish/guestfish-actions.pod:394 ../src/guestfs-actions.pod:592
4909 "The reason is because we don't know what groups are supported by the "
4910 "appliance/daemon until it is running and can be queried."
4914 #: ../fish/guestfish-actions.pod:400 ../src/guestfs-actions.pod:598
4916 "If a group of functions is available, this does not necessarily mean that "
4917 "they will work. You still have to check for errors when calling individual "
4918 "API functions even if they are available."
4922 #: ../fish/guestfish-actions.pod:407 ../src/guestfs-actions.pod:605
4924 "It is usually the job of distro packagers to build complete functionality "
4925 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4926 "with all requirements satisfied, will support everything."
4930 #: ../fish/guestfish-actions.pod:414
4932 "This call was added in version C<1.0.80>. In previous versions of "
4933 "libguestfs all you could do would be to speculatively execute a command to "
4934 "find out if the daemon implemented it. See also L</version>."
4938 #: ../fish/guestfish-actions.pod:421
4939 msgid "available-all-groups"
4943 #: ../fish/guestfish-actions.pod:423
4946 " available-all-groups\n"
4951 #: ../fish/guestfish-actions.pod:425
4953 "This command returns a list of all optional groups that this daemon knows "
4954 "about. Note this returns both supported and unsupported groups. To find "
4955 "out which ones the daemon can actually support you have to call L</"
4956 "available> on each member of the returned list."
4960 #: ../fish/guestfish-actions.pod:431
4961 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
4965 #: ../fish/guestfish-actions.pod:433
4970 #: ../fish/guestfish-actions.pod:435
4973 " base64-in (base64file|-) filename\n"
4978 #: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:649
4980 "This command uploads base64-encoded data from C<base64file> to C<filename>."
4984 #: ../fish/guestfish-actions.pod:440 ../fish/guestfish-actions.pod:449
4985 #: ../fish/guestfish-actions.pod:698 ../fish/guestfish-actions.pod:867
4986 #: ../fish/guestfish-actions.pod:886 ../fish/guestfish-actions.pod:1260
4987 #: ../fish/guestfish-actions.pod:4663 ../fish/guestfish-actions.pod:4675
4988 #: ../fish/guestfish-actions.pod:4686 ../fish/guestfish-actions.pod:4697
4989 #: ../fish/guestfish-actions.pod:4749 ../fish/guestfish-actions.pod:4758
4990 #: ../fish/guestfish-actions.pod:4812 ../fish/guestfish-actions.pod:4835
4991 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
4995 #: ../fish/guestfish-actions.pod:442
5000 #: ../fish/guestfish-actions.pod:444
5003 " base64-out filename (base64file|-)\n"
5008 #: ../fish/guestfish-actions.pod:446 ../src/guestfs-actions.pod:663
5010 "This command downloads the contents of C<filename>, writing it out to local "
5011 "file C<base64file> encoded as base64."
5015 #: ../fish/guestfish-actions.pod:451
5016 msgid "blockdev-flushbufs"
5020 #: ../fish/guestfish-actions.pod:453
5023 " blockdev-flushbufs device\n"
5028 #: ../fish/guestfish-actions.pod:455 ../src/guestfs-actions.pod:676
5030 "This tells the kernel to flush internal buffers associated with C<device>."
5034 #: ../fish/guestfish-actions.pod:458 ../fish/guestfish-actions.pod:469
5035 #: ../fish/guestfish-actions.pod:478 ../fish/guestfish-actions.pod:488
5036 #: ../fish/guestfish-actions.pod:500 ../fish/guestfish-actions.pod:513
5037 #: ../fish/guestfish-actions.pod:521 ../fish/guestfish-actions.pod:532
5038 #: ../fish/guestfish-actions.pod:540 ../fish/guestfish-actions.pod:548
5039 #: ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:696
5040 #: ../src/guestfs-actions.pod:711 ../src/guestfs-actions.pod:727
5041 #: ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:764
5042 #: ../src/guestfs-actions.pod:778 ../src/guestfs-actions.pod:796
5043 #: ../src/guestfs-actions.pod:810 ../src/guestfs-actions.pod:824
5044 msgid "This uses the L<blockdev(8)> command."
5048 #: ../fish/guestfish-actions.pod:460
5049 msgid "blockdev-getbsz"
5053 #: ../fish/guestfish-actions.pod:462
5056 " blockdev-getbsz device\n"
5061 #: ../fish/guestfish-actions.pod:464 ../src/guestfs-actions.pod:691
5062 msgid "This returns the block size of a device."
5066 #: ../fish/guestfish-actions.pod:466 ../fish/guestfish-actions.pod:529
5067 #: ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:793
5069 "(Note this is different from both I<size in blocks> and I<filesystem block "
5074 #: ../fish/guestfish-actions.pod:471
5075 msgid "blockdev-getro"
5079 #: ../fish/guestfish-actions.pod:473
5082 " blockdev-getro device\n"
5087 #: ../fish/guestfish-actions.pod:475 ../src/guestfs-actions.pod:708
5089 "Returns a boolean indicating if the block device is read-only (true if read-"
5090 "only, false if not)."
5094 #: ../fish/guestfish-actions.pod:480
5095 msgid "blockdev-getsize64"
5099 #: ../fish/guestfish-actions.pod:482
5102 " blockdev-getsize64 device\n"
5107 #: ../fish/guestfish-actions.pod:484 ../src/guestfs-actions.pod:723
5108 msgid "This returns the size of the device in bytes."
5112 #: ../fish/guestfish-actions.pod:486
5113 msgid "See also L</blockdev-getsz>."
5117 #: ../fish/guestfish-actions.pod:490
5118 msgid "blockdev-getss"
5122 #: ../fish/guestfish-actions.pod:492
5125 " blockdev-getss device\n"
5130 #: ../fish/guestfish-actions.pod:494 ../src/guestfs-actions.pod:739
5132 "This returns the size of sectors on a block device. Usually 512, but can be "
5133 "larger for modern devices."
5137 #: ../fish/guestfish-actions.pod:497
5139 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
5143 #: ../fish/guestfish-actions.pod:502
5144 msgid "blockdev-getsz"
5148 #: ../fish/guestfish-actions.pod:504
5151 " blockdev-getsz device\n"
5156 #: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:757
5158 "This returns the size of the device in units of 512-byte sectors (even if "
5159 "the sectorsize isn't 512 bytes ... weird)."
5163 #: ../fish/guestfish-actions.pod:509
5165 "See also L</blockdev-getss> for the real sector size of the device, and L</"
5166 "blockdev-getsize64> for the more useful I<size in bytes>."
5170 #: ../fish/guestfish-actions.pod:515
5171 msgid "blockdev-rereadpt"
5175 #: ../fish/guestfish-actions.pod:517
5178 " blockdev-rereadpt device\n"
5183 #: ../fish/guestfish-actions.pod:519 ../src/guestfs-actions.pod:776
5184 msgid "Reread the partition table on C<device>."
5188 #: ../fish/guestfish-actions.pod:523
5189 msgid "blockdev-setbsz"
5193 #: ../fish/guestfish-actions.pod:525
5196 " blockdev-setbsz device blocksize\n"
5201 #: ../fish/guestfish-actions.pod:527 ../src/guestfs-actions.pod:791
5202 msgid "This sets the block size of a device."
5206 #: ../fish/guestfish-actions.pod:534
5207 msgid "blockdev-setro"
5211 #: ../fish/guestfish-actions.pod:536
5214 " blockdev-setro device\n"
5219 #: ../fish/guestfish-actions.pod:538 ../src/guestfs-actions.pod:808
5220 msgid "Sets the block device named C<device> to read-only."
5224 #: ../fish/guestfish-actions.pod:542
5225 msgid "blockdev-setrw"
5229 #: ../fish/guestfish-actions.pod:544
5232 " blockdev-setrw device\n"
5237 #: ../fish/guestfish-actions.pod:546 ../src/guestfs-actions.pod:822
5238 msgid "Sets the block device named C<device> to read-write."
5242 #: ../fish/guestfish-actions.pod:550
5243 msgid "btrfs-filesystem-resize"
5247 #: ../fish/guestfish-actions.pod:552
5250 " btrfs-filesystem-resize mountpoint [size:..]\n"
5255 #: ../fish/guestfish-actions.pod:554 ../src/guestfs-actions.pod:844
5256 msgid "This command resizes a btrfs filesystem."
5260 #: ../fish/guestfish-actions.pod:556 ../src/guestfs-actions.pod:846
5262 "Note that unlike other resize calls, the filesystem has to be mounted and "
5263 "the parameter is the mountpoint not the device (this is a requirement of "
5268 #: ../fish/guestfish-actions.pod:560 ../fish/guestfish-actions.pod:3422
5269 #: ../src/guestfs-actions.pod:850 ../src/guestfs-actions.pod:5194
5270 msgid "The optional parameters are:"
5274 #: ../fish/guestfish-actions.pod:564 ../fish/guestfish-actions.pod:3426
5275 #: ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:5198
5280 #: ../fish/guestfish-actions.pod:566 ../src/guestfs-actions.pod:856
5282 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
5283 "resized to the maximum size."
5287 #: ../fish/guestfish-actions.pod:571 ../src/guestfs-actions.pod:861
5288 msgid "See also L<btrfs(8)>."
5292 #: ../fish/guestfish-actions.pod:575
5293 msgid "case-sensitive-path"
5297 #: ../fish/guestfish-actions.pod:577
5300 " case-sensitive-path path\n"
5305 #: ../fish/guestfish-actions.pod:579 ../src/guestfs-actions.pod:895
5307 "This can be used to resolve case insensitive paths on a filesystem which is "
5308 "case sensitive. The use case is to resolve paths which you have read from "
5309 "Windows configuration files or the Windows Registry, to the true path."
5313 #: ../fish/guestfish-actions.pod:584 ../src/guestfs-actions.pod:900
5315 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5316 "(and probably others), which is that although the underlying filesystem is "
5317 "case-insensitive, the driver exports the filesystem to Linux as case-"
5322 #: ../fish/guestfish-actions.pod:589 ../src/guestfs-actions.pod:905
5324 "One consequence of this is that special directories such as C<c:\\windows> "
5325 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5326 "precise details of how they were created. In Windows itself this would not "
5331 #: ../fish/guestfish-actions.pod:595 ../src/guestfs-actions.pod:911
5333 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5338 #: ../fish/guestfish-actions.pod:598 ../src/guestfs-actions.pod:914
5340 "This function resolves the true case of each element in the path and returns "
5341 "the case-sensitive path."
5345 #: ../fish/guestfish-actions.pod:601
5347 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
5348 "WINDOWS/system32\"> (the exact return value would depend on details of how "
5349 "the directories were originally created under Windows)."
5353 #: ../fish/guestfish-actions.pod:606 ../src/guestfs-actions.pod:922
5354 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5358 #: ../fish/guestfish-actions.pod:609
5359 msgid "See also L</realpath>."
5363 #: ../fish/guestfish-actions.pod:611
5368 #: ../fish/guestfish-actions.pod:613
5376 #: ../fish/guestfish-actions.pod:615 ../fish/guestfish-actions.pod:3842
5377 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:5837
5378 msgid "Return the contents of the file named C<path>."
5382 #: ../fish/guestfish-actions.pod:617
5384 "Note that this function cannot correctly handle binary files (specifically, "
5385 "files containing C<\\0> character which is treated as end of string). For "
5386 "those you need to use the L</read-file> or L</download> functions which have "
5387 "a more complex interface."
5391 #: ../fish/guestfish-actions.pod:622 ../fish/guestfish-actions.pod:757
5392 #: ../fish/guestfish-actions.pod:769 ../fish/guestfish-actions.pod:945
5393 #: ../fish/guestfish-actions.pod:955 ../fish/guestfish-actions.pod:1022
5394 #: ../fish/guestfish-actions.pod:1032 ../fish/guestfish-actions.pod:1224
5395 #: ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:1541
5396 #: ../fish/guestfish-actions.pod:1569 ../fish/guestfish-actions.pod:1584
5397 #: ../fish/guestfish-actions.pod:1594 ../fish/guestfish-actions.pod:1613
5398 #: ../fish/guestfish-actions.pod:3712 ../fish/guestfish-actions.pod:3727
5399 #: ../fish/guestfish-actions.pod:3803 ../fish/guestfish-actions.pod:3820
5400 #: ../fish/guestfish-actions.pod:3835 ../fish/guestfish-actions.pod:4504
5401 #: ../fish/guestfish-actions.pod:4550 ../fish/guestfish-actions.pod:4635
5402 #: ../fish/guestfish-actions.pod:4650 ../fish/guestfish-actions.pod:5056
5403 #: ../fish/guestfish-actions.pod:5068 ../fish/guestfish-actions.pod:5086
5404 #: ../fish/guestfish-actions.pod:5103 ../fish/guestfish-actions.pod:5113
5405 #: ../fish/guestfish-actions.pod:5170 ../fish/guestfish-actions.pod:5180
5406 #: ../fish/guestfish-actions.pod:5209 ../fish/guestfish-actions.pod:5219
5407 #: ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:1127
5408 #: ../src/guestfs-actions.pod:1147 ../src/guestfs-actions.pod:1443
5409 #: ../src/guestfs-actions.pod:1462 ../src/guestfs-actions.pod:1565
5410 #: ../src/guestfs-actions.pod:1584 ../src/guestfs-actions.pod:1830
5411 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:2320
5412 #: ../src/guestfs-actions.pod:2363 ../src/guestfs-actions.pod:2387
5413 #: ../src/guestfs-actions.pod:2404 ../src/guestfs-actions.pod:2433
5414 #: ../src/guestfs-actions.pod:5619 ../src/guestfs-actions.pod:5645
5415 #: ../src/guestfs-actions.pod:5776 ../src/guestfs-actions.pod:5802
5416 #: ../src/guestfs-actions.pod:5826 ../src/guestfs-actions.pod:6777
5417 #: ../src/guestfs-actions.pod:6832 ../src/guestfs-actions.pod:6978
5418 #: ../src/guestfs-actions.pod:7002 ../src/guestfs-actions.pod:7667
5419 #: ../src/guestfs-actions.pod:7687 ../src/guestfs-actions.pod:7720
5420 #: ../src/guestfs-actions.pod:7739 ../src/guestfs-actions.pod:7758
5421 #: ../src/guestfs-actions.pod:7852 ../src/guestfs-actions.pod:7871
5422 #: ../src/guestfs-actions.pod:7917 ../src/guestfs-actions.pod:7936
5424 "Because of the message protocol, there is a transfer limit of somewhere "
5425 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5429 #: ../fish/guestfish-actions.pod:625
5434 #: ../fish/guestfish-actions.pod:627
5437 " checksum csumtype path\n"
5442 #: ../fish/guestfish-actions.pod:629 ../src/guestfs-actions.pod:960
5444 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5448 #: ../fish/guestfish-actions.pod:632 ../src/guestfs-actions.pod:963
5450 "The type of checksum to compute is given by the C<csumtype> parameter which "
5451 "must have one of the following values:"
5455 #: ../fish/guestfish-actions.pod:637 ../src/guestfs-actions.pod:968
5460 #: ../fish/guestfish-actions.pod:639 ../src/guestfs-actions.pod:970
5462 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5467 #: ../fish/guestfish-actions.pod:642 ../src/guestfs-actions.pod:973
5472 #: ../fish/guestfish-actions.pod:644 ../src/guestfs-actions.pod:975
5473 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5477 #: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:977
5482 #: ../fish/guestfish-actions.pod:648 ../src/guestfs-actions.pod:979
5483 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5487 #: ../fish/guestfish-actions.pod:650 ../src/guestfs-actions.pod:981
5492 #: ../fish/guestfish-actions.pod:652 ../src/guestfs-actions.pod:983
5493 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5497 #: ../fish/guestfish-actions.pod:654 ../src/guestfs-actions.pod:985
5502 #: ../fish/guestfish-actions.pod:656 ../src/guestfs-actions.pod:987
5503 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5507 #: ../fish/guestfish-actions.pod:658 ../src/guestfs-actions.pod:989
5512 #: ../fish/guestfish-actions.pod:660 ../src/guestfs-actions.pod:991
5513 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5517 #: ../fish/guestfish-actions.pod:662 ../src/guestfs-actions.pod:993
5522 #: ../fish/guestfish-actions.pod:664 ../src/guestfs-actions.pod:995
5523 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5527 #: ../fish/guestfish-actions.pod:668 ../src/guestfs-actions.pod:999
5528 msgid "The checksum is returned as a printable string."
5532 #: ../fish/guestfish-actions.pod:670
5533 msgid "To get the checksum for a device, use L</checksum-device>."
5537 #: ../fish/guestfish-actions.pod:672
5538 msgid "To get the checksums for many files, use L</checksums-out>."
5542 #: ../fish/guestfish-actions.pod:674
5543 msgid "checksum-device"
5547 #: ../fish/guestfish-actions.pod:676
5550 " checksum-device csumtype device\n"
5555 #: ../fish/guestfish-actions.pod:678
5557 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5558 "device named C<device>. For the types of checksums supported see the L</"
5559 "checksum> command."
5563 #: ../fish/guestfish-actions.pod:682
5564 msgid "checksums-out"
5568 #: ../fish/guestfish-actions.pod:684
5571 " checksums-out csumtype directory (sumsfile|-)\n"
5576 #: ../fish/guestfish-actions.pod:686 ../src/guestfs-actions.pod:1034
5578 "This command computes the checksums of all regular files in C<directory> and "
5579 "then emits a list of those checksums to the local output file C<sumsfile>."
5583 #: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1038
5585 "This can be used for verifying the integrity of a virtual machine. However "
5586 "to be properly secure you should pay attention to the output of the checksum "
5587 "command (it uses the ones from GNU coreutils). In particular when the "
5588 "filename is not printable, coreutils uses a special backslash syntax. For "
5589 "more information, see the GNU coreutils info file."
5593 #: ../fish/guestfish-actions.pod:700
5598 #: ../fish/guestfish-actions.pod:702
5601 " chmod mode path\n"
5606 #: ../fish/guestfish-actions.pod:704 ../src/guestfs-actions.pod:1057
5608 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5613 #: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1060
5615 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5616 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5621 #: ../fish/guestfish-actions.pod:711 ../fish/guestfish-actions.pod:3065
5622 #: ../fish/guestfish-actions.pod:3204 ../fish/guestfish-actions.pod:3214
5623 #: ../fish/guestfish-actions.pod:3224 ../src/guestfs-actions.pod:1064
5624 #: ../src/guestfs-actions.pod:4591 ../src/guestfs-actions.pod:4800
5625 #: ../src/guestfs-actions.pod:4819 ../src/guestfs-actions.pod:4838
5626 msgid "The mode actually set is affected by the umask."
5630 #: ../fish/guestfish-actions.pod:713
5635 #: ../fish/guestfish-actions.pod:715
5638 " chown owner group path\n"
5643 #: ../fish/guestfish-actions.pod:717 ../src/guestfs-actions.pod:1078
5644 msgid "Change the file owner to C<owner> and group to C<group>."
5648 #: ../fish/guestfish-actions.pod:719 ../fish/guestfish-actions.pod:2500
5649 #: ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:3662
5651 "Only numeric uid and gid are supported. If you want to use names, you will "
5652 "need to locate and parse the password file yourself (Augeas support makes "
5653 "this relatively easy)."
5657 #: ../fish/guestfish-actions.pod:723
5662 #: ../fish/guestfish-actions.pod:725
5665 " command 'arguments ...'\n"
5670 #: ../fish/guestfish-actions.pod:727 ../src/guestfs-actions.pod:1094
5672 "This call runs a command from the guest filesystem. The filesystem must be "
5673 "mounted, and must contain a compatible operating system (ie. something "
5674 "Linux, with the same or compatible processor architecture)."
5678 #: ../fish/guestfish-actions.pod:732
5680 "The single parameter is an argv-style list of arguments. The first element "
5681 "is the name of the program to run. Subsequent elements are parameters. The "
5682 "list must be non-empty (ie. must contain a program name). Note that the "
5683 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
5687 #: ../fish/guestfish-actions.pod:739 ../src/guestfs-actions.pod:1106
5688 msgid "The return value is anything printed to I<stdout> by the command."
5692 #: ../fish/guestfish-actions.pod:742 ../src/guestfs-actions.pod:1109
5694 "If the command returns a non-zero exit status, then this function returns an "
5695 "error message. The error message string is the content of I<stderr> from "
5700 #: ../fish/guestfish-actions.pod:746 ../src/guestfs-actions.pod:1113
5702 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
5703 "bin>. If you require a program from another location, you should provide "
5704 "the full path in the first parameter."
5708 #: ../fish/guestfish-actions.pod:751 ../src/guestfs-actions.pod:1118
5710 "Shared libraries and data files required by the program must be available on "
5711 "filesystems which are mounted in the correct places. It is the caller's "
5712 "responsibility to ensure all filesystems that are needed are mounted at the "
5717 #: ../fish/guestfish-actions.pod:760
5718 msgid "command-lines"
5722 #: ../fish/guestfish-actions.pod:762
5725 " command-lines 'arguments ...'\n"
5730 #: ../fish/guestfish-actions.pod:764
5732 "This is the same as L</command>, but splits the result into a list of lines."
5736 #: ../fish/guestfish-actions.pod:767
5737 msgid "See also: L</sh-lines>"
5741 #: ../fish/guestfish-actions.pod:772
5746 #: ../fish/guestfish-actions.pod:774
5749 " config qemuparam qemuvalue\n"
5754 #: ../fish/guestfish-actions.pod:776 ../src/guestfs-actions.pod:1159
5756 "This can be used to add arbitrary qemu command line parameters of the form "
5757 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
5758 "setting some parameters which would interfere with parameters that we use."
5762 #: ../fish/guestfish-actions.pod:781 ../src/guestfs-actions.pod:1164
5763 msgid "The first character of C<param> string must be a C<-> (dash)."
5767 #: ../fish/guestfish-actions.pod:783 ../src/guestfs-actions.pod:1166
5768 msgid "C<value> can be NULL."
5772 #: ../fish/guestfish-actions.pod:785
5777 #: ../fish/guestfish-actions.pod:787
5780 " copy-size src dest size\n"
5785 #: ../fish/guestfish-actions.pod:789 ../src/guestfs-actions.pod:1180
5787 "This command copies exactly C<size> bytes from one source device or file "
5788 "C<src> to another destination device or file C<dest>."
5792 #: ../fish/guestfish-actions.pod:792 ../src/guestfs-actions.pod:1183
5794 "Note this will fail if the source is too short or if the destination is not "
5799 #: ../fish/guestfish-actions.pod:795
5804 #: ../fish/guestfish-actions.pod:797
5812 #: ../fish/guestfish-actions.pod:799 ../src/guestfs-actions.pod:1202
5814 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5815 "destination filename or destination directory."
5819 #: ../fish/guestfish-actions.pod:802
5824 #: ../fish/guestfish-actions.pod:804
5832 #: ../fish/guestfish-actions.pod:806 ../src/guestfs-actions.pod:1216
5834 "This copies a file or directory from C<src> to C<dest> recursively using the "
5839 #: ../fish/guestfish-actions.pod:809
5844 #: ../fish/guestfish-actions.pod:811
5852 #: ../fish/guestfish-actions.pod:813 ../src/guestfs-actions.pod:1230
5854 "This command copies from one source device or file C<src> to another "
5855 "destination device or file C<dest>. Normally you would use this to copy to "
5856 "or from a device or partition, for example to duplicate a filesystem."
5860 #: ../fish/guestfish-actions.pod:818
5862 "If the destination is a device, it must be as large or larger than the "
5863 "source file or device, otherwise the copy will fail. This command cannot do "
5864 "partial copies (see L</copy-size>)."
5868 #: ../fish/guestfish-actions.pod:822
5873 #: ../fish/guestfish-actions.pod:824
5881 #: ../fish/guestfish-actions.pod:826 ../src/guestfs-actions.pod:1248
5882 msgid "This command runs the C<df> command to report disk space used."
5886 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:839
5888 "This command is mostly useful for interactive sessions. It is I<not> "
5889 "intended that you try to parse the output string. Use L</statvfs> from "
5894 #: ../fish/guestfish-actions.pod:832
5899 #: ../fish/guestfish-actions.pod:834
5907 #: ../fish/guestfish-actions.pod:836 ../src/guestfs-actions.pod:1264
5909 "This command runs the C<df -h> command to report disk space used in human-"
5914 #: ../fish/guestfish-actions.pod:843
5919 #: ../fish/guestfish-actions.pod:845
5927 #: ../fish/guestfish-actions.pod:847 ../src/guestfs-actions.pod:1281
5929 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5930 "This is sometimes useful for extended debugging of problems."
5934 #: ../fish/guestfish-actions.pod:851
5936 "Another way to get the same information is to enable verbose messages with "
5937 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
5938 "before running the program."
5942 #: ../fish/guestfish-actions.pod:856
5947 #: ../fish/guestfish-actions.pod:858
5950 " download remotefilename (filename|-)\n"
5955 #: ../fish/guestfish-actions.pod:860 ../fish/guestfish-actions.pod:873
5956 #: ../src/guestfs-actions.pod:1302 ../src/guestfs-actions.pod:1327
5958 "Download file C<remotefilename> and save it as C<filename> on the local "
5963 #: ../fish/guestfish-actions.pod:863 ../fish/guestfish-actions.pod:4808
5964 #: ../src/guestfs-actions.pod:1305 ../src/guestfs-actions.pod:7237
5965 msgid "C<filename> can also be a named pipe."
5969 #: ../fish/guestfish-actions.pod:865
5970 msgid "See also L</upload>, L</cat>."
5974 #: ../fish/guestfish-actions.pod:869
5975 msgid "download-offset"
5979 #: ../fish/guestfish-actions.pod:871
5982 " download-offset remotefilename (filename|-) offset size\n"
5987 #: ../fish/guestfish-actions.pod:876 ../src/guestfs-actions.pod:1330
5989 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
5990 "region must be within the file or device)."
5994 #: ../fish/guestfish-actions.pod:879
5996 "Note that there is no limit on the amount of data that can be downloaded "
5997 "with this call, unlike with L</pread>, and this call always reads the full "
5998 "amount unless an error occurs."
6002 #: ../fish/guestfish-actions.pod:884
6003 msgid "See also L</download>, L</pread>."
6007 #: ../fish/guestfish-actions.pod:888
6012 #: ../fish/guestfish-actions.pod:890
6015 " drop-caches whattodrop\n"
6020 #: ../fish/guestfish-actions.pod:892 ../src/guestfs-actions.pod:1355
6022 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6023 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6024 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6028 #: ../fish/guestfish-actions.pod:897 ../src/guestfs-actions.pod:1360
6029 msgid "Setting C<whattodrop> to 3 should drop everything."
6033 #: ../fish/guestfish-actions.pod:899 ../src/guestfs-actions.pod:1362
6035 "This automatically calls L<sync(2)> before the operation, so that the "
6036 "maximum guest memory is freed."
6040 #: ../fish/guestfish-actions.pod:902
6045 #: ../fish/guestfish-actions.pod:904
6053 #: ../fish/guestfish-actions.pod:906 ../src/guestfs-actions.pod:1375
6055 "This command runs the C<du -s> command to estimate file space usage for "
6060 #: ../fish/guestfish-actions.pod:909 ../src/guestfs-actions.pod:1378
6062 "C<path> can be a file or a directory. If C<path> is a directory then the "
6063 "estimate includes the contents of the directory and all subdirectories "
6068 #: ../fish/guestfish-actions.pod:913 ../src/guestfs-actions.pod:1382
6070 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6074 #: ../fish/guestfish-actions.pod:916
6079 #: ../fish/guestfish-actions.pod:918
6082 " e2fsck-f device\n"
6087 #: ../fish/guestfish-actions.pod:920 ../src/guestfs-actions.pod:1400
6089 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6090 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
6095 #: ../fish/guestfish-actions.pod:924
6097 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
6098 "should use L</fsck>."
6102 #: ../fish/guestfish-actions.pod:927
6107 #: ../fish/guestfish-actions.pod:929
6110 " echo-daemon 'words ...'\n"
6115 #: ../fish/guestfish-actions.pod:931 ../src/guestfs-actions.pod:1417
6117 "This command concatenates the list of C<words> passed with single spaces "
6118 "between them and returns the resulting string."
6122 #: ../fish/guestfish-actions.pod:934 ../src/guestfs-actions.pod:1420
6123 msgid "You can use this command to test the connection through to the daemon."
6127 #: ../fish/guestfish-actions.pod:936
6128 msgid "See also L</ping-daemon>."
6132 #: ../fish/guestfish-actions.pod:938
6137 #: ../fish/guestfish-actions.pod:940
6140 " egrep regex path\n"
6145 #: ../fish/guestfish-actions.pod:942 ../src/guestfs-actions.pod:1436
6147 "This calls the external C<egrep> program and returns the matching lines."
6151 #: ../fish/guestfish-actions.pod:948
6156 #: ../fish/guestfish-actions.pod:950
6159 " egrepi regex path\n"
6164 #: ../fish/guestfish-actions.pod:952 ../src/guestfs-actions.pod:1455
6166 "This calls the external C<egrep -i> program and returns the matching lines."
6170 #: ../fish/guestfish-actions.pod:958
6175 #: ../fish/guestfish-actions.pod:960
6178 " equal file1 file2\n"
6183 #: ../fish/guestfish-actions.pod:962 ../src/guestfs-actions.pod:1474
6185 "This compares the two files C<file1> and C<file2> and returns true if their "
6186 "content is exactly equal, or false otherwise."
6190 #: ../fish/guestfish-actions.pod:965 ../src/guestfs-actions.pod:1477
6191 msgid "The external L<cmp(1)> program is used for the comparison."
6195 #: ../fish/guestfish-actions.pod:967
6200 #: ../fish/guestfish-actions.pod:969
6208 #: ../fish/guestfish-actions.pod:971 ../src/guestfs-actions.pod:1489
6210 "This returns C<true> if and only if there is a file, directory (or anything) "
6211 "with the given C<path> name."
6215 #: ../fish/guestfish-actions.pod:974
6216 msgid "See also L</is-file>, L</is-dir>, L</stat>."
6220 #: ../fish/guestfish-actions.pod:976
6225 #: ../fish/guestfish-actions.pod:978
6228 " fallocate path len\n"
6233 #: ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:999
6234 #: ../src/guestfs-actions.pod:1512 ../src/guestfs-actions.pod:1531
6236 "This command preallocates a file (containing zero bytes) named C<path> of "
6237 "size C<len> bytes. If the file exists already, it is overwritten."
6241 #: ../fish/guestfish-actions.pod:984 ../src/guestfs-actions.pod:1516
6243 "Do not confuse this with the guestfish-specific C<alloc> command which "
6244 "allocates a file in the host and attaches it as a device."
6248 #: ../fish/guestfish-actions.pod:988
6250 "I<This function is deprecated.> In new code, use the L</fallocate64> call "
6255 #: ../fish/guestfish-actions.pod:995
6260 #: ../fish/guestfish-actions.pod:997
6263 " fallocate64 path len\n"
6268 #: ../fish/guestfish-actions.pod:1003
6270 "Note that this call allocates disk blocks for the file. To create a sparse "
6271 "file use L</truncate-size> instead."
6275 #: ../fish/guestfish-actions.pod:1006
6277 "The deprecated call L</fallocate> does the same, but owing to an oversight "
6278 "it only allowed 30 bit lengths to be specified, effectively limiting the "
6279 "maximum size of files created through that call to 1GB."
6283 #: ../fish/guestfish-actions.pod:1011 ../src/guestfs-actions.pod:1543
6285 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6286 "commands which create a file in the host and attach it as a device."
6290 #: ../fish/guestfish-actions.pod:1015
6295 #: ../fish/guestfish-actions.pod:1017
6298 " fgrep pattern path\n"
6303 #: ../fish/guestfish-actions.pod:1019 ../src/guestfs-actions.pod:1558
6305 "This calls the external C<fgrep> program and returns the matching lines."
6309 #: ../fish/guestfish-actions.pod:1025
6314 #: ../fish/guestfish-actions.pod:1027
6317 " fgrepi pattern path\n"
6322 #: ../fish/guestfish-actions.pod:1029 ../src/guestfs-actions.pod:1577
6324 "This calls the external C<fgrep -i> program and returns the matching lines."
6328 #: ../fish/guestfish-actions.pod:1035
6333 #: ../fish/guestfish-actions.pod:1037
6341 #: ../fish/guestfish-actions.pod:1039 ../src/guestfs-actions.pod:1595
6343 "This call uses the standard L<file(1)> command to determine the type or "
6344 "contents of the file."
6348 #: ../fish/guestfish-actions.pod:1042 ../src/guestfs-actions.pod:1598
6350 "This call will also transparently look inside various types of compressed "
6355 #: ../fish/guestfish-actions.pod:1045 ../src/guestfs-actions.pod:1601
6357 "The exact command which runs is C<file -zb path>. Note in particular that "
6358 "the filename is not prepended to the output (the I<-b> option)."
6362 #: ../fish/guestfish-actions.pod:1049 ../src/guestfs-actions.pod:1605
6364 "The output depends on the output of the underlying L<file(1)> command and it "
6365 "can change in future in ways beyond our control. In other words, the output "
6366 "is not guaranteed by the ABI."
6370 #: ../fish/guestfish-actions.pod:1053
6372 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
6373 "(etc), L</is-zero>."
6377 #: ../fish/guestfish-actions.pod:1056
6378 msgid "file-architecture"
6382 #: ../fish/guestfish-actions.pod:1058
6385 " file-architecture filename\n"
6390 #: ../fish/guestfish-actions.pod:1060 ../src/guestfs-actions.pod:1623
6392 "This detects the architecture of the binary C<filename>, and returns it if "
6397 #: ../fish/guestfish-actions.pod:1063 ../src/guestfs-actions.pod:1626
6398 msgid "Currently defined architectures are:"
6402 #: ../fish/guestfish-actions.pod:1067 ../src/guestfs-actions.pod:1630
6407 #: ../fish/guestfish-actions.pod:1069 ../src/guestfs-actions.pod:1632
6409 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6410 "irrespective of the precise processor requirements of the binary."
6414 #: ../fish/guestfish-actions.pod:1072 ../src/guestfs-actions.pod:1635
6419 #: ../fish/guestfish-actions.pod:1074 ../src/guestfs-actions.pod:1637
6420 msgid "64 bit x86-64."
6424 #: ../fish/guestfish-actions.pod:1076 ../src/guestfs-actions.pod:1639
6429 #: ../fish/guestfish-actions.pod:1078 ../src/guestfs-actions.pod:1641
6430 msgid "32 bit SPARC."
6434 #: ../fish/guestfish-actions.pod:1080 ../src/guestfs-actions.pod:1643
6439 #: ../fish/guestfish-actions.pod:1082 ../src/guestfs-actions.pod:1645
6440 msgid "64 bit SPARC V9 and above."
6444 #: ../fish/guestfish-actions.pod:1084 ../src/guestfs-actions.pod:1647
6449 #: ../fish/guestfish-actions.pod:1086 ../src/guestfs-actions.pod:1649
6450 msgid "Intel Itanium."
6454 #: ../fish/guestfish-actions.pod:1088 ../src/guestfs-actions.pod:1651
6459 #: ../fish/guestfish-actions.pod:1090 ../src/guestfs-actions.pod:1653
6460 msgid "32 bit Power PC."
6464 #: ../fish/guestfish-actions.pod:1092 ../src/guestfs-actions.pod:1655
6469 #: ../fish/guestfish-actions.pod:1094 ../src/guestfs-actions.pod:1657
6470 msgid "64 bit Power PC."
6474 #: ../fish/guestfish-actions.pod:1098 ../src/guestfs-actions.pod:1661
6475 msgid "Libguestfs may return other architecture strings in future."
6479 #: ../fish/guestfish-actions.pod:1100 ../src/guestfs-actions.pod:1663
6480 msgid "The function works on at least the following types of files:"
6484 #: ../fish/guestfish-actions.pod:1106 ../src/guestfs-actions.pod:1669
6485 msgid "many types of Un*x and Linux binary"
6489 #: ../fish/guestfish-actions.pod:1110 ../src/guestfs-actions.pod:1673
6490 msgid "many types of Un*x and Linux shared library"
6494 #: ../fish/guestfish-actions.pod:1114 ../src/guestfs-actions.pod:1677
6495 msgid "Windows Win32 and Win64 binaries"
6499 #: ../fish/guestfish-actions.pod:1118 ../src/guestfs-actions.pod:1681
6500 msgid "Windows Win32 and Win64 DLLs"
6504 #: ../fish/guestfish-actions.pod:1120 ../src/guestfs-actions.pod:1683
6505 msgid "Win32 binaries and DLLs return C<i386>."
6509 #: ../fish/guestfish-actions.pod:1122 ../src/guestfs-actions.pod:1685
6510 msgid "Win64 binaries and DLLs return C<x86_64>."
6514 #: ../fish/guestfish-actions.pod:1126 ../src/guestfs-actions.pod:1689
6515 msgid "Linux kernel modules"
6519 #: ../fish/guestfish-actions.pod:1130 ../src/guestfs-actions.pod:1693
6520 msgid "Linux new-style initrd images"
6524 #: ../fish/guestfish-actions.pod:1134 ../src/guestfs-actions.pod:1697
6525 msgid "some non-x86 Linux vmlinuz kernels"
6529 #: ../fish/guestfish-actions.pod:1138 ../src/guestfs-actions.pod:1701
6530 msgid "What it can't do currently:"
6534 #: ../fish/guestfish-actions.pod:1144 ../src/guestfs-actions.pod:1707
6535 msgid "static libraries (libfoo.a)"
6539 #: ../fish/guestfish-actions.pod:1148 ../src/guestfs-actions.pod:1711
6540 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6544 #: ../fish/guestfish-actions.pod:1152 ../src/guestfs-actions.pod:1715
6545 msgid "x86 Linux vmlinuz kernels"
6549 #: ../fish/guestfish-actions.pod:1154 ../src/guestfs-actions.pod:1717
6551 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6552 "compressed code, and are horribly hard to unpack. If you want to find the "
6553 "architecture of a kernel, use the architecture of the associated initrd or "
6554 "kernel module(s) instead."
6558 #: ../fish/guestfish-actions.pod:1161
6563 #: ../fish/guestfish-actions.pod:1163
6571 #: ../fish/guestfish-actions.pod:1165 ../src/guestfs-actions.pod:1735
6572 msgid "This command returns the size of C<file> in bytes."
6576 #: ../fish/guestfish-actions.pod:1167
6578 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
6579 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
6583 #: ../fish/guestfish-actions.pod:1171
6588 #: ../fish/guestfish-actions.pod:1173
6591 " fill c len path\n"
6596 #: ../fish/guestfish-actions.pod:1175 ../src/guestfs-actions.pod:1753
6598 "This command creates a new file called C<path>. The initial content of the "
6599 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
6604 #: ../fish/guestfish-actions.pod:1179
6606 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6607 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
6612 #: ../fish/guestfish-actions.pod:1184
6613 msgid "fill-pattern"
6617 #: ../fish/guestfish-actions.pod:1186
6620 " fill-pattern pattern len path\n"
6625 #: ../fish/guestfish-actions.pod:1188
6627 "This function is like L</fill> except that it creates a new file of length "
6628 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
6629 "is truncated if necessary to ensure the length of the file is exactly C<len> "
6634 #: ../fish/guestfish-actions.pod:1193
6639 #: ../fish/guestfish-actions.pod:1195
6647 #: ../fish/guestfish-actions.pod:1197 ../src/guestfs-actions.pod:1799
6649 "This command lists out all files and directories, recursively, starting at "
6650 "C<directory>. It is essentially equivalent to running the shell command "
6651 "C<find directory -print> but some post-processing happens on the output, "
6656 #: ../fish/guestfish-actions.pod:1202 ../src/guestfs-actions.pod:1804
6658 "This returns a list of strings I<without any prefix>. Thus if the directory "
6663 #: ../fish/guestfish-actions.pod:1205 ../src/guestfs-actions.pod:1807
6673 #: ../fish/guestfish-actions.pod:1209
6674 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
6678 #: ../fish/guestfish-actions.pod:1212 ../src/guestfs-actions.pod:1814
6689 #: ../fish/guestfish-actions.pod:1217 ../src/guestfs-actions.pod:1819
6690 msgid "If C<directory> is not a directory, then this command returns an error."
6694 #: ../fish/guestfish-actions.pod:1220 ../src/guestfs-actions.pod:1822
6695 msgid "The returned list is sorted."
6699 #: ../fish/guestfish-actions.pod:1222
6700 msgid "See also L</find0>."
6704 #: ../fish/guestfish-actions.pod:1227
6709 #: ../fish/guestfish-actions.pod:1229
6712 " find0 directory (files|-)\n"
6717 #: ../fish/guestfish-actions.pod:1231 ../src/guestfs-actions.pod:1842
6719 "This command lists out all files and directories, recursively, starting at "
6720 "C<directory>, placing the resulting list in the external file called "
6725 #: ../fish/guestfish-actions.pod:1235
6727 "This command works the same way as L</find> with the following exceptions:"
6731 #: ../fish/guestfish-actions.pod:1242 ../src/guestfs-actions.pod:1853
6732 msgid "The resulting list is written to an external file."
6736 #: ../fish/guestfish-actions.pod:1246 ../src/guestfs-actions.pod:1857
6738 "Items (filenames) in the result are separated by C<\\0> characters. See "
6739 "L<find(1)> option I<-print0>."
6743 #: ../fish/guestfish-actions.pod:1251 ../src/guestfs-actions.pod:1862
6744 msgid "This command is not limited in the number of names that it can return."
6748 #: ../fish/guestfish-actions.pod:1256 ../src/guestfs-actions.pod:1867
6749 msgid "The result list is not sorted."
6753 #: ../fish/guestfish-actions.pod:1262
6754 msgid "findfs-label"
6758 #: ../fish/guestfish-actions.pod:1264
6761 " findfs-label label\n"
6766 #: ../fish/guestfish-actions.pod:1266 ../src/guestfs-actions.pod:1881
6768 "This command searches the filesystems and returns the one which has the "
6769 "given label. An error is returned if no such filesystem can be found."
6773 #: ../fish/guestfish-actions.pod:1270
6774 msgid "To find the label of a filesystem, use L</vfs-label>."
6778 #: ../fish/guestfish-actions.pod:1272
6783 #: ../fish/guestfish-actions.pod:1274
6786 " findfs-uuid uuid\n"
6791 #: ../fish/guestfish-actions.pod:1276 ../src/guestfs-actions.pod:1898
6793 "This command searches the filesystems and returns the one which has the "
6794 "given UUID. An error is returned if no such filesystem can be found."
6798 #: ../fish/guestfish-actions.pod:1280
6799 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
6803 #: ../fish/guestfish-actions.pod:1282
6808 #: ../fish/guestfish-actions.pod:1284
6811 " fsck fstype device\n"
6816 #: ../fish/guestfish-actions.pod:1286 ../src/guestfs-actions.pod:1916
6818 "This runs the filesystem checker (fsck) on C<device> which should have "
6819 "filesystem type C<fstype>."
6823 #: ../fish/guestfish-actions.pod:1289 ../src/guestfs-actions.pod:1919
6825 "The returned integer is the status. See L<fsck(8)> for the list of status "
6826 "codes from C<fsck>."
6830 #: ../fish/guestfish-actions.pod:1298 ../src/guestfs-actions.pod:1928
6831 msgid "Multiple status codes can be summed together."
6835 #: ../fish/guestfish-actions.pod:1302 ../src/guestfs-actions.pod:1932
6837 "A non-zero return code can mean \"success\", for example if errors have been "
6838 "corrected on the filesystem."
6842 #: ../fish/guestfish-actions.pod:1307 ../src/guestfs-actions.pod:1937
6843 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6847 #: ../fish/guestfish-actions.pod:1312 ../src/guestfs-actions.pod:1942
6849 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6853 #: ../fish/guestfish-actions.pod:1314
6858 #: ../fish/guestfish-actions.pod:1316
6866 #: ../fish/guestfish-actions.pod:1318 ../src/guestfs-actions.pod:1953
6868 "Return the additional kernel options which are added to the guest kernel "
6873 #: ../fish/guestfish-actions.pod:1321 ../src/guestfs-actions.pod:1956
6874 msgid "If C<NULL> then no options are added."
6878 #: ../fish/guestfish-actions.pod:1323
6879 msgid "get-attach-method"
6883 #: ../fish/guestfish-actions.pod:1325
6886 " get-attach-method\n"
6891 #: ../fish/guestfish-actions.pod:1327
6892 msgid "Return the current attach method. See L</set-attach-method>."
6896 #: ../fish/guestfish-actions.pod:1329
6897 msgid "get-autosync"
6901 #: ../fish/guestfish-actions.pod:1331
6909 #: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:1981
6910 msgid "Get the autosync flag."
6914 #: ../fish/guestfish-actions.pod:1335
6919 #: ../fish/guestfish-actions.pod:1337
6927 #: ../fish/guestfish-actions.pod:1339 ../src/guestfs-actions.pod:1992
6928 msgid "Return the direct appliance mode flag."
6932 #: ../fish/guestfish-actions.pod:1341
6937 #: ../fish/guestfish-actions.pod:1343
6940 " get-e2label device\n"
6945 #: ../fish/guestfish-actions.pod:1345 ../src/guestfs-actions.pod:2011
6947 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6951 #: ../fish/guestfish-actions.pod:1348
6953 "I<This function is deprecated.> In new code, use the L</vfs_label> call "
6958 #: ../fish/guestfish-actions.pod:1355
6963 #: ../fish/guestfish-actions.pod:1357
6966 " get-e2uuid device\n"
6971 #: ../fish/guestfish-actions.pod:1359 ../src/guestfs-actions.pod:2032
6973 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6977 #: ../fish/guestfish-actions.pod:1362
6979 "I<This function is deprecated.> In new code, use the L</vfs_uuid> call "
6984 #: ../fish/guestfish-actions.pod:1369
6989 #: ../fish/guestfish-actions.pod:1371
6997 #: ../fish/guestfish-actions.pod:1373 ../src/guestfs-actions.pod:2045
6999 "This gets the memory size in megabytes allocated to the qemu subprocess."
7003 #: ../fish/guestfish-actions.pod:1376
7005 "If L</set-memsize> was not called on this handle, and if "
7006 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7007 "value for memsize."
7011 #: ../fish/guestfish-actions.pod:1380 ../fish/guestfish-actions.pod:1437
7012 #: ../fish/guestfish-actions.pod:4168 ../fish/guestfish-actions.pod:4270
7013 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2144
7014 #: ../src/guestfs-actions.pod:6298 ../src/guestfs-actions.pod:6424
7016 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7020 #: ../fish/guestfish-actions.pod:1383
7025 #: ../fish/guestfish-actions.pod:1385
7033 #: ../fish/guestfish-actions.pod:1387 ../src/guestfs-actions.pod:2064
7034 msgid "This returns the enable network flag."
7038 #: ../fish/guestfish-actions.pod:1389
7043 #: ../fish/guestfish-actions.pod:1391
7051 #: ../fish/guestfish-actions.pod:1393 ../src/guestfs-actions.pod:2075
7052 msgid "Return the current search path."
7056 #: ../fish/guestfish-actions.pod:1395 ../src/guestfs-actions.pod:2077
7058 "This is always non-NULL. If it wasn't set already, then this will return "
7063 #: ../fish/guestfish-actions.pod:1398
7068 #: ../fish/guestfish-actions.pod:1400
7076 #: ../fish/guestfish-actions.pod:1402 ../src/guestfs-actions.pod:2090
7077 msgid "This returns the process group flag."
7081 #: ../fish/guestfish-actions.pod:1404
7086 #: ../fish/guestfish-actions.pod:1406
7091 #: ../fish/guestfish-actions.pod:1408
7099 #: ../fish/guestfish-actions.pod:1410 ../src/guestfs-actions.pod:2101
7101 "Return the process ID of the qemu subprocess. If there is no qemu "
7102 "subprocess, then this will return an error."
7106 #: ../fish/guestfish-actions.pod:1413 ../src/guestfs-actions.pod:2104
7107 msgid "This is an internal call used for debugging and testing."
7111 #: ../fish/guestfish-actions.pod:1415
7116 #: ../fish/guestfish-actions.pod:1417
7124 #: ../fish/guestfish-actions.pod:1419 ../src/guestfs-actions.pod:2115
7125 msgid "Return the current qemu binary."
7129 #: ../fish/guestfish-actions.pod:1421 ../src/guestfs-actions.pod:2117
7131 "This is always non-NULL. If it wasn't set already, then this will return "
7132 "the default qemu binary name."
7136 #: ../fish/guestfish-actions.pod:1424
7137 msgid "get-recovery-proc"
7141 #: ../fish/guestfish-actions.pod:1426
7144 " get-recovery-proc\n"
7149 #: ../fish/guestfish-actions.pod:1428 ../src/guestfs-actions.pod:2130
7150 msgid "Return the recovery process enabled flag."
7154 #: ../fish/guestfish-actions.pod:1430
7159 #: ../fish/guestfish-actions.pod:1432
7167 #: ../fish/guestfish-actions.pod:1434
7169 "This returns the current setting of the selinux flag which is passed to the "
7170 "appliance at boot time. See L</set-selinux>."
7174 #: ../fish/guestfish-actions.pod:1440
7179 #: ../fish/guestfish-actions.pod:1442
7187 #: ../fish/guestfish-actions.pod:1444 ../src/guestfs-actions.pod:2156
7189 "This returns the current state as an opaque integer. This is only useful "
7190 "for printing debug and internal error messages."
7194 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2367
7195 #: ../fish/guestfish-actions.pod:2385 ../fish/guestfish-actions.pod:2423
7196 #: ../fish/guestfish-actions.pod:2439 ../src/guestfs-actions.pod:2159
7197 #: ../src/guestfs-actions.pod:3439 ../src/guestfs-actions.pod:3468
7198 #: ../src/guestfs-actions.pod:3529 ../src/guestfs-actions.pod:3556
7199 msgid "For more information on states, see L<guestfs(3)>."
7203 #: ../fish/guestfish-actions.pod:1449
7208 #: ../fish/guestfish-actions.pod:1451
7216 #: ../fish/guestfish-actions.pod:1453 ../src/guestfs-actions.pod:2170
7217 msgid "Return the command trace flag."
7221 #: ../fish/guestfish-actions.pod:1455
7226 #: ../fish/guestfish-actions.pod:1457
7234 #: ../fish/guestfish-actions.pod:1459
7236 "Return the current umask. By default the umask is C<022> unless it has been "
7237 "set by calling L</umask>."
7241 #: ../fish/guestfish-actions.pod:1462
7246 #: ../fish/guestfish-actions.pod:1464
7254 #: ../fish/guestfish-actions.pod:1466 ../src/guestfs-actions.pod:2193
7255 msgid "This returns the verbose messages flag."
7259 #: ../fish/guestfish-actions.pod:1468
7264 #: ../fish/guestfish-actions.pod:1470
7272 #: ../fish/guestfish-actions.pod:1472 ../src/guestfs-actions.pod:2204
7273 msgid "This gets the SELinux security context of the daemon."
7277 #: ../fish/guestfish-actions.pod:1474
7278 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
7282 #: ../fish/guestfish-actions.pod:1477
7287 #: ../fish/guestfish-actions.pod:1479
7290 " getxattr path name\n"
7295 #: ../fish/guestfish-actions.pod:1481
7297 "Get a single extended attribute from file C<path> named C<name>. This call "
7298 "follows symlinks. If you want to lookup an extended attribute for the "
7299 "symlink itself, use L</lgetxattr>."
7303 #: ../fish/guestfish-actions.pod:1485 ../fish/guestfish-actions.pod:2512
7305 "Normally it is better to get all extended attributes from a file in one go "
7306 "by calling L</getxattrs>. However some Linux filesystem implementations are "
7307 "buggy and do not provide a way to list out attributes. For these "
7308 "filesystems (notably ntfs-3g) you have to know the names of the extended "
7309 "attributes you want in advance and call this function."
7313 #: ../fish/guestfish-actions.pod:1492 ../fish/guestfish-actions.pod:2519
7314 #: ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:3689
7316 "Extended attribute values are blobs of binary data. If there is no extended "
7317 "attribute named C<name>, this returns an error."
7321 #: ../fish/guestfish-actions.pod:1495
7322 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
7326 #: ../fish/guestfish-actions.pod:1497
7331 #: ../fish/guestfish-actions.pod:1499
7339 #: ../fish/guestfish-actions.pod:1501 ../src/guestfs-actions.pod:2250
7341 "This call lists the extended attributes of the file or directory C<path>."
7345 #: ../fish/guestfish-actions.pod:1504 ../src/guestfs-actions.pod:2253
7347 "At the system call level, this is a combination of the L<listxattr(2)> and "
7348 "L<getxattr(2)> calls."
7352 #: ../fish/guestfish-actions.pod:1507
7353 msgid "See also: L</lgetxattrs>, L<attr(5)>."
7357 #: ../fish/guestfish-actions.pod:1509
7362 #: ../fish/guestfish-actions.pod:1511
7365 " glob-expand pattern\n"
7370 #: ../fish/guestfish-actions.pod:1513 ../src/guestfs-actions.pod:2270
7372 "This command searches for all the pathnames matching C<pattern> according to "
7373 "the wildcard expansion rules used by the shell."
7377 #: ../fish/guestfish-actions.pod:1517 ../src/guestfs-actions.pod:2274
7379 "If no paths match, then this returns an empty list (note: not an error)."
7383 #: ../fish/guestfish-actions.pod:1520 ../src/guestfs-actions.pod:2277
7385 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
7386 "GLOB_BRACE>. See that manual page for more details."
7390 #: ../fish/guestfish-actions.pod:1524
7395 #: ../fish/guestfish-actions.pod:1526
7398 " grep regex path\n"
7403 #: ../fish/guestfish-actions.pod:1528 ../src/guestfs-actions.pod:2294
7404 msgid "This calls the external C<grep> program and returns the matching lines."
7408 #: ../fish/guestfish-actions.pod:1534
7413 #: ../fish/guestfish-actions.pod:1536
7416 " grepi regex path\n"
7421 #: ../fish/guestfish-actions.pod:1538 ../src/guestfs-actions.pod:2313
7423 "This calls the external C<grep -i> program and returns the matching lines."
7427 #: ../fish/guestfish-actions.pod:1544
7428 msgid "grub-install"
7432 #: ../fish/guestfish-actions.pod:1546
7435 " grub-install root device\n"
7440 #: ../fish/guestfish-actions.pod:1548 ../src/guestfs-actions.pod:2332
7442 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7443 "the root directory being C<root>."
7447 #: ../fish/guestfish-actions.pod:1551 ../src/guestfs-actions.pod:2335
7449 "Note: If grub-install reports the error \"No suitable drive was found in the "
7450 "generated device map.\" it may be that you need to create a C</boot/grub/"
7451 "device.map> file first that contains the mapping between grub device names "
7452 "and Linux device names. It is usually sufficient to create a file "
7457 #: ../fish/guestfish-actions.pod:1558 ../src/guestfs-actions.pod:2342
7465 #: ../fish/guestfish-actions.pod:1560 ../src/guestfs-actions.pod:2344
7466 msgid "replacing C</dev/vda> with the name of the installation device."
7470 #: ../fish/guestfish-actions.pod:1562
7475 #: ../fish/guestfish-actions.pod:1564
7483 #: ../fish/guestfish-actions.pod:1566 ../src/guestfs-actions.pod:2356
7485 "This command returns up to the first 10 lines of a file as a list of strings."
7489 #: ../fish/guestfish-actions.pod:1572
7494 #: ../fish/guestfish-actions.pod:1574
7497 " head-n nrlines path\n"
7502 #: ../fish/guestfish-actions.pod:1576 ../src/guestfs-actions.pod:2375
7504 "If the parameter C<nrlines> is a positive number, this returns the first "
7505 "C<nrlines> lines of the file C<path>."
7509 #: ../fish/guestfish-actions.pod:1579 ../src/guestfs-actions.pod:2378
7511 "If the parameter C<nrlines> is a negative number, this returns lines from "
7512 "the file C<path>, excluding the last C<nrlines> lines."
7516 #: ../fish/guestfish-actions.pod:1582 ../fish/guestfish-actions.pod:4648
7517 #: ../src/guestfs-actions.pod:2381 ../src/guestfs-actions.pod:6996
7518 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7522 #: ../fish/guestfish-actions.pod:1587
7527 #: ../fish/guestfish-actions.pod:1589
7535 #: ../fish/guestfish-actions.pod:1591 ../src/guestfs-actions.pod:2398
7537 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
7538 "readable, canonical hex dump of the file."
7542 #: ../fish/guestfish-actions.pod:1597
7547 #: ../fish/guestfish-actions.pod:1599
7550 " initrd-cat initrdpath filename\n"
7555 #: ../fish/guestfish-actions.pod:1601 ../src/guestfs-actions.pod:2417
7557 "This command unpacks the file C<filename> from the initrd file called "
7558 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7563 #: ../fish/guestfish-actions.pod:1605 ../src/guestfs-actions.pod:2421
7565 "For example, in guestfish you could use the following command to examine the "
7566 "boot script (usually called C</init>) contained in a Linux initrd or "
7571 #: ../fish/guestfish-actions.pod:1609 ../src/guestfs-actions.pod:2425
7574 " initrd-cat /boot/initrd-<version>.img init\n"
7579 #: ../fish/guestfish-actions.pod:1611
7580 msgid "See also L</initrd-list>."
7584 #: ../fish/guestfish-actions.pod:1616
7589 #: ../fish/guestfish-actions.pod:1618
7592 " initrd-list path\n"
7597 #: ../fish/guestfish-actions.pod:1620 ../src/guestfs-actions.pod:2444
7598 msgid "This command lists out files contained in an initrd."
7602 #: ../fish/guestfish-actions.pod:1622 ../src/guestfs-actions.pod:2446
7604 "The files are listed without any initial C</> character. The files are "
7605 "listed in the order they appear (not necessarily alphabetical). Directory "
7606 "names are listed as separate items."
7610 #: ../fish/guestfish-actions.pod:1626 ../src/guestfs-actions.pod:2450
7612 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7613 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7618 #: ../fish/guestfish-actions.pod:1630
7619 msgid "inotify-add-watch"
7623 #: ../fish/guestfish-actions.pod:1632
7626 " inotify-add-watch path mask\n"
7631 #: ../fish/guestfish-actions.pod:1634 ../src/guestfs-actions.pod:2467
7632 msgid "Watch C<path> for the events listed in C<mask>."
7636 #: ../fish/guestfish-actions.pod:1636 ../src/guestfs-actions.pod:2469
7638 "Note that if C<path> is a directory then events within that directory are "
7639 "watched, but this does I<not> happen recursively (in subdirectories)."
7643 #: ../fish/guestfish-actions.pod:1640 ../src/guestfs-actions.pod:2473
7645 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7646 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7650 #: ../fish/guestfish-actions.pod:1644
7651 msgid "inotify-close"
7655 #: ../fish/guestfish-actions.pod:1646
7663 #: ../fish/guestfish-actions.pod:1648 ../src/guestfs-actions.pod:2486
7665 "This closes the inotify handle which was previously opened by inotify_init. "
7666 "It removes all watches, throws away any pending events, and deallocates all "
7671 #: ../fish/guestfish-actions.pod:1652
7672 msgid "inotify-files"
7676 #: ../fish/guestfish-actions.pod:1654
7684 #: ../fish/guestfish-actions.pod:1656
7686 "This function is a helpful wrapper around L</inotify-read> which just "
7687 "returns a list of pathnames of objects that were touched. The returned "
7688 "pathnames are sorted and deduplicated."
7692 #: ../fish/guestfish-actions.pod:1660
7693 msgid "inotify-init"
7697 #: ../fish/guestfish-actions.pod:1662
7700 " inotify-init maxevents\n"
7705 #: ../fish/guestfish-actions.pod:1664 ../src/guestfs-actions.pod:2515
7707 "This command creates a new inotify handle. The inotify subsystem can be "
7708 "used to notify events which happen to objects in the guest filesystem."
7712 #: ../fish/guestfish-actions.pod:1668
7714 "C<maxevents> is the maximum number of events which will be queued up between "
7715 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
7716 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
7717 "default was 16384 events. Beyond this limit, the kernel throws away events, "
7718 "but records the fact that it threw them away by setting a flag "
7719 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
7723 #: ../fish/guestfish-actions.pod:1678
7725 "Before any events are generated, you have to add some watches to the "
7726 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
7727 "L</inotify-watch-all>."
7731 #: ../fish/guestfish-actions.pod:1684
7733 "Queued up events should be read periodically by calling L</inotify-read> (or "
7734 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
7735 "If you don't read the events out often enough then you risk the internal "
7736 "queue overflowing."
7740 #: ../fish/guestfish-actions.pod:1691
7742 "The handle should be closed after use by calling L</inotify-close>. This "
7743 "also removes any watches automatically."
7747 #: ../fish/guestfish-actions.pod:1695 ../src/guestfs-actions.pod:2546
7749 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7750 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7751 "that there is one global inotify handle per libguestfs instance."
7755 #: ../fish/guestfish-actions.pod:1700
7756 msgid "inotify-read"
7760 #: ../fish/guestfish-actions.pod:1702
7768 #: ../fish/guestfish-actions.pod:1704 ../src/guestfs-actions.pod:2560
7770 "Return the complete queue of events that have happened since the previous "
7775 #: ../fish/guestfish-actions.pod:1707 ../src/guestfs-actions.pod:2563
7776 msgid "If no events have happened, this returns an empty list."
7780 #: ../fish/guestfish-actions.pod:1709 ../src/guestfs-actions.pod:2565
7782 "I<Note>: In order to make sure that all events have been read, you must call "
7783 "this function repeatedly until it returns an empty list. The reason is that "
7784 "the call will read events up to the maximum appliance-to-host message size "
7785 "and leave remaining events in the queue."
7789 #: ../fish/guestfish-actions.pod:1715
7790 msgid "inotify-rm-watch"
7794 #: ../fish/guestfish-actions.pod:1717
7797 " inotify-rm-watch wd\n"
7802 #: ../fish/guestfish-actions.pod:1719
7803 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
7807 #: ../fish/guestfish-actions.pod:1722
7808 msgid "inspect-get-arch"
7812 #: ../fish/guestfish-actions.pod:1724
7815 " inspect-get-arch root\n"
7820 #: ../fish/guestfish-actions.pod:1726
7822 "This returns the architecture of the inspected operating system. The "
7823 "possible return values are listed under L</file-architecture>."
7827 #: ../fish/guestfish-actions.pod:1730 ../src/guestfs-actions.pod:2600
7829 "If the architecture could not be determined, then the string C<unknown> is "
7834 #: ../fish/guestfish-actions.pod:1733 ../fish/guestfish-actions.pod:1816
7835 #: ../fish/guestfish-actions.pod:1895 ../fish/guestfish-actions.pod:1907
7836 #: ../fish/guestfish-actions.pod:1991 ../fish/guestfish-actions.pod:2052
7837 #: ../fish/guestfish-actions.pod:2073 ../fish/guestfish-actions.pod:2087
7838 #: ../fish/guestfish-actions.pod:2127 ../fish/guestfish-actions.pod:2159
7839 #: ../fish/guestfish-actions.pod:2172 ../fish/guestfish-actions.pod:2185
7840 #: ../fish/guestfish-actions.pod:2195 ../fish/guestfish-actions.pod:2205
7841 #: ../fish/guestfish-actions.pod:2217 ../fish/guestfish-actions.pod:2313
7842 #: ../fish/guestfish-actions.pod:2347 ../src/guestfs-actions.pod:2603
7843 #: ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2797
7844 #: ../src/guestfs-actions.pod:2816 ../src/guestfs-actions.pod:2947
7845 #: ../src/guestfs-actions.pod:3030 ../src/guestfs-actions.pod:3058
7846 #: ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3132
7847 #: ../src/guestfs-actions.pod:3172 ../src/guestfs-actions.pod:3192
7848 #: ../src/guestfs-actions.pod:3212 ../src/guestfs-actions.pod:3229
7849 #: ../src/guestfs-actions.pod:3245 ../src/guestfs-actions.pod:3263
7850 #: ../src/guestfs-actions.pod:3365 ../src/guestfs-actions.pod:3406
7851 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7855 #: ../fish/guestfish-actions.pod:1735
7856 msgid "inspect-get-distro"
7860 #: ../fish/guestfish-actions.pod:1737
7863 " inspect-get-distro root\n"
7868 #: ../fish/guestfish-actions.pod:1739 ../src/guestfs-actions.pod:2616
7870 "This returns the distro (distribution) of the inspected operating system."
7874 #: ../fish/guestfish-actions.pod:1742 ../src/guestfs-actions.pod:2619
7875 msgid "Currently defined distros are:"
7879 #: ../fish/guestfish-actions.pod:1746 ../src/guestfs-actions.pod:2623
7880 msgid "\"archlinux\""
7884 #: ../fish/guestfish-actions.pod:1748 ../src/guestfs-actions.pod:2625
7889 #: ../fish/guestfish-actions.pod:1750 ../src/guestfs-actions.pod:2627
7894 #: ../fish/guestfish-actions.pod:1752 ../src/guestfs-actions.pod:2629
7899 #: ../fish/guestfish-actions.pod:1754 ../src/guestfs-actions.pod:2631
7904 #: ../fish/guestfish-actions.pod:1756 ../src/guestfs-actions.pod:2633
7909 #: ../fish/guestfish-actions.pod:1758 ../src/guestfs-actions.pod:2635
7914 #: ../fish/guestfish-actions.pod:1760 ../src/guestfs-actions.pod:2637
7919 #: ../fish/guestfish-actions.pod:1762 ../src/guestfs-actions.pod:2639
7924 #: ../fish/guestfish-actions.pod:1764 ../src/guestfs-actions.pod:2641
7929 #: ../fish/guestfish-actions.pod:1766 ../src/guestfs-actions.pod:2643
7930 msgid "\"linuxmint\""
7934 #: ../fish/guestfish-actions.pod:1768 ../src/guestfs-actions.pod:2645
7939 #: ../fish/guestfish-actions.pod:1770 ../src/guestfs-actions.pod:2647
7940 msgid "\"mandriva\""
7944 #: ../fish/guestfish-actions.pod:1772 ../src/guestfs-actions.pod:2649
7949 #: ../fish/guestfish-actions.pod:1774 ../src/guestfs-actions.pod:2651
7954 #: ../fish/guestfish-actions.pod:1776 ../src/guestfs-actions.pod:2653
7959 #: ../fish/guestfish-actions.pod:1778 ../src/guestfs-actions.pod:2655
7964 #: ../fish/guestfish-actions.pod:1780 ../src/guestfs-actions.pod:2657
7969 #: ../fish/guestfish-actions.pod:1782 ../src/guestfs-actions.pod:2659
7970 msgid "\"redhat-based\""
7974 #: ../fish/guestfish-actions.pod:1784 ../src/guestfs-actions.pod:2661
7975 msgid "Some Red Hat-derived distro."
7979 #: ../fish/guestfish-actions.pod:1786 ../src/guestfs-actions.pod:2663
7984 #: ../fish/guestfish-actions.pod:1788 ../src/guestfs-actions.pod:2665
7985 msgid "Red Hat Enterprise Linux."
7989 #: ../fish/guestfish-actions.pod:1790 ../src/guestfs-actions.pod:2667
7990 msgid "\"scientificlinux\""
7994 #: ../fish/guestfish-actions.pod:1792 ../src/guestfs-actions.pod:2669
7995 msgid "Scientific Linux."
7999 #: ../fish/guestfish-actions.pod:1794 ../src/guestfs-actions.pod:2671
8000 msgid "\"slackware\""
8004 #: ../fish/guestfish-actions.pod:1796 ../src/guestfs-actions.pod:2673
8009 #: ../fish/guestfish-actions.pod:1798 ../src/guestfs-actions.pod:2675
8014 #: ../fish/guestfish-actions.pod:1800 ../src/guestfs-actions.pod:2677
8019 #: ../fish/guestfish-actions.pod:1802 ../fish/guestfish-actions.pod:1886
8020 #: ../fish/guestfish-actions.pod:2150 ../src/guestfs-actions.pod:2679
8021 #: ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:3163
8026 #: ../fish/guestfish-actions.pod:1804 ../src/guestfs-actions.pod:2681
8027 msgid "The distro could not be determined."
8031 #: ../fish/guestfish-actions.pod:1806 ../fish/guestfish-actions.pod:2142
8032 #: ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:3155
8037 #: ../fish/guestfish-actions.pod:1808 ../src/guestfs-actions.pod:2685
8039 "Windows does not have distributions. This string is returned if the OS type "
8044 #: ../fish/guestfish-actions.pod:1813 ../fish/guestfish-actions.pod:1892
8045 #: ../fish/guestfish-actions.pod:2156 ../src/guestfs-actions.pod:2690
8046 #: ../src/guestfs-actions.pod:2794 ../src/guestfs-actions.pod:3169
8048 "Future versions of libguestfs may return other strings here. The caller "
8049 "should be prepared to handle any string."
8053 #: ../fish/guestfish-actions.pod:1818
8054 msgid "inspect-get-drive-mappings"
8058 #: ../fish/guestfish-actions.pod:1820
8061 " inspect-get-drive-mappings root\n"
8066 #: ../fish/guestfish-actions.pod:1822 ../src/guestfs-actions.pod:2706
8068 "This call is useful for Windows which uses a primitive system of assigning "
8069 "drive letters (like \"C:\") to partitions. This inspection API examines the "
8070 "Windows Registry to find out how disks/partitions are mapped to drive "
8071 "letters, and returns a hash table as in the example below:"
8075 #: ../fish/guestfish-actions.pod:1828 ../src/guestfs-actions.pod:2712
8085 #: ../fish/guestfish-actions.pod:1832 ../src/guestfs-actions.pod:2716
8087 "Note that keys are drive letters. For Windows, the key is case insensitive "
8088 "and just contains the drive letter, without the customary colon separator "
8093 #: ../fish/guestfish-actions.pod:1836 ../src/guestfs-actions.pod:2720
8095 "In future we may support other operating systems that also used drive "
8096 "letters, but the keys for those might not be case insensitive and might be "
8097 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
8102 #: ../fish/guestfish-actions.pod:1841 ../src/guestfs-actions.pod:2725
8104 "For Windows guests, currently only hard drive mappings are returned. "
8105 "Removable disks (eg. DVD-ROMs) are ignored."
8109 #: ../fish/guestfish-actions.pod:1844 ../src/guestfs-actions.pod:2728
8111 "For guests that do not use drive mappings, or if the drive mappings could "
8112 "not be determined, this returns an empty hash table."
8116 #: ../fish/guestfish-actions.pod:1847
8118 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8119 "get-mountpoints>, L</inspect-get-filesystems>."
8123 #: ../fish/guestfish-actions.pod:1851
8124 msgid "inspect-get-filesystems"
8128 #: ../fish/guestfish-actions.pod:1853
8131 " inspect-get-filesystems root\n"
8136 #: ../fish/guestfish-actions.pod:1855 ../src/guestfs-actions.pod:2749
8138 "This returns a list of all the filesystems that we think are associated with "
8139 "this operating system. This includes the root filesystem, other ordinary "
8140 "filesystems, and non-mounted devices like swap partitions."
8144 #: ../fish/guestfish-actions.pod:1860 ../src/guestfs-actions.pod:2754
8146 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8147 "to be shared between operating systems."
8151 #: ../fish/guestfish-actions.pod:1863
8153 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8158 #: ../fish/guestfish-actions.pod:1866
8159 msgid "inspect-get-format"
8163 #: ../fish/guestfish-actions.pod:1868
8166 " inspect-get-format root\n"
8171 #: ../fish/guestfish-actions.pod:1870 ../src/guestfs-actions.pod:2772
8173 "This returns the format of the inspected operating system. You can use it "
8174 "to detect install images, live CDs and similar."
8178 #: ../fish/guestfish-actions.pod:1873 ../src/guestfs-actions.pod:2775
8179 msgid "Currently defined formats are:"
8183 #: ../fish/guestfish-actions.pod:1877 ../src/guestfs-actions.pod:2779
8184 msgid "\"installed\""
8188 #: ../fish/guestfish-actions.pod:1879 ../src/guestfs-actions.pod:2781
8189 msgid "This is an installed operating system."
8193 #: ../fish/guestfish-actions.pod:1881 ../src/guestfs-actions.pod:2783
8194 msgid "\"installer\""
8198 #: ../fish/guestfish-actions.pod:1883 ../src/guestfs-actions.pod:2785
8200 "The disk image being inspected is not an installed operating system, but a "
8201 "I<bootable> install disk, live CD, or similar."
8205 #: ../fish/guestfish-actions.pod:1888 ../src/guestfs-actions.pod:2790
8206 msgid "The format of this disk image is not known."
8210 #: ../fish/guestfish-actions.pod:1897
8211 msgid "inspect-get-hostname"
8215 #: ../fish/guestfish-actions.pod:1899
8218 " inspect-get-hostname root\n"
8223 #: ../fish/guestfish-actions.pod:1901 ../src/guestfs-actions.pod:2810
8225 "This function returns the hostname of the operating system as found by "
8226 "inspection of the guest's configuration files."
8230 #: ../fish/guestfish-actions.pod:1904 ../src/guestfs-actions.pod:2813
8232 "If the hostname could not be determined, then the string C<unknown> is "
8237 #: ../fish/guestfish-actions.pod:1909
8238 msgid "inspect-get-icon"
8242 #: ../fish/guestfish-actions.pod:1911
8245 " inspect-get-icon root [favicon:..] [highquality:..]\n"
8250 #: ../fish/guestfish-actions.pod:1913 ../src/guestfs-actions.pod:2839
8252 "This function returns an icon corresponding to the inspected operating "
8253 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
8254 "to PNG if necessary)."
8258 #: ../fish/guestfish-actions.pod:1917 ../src/guestfs-actions.pod:2843
8260 "If it was not possible to get an icon this function returns a zero-length "
8261 "(non-NULL) buffer. I<Callers must check for this case>."
8265 #: ../fish/guestfish-actions.pod:1920 ../src/guestfs-actions.pod:2846
8267 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
8268 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
8269 "this file will be returned. You can disable favicons by passing the "
8270 "optional C<favicon> boolean as false (default is true)."
8274 #: ../fish/guestfish-actions.pod:1926 ../src/guestfs-actions.pod:2852
8276 "If finding the favicon fails, then we look in other places in the guest for "
8281 #: ../fish/guestfish-actions.pod:1929 ../src/guestfs-actions.pod:2855
8283 "If the optional C<highquality> boolean is true then only high quality icons "
8284 "are returned, which means only icons of high resolution with an alpha "
8285 "channel. The default (false) is to return any icon we can, even if it is of "
8286 "substandard quality."
8290 #: ../fish/guestfish-actions.pod:1940 ../src/guestfs-actions.pod:2866
8292 "Unlike most other inspection API calls, the guest's disks must be mounted up "
8293 "before you call this, since it needs to read information from the guest "
8294 "filesystem during the call."
8298 #: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:2872
8300 "B<Security:> The icon data comes from the untrusted guest, and should be "
8301 "treated with caution. PNG files have been known to contain exploits. "
8302 "Ensure that libpng (or other relevant libraries) are fully up to date before "
8303 "trying to process or display the icon."
8307 #: ../fish/guestfish-actions.pod:1954 ../src/guestfs-actions.pod:2880
8309 "The PNG image returned can be any size. It might not be square. Libguestfs "
8310 "tries to return the largest, highest quality icon available. The "
8311 "application must scale the icon to the required size."
8315 #: ../fish/guestfish-actions.pod:1961 ../src/guestfs-actions.pod:2887
8317 "Extracting icons from Windows guests requires the external C<wrestool> "
8318 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
8319 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
8320 "installed separately."
8324 #: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:2894
8326 "Operating system icons are usually trademarks. Seek legal advice before "
8327 "using trademarks in applications."
8331 #: ../fish/guestfish-actions.pod:1975
8332 msgid "inspect-get-major-version"
8336 #: ../fish/guestfish-actions.pod:1977
8339 " inspect-get-major-version root\n"
8344 #: ../fish/guestfish-actions.pod:1979 ../src/guestfs-actions.pod:2935
8346 "This returns the major version number of the inspected operating system."
8350 #: ../fish/guestfish-actions.pod:1982 ../src/guestfs-actions.pod:2938
8352 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8353 "popular public names used by the operating system. Notably the operating "
8354 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8355 "1). You can find out the real versions corresponding to releases of Windows "
8356 "by consulting Wikipedia or MSDN."
8360 #: ../fish/guestfish-actions.pod:1989 ../fish/guestfish-actions.pod:2000
8361 #: ../src/guestfs-actions.pod:2945 ../src/guestfs-actions.pod:2962
8362 msgid "If the version could not be determined, then C<0> is returned."
8366 #: ../fish/guestfish-actions.pod:1993
8367 msgid "inspect-get-minor-version"
8371 #: ../fish/guestfish-actions.pod:1995
8374 " inspect-get-minor-version root\n"
8379 #: ../fish/guestfish-actions.pod:1997 ../src/guestfs-actions.pod:2959
8381 "This returns the minor version number of the inspected operating system."
8385 #: ../fish/guestfish-actions.pod:2002
8387 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8388 "get-major-version>."
8392 #: ../fish/guestfish-actions.pod:2005
8393 msgid "inspect-get-mountpoints"
8397 #: ../fish/guestfish-actions.pod:2007
8400 " inspect-get-mountpoints root\n"
8405 #: ../fish/guestfish-actions.pod:2009 ../src/guestfs-actions.pod:2977
8407 "This returns a hash of where we think the filesystems associated with this "
8408 "operating system should be mounted. Callers should note that this is at "
8409 "best an educated guess made by reading configuration files such as C</etc/"
8410 "fstab>. I<In particular note> that this may return filesystems which are "
8411 "non-existent or not mountable and callers should be prepared to handle or "
8412 "ignore failures if they try to mount them."
8416 #: ../fish/guestfish-actions.pod:2018 ../src/guestfs-actions.pod:2986
8418 "Each element in the returned hashtable has a key which is the path of the "
8419 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8420 "mounted there (eg. C</dev/sda1>)."
8424 #: ../fish/guestfish-actions.pod:2023 ../src/guestfs-actions.pod:2991
8426 "Non-mounted devices such as swap devices are I<not> returned in this list."
8430 #: ../fish/guestfish-actions.pod:2026
8432 "For operating systems like Windows which still use drive letters, this call "
8433 "will only return an entry for the first drive \"mounted on\" C</>. For "
8434 "information about the mapping of drive letters to partitions, see L</inspect-"
8435 "get-drive-mappings>."
8439 #: ../fish/guestfish-actions.pod:2032
8441 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8446 #: ../fish/guestfish-actions.pod:2035
8447 msgid "inspect-get-package-format"
8451 #: ../fish/guestfish-actions.pod:2037
8454 " inspect-get-package-format root\n"
8459 #: ../fish/guestfish-actions.pod:2039
8461 "This function and L</inspect-get-package-management> return the package "
8462 "format and package management tool used by the inspected operating system. "
8463 "For example for Fedora these functions would return C<rpm> (package format) "
8464 "and C<yum> (package management)."
8468 #: ../fish/guestfish-actions.pod:2045 ../src/guestfs-actions.pod:3023
8470 "This returns the string C<unknown> if we could not determine the package "
8471 "format I<or> if the operating system does not have a real packaging system "
8476 #: ../fish/guestfish-actions.pod:2049 ../src/guestfs-actions.pod:3027
8478 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
8479 "Future versions of libguestfs may return other strings."
8483 #: ../fish/guestfish-actions.pod:2054
8484 msgid "inspect-get-package-management"
8488 #: ../fish/guestfish-actions.pod:2056
8491 " inspect-get-package-management root\n"
8496 #: ../fish/guestfish-actions.pod:2058
8498 "L</inspect-get-package-format> and this function return the package format "
8499 "and package management tool used by the inspected operating system. For "
8500 "example for Fedora these functions would return C<rpm> (package format) and "
8501 "C<yum> (package management)."
8505 #: ../fish/guestfish-actions.pod:2064 ../src/guestfs-actions.pod:3049
8507 "This returns the string C<unknown> if we could not determine the package "
8508 "management tool I<or> if the operating system does not have a real packaging "
8509 "system (eg. Windows)."
8513 #: ../fish/guestfish-actions.pod:2068 ../src/guestfs-actions.pod:3053
8515 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8516 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
8517 "libguestfs may return other strings."
8521 #: ../fish/guestfish-actions.pod:2075
8522 msgid "inspect-get-product-name"
8526 #: ../fish/guestfish-actions.pod:2077
8529 " inspect-get-product-name root\n"
8534 #: ../fish/guestfish-actions.pod:2079 ../src/guestfs-actions.pod:3071
8536 "This returns the product name of the inspected operating system. The "
8537 "product name is generally some freeform string which can be displayed to the "
8538 "user, but should not be parsed by programs."
8542 #: ../fish/guestfish-actions.pod:2084 ../src/guestfs-actions.pod:3076
8544 "If the product name could not be determined, then the string C<unknown> is "
8549 #: ../fish/guestfish-actions.pod:2089
8550 msgid "inspect-get-product-variant"
8554 #: ../fish/guestfish-actions.pod:2091
8557 " inspect-get-product-variant root\n"
8562 #: ../fish/guestfish-actions.pod:2093 ../src/guestfs-actions.pod:3092
8563 msgid "This returns the product variant of the inspected operating system."
8567 #: ../fish/guestfish-actions.pod:2096 ../src/guestfs-actions.pod:3095
8569 "For Windows guests, this returns the contents of the Registry key C<HKLM"
8570 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
8571 "is usually a string such as C<Client> or C<Server> (other values are "
8572 "possible). This can be used to distinguish consumer and enterprise versions "
8573 "of Windows that have the same version number (for example, Windows 7 and "
8574 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
8575 "the latter is C<Server>)."
8579 #: ../fish/guestfish-actions.pod:2105 ../src/guestfs-actions.pod:3104
8581 "For enterprise Linux guests, in future we intend this to return the product "
8582 "variant such as C<Desktop>, C<Server> and so on. But this is not "
8583 "implemented at present."
8587 #: ../fish/guestfish-actions.pod:2109 ../src/guestfs-actions.pod:3108
8589 "If the product variant could not be determined, then the string C<unknown> "
8594 #: ../fish/guestfish-actions.pod:2112
8596 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8597 "get-product-name>, L</inspect-get-major-version>."
8601 #: ../fish/guestfish-actions.pod:2116
8602 msgid "inspect-get-roots"
8606 #: ../fish/guestfish-actions.pod:2118
8609 " inspect-get-roots\n"
8614 #: ../fish/guestfish-actions.pod:2120
8616 "This function is a convenient way to get the list of root devices, as "
8617 "returned from a previous call to L</inspect-os>, but without redoing the "
8618 "whole inspection process."
8622 #: ../fish/guestfish-actions.pod:2124
8624 "This returns an empty list if either no root devices were found or the "
8625 "caller has not called L</inspect-os>."
8629 #: ../fish/guestfish-actions.pod:2129
8630 msgid "inspect-get-type"
8634 #: ../fish/guestfish-actions.pod:2131
8637 " inspect-get-type root\n"
8642 #: ../fish/guestfish-actions.pod:2133 ../src/guestfs-actions.pod:3146
8644 "This returns the type of the inspected operating system. Currently defined "
8649 #: ../fish/guestfish-actions.pod:2138 ../src/guestfs-actions.pod:3151
8654 #: ../fish/guestfish-actions.pod:2140 ../src/guestfs-actions.pod:3153
8655 msgid "Any Linux-based operating system."
8659 #: ../fish/guestfish-actions.pod:2144 ../src/guestfs-actions.pod:3157
8660 msgid "Any Microsoft Windows operating system."
8664 #: ../fish/guestfish-actions.pod:2146 ../src/guestfs-actions.pod:3159
8669 #: ../fish/guestfish-actions.pod:2148 ../src/guestfs-actions.pod:3161
8674 #: ../fish/guestfish-actions.pod:2152 ../src/guestfs-actions.pod:3165
8675 msgid "The operating system type could not be determined."
8679 #: ../fish/guestfish-actions.pod:2161
8680 msgid "inspect-get-windows-current-control-set"
8684 #: ../fish/guestfish-actions.pod:2163
8687 " inspect-get-windows-current-control-set root\n"
8692 #: ../fish/guestfish-actions.pod:2165 ../src/guestfs-actions.pod:3185
8694 "This returns the Windows CurrentControlSet of the inspected guest. The "
8695 "CurrentControlSet is a registry key name such as C<ControlSet001>."
8699 #: ../fish/guestfish-actions.pod:2168 ../src/guestfs-actions.pod:3188
8701 "This call assumes that the guest is Windows and that the Registry could be "
8702 "examined by inspection. If this is not the case then an error is returned."
8706 #: ../fish/guestfish-actions.pod:2174
8707 msgid "inspect-get-windows-systemroot"
8711 #: ../fish/guestfish-actions.pod:2176
8714 " inspect-get-windows-systemroot root\n"
8719 #: ../fish/guestfish-actions.pod:2178 ../src/guestfs-actions.pod:3205
8721 "This returns the Windows systemroot of the inspected guest. The systemroot "
8722 "is a directory path such as C</WINDOWS>."
8726 #: ../fish/guestfish-actions.pod:2181 ../src/guestfs-actions.pod:3208
8728 "This call assumes that the guest is Windows and that the systemroot could be "
8729 "determined by inspection. If this is not the case then an error is returned."
8733 #: ../fish/guestfish-actions.pod:2187
8734 msgid "inspect-is-live"
8738 #: ../fish/guestfish-actions.pod:2189
8741 " inspect-is-live root\n"
8746 #: ../fish/guestfish-actions.pod:2191
8748 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8749 "then this returns true if a live image was detected on the disk."
8753 #: ../fish/guestfish-actions.pod:2197
8754 msgid "inspect-is-multipart"
8758 #: ../fish/guestfish-actions.pod:2199
8761 " inspect-is-multipart root\n"
8766 #: ../fish/guestfish-actions.pod:2201
8768 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8769 "then this returns true if the disk is part of a set."
8773 #: ../fish/guestfish-actions.pod:2207
8774 msgid "inspect-is-netinst"
8778 #: ../fish/guestfish-actions.pod:2209
8781 " inspect-is-netinst root\n"
8786 #: ../fish/guestfish-actions.pod:2211
8788 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8789 "then this returns true if the disk is a network installer, ie. not a self-"
8790 "contained install CD but one which is likely to require network access to "
8791 "complete the install."
8795 #: ../fish/guestfish-actions.pod:2219
8796 msgid "inspect-list-applications"
8800 #: ../fish/guestfish-actions.pod:2221
8803 " inspect-list-applications root\n"
8808 #: ../fish/guestfish-actions.pod:2223 ../src/guestfs-actions.pod:3275
8809 msgid "Return the list of applications installed in the operating system."
8813 #: ../fish/guestfish-actions.pod:2225
8815 "I<Note:> This call works differently from other parts of the inspection "
8816 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
8817 "then mount up the disks, before calling this. Listing applications is a "
8818 "significantly more difficult operation which requires access to the full "
8819 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
8820 "are just returning data cached in the libguestfs handle, this call actually "
8821 "reads parts of the mounted filesystems during the call."
8825 #: ../fish/guestfish-actions.pod:2235 ../src/guestfs-actions.pod:3287
8827 "This returns an empty list if the inspection code was not able to determine "
8828 "the list of applications."
8832 #: ../fish/guestfish-actions.pod:2238 ../src/guestfs-actions.pod:3290
8833 msgid "The application structure contains the following fields:"
8837 #: ../fish/guestfish-actions.pod:2242 ../src/guestfs-actions.pod:3294
8842 #: ../fish/guestfish-actions.pod:2244 ../src/guestfs-actions.pod:3296
8844 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8845 "guests, this is the package name."
8849 #: ../fish/guestfish-actions.pod:2247 ../src/guestfs-actions.pod:3299
8850 msgid "C<app_display_name>"
8854 #: ../fish/guestfish-actions.pod:2249 ../src/guestfs-actions.pod:3301
8856 "The display name of the application, sometimes localized to the install "
8857 "language of the guest operating system."
8861 #: ../fish/guestfish-actions.pod:2252 ../src/guestfs-actions.pod:3304
8863 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8864 "to display something can use C<app_name> instead."
8868 #: ../fish/guestfish-actions.pod:2255 ../src/guestfs-actions.pod:3307
8869 msgid "C<app_epoch>"
8873 #: ../fish/guestfish-actions.pod:2257 ../src/guestfs-actions.pod:3309
8875 "For package managers which use epochs, this contains the epoch of the "
8876 "package (an integer). If unavailable, this is returned as C<0>."
8880 #: ../fish/guestfish-actions.pod:2260 ../src/guestfs-actions.pod:3312
8881 msgid "C<app_version>"
8885 #: ../fish/guestfish-actions.pod:2262 ../src/guestfs-actions.pod:3314
8887 "The version string of the application or package. If unavailable this is "
8888 "returned as an empty string C<\"\">."
8892 #: ../fish/guestfish-actions.pod:2265 ../src/guestfs-actions.pod:3317
8893 msgid "C<app_release>"
8897 #: ../fish/guestfish-actions.pod:2267 ../src/guestfs-actions.pod:3319
8899 "The release string of the application or package, for package managers that "
8900 "use this. If unavailable this is returned as an empty string C<\"\">."
8904 #: ../fish/guestfish-actions.pod:2271 ../src/guestfs-actions.pod:3323
8905 msgid "C<app_install_path>"
8909 #: ../fish/guestfish-actions.pod:2273 ../src/guestfs-actions.pod:3325
8911 "The installation path of the application (on operating systems such as "
8912 "Windows which use installation paths). This path is in the format used by "
8913 "the guest operating system, it is not a libguestfs path."
8917 #: ../fish/guestfish-actions.pod:2278 ../src/guestfs-actions.pod:3330
8918 msgid "If unavailable this is returned as an empty string C<\"\">."
8922 #: ../fish/guestfish-actions.pod:2280 ../src/guestfs-actions.pod:3332
8923 msgid "C<app_trans_path>"
8927 #: ../fish/guestfish-actions.pod:2282 ../src/guestfs-actions.pod:3334
8929 "The install path translated into a libguestfs path. If unavailable this is "
8930 "returned as an empty string C<\"\">."
8934 #: ../fish/guestfish-actions.pod:2285 ../src/guestfs-actions.pod:3337
8935 msgid "C<app_publisher>"
8939 #: ../fish/guestfish-actions.pod:2287 ../src/guestfs-actions.pod:3339
8941 "The name of the publisher of the application, for package managers that use "
8942 "this. If unavailable this is returned as an empty string C<\"\">."
8946 #: ../fish/guestfish-actions.pod:2291 ../src/guestfs-actions.pod:3343
8951 #: ../fish/guestfish-actions.pod:2293 ../src/guestfs-actions.pod:3345
8953 "The URL (eg. upstream URL) of the application. If unavailable this is "
8954 "returned as an empty string C<\"\">."
8958 #: ../fish/guestfish-actions.pod:2296 ../src/guestfs-actions.pod:3348
8959 msgid "C<app_source_package>"
8963 #: ../fish/guestfish-actions.pod:2298 ../src/guestfs-actions.pod:3350
8965 "For packaging systems which support this, the name of the source package. "
8966 "If unavailable this is returned as an empty string C<\"\">."
8970 #: ../fish/guestfish-actions.pod:2301 ../src/guestfs-actions.pod:3353
8971 msgid "C<app_summary>"
8975 #: ../fish/guestfish-actions.pod:2303 ../src/guestfs-actions.pod:3355
8977 "A short (usually one line) description of the application or package. If "
8978 "unavailable this is returned as an empty string C<\"\">."
8982 #: ../fish/guestfish-actions.pod:2306 ../src/guestfs-actions.pod:3358
8983 msgid "C<app_description>"
8987 #: ../fish/guestfish-actions.pod:2308 ../src/guestfs-actions.pod:3360
8989 "A longer description of the application or package. If unavailable this is "
8990 "returned as an empty string C<\"\">."
8994 #: ../fish/guestfish-actions.pod:2315
8999 #: ../fish/guestfish-actions.pod:2317
9007 #: ../fish/guestfish-actions.pod:2319 ../src/guestfs-actions.pod:3378
9009 "This function uses other libguestfs functions and certain heuristics to "
9010 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9011 "for operating systems."
9015 #: ../fish/guestfish-actions.pod:2323 ../src/guestfs-actions.pod:3382
9016 msgid "The list returned is empty if no operating systems were found."
9020 #: ../fish/guestfish-actions.pod:2325 ../src/guestfs-actions.pod:3384
9022 "If one operating system was found, then this returns a list with a single "
9023 "element, which is the name of the root filesystem of this operating system. "
9024 "It is also possible for this function to return a list containing more than "
9025 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9026 "element being the root filesystem of one of the operating systems."
9030 #: ../fish/guestfish-actions.pod:2332
9032 "You can pass the root string(s) returned to other L</inspect-get-*> "
9033 "functions in order to query further information about each operating system, "
9034 "such as the name and version."
9038 #: ../fish/guestfish-actions.pod:2337
9040 "This function uses other libguestfs features such as L</mount-ro> and L</"
9041 "umount-all> in order to mount and unmount filesystems and look at the "
9042 "contents. This should be called with no disks currently mounted. The "
9043 "function may also use Augeas, so any existing Augeas handle will be closed."
9047 #: ../fish/guestfish-actions.pod:2343 ../src/guestfs-actions.pod:3402
9049 "This function cannot decrypt encrypted disks. The caller must do that first "
9050 "(supplying the necessary keys) if the disk is encrypted."
9054 #: ../fish/guestfish-actions.pod:2349 ../fish/guestfish-actions.pod:2547
9055 #: ../fish/guestfish-actions.pod:2606
9056 msgid "See also L</list-filesystems>."
9060 #: ../fish/guestfish-actions.pod:2351
9065 #: ../fish/guestfish-actions.pod:2353
9068 " is-blockdev path\n"
9073 #: ../fish/guestfish-actions.pod:2355 ../src/guestfs-actions.pod:3422
9075 "This returns C<true> if and only if there is a block device with the given "
9080 #: ../fish/guestfish-actions.pod:2358 ../fish/guestfish-actions.pod:2376
9081 #: ../fish/guestfish-actions.pod:2395 ../fish/guestfish-actions.pod:2404
9082 #: ../fish/guestfish-actions.pod:2414 ../fish/guestfish-actions.pod:2448
9083 #: ../fish/guestfish-actions.pod:2457
9084 msgid "See also L</stat>."
9088 #: ../fish/guestfish-actions.pod:2360
9093 #: ../fish/guestfish-actions.pod:2362
9101 #: ../fish/guestfish-actions.pod:2364 ../src/guestfs-actions.pod:3436
9103 "This returns true iff this handle is busy processing a command (in the "
9108 #: ../fish/guestfish-actions.pod:2369
9113 #: ../fish/guestfish-actions.pod:2371
9116 " is-chardev path\n"
9121 #: ../fish/guestfish-actions.pod:2373 ../src/guestfs-actions.pod:3451
9123 "This returns C<true> if and only if there is a character device with the "
9124 "given C<path> name."
9128 #: ../fish/guestfish-actions.pod:2378
9133 #: ../fish/guestfish-actions.pod:2380
9141 #: ../fish/guestfish-actions.pod:2382 ../src/guestfs-actions.pod:3465
9143 "This returns true iff this handle is being configured (in the C<CONFIG> "
9148 #: ../fish/guestfish-actions.pod:2387
9153 #: ../fish/guestfish-actions.pod:2389
9161 #: ../fish/guestfish-actions.pod:2391 ../src/guestfs-actions.pod:3480
9163 "This returns C<true> if and only if there is a directory with the given "
9164 "C<path> name. Note that it returns false for other objects like files."
9168 #: ../fish/guestfish-actions.pod:2397
9173 #: ../fish/guestfish-actions.pod:2399
9181 #: ../fish/guestfish-actions.pod:2401 ../src/guestfs-actions.pod:3496
9183 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9184 "given C<path> name."
9188 #: ../fish/guestfish-actions.pod:2406
9193 #: ../fish/guestfish-actions.pod:2408
9201 #: ../fish/guestfish-actions.pod:2410 ../src/guestfs-actions.pod:3511
9203 "This returns C<true> if and only if there is a regular file with the given "
9204 "C<path> name. Note that it returns false for other objects like directories."
9208 #: ../fish/guestfish-actions.pod:2416
9209 msgid "is-launching"
9213 #: ../fish/guestfish-actions.pod:2418
9221 #: ../fish/guestfish-actions.pod:2420 ../src/guestfs-actions.pod:3526
9223 "This returns true iff this handle is launching the subprocess (in the "
9224 "C<LAUNCHING> state)."
9228 #: ../fish/guestfish-actions.pod:2425
9233 #: ../fish/guestfish-actions.pod:2427
9241 #: ../fish/guestfish-actions.pod:2429 ../src/guestfs-actions.pod:3541
9243 "This command tests whether C<device> is a logical volume, and returns true "
9244 "iff this is the case."
9248 #: ../fish/guestfish-actions.pod:2432
9253 #: ../fish/guestfish-actions.pod:2434
9261 #: ../fish/guestfish-actions.pod:2436 ../src/guestfs-actions.pod:3553
9263 "This returns true iff this handle is ready to accept commands (in the "
9268 #: ../fish/guestfish-actions.pod:2441
9273 #: ../fish/guestfish-actions.pod:2443
9281 #: ../fish/guestfish-actions.pod:2445 ../src/guestfs-actions.pod:3568
9283 "This returns C<true> if and only if there is a Unix domain socket with the "
9284 "given C<path> name."
9288 #: ../fish/guestfish-actions.pod:2450
9293 #: ../fish/guestfish-actions.pod:2452
9296 " is-symlink path\n"
9301 #: ../fish/guestfish-actions.pod:2454 ../src/guestfs-actions.pod:3583
9303 "This returns C<true> if and only if there is a symbolic link with the given "
9308 #: ../fish/guestfish-actions.pod:2459
9313 #: ../fish/guestfish-actions.pod:2461
9321 #: ../fish/guestfish-actions.pod:2463 ../src/guestfs-actions.pod:3598
9323 "This returns true iff the file exists and the file is empty or it contains "
9328 #: ../fish/guestfish-actions.pod:2466
9329 msgid "is-zero-device"
9333 #: ../fish/guestfish-actions.pod:2468
9336 " is-zero-device device\n"
9341 #: ../fish/guestfish-actions.pod:2470 ../src/guestfs-actions.pod:3611
9342 msgid "This returns true iff the device exists and contains all zero bytes."
9346 #: ../fish/guestfish-actions.pod:2472 ../src/guestfs-actions.pod:3613
9347 msgid "Note that for large devices this can take a long time to run."
9351 #: ../fish/guestfish-actions.pod:2474
9352 msgid "kill-subprocess"
9356 #: ../fish/guestfish-actions.pod:2476
9359 " kill-subprocess\n"
9364 #: ../fish/guestfish-actions.pod:2478 ../src/guestfs-actions.pod:3624
9365 msgid "This kills the qemu subprocess. You should never need to call this."
9369 #: ../fish/guestfish-actions.pod:2480
9374 #: ../fish/guestfish-actions.pod:2482
9379 #: ../fish/guestfish-actions.pod:2484
9387 #: ../fish/guestfish-actions.pod:2486 ../src/guestfs-actions.pod:3635
9389 "Internally libguestfs is implemented by running a virtual machine using "
9394 #: ../fish/guestfish-actions.pod:2489 ../src/guestfs-actions.pod:3638
9396 "You should call this after configuring the handle (eg. adding drives) but "
9397 "before performing any actions."
9401 #: ../fish/guestfish-actions.pod:2492
9406 #: ../fish/guestfish-actions.pod:2494
9409 " lchown owner group path\n"
9414 #: ../fish/guestfish-actions.pod:2496
9416 "Change the file owner to C<owner> and group to C<group>. This is like L</"
9417 "chown> but if C<path> is a symlink then the link itself is changed, not the "
9422 #: ../fish/guestfish-actions.pod:2504
9427 #: ../fish/guestfish-actions.pod:2506
9430 " lgetxattr path name\n"
9435 #: ../fish/guestfish-actions.pod:2508 ../src/guestfs-actions.pod:3678
9437 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
9438 "is a symlink, then this call returns an extended attribute from the symlink."
9442 #: ../fish/guestfish-actions.pod:2522
9443 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
9447 #: ../fish/guestfish-actions.pod:2524
9452 #: ../fish/guestfish-actions.pod:2526
9455 " lgetxattrs path\n"
9460 #: ../fish/guestfish-actions.pod:2528
9462 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
9463 "it returns the extended attributes of the link itself."
9467 #: ../fish/guestfish-actions.pod:2532
9472 #: ../fish/guestfish-actions.pod:2534
9480 #: ../fish/guestfish-actions.pod:2536 ../src/guestfs-actions.pod:3721
9482 "List all 9p filesystems attached to the guest. A list of mount tags is "
9487 #: ../fish/guestfish-actions.pod:2539
9488 msgid "list-devices"
9492 #: ../fish/guestfish-actions.pod:2541
9500 #: ../fish/guestfish-actions.pod:2543 ../src/guestfs-actions.pod:3735
9501 msgid "List all the block devices."
9505 #: ../fish/guestfish-actions.pod:2545 ../src/guestfs-actions.pod:3737
9506 msgid "The full block device names are returned, eg. C</dev/sda>."
9510 #: ../fish/guestfish-actions.pod:2549
9511 msgid "list-dm-devices"
9515 #: ../fish/guestfish-actions.pod:2551
9518 " list-dm-devices\n"
9523 #: ../fish/guestfish-actions.pod:2553 ../src/guestfs-actions.pod:3752
9524 msgid "List all device mapper devices."
9528 #: ../fish/guestfish-actions.pod:2555
9530 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
9531 "previous call to L</luks-open>."
9535 #: ../fish/guestfish-actions.pod:2558
9537 "Device mapper devices which correspond to logical volumes are I<not> "
9538 "returned in this list. Call L</lvs> if you want to list logical volumes."
9542 #: ../fish/guestfish-actions.pod:2562
9543 msgid "list-filesystems"
9547 #: ../fish/guestfish-actions.pod:2564
9550 " list-filesystems\n"
9555 #: ../fish/guestfish-actions.pod:2566 ../src/guestfs-actions.pod:3772
9557 "This inspection command looks for filesystems on partitions, block devices "
9558 "and logical volumes, returning a list of devices containing filesystems and "
9563 #: ../fish/guestfish-actions.pod:2570 ../src/guestfs-actions.pod:3776
9565 "The return value is a hash, where the keys are the devices containing "
9566 "filesystems, and the values are the filesystem types. For example:"
9570 #: ../fish/guestfish-actions.pod:2574 ../src/guestfs-actions.pod:3780
9573 " \"/dev/sda1\" => \"ntfs\"\n"
9574 " \"/dev/sda2\" => \"ext2\"\n"
9575 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9576 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9581 #: ../fish/guestfish-actions.pod:2579 ../src/guestfs-actions.pod:3785
9583 "The value can have the special value \"unknown\", meaning the content of the "
9584 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9588 #: ../fish/guestfish-actions.pod:2583
9590 "This command runs other libguestfs commands, which might include L</mount> "
9591 "and L</umount>, and therefore you should use this soon after launch and only "
9592 "when nothing is mounted."
9596 #: ../fish/guestfish-actions.pod:2587
9598 "Not all of the filesystems returned will be mountable. In particular, swap "
9599 "partitions are returned in the list. Also this command does not check that "
9600 "each filesystem found is valid and mountable, and some filesystems might be "
9601 "mountable but require special options. Filesystems may not all belong to a "
9602 "single logical operating system (use L</inspect-os> to look for OSes)."
9606 #: ../fish/guestfish-actions.pod:2595
9607 msgid "list-partitions"
9611 #: ../fish/guestfish-actions.pod:2597
9614 " list-partitions\n"
9619 #: ../fish/guestfish-actions.pod:2599 ../src/guestfs-actions.pod:3814
9620 msgid "List all the partitions detected on all block devices."
9624 #: ../fish/guestfish-actions.pod:2601 ../src/guestfs-actions.pod:3816
9625 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9629 #: ../fish/guestfish-actions.pod:2603
9631 "This does not return logical volumes. For that you will need to call L</"
9636 #: ../fish/guestfish-actions.pod:2608
9641 #: ../fish/guestfish-actions.pod:2610
9649 #: ../fish/guestfish-actions.pod:2612 ../src/guestfs-actions.pod:3835
9651 "List the files in C<directory> (relative to the root directory, there is no "
9652 "cwd) in the format of 'ls -la'."
9656 #: ../fish/guestfish-actions.pod:2615 ../src/guestfs-actions.pod:3838
9658 "This command is mostly useful for interactive sessions. It is I<not> "
9659 "intended that you try to parse the output string."
9663 #: ../fish/guestfish-actions.pod:2618
9668 #: ../fish/guestfish-actions.pod:2620
9671 " ln target linkname\n"
9676 #: ../fish/guestfish-actions.pod:2622 ../src/guestfs-actions.pod:3853
9677 msgid "This command creates a hard link using the C<ln> command."
9681 #: ../fish/guestfish-actions.pod:2624
9686 #: ../fish/guestfish-actions.pod:2626
9689 " ln-f target linkname\n"
9694 #: ../fish/guestfish-actions.pod:2628 ../src/guestfs-actions.pod:3866
9696 "This command creates a hard link using the C<ln -f> command. The I<-f> "
9697 "option removes the link (C<linkname>) if it exists already."
9701 #: ../fish/guestfish-actions.pod:2631
9706 #: ../fish/guestfish-actions.pod:2633
9709 " ln-s target linkname\n"
9714 #: ../fish/guestfish-actions.pod:2635 ../src/guestfs-actions.pod:3880
9715 msgid "This command creates a symbolic link using the C<ln -s> command."
9719 #: ../fish/guestfish-actions.pod:2637
9724 #: ../fish/guestfish-actions.pod:2639
9727 " ln-sf target linkname\n"
9732 #: ../fish/guestfish-actions.pod:2641 ../src/guestfs-actions.pod:3893
9734 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
9735 "option removes the link (C<linkname>) if it exists already."
9739 #: ../fish/guestfish-actions.pod:2644
9740 msgid "lremovexattr"
9744 #: ../fish/guestfish-actions.pod:2646
9747 " lremovexattr xattr path\n"
9752 #: ../fish/guestfish-actions.pod:2648
9754 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
9755 "it removes an extended attribute of the link itself."
9759 #: ../fish/guestfish-actions.pod:2652
9764 #: ../fish/guestfish-actions.pod:2654
9772 #: ../fish/guestfish-actions.pod:2656 ../src/guestfs-actions.pod:3921
9774 "List the files in C<directory> (relative to the root directory, there is no "
9775 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
9779 #: ../fish/guestfish-actions.pod:2660
9781 "This command is mostly useful for interactive sessions. Programs should "
9782 "probably use L</readdir> instead."
9786 #: ../fish/guestfish-actions.pod:2663
9791 #: ../fish/guestfish-actions.pod:2665
9794 " lsetxattr xattr val vallen path\n"
9799 #: ../fish/guestfish-actions.pod:2667
9801 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
9802 "sets an extended attribute of the link itself."
9806 #: ../fish/guestfish-actions.pod:2671
9811 #: ../fish/guestfish-actions.pod:2673
9819 #: ../fish/guestfish-actions.pod:2675 ../fish/guestfish-actions.pod:4483
9820 #: ../src/guestfs-actions.pod:3957 ../src/guestfs-actions.pod:6736
9821 msgid "Returns file information for the given C<path>."
9825 #: ../fish/guestfish-actions.pod:2677
9827 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
9828 "the link is stat-ed, not the file it refers to."
9832 #: ../fish/guestfish-actions.pod:2681 ../src/guestfs-actions.pod:3963
9833 msgid "This is the same as the C<lstat(2)> system call."
9837 #: ../fish/guestfish-actions.pod:2683
9842 #: ../fish/guestfish-actions.pod:2685
9845 " lstatlist path 'names ...'\n"
9850 #: ../fish/guestfish-actions.pod:2687
9852 "This call allows you to perform the L</lstat> operation on multiple files, "
9853 "where all files are in the directory C<path>. C<names> is the list of files "
9854 "from this directory."
9858 #: ../fish/guestfish-actions.pod:2691 ../src/guestfs-actions.pod:3982
9860 "On return you get a list of stat structs, with a one-to-one correspondence "
9861 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9862 "then the C<ino> field of that structure is set to C<-1>."
9866 #: ../fish/guestfish-actions.pod:2696
9868 "This call is intended for programs that want to efficiently list a directory "
9869 "contents without making many round-trips. See also L</lxattrlist> for a "
9870 "similarly efficient call for getting extended attributes. Very long "
9871 "directory listings might cause the protocol message size to be exceeded, "
9872 "causing this call to fail. The caller must split up such requests into "
9873 "smaller groups of names."
9877 #: ../fish/guestfish-actions.pod:2704
9878 msgid "luks-add-key"
9882 #: ../fish/guestfish-actions.pod:2706
9885 " luks-add-key device keyslot\n"
9890 #: ../fish/guestfish-actions.pod:2708 ../src/guestfs-actions.pod:4010
9892 "This command adds a new key on LUKS device C<device>. C<key> is any "
9893 "existing key, and is used to access the device. C<newkey> is the new key to "
9894 "add. C<keyslot> is the key slot that will be replaced."
9898 #: ../fish/guestfish-actions.pod:2713
9900 "Note that if C<keyslot> already contains a key, then this command will "
9901 "fail. You have to use L</luks-kill-slot> first to remove that key."
9905 #: ../fish/guestfish-actions.pod:2717 ../fish/guestfish-actions.pod:2739
9906 #: ../fish/guestfish-actions.pod:2752 ../fish/guestfish-actions.pod:2766
9907 #: ../fish/guestfish-actions.pod:2792 ../fish/guestfish-actions.pod:2802
9909 "This command has one or more key or passphrase parameters. Guestfish will "
9910 "prompt for these separately."
9914 #: ../fish/guestfish-actions.pod:2720
9919 #: ../fish/guestfish-actions.pod:2722
9922 " luks-close device\n"
9927 #: ../fish/guestfish-actions.pod:2724
9929 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
9930 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
9931 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
9936 #: ../fish/guestfish-actions.pod:2730
9941 #: ../fish/guestfish-actions.pod:2732
9944 " luks-format device keyslot\n"
9949 #: ../fish/guestfish-actions.pod:2734 ../src/guestfs-actions.pod:4051
9951 "This command erases existing data on C<device> and formats the device as a "
9952 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9953 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9957 #: ../fish/guestfish-actions.pod:2742 ../fish/guestfish-actions.pod:2755
9958 #: ../fish/guestfish-actions.pod:2842 ../fish/guestfish-actions.pod:3503
9959 #: ../fish/guestfish-actions.pod:4029 ../fish/guestfish-actions.pod:4354
9960 #: ../fish/guestfish-actions.pod:4377 ../fish/guestfish-actions.pod:4399
9961 #: ../fish/guestfish-actions.pod:5145 ../src/guestfs-actions.pod:4058
9962 #: ../src/guestfs-actions.pod:4081 ../src/guestfs-actions.pod:4224
9963 #: ../src/guestfs-actions.pod:5327 ../src/guestfs-actions.pod:6115
9964 #: ../src/guestfs-actions.pod:6550 ../src/guestfs-actions.pod:6580
9965 #: ../src/guestfs-actions.pod:6613 ../src/guestfs-actions.pod:7812
9967 "B<This command is dangerous. Without careful use you can easily destroy all "
9972 #: ../fish/guestfish-actions.pod:2745
9973 msgid "luks-format-cipher"
9977 #: ../fish/guestfish-actions.pod:2747
9980 " luks-format-cipher device keyslot cipher\n"
9985 #: ../fish/guestfish-actions.pod:2749
9987 "This command is the same as L</luks-format> but it also allows you to set "
9988 "the C<cipher> used."
9992 #: ../fish/guestfish-actions.pod:2758
9993 msgid "luks-kill-slot"
9997 #: ../fish/guestfish-actions.pod:2760
10000 " luks-kill-slot device keyslot\n"
10005 #: ../fish/guestfish-actions.pod:2762 ../src/guestfs-actions.pod:4098
10007 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10008 "device C<device>. C<key> must be one of the I<other> keys."
10012 #: ../fish/guestfish-actions.pod:2769
10017 #: ../fish/guestfish-actions.pod:2771
10020 " luks-open device mapname\n"
10025 #: ../fish/guestfish-actions.pod:2773 ../src/guestfs-actions.pod:4118
10027 "This command opens a block device which has been encrypted according to the "
10028 "Linux Unified Key Setup (LUKS) standard."
10032 #: ../fish/guestfish-actions.pod:2776 ../src/guestfs-actions.pod:4121
10033 msgid "C<device> is the encrypted block device or partition."
10037 #: ../fish/guestfish-actions.pod:2778 ../src/guestfs-actions.pod:4123
10039 "The caller must supply one of the keys associated with the LUKS block "
10040 "device, in the C<key> parameter."
10044 #: ../fish/guestfish-actions.pod:2781 ../src/guestfs-actions.pod:4126
10046 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10047 "writes to this block device are decrypted from and encrypted to the "
10048 "underlying C<device> respectively."
10052 #: ../fish/guestfish-actions.pod:2785
10054 "If this block device contains LVM volume groups, then calling L</vgscan> "
10055 "followed by L</vg-activate-all> will make them visible."
10059 #: ../fish/guestfish-actions.pod:2789
10060 msgid "Use L</list-dm-devices> to list all device mapper devices."
10064 #: ../fish/guestfish-actions.pod:2795
10065 msgid "luks-open-ro"
10069 #: ../fish/guestfish-actions.pod:2797
10072 " luks-open-ro device mapname\n"
10077 #: ../fish/guestfish-actions.pod:2799
10079 "This is the same as L</luks-open> except that a read-only mapping is created."
10083 #: ../fish/guestfish-actions.pod:2805
10088 #: ../fish/guestfish-actions.pod:2807
10091 " lvcreate logvol volgroup mbytes\n"
10096 #: ../fish/guestfish-actions.pod:2809 ../src/guestfs-actions.pod:4172
10098 "This creates an LVM logical volume called C<logvol> on the volume group "
10099 "C<volgroup>, with C<size> megabytes."
10103 #: ../fish/guestfish-actions.pod:2812
10104 msgid "lvm-canonical-lv-name"
10108 #: ../fish/guestfish-actions.pod:2814
10111 " lvm-canonical-lv-name lvname\n"
10116 #: ../fish/guestfish-actions.pod:2816 ../src/guestfs-actions.pod:4185
10118 "This converts alternative naming schemes for LVs that you might find to the "
10119 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10124 #: ../fish/guestfish-actions.pod:2820 ../src/guestfs-actions.pod:4189
10126 "This command returns an error if the C<lvname> parameter does not refer to a "
10131 #: ../fish/guestfish-actions.pod:2823
10132 msgid "See also L</is-lv>."
10136 #: ../fish/guestfish-actions.pod:2825
10137 msgid "lvm-clear-filter"
10141 #: ../fish/guestfish-actions.pod:2827
10144 " lvm-clear-filter\n"
10149 #: ../fish/guestfish-actions.pod:2829
10151 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
10156 #: ../fish/guestfish-actions.pod:2832 ../fish/guestfish-actions.pod:2863
10157 #: ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4249
10159 "This command also clears the LVM cache and performs a volume group scan."
10163 #: ../fish/guestfish-actions.pod:2835
10164 msgid "lvm-remove-all"
10168 #: ../fish/guestfish-actions.pod:2837
10171 " lvm-remove-all\n"
10176 #: ../fish/guestfish-actions.pod:2839 ../src/guestfs-actions.pod:4219
10178 "This command removes all LVM logical volumes, volume groups and physical "
10183 #: ../fish/guestfish-actions.pod:2845
10184 msgid "lvm-set-filter"
10188 #: ../fish/guestfish-actions.pod:2847
10191 " lvm-set-filter 'devices ...'\n"
10196 #: ../fish/guestfish-actions.pod:2849 ../src/guestfs-actions.pod:4235
10198 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10199 "block devices in the list C<devices>, and will ignore all other attached "
10204 #: ../fish/guestfish-actions.pod:2853 ../src/guestfs-actions.pod:4239
10206 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10207 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10208 "there are two types of duplication possible: either cloned PVs/VGs which "
10209 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10210 "same name. In normal operation you cannot create this situation, but you "
10211 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10212 "inside the LVM metadata."
10216 #: ../fish/guestfish-actions.pod:2866 ../src/guestfs-actions.pod:4252
10217 msgid "You can filter whole block devices or individual partitions."
10221 #: ../fish/guestfish-actions.pod:2868 ../src/guestfs-actions.pod:4254
10223 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10224 "filesystem), even if you are not filtering out that VG."
10228 #: ../fish/guestfish-actions.pod:2872
10233 #: ../fish/guestfish-actions.pod:2874
10236 " lvremove device\n"
10241 #: ../fish/guestfish-actions.pod:2876 ../src/guestfs-actions.pod:4268
10243 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10244 "LV, such as C</dev/VG/LV>."
10248 #: ../fish/guestfish-actions.pod:2879 ../src/guestfs-actions.pod:4271
10250 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10255 #: ../fish/guestfish-actions.pod:2882
10260 #: ../fish/guestfish-actions.pod:2884
10263 " lvrename logvol newlogvol\n"
10268 #: ../fish/guestfish-actions.pod:2886 ../src/guestfs-actions.pod:4285
10269 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10273 #: ../fish/guestfish-actions.pod:2888
10278 #: ../fish/guestfish-actions.pod:2890
10281 " lvresize device mbytes\n"
10286 #: ../fish/guestfish-actions.pod:2892 ../src/guestfs-actions.pod:4298
10288 "This resizes (expands or shrinks) an existing LVM logical volume to "
10289 "C<mbytes>. When reducing, data in the reduced part is lost."
10293 #: ../fish/guestfish-actions.pod:2896
10294 msgid "lvresize-free"
10298 #: ../fish/guestfish-actions.pod:2898
10301 " lvresize-free lv percent\n"
10306 #: ../fish/guestfish-actions.pod:2900 ../src/guestfs-actions.pod:4313
10308 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10309 "remaining free space in the volume group. Commonly you would call this with "
10310 "pc = 100 which expands the logical volume as much as possible, using all "
10311 "remaining free space in the volume group."
10315 #: ../fish/guestfish-actions.pod:2906
10320 #: ../fish/guestfish-actions.pod:2908
10328 #: ../fish/guestfish-actions.pod:2910 ../src/guestfs-actions.pod:4328
10330 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10335 #: ../fish/guestfish-actions.pod:2913 ../src/guestfs-actions.pod:4331
10337 "This returns a list of the logical volume device names (eg. C</dev/"
10338 "VolGroup00/LogVol00>)."
10342 #: ../fish/guestfish-actions.pod:2916
10343 msgid "See also L</lvs-full>, L</list-filesystems>."
10347 #: ../fish/guestfish-actions.pod:2918
10352 #: ../fish/guestfish-actions.pod:2920
10360 #: ../fish/guestfish-actions.pod:2922 ../src/guestfs-actions.pod:4347
10362 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10363 "(8)> command. The \"full\" version includes all fields."
10367 #: ../fish/guestfish-actions.pod:2925
10372 #: ../fish/guestfish-actions.pod:2927
10380 #: ../fish/guestfish-actions.pod:2929 ../src/guestfs-actions.pod:4362
10381 msgid "This command returns the UUID of the LVM LV C<device>."
10385 #: ../fish/guestfish-actions.pod:2931
10390 #: ../fish/guestfish-actions.pod:2933
10393 " lxattrlist path 'names ...'\n"
10398 #: ../fish/guestfish-actions.pod:2935 ../src/guestfs-actions.pod:4376
10400 "This call allows you to get the extended attributes of multiple files, where "
10401 "all files are in the directory C<path>. C<names> is the list of files from "
10406 #: ../fish/guestfish-actions.pod:2939 ../src/guestfs-actions.pod:4380
10408 "On return you get a flat list of xattr structs which must be interpreted "
10409 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10410 "C<attrval> in this struct is zero-length to indicate there was an error "
10411 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10412 "number (the number of following attributes for this file, which could be C<"
10413 "\"0\">). Then after the first xattr struct are the zero or more attributes "
10414 "for the first named file. This repeats for the second and subsequent files."
10418 #: ../fish/guestfish-actions.pod:2949
10420 "This call is intended for programs that want to efficiently list a directory "
10421 "contents without making many round-trips. See also L</lstatlist> for a "
10422 "similarly efficient call for getting standard stats. Very long directory "
10423 "listings might cause the protocol message size to be exceeded, causing this "
10424 "call to fail. The caller must split up such requests into smaller groups of "
10429 #: ../fish/guestfish-actions.pod:2957
10434 #: ../fish/guestfish-actions.pod:2959
10442 #: ../fish/guestfish-actions.pod:2961 ../src/guestfs-actions.pod:4410
10443 msgid "Create a directory named C<path>."
10447 #: ../fish/guestfish-actions.pod:2963
10452 #: ../fish/guestfish-actions.pod:2965
10455 " mkdir-mode path mode\n"
10460 #: ../fish/guestfish-actions.pod:2967 ../src/guestfs-actions.pod:4423
10462 "This command creates a directory, setting the initial permissions of the "
10463 "directory to C<mode>."
10467 #: ../fish/guestfish-actions.pod:2970 ../src/guestfs-actions.pod:4426
10469 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10470 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10475 #: ../fish/guestfish-actions.pod:2974
10476 msgid "See also L</mkdir>, L</umask>"
10480 #: ../fish/guestfish-actions.pod:2976
10485 #: ../fish/guestfish-actions.pod:2978
10493 #: ../fish/guestfish-actions.pod:2980 ../src/guestfs-actions.pod:4442
10495 "Create a directory named C<path>, creating any parent directories as "
10496 "necessary. This is like the C<mkdir -p> shell command."
10500 #: ../fish/guestfish-actions.pod:2983
10505 #: ../fish/guestfish-actions.pod:2985
10508 " mkdtemp template\n"
10513 #: ../fish/guestfish-actions.pod:2987 ../src/guestfs-actions.pod:4455
10515 "This command creates a temporary directory. The C<template> parameter "
10516 "should be a full pathname for the temporary directory name with the final "
10517 "six characters being \"XXXXXX\"."
10521 #: ../fish/guestfish-actions.pod:2992 ../src/guestfs-actions.pod:4460
10523 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10524 "being suitable for Windows filesystems."
10528 #: ../fish/guestfish-actions.pod:2995 ../src/guestfs-actions.pod:4463
10529 msgid "The name of the temporary directory that was created is returned."
10533 #: ../fish/guestfish-actions.pod:2998 ../src/guestfs-actions.pod:4466
10534 msgid "The temporary directory is created with mode 0700 and is owned by root."
10538 #: ../fish/guestfish-actions.pod:3001 ../src/guestfs-actions.pod:4469
10540 "The caller is responsible for deleting the temporary directory and its "
10541 "contents after use."
10545 #: ../fish/guestfish-actions.pod:3004 ../src/guestfs-actions.pod:4472
10546 msgid "See also: L<mkdtemp(3)>"
10550 #: ../fish/guestfish-actions.pod:3006
10555 #: ../fish/guestfish-actions.pod:3008
10558 " mke2fs-J fstype blocksize device journal\n"
10563 #: ../fish/guestfish-actions.pod:3010 ../src/guestfs-actions.pod:4488
10565 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10566 "C<journal>. It is equivalent to the command:"
10570 #: ../fish/guestfish-actions.pod:3014 ../src/guestfs-actions.pod:4492
10573 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10578 #: ../fish/guestfish-actions.pod:3016
10579 msgid "See also L</mke2journal>."
10583 #: ../fish/guestfish-actions.pod:3018
10588 #: ../fish/guestfish-actions.pod:3020
10591 " mke2fs-JL fstype blocksize device label\n"
10596 #: ../fish/guestfish-actions.pod:3022 ../src/guestfs-actions.pod:4509
10598 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10599 "the journal labeled C<label>."
10603 #: ../fish/guestfish-actions.pod:3025
10604 msgid "See also L</mke2journal-L>."
10608 #: ../fish/guestfish-actions.pod:3027
10613 #: ../fish/guestfish-actions.pod:3029
10616 " mke2fs-JU fstype blocksize device uuid\n"
10621 #: ../fish/guestfish-actions.pod:3031 ../src/guestfs-actions.pod:4527
10623 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10624 "the journal with UUID C<uuid>."
10628 #: ../fish/guestfish-actions.pod:3034
10629 msgid "See also L</mke2journal-U>."
10633 #: ../fish/guestfish-actions.pod:3036
10634 msgid "mke2journal"
10638 #: ../fish/guestfish-actions.pod:3038
10641 " mke2journal blocksize device\n"
10646 #: ../fish/guestfish-actions.pod:3040 ../src/guestfs-actions.pod:4543
10648 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10653 #: ../fish/guestfish-actions.pod:3043 ../src/guestfs-actions.pod:4546
10656 " mke2fs -O journal_dev -b blocksize device\n"
10661 #: ../fish/guestfish-actions.pod:3045
10662 msgid "mke2journal-L"
10666 #: ../fish/guestfish-actions.pod:3047
10669 " mke2journal-L blocksize label device\n"
10674 #: ../fish/guestfish-actions.pod:3049 ../src/guestfs-actions.pod:4560
10675 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10679 #: ../fish/guestfish-actions.pod:3051
10680 msgid "mke2journal-U"
10684 #: ../fish/guestfish-actions.pod:3053
10687 " mke2journal-U blocksize uuid device\n"
10692 #: ../fish/guestfish-actions.pod:3055 ../src/guestfs-actions.pod:4574
10693 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10697 #: ../fish/guestfish-actions.pod:3057
10702 #: ../fish/guestfish-actions.pod:3059
10705 " mkfifo mode path\n"
10710 #: ../fish/guestfish-actions.pod:3061
10712 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10713 "is just a convenient wrapper around L</mknod>."
10717 #: ../fish/guestfish-actions.pod:3067
10722 #: ../fish/guestfish-actions.pod:3069
10725 " mkfs fstype device\n"
10730 #: ../fish/guestfish-actions.pod:3071 ../src/guestfs-actions.pod:4604
10732 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10733 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10737 #: ../fish/guestfish-actions.pod:3075
10742 #: ../fish/guestfish-actions.pod:3077
10745 " mkfs-b fstype blocksize device\n"
10750 #: ../fish/guestfish-actions.pod:3079
10752 "This call is similar to L</mkfs>, but it allows you to control the block "
10753 "size of the resulting filesystem. Supported block sizes depend on the "
10754 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10758 #: ../fish/guestfish-actions.pod:3084 ../fish/guestfish-actions.pod:3111
10759 #: ../src/guestfs-actions.pod:4632 ../src/guestfs-actions.pod:4670
10761 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10766 #: ../fish/guestfish-actions.pod:3087
10768 "I<This function is deprecated.> In new code, use the L</mkfs_opts> call "
10773 #: ../fish/guestfish-actions.pod:3094
10778 #: ../fish/guestfish-actions.pod:3096
10781 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
10786 #: ../fish/guestfish-actions.pod:3098 ../src/guestfs-actions.pod:4657
10788 "This function creates a filesystem on C<device>. The filesystem type is "
10789 "C<fstype>, for example C<ext3>."
10793 #: ../fish/guestfish-actions.pod:3105 ../src/guestfs-actions.pod:4664
10794 msgid "C<blocksize>"
10798 #: ../fish/guestfish-actions.pod:3107 ../src/guestfs-actions.pod:4666
10800 "The filesystem block size. Supported block sizes depend on the filesystem "
10801 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
10806 #: ../fish/guestfish-actions.pod:3114 ../src/guestfs-actions.pod:4673
10807 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
10811 #: ../fish/guestfish-actions.pod:3116 ../src/guestfs-actions.pod:4675
10812 msgid "C<features>"
10816 #: ../fish/guestfish-actions.pod:3118 ../src/guestfs-actions.pod:4677
10817 msgid "This passes the I<-O> parameter to the external mkfs program."
10821 #: ../fish/guestfish-actions.pod:3120 ../src/guestfs-actions.pod:4679
10823 "For certain filesystem types, this allows extra filesystem features to be "
10824 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
10828 #: ../fish/guestfish-actions.pod:3124 ../src/guestfs-actions.pod:4683
10830 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
10835 #: ../fish/guestfish-actions.pod:3127 ../src/guestfs-actions.pod:4686
10840 #: ../fish/guestfish-actions.pod:3129 ../src/guestfs-actions.pod:4688
10842 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
10843 "sets the inode size (only for ext2/3/4 filesystems at present)."
10847 #: ../fish/guestfish-actions.pod:3132 ../src/guestfs-actions.pod:4691
10848 msgid "C<sectorsize>"
10852 #: ../fish/guestfish-actions.pod:3134 ../src/guestfs-actions.pod:4693
10854 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
10855 "sets sector size for ufs filesystem."
10859 #: ../fish/guestfish-actions.pod:3141
10860 msgid "mkmountpoint"
10864 #: ../fish/guestfish-actions.pod:3143
10867 " mkmountpoint exemptpath\n"
10872 #: ../fish/guestfish-actions.pod:3145
10874 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
10875 "to create extra mountpoints before mounting the first filesystem."
10879 #: ../fish/guestfish-actions.pod:3149 ../src/guestfs-actions.pod:4736
10881 "These calls are I<only> necessary in some very limited circumstances, mainly "
10882 "the case where you want to mount a mix of unrelated and/or read-only "
10883 "filesystems together."
10887 #: ../fish/guestfish-actions.pod:3153 ../src/guestfs-actions.pod:4740
10889 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10890 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10891 "inside that. You can unpack this as follows in guestfish:"
10895 #: ../fish/guestfish-actions.pod:3158 ../src/guestfs-actions.pod:4745
10898 " add-ro Fedora-11-i686-Live.iso\n"
10900 " mkmountpoint /cd\n"
10901 " mkmountpoint /sqsh\n"
10902 " mkmountpoint /ext3fs\n"
10903 " mount /dev/sda /cd\n"
10904 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10905 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10910 #: ../fish/guestfish-actions.pod:3167 ../src/guestfs-actions.pod:4754
10911 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10915 #: ../fish/guestfish-actions.pod:3169
10917 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
10918 "unexpected errors if you try to mix these calls. It is safest to manually "
10919 "unmount filesystems and remove mountpoints after use."
10923 #: ../fish/guestfish-actions.pod:3173
10925 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
10926 "for this to work for manual mountpoints, you must ensure that the innermost "
10927 "mountpoints have the longest pathnames, as in the example code above."
10931 #: ../fish/guestfish-actions.pod:3178 ../src/guestfs-actions.pod:4765
10933 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10937 #: ../fish/guestfish-actions.pod:3180
10939 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
10940 "L</umount-all> to be called when the handle is closed which can also trigger "
10945 #: ../fish/guestfish-actions.pod:3184
10950 #: ../fish/guestfish-actions.pod:3186
10953 " mknod mode devmajor devminor path\n"
10958 #: ../fish/guestfish-actions.pod:3188 ../src/guestfs-actions.pod:4784
10960 "This call creates block or character special devices, or named pipes (FIFOs)."
10964 #: ../fish/guestfish-actions.pod:3191 ../src/guestfs-actions.pod:4787
10966 "The C<mode> parameter should be the mode, using the standard constants. "
10967 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10968 "used when creating block and character special devices."
10972 #: ../fish/guestfish-actions.pod:3196
10974 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10975 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10976 "regular file). These constants are available in the standard Linux header "
10977 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
10978 "wrappers around this command which bitwise OR in the appropriate constant "
10983 #: ../fish/guestfish-actions.pod:3206
10988 #: ../fish/guestfish-actions.pod:3208
10991 " mknod-b mode devmajor devminor path\n"
10996 #: ../fish/guestfish-actions.pod:3210
10998 "This call creates a block device node called C<path> with mode C<mode> and "
10999 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11000 "wrapper around L</mknod>."
11004 #: ../fish/guestfish-actions.pod:3216
11009 #: ../fish/guestfish-actions.pod:3218
11012 " mknod-c mode devmajor devminor path\n"
11017 #: ../fish/guestfish-actions.pod:3220
11019 "This call creates a char device node called C<path> with mode C<mode> and "
11020 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11021 "wrapper around L</mknod>."
11025 #: ../fish/guestfish-actions.pod:3226
11030 #: ../fish/guestfish-actions.pod:3228
11038 #: ../fish/guestfish-actions.pod:3230 ../src/guestfs-actions.pod:4850
11039 msgid "Create a swap partition on C<device>."
11043 #: ../fish/guestfish-actions.pod:3232
11048 #: ../fish/guestfish-actions.pod:3234
11051 " mkswap-L label device\n"
11056 #: ../fish/guestfish-actions.pod:3236 ../src/guestfs-actions.pod:4863
11057 msgid "Create a swap partition on C<device> with label C<label>."
11061 #: ../fish/guestfish-actions.pod:3238 ../src/guestfs-actions.pod:4865
11063 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
11064 "sda>), just to a partition. This appears to be a limitation of the kernel "
11069 #: ../fish/guestfish-actions.pod:3242
11074 #: ../fish/guestfish-actions.pod:3244
11077 " mkswap-U uuid device\n"
11082 #: ../fish/guestfish-actions.pod:3246 ../src/guestfs-actions.pod:4880
11083 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11087 #: ../fish/guestfish-actions.pod:3248
11088 msgid "mkswap-file"
11092 #: ../fish/guestfish-actions.pod:3250
11095 " mkswap-file path\n"
11100 #: ../fish/guestfish-actions.pod:3252 ../src/guestfs-actions.pod:4892
11101 msgid "Create a swap file."
11105 #: ../fish/guestfish-actions.pod:3254
11107 "This command just writes a swap file signature to an existing file. To "
11108 "create the file itself, use something like L</fallocate>."
11112 #: ../fish/guestfish-actions.pod:3257
11117 #: ../fish/guestfish-actions.pod:3259
11120 " modprobe modulename\n"
11125 #: ../fish/guestfish-actions.pod:3261 ../src/guestfs-actions.pod:4907
11126 msgid "This loads a kernel module in the appliance."
11130 #: ../fish/guestfish-actions.pod:3263 ../src/guestfs-actions.pod:4909
11132 "The kernel module must have been whitelisted when libguestfs was built (see "
11133 "C<appliance/kmod.whitelist.in> in the source)."
11137 #: ../fish/guestfish-actions.pod:3266
11142 #: ../fish/guestfish-actions.pod:3268
11145 " mount device mountpoint\n"
11150 #: ../fish/guestfish-actions.pod:3270 ../src/guestfs-actions.pod:4930
11152 "Mount a guest disk at a position in the filesystem. Block devices are named "
11153 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11154 "those block devices contain partitions, they will have the usual names (eg. "
11155 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11159 #: ../fish/guestfish-actions.pod:3276 ../src/guestfs-actions.pod:4936
11161 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11162 "mounted on C</> before others can be mounted. Other filesystems can only be "
11163 "mounted on directories which already exist."
11167 #: ../fish/guestfish-actions.pod:3281 ../src/guestfs-actions.pod:4941
11169 "The mounted filesystem is writable, if we have sufficient permissions on the "
11170 "underlying device."
11174 #: ../fish/guestfish-actions.pod:3284
11176 "B<Important note:> When you use this call, the filesystem options C<sync> "
11177 "and C<noatime> are set implicitly. This was originally done because we "
11178 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11179 "very large negative performance impact and negligible effect on "
11180 "reliability. Therefore we recommend that you avoid using L</mount> in any "
11181 "code that needs performance, and instead use L</mount-options> (use an empty "
11182 "string for the first parameter if you don't want any options)."
11186 #: ../fish/guestfish-actions.pod:3294
11188 "I<This function is deprecated.> In new code, use the L</mount_options> call "
11193 #: ../fish/guestfish-actions.pod:3301
11198 #: ../fish/guestfish-actions.pod:3303
11201 " mount-9p mounttag mountpoint [options:..]\n"
11206 #: ../fish/guestfish-actions.pod:3305 ../src/guestfs-actions.pod:4973
11208 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
11213 #: ../fish/guestfish-actions.pod:3308 ../src/guestfs-actions.pod:4976
11215 "If required, C<trans=virtio> will be automatically added to the options. "
11216 "Any other options required can be passed in the optional C<options> "
11221 #: ../fish/guestfish-actions.pod:3314
11226 #: ../fish/guestfish-actions.pod:3316
11229 " mount-loop file mountpoint\n"
11234 #: ../fish/guestfish-actions.pod:3318 ../src/guestfs-actions.pod:5015
11236 "This command lets you mount C<file> (a filesystem image in a file) on a "
11237 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11242 #: ../fish/guestfish-actions.pod:3322
11243 msgid "mount-options"
11247 #: ../fish/guestfish-actions.pod:3324
11250 " mount-options options device mountpoint\n"
11255 #: ../fish/guestfish-actions.pod:3326
11257 "This is the same as the L</mount> command, but it allows you to set the "
11258 "mount options as for the L<mount(8)> I<-o> flag."
11262 #: ../fish/guestfish-actions.pod:3330 ../src/guestfs-actions.pod:5035
11264 "If the C<options> parameter is an empty string, then no options are passed "
11265 "(all options default to whatever the filesystem uses)."
11269 #: ../fish/guestfish-actions.pod:3334
11274 #: ../fish/guestfish-actions.pod:3336
11277 " mount-ro device mountpoint\n"
11282 #: ../fish/guestfish-actions.pod:3338
11284 "This is the same as the L</mount> command, but it mounts the filesystem with "
11285 "the read-only (I<-o ro>) flag."
11289 #: ../fish/guestfish-actions.pod:3341
11294 #: ../fish/guestfish-actions.pod:3343
11297 " mount-vfs options vfstype device mountpoint\n"
11302 #: ../fish/guestfish-actions.pod:3345
11304 "This is the same as the L</mount> command, but it allows you to set both the "
11305 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
11309 #: ../fish/guestfish-actions.pod:3349
11310 msgid "mountpoints"
11314 #: ../fish/guestfish-actions.pod:3351
11322 #: ../fish/guestfish-actions.pod:3353
11324 "This call is similar to L</mounts>. That call returns a list of devices. "
11325 "This one returns a hash table (map) of device name to directory where the "
11326 "device is mounted."
11330 #: ../fish/guestfish-actions.pod:3357
11335 #: ../fish/guestfish-actions.pod:3359
11343 #: ../fish/guestfish-actions.pod:3361 ../src/guestfs-actions.pod:5096
11345 "This returns the list of currently mounted filesystems. It returns the list "
11346 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11350 #: ../fish/guestfish-actions.pod:3364 ../src/guestfs-actions.pod:5099
11351 msgid "Some internal mounts are not shown."
11355 #: ../fish/guestfish-actions.pod:3366
11356 msgid "See also: L</mountpoints>"
11360 #: ../fish/guestfish-actions.pod:3368
11365 #: ../fish/guestfish-actions.pod:3370
11373 #: ../fish/guestfish-actions.pod:3372 ../src/guestfs-actions.pod:5116
11375 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11376 "destination filename or destination directory."
11380 #: ../fish/guestfish-actions.pod:3375
11381 msgid "ntfs-3g-probe"
11385 #: ../fish/guestfish-actions.pod:3377
11388 " ntfs-3g-probe true|false device\n"
11393 #: ../fish/guestfish-actions.pod:3379 ../src/guestfs-actions.pod:5130
11395 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11396 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
11397 "write, and some cannot be mounted at all)."
11401 #: ../fish/guestfish-actions.pod:3383 ../src/guestfs-actions.pod:5134
11403 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11404 "can be mounted read-write. Set it to false if you want to test if the "
11405 "volume can be mounted read-only."
11409 #: ../fish/guestfish-actions.pod:3387 ../src/guestfs-actions.pod:5138
11411 "The return value is an integer which C<0> if the operation would succeed, or "
11412 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11416 #: ../fish/guestfish-actions.pod:3391
11421 #: ../fish/guestfish-actions.pod:3393
11424 " ntfsresize device\n"
11429 #: ../fish/guestfish-actions.pod:3395 ../fish/guestfish-actions.pod:3419
11430 #: ../src/guestfs-actions.pod:5159 ../src/guestfs-actions.pod:5191
11432 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11433 "size of the underlying device."
11437 #: ../fish/guestfish-actions.pod:3398 ../src/guestfs-actions.pod:5162
11439 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
11440 "consistency check (for safety). You have to boot into Windows to perform "
11441 "this check and clear this condition. Furthermore, ntfsresize refuses to "
11442 "resize filesystems which have been marked in this way. So in effect it is "
11443 "not possible to call ntfsresize multiple times on a single filesystem "
11444 "without booting into Windows between each resize."
11448 #: ../fish/guestfish-actions.pod:3406 ../fish/guestfish-actions.pod:3445
11449 #: ../src/guestfs-actions.pod:5170 ../src/guestfs-actions.pod:5217
11450 msgid "See also L<ntfsresize(8)>."
11454 #: ../fish/guestfish-actions.pod:3408 ../fish/guestfish-actions.pod:3456
11456 "I<This function is deprecated.> In new code, use the L</ntfsresize_opts> "
11461 #: ../fish/guestfish-actions.pod:3415
11462 msgid "ntfsresize-opts"
11466 #: ../fish/guestfish-actions.pod:3417
11469 " ntfsresize-opts device [size:..] [force:..]\n"
11474 #: ../fish/guestfish-actions.pod:3428 ../src/guestfs-actions.pod:5200
11476 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
11477 "resized to fit the container (eg. partition)."
11481 #: ../fish/guestfish-actions.pod:3431 ../src/guestfs-actions.pod:5203
11486 #: ../fish/guestfish-actions.pod:3433 ../src/guestfs-actions.pod:5205
11488 "If this option is true, then force the resize of the filesystem even if the "
11489 "filesystem is marked as requiring a consistency check."
11493 #: ../fish/guestfish-actions.pod:3436
11495 "After the resize operation, the filesystem is always marked as requiring a "
11496 "consistency check (for safety). You have to boot into Windows to perform "
11497 "this check and clear this condition. If you I<don't> set the C<force> "
11498 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
11499 "a single filesystem without booting into Windows between each resize."
11503 #: ../fish/guestfish-actions.pod:3449
11504 msgid "ntfsresize-size"
11508 #: ../fish/guestfish-actions.pod:3451
11511 " ntfsresize-size device size\n"
11516 #: ../fish/guestfish-actions.pod:3453
11518 "This command is the same as L</ntfsresize> except that it allows you to "
11519 "specify the new size (in bytes) explicitly."
11523 #: ../fish/guestfish-actions.pod:3463
11528 #: ../fish/guestfish-actions.pod:3465
11531 " part-add device prlogex startsect endsect\n"
11536 #: ../fish/guestfish-actions.pod:3467
11538 "This command adds a partition to C<device>. If there is no partition table "
11539 "on the device, call L</part-init> first."
11543 #: ../fish/guestfish-actions.pod:3470 ../src/guestfs-actions.pod:5278
11545 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11546 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11547 "C<logical>) and C<e> (or C<extended>) partition types."
11551 #: ../fish/guestfish-actions.pod:3475 ../src/guestfs-actions.pod:5283
11553 "C<startsect> and C<endsect> are the start and end of the partition in "
11554 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11555 "from the end of the disk (C<-1> is the last sector)."
11559 #: ../fish/guestfish-actions.pod:3479
11561 "Creating a partition which covers the whole disk is not so easy. Use L</"
11562 "part-disk> to do that."
11566 #: ../fish/guestfish-actions.pod:3482
11571 #: ../fish/guestfish-actions.pod:3484
11574 " part-del device partnum\n"
11579 #: ../fish/guestfish-actions.pod:3486 ../src/guestfs-actions.pod:5301
11580 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11584 #: ../fish/guestfish-actions.pod:3488 ../src/guestfs-actions.pod:5303
11586 "Note that in the case of MBR partitioning, deleting an extended partition "
11587 "also deletes any logical partitions it contains."
11591 #: ../fish/guestfish-actions.pod:3492
11596 #: ../fish/guestfish-actions.pod:3494
11599 " part-disk device parttype\n"
11604 #: ../fish/guestfish-actions.pod:3496
11606 "This command is simply a combination of L</part-init> followed by L</part-"
11607 "add> to create a single primary partition covering the whole disk."
11611 #: ../fish/guestfish-actions.pod:3500
11613 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11614 "possible values are described in L</part-init>."
11618 #: ../fish/guestfish-actions.pod:3506
11619 msgid "part-get-bootable"
11623 #: ../fish/guestfish-actions.pod:3508
11626 " part-get-bootable device partnum\n"
11631 #: ../fish/guestfish-actions.pod:3510 ../src/guestfs-actions.pod:5339
11633 "This command returns true if the partition C<partnum> on C<device> has the "
11634 "bootable flag set."
11638 #: ../fish/guestfish-actions.pod:3513
11639 msgid "See also L</part-set-bootable>."
11643 #: ../fish/guestfish-actions.pod:3515
11644 msgid "part-get-mbr-id"
11648 #: ../fish/guestfish-actions.pod:3517
11651 " part-get-mbr-id device partnum\n"
11656 #: ../fish/guestfish-actions.pod:3519 ../src/guestfs-actions.pod:5355
11658 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11659 "partition C<partnum>."
11663 #: ../fish/guestfish-actions.pod:3522 ../fish/guestfish-actions.pod:3666
11665 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11666 "undefined results for other partition table types (see L</part-get-"
11671 #: ../fish/guestfish-actions.pod:3526
11672 msgid "part-get-parttype"
11676 #: ../fish/guestfish-actions.pod:3528
11679 " part-get-parttype device\n"
11684 #: ../fish/guestfish-actions.pod:3530 ../src/guestfs-actions.pod:5372
11686 "This command examines the partition table on C<device> and returns the "
11687 "partition table type (format) being used."
11691 #: ../fish/guestfish-actions.pod:3533
11693 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11694 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11695 "possible, although unusual. See L</part-init> for a full list."
11699 #: ../fish/guestfish-actions.pod:3538
11704 #: ../fish/guestfish-actions.pod:3540
11707 " part-init device parttype\n"
11712 #: ../fish/guestfish-actions.pod:3542 ../src/guestfs-actions.pod:5392
11714 "This creates an empty partition table on C<device> of one of the partition "
11715 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11716 "(for large disks)."
11720 #: ../fish/guestfish-actions.pod:3546
11722 "Initially there are no partitions. Following this, you should call L</part-"
11723 "add> for each partition required."
11727 #: ../fish/guestfish-actions.pod:3549 ../src/guestfs-actions.pod:5399
11728 msgid "Possible values for C<parttype> are:"
11732 #: ../fish/guestfish-actions.pod:3553 ../src/guestfs-actions.pod:5403
11737 #: ../fish/guestfish-actions.pod:3555 ../src/guestfs-actions.pod:5405
11742 #: ../fish/guestfish-actions.pod:3557 ../src/guestfs-actions.pod:5407
11743 msgid "Intel EFI / GPT partition table."
11747 #: ../fish/guestfish-actions.pod:3559 ../src/guestfs-actions.pod:5409
11749 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11750 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11751 "the C<mbr> format."
11755 #: ../fish/guestfish-actions.pod:3563 ../src/guestfs-actions.pod:5413
11760 #: ../fish/guestfish-actions.pod:3565 ../src/guestfs-actions.pod:5415
11765 #: ../fish/guestfish-actions.pod:3567 ../src/guestfs-actions.pod:5417
11767 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11768 "Windows. This partition type will B<only> work for device sizes up to 2 "
11769 "TB. For large disks we recommend using C<gpt>."
11773 #: ../fish/guestfish-actions.pod:3574 ../src/guestfs-actions.pod:5424
11775 "Other partition table types that may work but are not supported include:"
11779 #: ../fish/guestfish-actions.pod:3579 ../src/guestfs-actions.pod:5429
11784 #: ../fish/guestfish-actions.pod:3581 ../src/guestfs-actions.pod:5431
11785 msgid "AIX disk labels."
11789 #: ../fish/guestfish-actions.pod:3583 ../src/guestfs-actions.pod:5433
11794 #: ../fish/guestfish-actions.pod:3585 ../src/guestfs-actions.pod:5435
11799 #: ../fish/guestfish-actions.pod:3587 ../src/guestfs-actions.pod:5437
11800 msgid "Amiga \"Rigid Disk Block\" format."
11804 #: ../fish/guestfish-actions.pod:3589 ../src/guestfs-actions.pod:5439
11809 #: ../fish/guestfish-actions.pod:3591 ../src/guestfs-actions.pod:5441
11810 msgid "BSD disk labels."
11814 #: ../fish/guestfish-actions.pod:3593 ../src/guestfs-actions.pod:5443
11819 #: ../fish/guestfish-actions.pod:3595 ../src/guestfs-actions.pod:5445
11820 msgid "DASD, used on IBM mainframes."
11824 #: ../fish/guestfish-actions.pod:3597 ../src/guestfs-actions.pod:5447
11829 #: ../fish/guestfish-actions.pod:3599 ../src/guestfs-actions.pod:5449
11830 msgid "MIPS/SGI volumes."
11834 #: ../fish/guestfish-actions.pod:3601 ../src/guestfs-actions.pod:5451
11839 #: ../fish/guestfish-actions.pod:3603 ../src/guestfs-actions.pod:5453
11840 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11844 #: ../fish/guestfish-actions.pod:3605 ../src/guestfs-actions.pod:5455
11849 #: ../fish/guestfish-actions.pod:3607 ../src/guestfs-actions.pod:5457
11850 msgid "NEC PC-98 format, common in Japan apparently."
11854 #: ../fish/guestfish-actions.pod:3609 ../src/guestfs-actions.pod:5459
11859 #: ../fish/guestfish-actions.pod:3611 ../src/guestfs-actions.pod:5461
11860 msgid "Sun disk labels."
11864 #: ../fish/guestfish-actions.pod:3615
11869 #: ../fish/guestfish-actions.pod:3617
11872 " part-list device\n"
11877 #: ../fish/guestfish-actions.pod:3619 ../src/guestfs-actions.pod:5475
11879 "This command parses the partition table on C<device> and returns the list of "
11880 "partitions found."
11884 #: ../fish/guestfish-actions.pod:3622 ../src/guestfs-actions.pod:5478
11885 msgid "The fields in the returned structure are:"
11889 #: ../fish/guestfish-actions.pod:3626 ../src/guestfs-actions.pod:5482
11890 msgid "B<part_num>"
11894 #: ../fish/guestfish-actions.pod:3628 ../src/guestfs-actions.pod:5484
11895 msgid "Partition number, counting from 1."
11899 #: ../fish/guestfish-actions.pod:3630 ../src/guestfs-actions.pod:5486
11900 msgid "B<part_start>"
11904 #: ../fish/guestfish-actions.pod:3632
11906 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11907 "the device's sector size, see L</blockdev-getss>."
11911 #: ../fish/guestfish-actions.pod:3635 ../src/guestfs-actions.pod:5491
11912 msgid "B<part_end>"
11916 #: ../fish/guestfish-actions.pod:3637 ../src/guestfs-actions.pod:5493
11917 msgid "End of the partition in bytes."
11921 #: ../fish/guestfish-actions.pod:3639 ../src/guestfs-actions.pod:5495
11922 msgid "B<part_size>"
11926 #: ../fish/guestfish-actions.pod:3641 ../src/guestfs-actions.pod:5497
11927 msgid "Size of the partition in bytes."
11931 #: ../fish/guestfish-actions.pod:3645
11932 msgid "part-set-bootable"
11936 #: ../fish/guestfish-actions.pod:3647
11939 " part-set-bootable device partnum true|false\n"
11944 #: ../fish/guestfish-actions.pod:3649 ../src/guestfs-actions.pod:5515
11946 "This sets the bootable flag on partition numbered C<partnum> on device "
11947 "C<device>. Note that partitions are numbered from 1."
11951 #: ../fish/guestfish-actions.pod:3652 ../src/guestfs-actions.pod:5518
11953 "The bootable flag is used by some operating systems (notably Windows) to "
11954 "determine which partition to boot from. It is by no means universally "
11959 #: ../fish/guestfish-actions.pod:3656
11960 msgid "part-set-mbr-id"
11964 #: ../fish/guestfish-actions.pod:3658
11967 " part-set-mbr-id device partnum idbyte\n"
11972 #: ../fish/guestfish-actions.pod:3660 ../src/guestfs-actions.pod:5534
11974 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11975 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11976 "documentation are in fact hexadecimal numbers, but usually documented "
11977 "without any leading \"0x\" which might be confusing."
11981 #: ../fish/guestfish-actions.pod:3670
11982 msgid "part-set-name"
11986 #: ../fish/guestfish-actions.pod:3672
11989 " part-set-name device partnum name\n"
11994 #: ../fish/guestfish-actions.pod:3674 ../src/guestfs-actions.pod:5556
11996 "This sets the partition name on partition numbered C<partnum> on device "
11997 "C<device>. Note that partitions are numbered from 1."
12001 #: ../fish/guestfish-actions.pod:3677 ../src/guestfs-actions.pod:5559
12003 "The partition name can only be set on certain types of partition table. "
12004 "This works on C<gpt> but not on C<mbr> partitions."
12008 #: ../fish/guestfish-actions.pod:3680
12009 msgid "part-to-dev"
12013 #: ../fish/guestfish-actions.pod:3682
12016 " part-to-dev partition\n"
12021 #: ../fish/guestfish-actions.pod:3684 ../src/guestfs-actions.pod:5572
12023 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12024 "partition number, returning the device name (eg. \"/dev/sdb\")."
12028 #: ../fish/guestfish-actions.pod:3688
12030 "The named partition must exist, for example as a string returned from L</"
12031 "list-partitions>."
12035 #: ../fish/guestfish-actions.pod:3691
12036 msgid "ping-daemon"
12040 #: ../fish/guestfish-actions.pod:3693
12048 #: ../fish/guestfish-actions.pod:3695 ../src/guestfs-actions.pod:5589
12050 "This is a test probe into the guestfs daemon running inside the qemu "
12051 "subprocess. Calling this function checks that the daemon responds to the "
12052 "ping message, without affecting the daemon or attached block device(s) in "
12057 #: ../fish/guestfish-actions.pod:3700
12062 #: ../fish/guestfish-actions.pod:3702
12065 " pread path count offset\n"
12070 #: ../fish/guestfish-actions.pod:3704 ../src/guestfs-actions.pod:5607
12072 "This command lets you read part of a file. It reads C<count> bytes of the "
12073 "file, starting at C<offset>, from file C<path>."
12077 #: ../fish/guestfish-actions.pod:3707 ../fish/guestfish-actions.pod:3722
12078 #: ../src/guestfs-actions.pod:5610 ../src/guestfs-actions.pod:5636
12080 "This may read fewer bytes than requested. For further details see the "
12081 "L<pread(2)> system call."
12085 #: ../fish/guestfish-actions.pod:3710
12086 msgid "See also L</pwrite>, L</pread-device>."
12090 #: ../fish/guestfish-actions.pod:3715
12091 msgid "pread-device"
12095 #: ../fish/guestfish-actions.pod:3717
12098 " pread-device device count offset\n"
12103 #: ../fish/guestfish-actions.pod:3719 ../src/guestfs-actions.pod:5633
12105 "This command lets you read part of a file. It reads C<count> bytes of "
12106 "C<device>, starting at C<offset>."
12110 #: ../fish/guestfish-actions.pod:3725
12111 msgid "See also L</pread>."
12115 #: ../fish/guestfish-actions.pod:3730
12120 #: ../fish/guestfish-actions.pod:3732
12123 " pvcreate device\n"
12128 #: ../fish/guestfish-actions.pod:3734 ../src/guestfs-actions.pod:5656
12130 "This creates an LVM physical volume on the named C<device>, where C<device> "
12131 "should usually be a partition name such as C</dev/sda1>."
12135 #: ../fish/guestfish-actions.pod:3738
12140 #: ../fish/guestfish-actions.pod:3740
12143 " pvremove device\n"
12148 #: ../fish/guestfish-actions.pod:3742 ../src/guestfs-actions.pod:5670
12150 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12155 #: ../fish/guestfish-actions.pod:3745 ../src/guestfs-actions.pod:5673
12157 "The implementation uses the C<pvremove> command which refuses to wipe "
12158 "physical volumes that contain any volume groups, so you have to remove those "
12163 #: ../fish/guestfish-actions.pod:3749
12168 #: ../fish/guestfish-actions.pod:3751
12171 " pvresize device\n"
12176 #: ../fish/guestfish-actions.pod:3753 ../src/guestfs-actions.pod:5687
12178 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12179 "the new size of the underlying device."
12183 #: ../fish/guestfish-actions.pod:3756
12184 msgid "pvresize-size"
12188 #: ../fish/guestfish-actions.pod:3758
12191 " pvresize-size device size\n"
12196 #: ../fish/guestfish-actions.pod:3760
12198 "This command is the same as L</pvresize> except that it allows you to "
12199 "specify the new size (in bytes) explicitly."
12203 #: ../fish/guestfish-actions.pod:3763
12208 #: ../fish/guestfish-actions.pod:3765
12216 #: ../fish/guestfish-actions.pod:3767 ../src/guestfs-actions.pod:5713
12218 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12223 #: ../fish/guestfish-actions.pod:3770 ../src/guestfs-actions.pod:5716
12225 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12230 #: ../fish/guestfish-actions.pod:3773
12231 msgid "See also L</pvs-full>."
12235 #: ../fish/guestfish-actions.pod:3775
12240 #: ../fish/guestfish-actions.pod:3777
12248 #: ../fish/guestfish-actions.pod:3779 ../src/guestfs-actions.pod:5732
12250 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12251 "(8)> command. The \"full\" version includes all fields."
12255 #: ../fish/guestfish-actions.pod:3782
12260 #: ../fish/guestfish-actions.pod:3784
12268 #: ../fish/guestfish-actions.pod:3786 ../src/guestfs-actions.pod:5747
12269 msgid "This command returns the UUID of the LVM PV C<device>."
12273 #: ../fish/guestfish-actions.pod:3788
12278 #: ../fish/guestfish-actions.pod:3790
12281 " pwrite path content offset\n"
12286 #: ../fish/guestfish-actions.pod:3792 ../src/guestfs-actions.pod:5763
12288 "This command writes to part of a file. It writes the data buffer C<content> "
12289 "to the file C<path> starting at offset C<offset>."
12293 #: ../fish/guestfish-actions.pod:3795 ../src/guestfs-actions.pod:5766
12295 "This command implements the L<pwrite(2)> system call, and like that system "
12296 "call it may not write the full data requested. The return value is the "
12297 "number of bytes that were actually written to the file. This could even be "
12298 "0, although short writes are unlikely for regular files in ordinary "
12303 #: ../fish/guestfish-actions.pod:3801
12304 msgid "See also L</pread>, L</pwrite-device>."
12308 #: ../fish/guestfish-actions.pod:3806
12309 msgid "pwrite-device"
12313 #: ../fish/guestfish-actions.pod:3808
12316 " pwrite-device device content offset\n"
12321 #: ../fish/guestfish-actions.pod:3810 ../src/guestfs-actions.pod:5790
12323 "This command writes to part of a device. It writes the data buffer "
12324 "C<content> to C<device> starting at offset C<offset>."
12328 #: ../fish/guestfish-actions.pod:3813 ../src/guestfs-actions.pod:5793
12330 "This command implements the L<pwrite(2)> system call, and like that system "
12331 "call it may not write the full data requested (although short writes to disk "
12332 "devices and partitions are probably impossible with standard Linux kernels)."
12336 #: ../fish/guestfish-actions.pod:3818
12337 msgid "See also L</pwrite>."
12341 #: ../fish/guestfish-actions.pod:3823
12346 #: ../fish/guestfish-actions.pod:3825
12349 " read-file path\n"
12354 #: ../fish/guestfish-actions.pod:3827 ../src/guestfs-actions.pod:5814
12355 msgid "This calls returns the contents of the file C<path> as a buffer."
12359 #: ../fish/guestfish-actions.pod:3830
12361 "Unlike L</cat>, this function can correctly handle files that contain "
12362 "embedded ASCII NUL characters. However unlike L</download>, this function "
12363 "is limited in the total size of file that can be handled."
12367 #: ../fish/guestfish-actions.pod:3838
12372 #: ../fish/guestfish-actions.pod:3840
12375 " read-lines path\n"
12380 #: ../fish/guestfish-actions.pod:3844 ../src/guestfs-actions.pod:5839
12382 "The file contents are returned as a list of lines. Trailing C<LF> and "
12383 "C<CRLF> character sequences are I<not> returned."
12387 #: ../fish/guestfish-actions.pod:3847
12389 "Note that this function cannot correctly handle binary files (specifically, "
12390 "files containing C<\\0> character which is treated as end of line). For "
12391 "those you need to use the L</read-file> function which has a more complex "
12396 #: ../fish/guestfish-actions.pod:3852
12401 #: ../fish/guestfish-actions.pod:3854
12409 #: ../fish/guestfish-actions.pod:3856 ../src/guestfs-actions.pod:5859
12410 msgid "This returns the list of directory entries in directory C<dir>."
12414 #: ../fish/guestfish-actions.pod:3858 ../src/guestfs-actions.pod:5861
12416 "All entries in the directory are returned, including C<.> and C<..>. The "
12417 "entries are I<not> sorted, but returned in the same order as the underlying "
12422 #: ../fish/guestfish-actions.pod:3862 ../src/guestfs-actions.pod:5865
12424 "Also this call returns basic file type information about each file. The "
12425 "C<ftyp> field will contain one of the following characters:"
12429 #: ../fish/guestfish-actions.pod:3867 ../src/guestfs-actions.pod:5870
12434 #: ../fish/guestfish-actions.pod:3869 ../src/guestfs-actions.pod:5872
12435 msgid "Block special"
12439 #: ../fish/guestfish-actions.pod:3871 ../src/guestfs-actions.pod:5874
12444 #: ../fish/guestfish-actions.pod:3873 ../src/guestfs-actions.pod:5876
12445 msgid "Char special"
12449 #: ../fish/guestfish-actions.pod:3875 ../src/guestfs-actions.pod:5878
12454 #: ../fish/guestfish-actions.pod:3877 ../src/guestfs-actions.pod:5880
12459 #: ../fish/guestfish-actions.pod:3879 ../src/guestfs-actions.pod:5882
12464 #: ../fish/guestfish-actions.pod:3881 ../src/guestfs-actions.pod:5884
12465 msgid "FIFO (named pipe)"
12469 #: ../fish/guestfish-actions.pod:3883 ../src/guestfs-actions.pod:5886
12474 #: ../fish/guestfish-actions.pod:3885 ../src/guestfs-actions.pod:5888
12475 msgid "Symbolic link"
12479 #: ../fish/guestfish-actions.pod:3887 ../src/guestfs-actions.pod:5890
12484 #: ../fish/guestfish-actions.pod:3889 ../src/guestfs-actions.pod:5892
12485 msgid "Regular file"
12489 #: ../fish/guestfish-actions.pod:3891 ../src/guestfs-actions.pod:5894
12494 #: ../fish/guestfish-actions.pod:3893 ../src/guestfs-actions.pod:5896
12499 #: ../fish/guestfish-actions.pod:3895 ../src/guestfs-actions.pod:5898
12504 #: ../fish/guestfish-actions.pod:3897 ../src/guestfs-actions.pod:5900
12505 msgid "Unknown file type"
12509 #: ../fish/guestfish-actions.pod:3899 ../src/guestfs-actions.pod:5902
12514 #: ../fish/guestfish-actions.pod:3901 ../src/guestfs-actions.pod:5904
12516 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12520 #: ../fish/guestfish-actions.pod:3906
12522 "This function is primarily intended for use by programs. To get a simple "
12523 "list of names, use L</ls>. To get a printable directory for human "
12524 "consumption, use L</ll>."
12528 #: ../fish/guestfish-actions.pod:3910
12533 #: ../fish/guestfish-actions.pod:3912
12541 #: ../fish/guestfish-actions.pod:3914 ../src/guestfs-actions.pod:5925
12542 msgid "This command reads the target of a symbolic link."
12546 #: ../fish/guestfish-actions.pod:3916
12547 msgid "readlinklist"
12551 #: ../fish/guestfish-actions.pod:3918
12554 " readlinklist path 'names ...'\n"
12559 #: ../fish/guestfish-actions.pod:3920 ../src/guestfs-actions.pod:5939
12561 "This call allows you to do a C<readlink> operation on multiple files, where "
12562 "all files are in the directory C<path>. C<names> is the list of files from "
12567 #: ../fish/guestfish-actions.pod:3924 ../src/guestfs-actions.pod:5943
12569 "On return you get a list of strings, with a one-to-one correspondence to the "
12570 "C<names> list. Each string is the value of the symbolic link."
12574 #: ../fish/guestfish-actions.pod:3928 ../src/guestfs-actions.pod:5947
12576 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12577 "result string is the empty string C<\"\">. However the whole operation is "
12578 "completed even if there were C<readlink(2)> errors, and so you can call this "
12579 "function with names where you don't know if they are symbolic links already "
12580 "(albeit slightly less efficient)."
12584 #: ../fish/guestfish-actions.pod:3935 ../src/guestfs-actions.pod:5954
12586 "This call is intended for programs that want to efficiently list a directory "
12587 "contents without making many round-trips. Very long directory listings "
12588 "might cause the protocol message size to be exceeded, causing this call to "
12589 "fail. The caller must split up such requests into smaller groups of names."
12593 #: ../fish/guestfish-actions.pod:3942
12598 #: ../fish/guestfish-actions.pod:3944
12606 #: ../fish/guestfish-actions.pod:3946 ../src/guestfs-actions.pod:5973
12608 "Return the canonicalized absolute pathname of C<path>. The returned path "
12609 "has no C<.>, C<..> or symbolic link path elements."
12613 #: ../fish/guestfish-actions.pod:3949
12614 msgid "removexattr"
12618 #: ../fish/guestfish-actions.pod:3951
12621 " removexattr xattr path\n"
12626 #: ../fish/guestfish-actions.pod:3953 ../src/guestfs-actions.pod:5988
12628 "This call removes the extended attribute named C<xattr> of the file C<path>."
12632 #: ../fish/guestfish-actions.pod:3956
12633 msgid "See also: L</lremovexattr>, L<attr(5)>."
12637 #: ../fish/guestfish-actions.pod:3958
12642 #: ../fish/guestfish-actions.pod:3960
12645 " resize2fs device\n"
12650 #: ../fish/guestfish-actions.pod:3962 ../src/guestfs-actions.pod:6003
12652 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12653 "underlying device."
12657 #: ../fish/guestfish-actions.pod:3965
12659 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
12660 "before calling this command. For unknown reasons C<resize2fs> sometimes "
12661 "gives an error about this and sometimes not. In any case, it is always safe "
12662 "to call L</e2fsck-f> before calling this function."
12666 #: ../fish/guestfish-actions.pod:3971
12667 msgid "resize2fs-M"
12671 #: ../fish/guestfish-actions.pod:3973
12674 " resize2fs-M device\n"
12679 #: ../fish/guestfish-actions.pod:3975
12681 "This command is the same as L</resize2fs>, but the filesystem is resized to "
12682 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
12687 #: ../fish/guestfish-actions.pod:3979
12689 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
12690 "and read the C<Block size> and C<Block count> values. These two numbers, "
12691 "multiplied together, give the resulting size of the minimal filesystem in "
12696 #: ../fish/guestfish-actions.pod:3984
12697 msgid "resize2fs-size"
12701 #: ../fish/guestfish-actions.pod:3986
12704 " resize2fs-size device size\n"
12709 #: ../fish/guestfish-actions.pod:3988
12711 "This command is the same as L</resize2fs> except that it allows you to "
12712 "specify the new size (in bytes) explicitly."
12716 #: ../fish/guestfish-actions.pod:3991
12721 #: ../fish/guestfish-actions.pod:3993
12729 #: ../fish/guestfish-actions.pod:3995 ../src/guestfs-actions.pod:6055
12730 msgid "Remove the single file C<path>."
12734 #: ../fish/guestfish-actions.pod:3997
12739 #: ../fish/guestfish-actions.pod:3999
12747 #: ../fish/guestfish-actions.pod:4001 ../src/guestfs-actions.pod:6067
12749 "Remove the file or directory C<path>, recursively removing the contents if "
12750 "its a directory. This is like the C<rm -rf> shell command."
12754 #: ../fish/guestfish-actions.pod:4005
12759 #: ../fish/guestfish-actions.pod:4007
12767 #: ../fish/guestfish-actions.pod:4009 ../src/guestfs-actions.pod:6081
12768 msgid "Remove the single directory C<path>."
12772 #: ../fish/guestfish-actions.pod:4011
12773 msgid "rmmountpoint"
12777 #: ../fish/guestfish-actions.pod:4013
12780 " rmmountpoint exemptpath\n"
12785 #: ../fish/guestfish-actions.pod:4015
12787 "This calls removes a mountpoint that was previously created with L</"
12788 "mkmountpoint>. See L</mkmountpoint> for full details."
12792 #: ../fish/guestfish-actions.pod:4019
12793 msgid "scrub-device"
12797 #: ../fish/guestfish-actions.pod:4021
12800 " scrub-device device\n"
12805 #: ../fish/guestfish-actions.pod:4023 ../src/guestfs-actions.pod:6107
12807 "This command writes patterns over C<device> to make data retrieval more "
12812 #: ../fish/guestfish-actions.pod:4026 ../fish/guestfish-actions.pod:4041
12813 #: ../fish/guestfish-actions.pod:4054 ../src/guestfs-actions.pod:6110
12814 #: ../src/guestfs-actions.pod:6131 ../src/guestfs-actions.pod:6150
12816 "It is an interface to the L<scrub(1)> program. See that manual page for "
12821 #: ../fish/guestfish-actions.pod:4032
12826 #: ../fish/guestfish-actions.pod:4034
12829 " scrub-file file\n"
12834 #: ../fish/guestfish-actions.pod:4036 ../src/guestfs-actions.pod:6126
12836 "This command writes patterns over a file to make data retrieval more "
12841 #: ../fish/guestfish-actions.pod:4039 ../src/guestfs-actions.pod:6129
12842 msgid "The file is I<removed> after scrubbing."
12846 #: ../fish/guestfish-actions.pod:4044
12847 msgid "scrub-freespace"
12851 #: ../fish/guestfish-actions.pod:4046
12854 " scrub-freespace dir\n"
12859 #: ../fish/guestfish-actions.pod:4048
12861 "This command creates the directory C<dir> and then fills it with files until "
12862 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
12863 "deletes them. The intention is to scrub any free space on the partition "
12864 "containing C<dir>."
12868 #: ../fish/guestfish-actions.pod:4057
12873 #: ../fish/guestfish-actions.pod:4059
12878 #: ../fish/guestfish-actions.pod:4061
12881 " set-append append\n"
12886 #: ../fish/guestfish-actions.pod:4063 ../src/guestfs-actions.pod:6163
12888 "This function is used to add additional options to the guest kernel command "
12893 #: ../fish/guestfish-actions.pod:4066 ../src/guestfs-actions.pod:6166
12895 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12896 "environment variable."
12900 #: ../fish/guestfish-actions.pod:4069 ../src/guestfs-actions.pod:6169
12902 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12903 "(libguestfs always adds a few of its own)."
12907 #: ../fish/guestfish-actions.pod:4072
12908 msgid "set-attach-method"
12912 #: ../fish/guestfish-actions.pod:4074
12913 msgid "attach-method"
12917 #: ../fish/guestfish-actions.pod:4076
12920 " set-attach-method attachmethod\n"
12925 #: ../fish/guestfish-actions.pod:4078 ../src/guestfs-actions.pod:6182
12927 "Set the method that libguestfs uses to connect to the back end guestfsd "
12928 "daemon. Possible methods are:"
12932 #: ../fish/guestfish-actions.pod:4083 ../src/guestfs-actions.pod:6187
12933 #: ../src/guestfs.pod:2688
12934 msgid "C<appliance>"
12938 #: ../fish/guestfish-actions.pod:4085 ../src/guestfs-actions.pod:6189
12940 "Launch an appliance and connect to it. This is the ordinary method and the "
12945 #: ../fish/guestfish-actions.pod:4088 ../src/guestfs-actions.pod:6192
12946 msgid "C<unix:I<path>>"
12950 #: ../fish/guestfish-actions.pod:4090 ../src/guestfs-actions.pod:6194
12951 msgid "Connect to the Unix domain socket I<path>."
12955 #: ../fish/guestfish-actions.pod:4092 ../src/guestfs-actions.pod:6196
12957 "This method lets you connect to an existing daemon or (using virtio-serial) "
12958 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
12959 "RUNNING DAEMONS>."
12963 #: ../fish/guestfish-actions.pod:4098
12964 msgid "set-autosync"
12968 #: ../fish/guestfish-actions.pod:4100
12973 #: ../fish/guestfish-actions.pod:4102
12976 " set-autosync true|false\n"
12981 #: ../fish/guestfish-actions.pod:4104 ../src/guestfs-actions.pod:6212
12983 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12984 "effort attempt to make filesystems consistent and synchronized when the "
12985 "handle is closed (also if the program exits without closing handles)."
12989 #: ../fish/guestfish-actions.pod:4109 ../src/guestfs-actions.pod:6217
12991 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12992 "disabled by default)."
12996 #: ../fish/guestfish-actions.pod:4112
13001 #: ../fish/guestfish-actions.pod:4114
13006 #: ../fish/guestfish-actions.pod:4116
13009 " set-direct true|false\n"
13014 #: ../fish/guestfish-actions.pod:4118 ../src/guestfs-actions.pod:6230
13016 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13017 "passed directly through to the appliance once it is launched."
13021 #: ../fish/guestfish-actions.pod:4122
13023 "One consequence of this is that log messages aren't caught by the library "
13024 "and handled by L</set-log-message-callback>, but go straight to stdout."
13028 #: ../fish/guestfish-actions.pod:4126 ../src/guestfs-actions.pod:6238
13029 msgid "You probably don't want to use this unless you know what you are doing."
13033 #: ../fish/guestfish-actions.pod:4129 ../src/guestfs-actions.pod:6241
13034 msgid "The default is disabled."
13038 #: ../fish/guestfish-actions.pod:4131
13039 msgid "set-e2label"
13043 #: ../fish/guestfish-actions.pod:4133
13046 " set-e2label device label\n"
13051 #: ../fish/guestfish-actions.pod:4135 ../src/guestfs-actions.pod:6254
13053 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13054 "C<label>. Filesystem labels are limited to 16 characters."
13058 #: ../fish/guestfish-actions.pod:4139
13060 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
13061 "label on a filesystem."
13065 #: ../fish/guestfish-actions.pod:4142
13070 #: ../fish/guestfish-actions.pod:4144
13073 " set-e2uuid device uuid\n"
13078 #: ../fish/guestfish-actions.pod:4146 ../src/guestfs-actions.pod:6272
13080 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13081 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13082 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13086 #: ../fish/guestfish-actions.pod:4151
13088 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
13089 "UUID of a filesystem."
13093 #: ../fish/guestfish-actions.pod:4154
13094 msgid "set-memsize"
13098 #: ../fish/guestfish-actions.pod:4156
13103 #: ../fish/guestfish-actions.pod:4158
13106 " set-memsize memsize\n"
13111 #: ../fish/guestfish-actions.pod:4160
13113 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13114 "This only has any effect if called before L</launch>."
13118 #: ../fish/guestfish-actions.pod:4164 ../src/guestfs-actions.pod:6294
13120 "You can also change this by setting the environment variable "
13121 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13125 #: ../fish/guestfish-actions.pod:4171
13126 msgid "set-network"
13130 #: ../fish/guestfish-actions.pod:4173
13135 #: ../fish/guestfish-actions.pod:4175
13138 " set-network true|false\n"
13143 #: ../fish/guestfish-actions.pod:4177 ../src/guestfs-actions.pod:6311
13145 "If C<network> is true, then the network is enabled in the libguestfs "
13146 "appliance. The default is false."
13150 #: ../fish/guestfish-actions.pod:4180 ../src/guestfs-actions.pod:6314
13152 "This affects whether commands are able to access the network (see L<guestfs"
13153 "(3)/RUNNING COMMANDS>)."
13157 #: ../fish/guestfish-actions.pod:4183
13159 "You must call this before calling L</launch>, otherwise it has no effect."
13163 #: ../fish/guestfish-actions.pod:4186
13168 #: ../fish/guestfish-actions.pod:4190
13171 " set-path searchpath\n"
13176 #: ../fish/guestfish-actions.pod:4192 ../src/guestfs-actions.pod:6330
13177 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13181 #: ../fish/guestfish-actions.pod:4194 ../src/guestfs-actions.pod:6332
13183 "The default is C<$libdir/guestfs> unless overridden by setting "
13184 "C<LIBGUESTFS_PATH> environment variable."
13188 #: ../fish/guestfish-actions.pod:4197 ../src/guestfs-actions.pod:6335
13189 msgid "Setting C<path> to C<NULL> restores the default path."
13193 #: ../fish/guestfish-actions.pod:4199
13198 #: ../fish/guestfish-actions.pod:4201
13203 #: ../fish/guestfish-actions.pod:4203
13206 " set-pgroup true|false\n"
13211 #: ../fish/guestfish-actions.pod:4205 ../src/guestfs-actions.pod:6347
13213 "If C<pgroup> is true, child processes are placed into their own process "
13218 #: ../fish/guestfish-actions.pod:4208 ../src/guestfs-actions.pod:6350
13220 "The practical upshot of this is that signals like C<SIGINT> (from users "
13221 "pressing C<^C>) won't be received by the child process."
13225 #: ../fish/guestfish-actions.pod:4211 ../src/guestfs-actions.pod:6353
13227 "The default for this flag is false, because usually you want C<^C> to kill "
13232 #: ../fish/guestfish-actions.pod:4214
13237 #: ../fish/guestfish-actions.pod:4216
13242 #: ../fish/guestfish-actions.pod:4218
13250 #: ../fish/guestfish-actions.pod:4220 ../src/guestfs-actions.pod:6366
13251 msgid "Set the qemu binary that we will use."
13255 #: ../fish/guestfish-actions.pod:4222 ../src/guestfs-actions.pod:6368
13257 "The default is chosen when the library was compiled by the configure script."
13261 #: ../fish/guestfish-actions.pod:4225 ../src/guestfs-actions.pod:6371
13263 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13268 #: ../fish/guestfish-actions.pod:4228 ../src/guestfs-actions.pod:6374
13269 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13273 #: ../fish/guestfish-actions.pod:4230 ../src/guestfs-actions.pod:6376
13275 "Note that you should call this function as early as possible after creating "
13276 "the handle. This is because some pre-launch operations depend on testing "
13277 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13278 "don't retest features, and so you might see inconsistent results. Using the "
13279 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13280 "the qemu binary at the same time as the handle is created."
13284 #: ../fish/guestfish-actions.pod:4238
13285 msgid "set-recovery-proc"
13289 #: ../fish/guestfish-actions.pod:4240
13290 msgid "recovery-proc"
13294 #: ../fish/guestfish-actions.pod:4242
13297 " set-recovery-proc true|false\n"
13302 #: ../fish/guestfish-actions.pod:4244
13304 "If this is called with the parameter C<false> then L</launch> does not "
13305 "create a recovery process. The purpose of the recovery process is to stop "
13306 "runaway qemu processes in the case where the main program aborts abruptly."
13310 #: ../fish/guestfish-actions.pod:4249
13312 "This only has any effect if called before L</launch>, and the default is "
13317 #: ../fish/guestfish-actions.pod:4252 ../src/guestfs-actions.pod:6402
13319 "About the only time when you would want to disable this is if the main "
13320 "process will fork itself into the background (\"daemonize\" itself). In "
13321 "this case the recovery process thinks that the main program has disappeared "
13322 "and so kills qemu, which is not very helpful."
13326 #: ../fish/guestfish-actions.pod:4258
13327 msgid "set-selinux"
13331 #: ../fish/guestfish-actions.pod:4260
13336 #: ../fish/guestfish-actions.pod:4262
13339 " set-selinux true|false\n"
13344 #: ../fish/guestfish-actions.pod:4264 ../src/guestfs-actions.pod:6418
13346 "This sets the selinux flag that is passed to the appliance at boot time. "
13347 "The default is C<selinux=0> (disabled)."
13351 #: ../fish/guestfish-actions.pod:4267 ../src/guestfs-actions.pod:6421
13353 "Note that if SELinux is enabled, it is always in Permissive mode "
13354 "(C<enforcing=0>)."
13358 #: ../fish/guestfish-actions.pod:4273
13363 #: ../fish/guestfish-actions.pod:4275
13368 #: ../fish/guestfish-actions.pod:4277
13371 " set-trace true|false\n"
13376 #: ../fish/guestfish-actions.pod:4279 ../src/guestfs-actions.pod:6437
13378 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
13379 "return values are traced."
13383 #: ../fish/guestfish-actions.pod:4282 ../src/guestfs-actions.pod:6440
13385 "If you want to trace C API calls into libguestfs (and other libraries) then "
13386 "possibly a better way is to use the external ltrace(1) command."
13390 #: ../fish/guestfish-actions.pod:4286 ../src/guestfs-actions.pod:6444
13392 "Command traces are disabled unless the environment variable "
13393 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13397 #: ../fish/guestfish-actions.pod:4289
13399 "Trace messages are normally sent to C<stderr>, unless you register a "
13400 "callback to send them somewhere else (see L</set-event-callback>)."
13404 #: ../fish/guestfish-actions.pod:4293
13405 msgid "set-verbose"
13409 #: ../fish/guestfish-actions.pod:4295
13414 #: ../fish/guestfish-actions.pod:4297
13417 " set-verbose true|false\n"
13422 #: ../fish/guestfish-actions.pod:4299 ../src/guestfs-actions.pod:6461
13423 msgid "If C<verbose> is true, this turns on verbose messages."
13427 #: ../fish/guestfish-actions.pod:4301 ../src/guestfs-actions.pod:6463
13429 "Verbose messages are disabled unless the environment variable "
13430 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13434 #: ../fish/guestfish-actions.pod:4304
13436 "Verbose messages are normally sent to C<stderr>, unless you register a "
13437 "callback to send them somewhere else (see L</set-event-callback>)."
13441 #: ../fish/guestfish-actions.pod:4308
13446 #: ../fish/guestfish-actions.pod:4310
13449 " setcon context\n"
13454 #: ../fish/guestfish-actions.pod:4312 ../src/guestfs-actions.pod:6480
13456 "This sets the SELinux security context of the daemon to the string "
13461 #: ../fish/guestfish-actions.pod:4315 ../src/guestfs-actions.pod:6483
13462 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13466 #: ../fish/guestfish-actions.pod:4317
13471 #: ../fish/guestfish-actions.pod:4319
13474 " setxattr xattr val vallen path\n"
13479 #: ../fish/guestfish-actions.pod:4321 ../src/guestfs-actions.pod:6498
13481 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13482 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13486 #: ../fish/guestfish-actions.pod:4325
13487 msgid "See also: L</lsetxattr>, L<attr(5)>."
13491 #: ../fish/guestfish-actions.pod:4327
13496 #: ../fish/guestfish-actions.pod:4329
13499 " sfdisk device cyls heads sectors 'lines ...'\n"
13504 #: ../fish/guestfish-actions.pod:4331 ../src/guestfs-actions.pod:6525
13506 "This is a direct interface to the L<sfdisk(8)> program for creating "
13507 "partitions on block devices."
13511 #: ../fish/guestfish-actions.pod:4334 ../src/guestfs-actions.pod:6528
13512 msgid "C<device> should be a block device, for example C</dev/sda>."
13516 #: ../fish/guestfish-actions.pod:4336 ../src/guestfs-actions.pod:6530
13518 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13519 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
13520 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13521 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13522 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13523 "the kernel) cannot work out the right geometry and you will need to tell it."
13527 #: ../fish/guestfish-actions.pod:4344 ../src/guestfs-actions.pod:6538
13529 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13530 "refer to the L<sfdisk(8)> manpage."
13534 #: ../fish/guestfish-actions.pod:4347 ../src/guestfs-actions.pod:6541
13536 "To create a single partition occupying the whole disk, you would pass "
13537 "C<lines> as a single element list, when the single element being the string "
13542 #: ../fish/guestfish-actions.pod:4351
13543 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
13547 #: ../fish/guestfish-actions.pod:4357 ../fish/guestfish-actions.pod:4380
13548 #: ../fish/guestfish-actions.pod:4402
13550 "I<This function is deprecated.> In new code, use the L</part_add> call "
13555 #: ../fish/guestfish-actions.pod:4364
13560 #: ../fish/guestfish-actions.pod:4366
13563 " sfdiskM device 'lines ...'\n"
13568 #: ../fish/guestfish-actions.pod:4368
13570 "This is a simplified interface to the L</sfdisk> command, where partition "
13571 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
13572 "you don't need to specify the cyls, heads and sectors parameters which were "
13573 "rarely if ever used anyway."
13577 #: ../fish/guestfish-actions.pod:4374
13578 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
13582 #: ../fish/guestfish-actions.pod:4387
13587 #: ../fish/guestfish-actions.pod:4389
13590 " sfdisk-N device partnum cyls heads sectors line\n"
13595 #: ../fish/guestfish-actions.pod:4391 ../src/guestfs-actions.pod:6603
13597 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13598 "(note: C<n> counts from 1)."
13602 #: ../fish/guestfish-actions.pod:4394
13604 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
13605 "cyls/heads/sectors parameters."
13609 #: ../fish/guestfish-actions.pod:4397
13610 msgid "See also: L</part-add>"
13614 #: ../fish/guestfish-actions.pod:4409
13615 msgid "sfdisk-disk-geometry"
13619 #: ../fish/guestfish-actions.pod:4411
13622 " sfdisk-disk-geometry device\n"
13627 #: ../fish/guestfish-actions.pod:4413
13629 "This displays the disk geometry of C<device> read from the partition table. "
13630 "Especially in the case where the underlying block device has been resized, "
13631 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
13632 "kernel-geometry>)."
13636 #: ../fish/guestfish-actions.pod:4418 ../fish/guestfish-actions.pod:4427
13637 #: ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6645
13638 msgid "The result is in human-readable format, and not designed to be parsed."
13642 #: ../fish/guestfish-actions.pod:4421
13643 msgid "sfdisk-kernel-geometry"
13647 #: ../fish/guestfish-actions.pod:4423
13650 " sfdisk-kernel-geometry device\n"
13655 #: ../fish/guestfish-actions.pod:4425 ../src/guestfs-actions.pod:6643
13656 msgid "This displays the kernel's idea of the geometry of C<device>."
13660 #: ../fish/guestfish-actions.pod:4430
13665 #: ../fish/guestfish-actions.pod:4432
13668 " sfdisk-l device\n"
13673 #: ../fish/guestfish-actions.pod:4434 ../src/guestfs-actions.pod:6666
13675 "This displays the partition table on C<device>, in the human-readable output "
13676 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13680 #: ../fish/guestfish-actions.pod:4438
13681 msgid "See also: L</part-list>"
13685 #: ../fish/guestfish-actions.pod:4440
13687 "I<This function is deprecated.> In new code, use the L</part_list> call "
13692 #: ../fish/guestfish-actions.pod:4447
13697 #: ../fish/guestfish-actions.pod:4449
13705 #: ../fish/guestfish-actions.pod:4451 ../src/guestfs-actions.pod:6683
13707 "This call runs a command from the guest filesystem via the guest's C</bin/"
13712 #: ../fish/guestfish-actions.pod:4454
13713 msgid "This is like L</command>, but passes the command to:"
13717 #: ../fish/guestfish-actions.pod:4456 ../src/guestfs-actions.pod:6688
13720 " /bin/sh -c \"command\"\n"
13725 #: ../fish/guestfish-actions.pod:4458 ../src/guestfs-actions.pod:6690
13727 "Depending on the guest's shell, this usually results in wildcards being "
13728 "expanded, shell expressions being interpolated and so on."
13732 #: ../fish/guestfish-actions.pod:4462
13733 msgid "All the provisos about L</command> apply to this call."
13737 #: ../fish/guestfish-actions.pod:4464
13742 #: ../fish/guestfish-actions.pod:4466
13745 " sh-lines command\n"
13750 #: ../fish/guestfish-actions.pod:4468
13751 msgid "This is the same as L</sh>, but splits the result into a list of lines."
13755 #: ../fish/guestfish-actions.pod:4471
13756 msgid "See also: L</command-lines>"
13760 #: ../fish/guestfish-actions.pod:4473
13765 #: ../fish/guestfish-actions.pod:4475
13773 #: ../fish/guestfish-actions.pod:4477 ../src/guestfs-actions.pod:6724
13774 msgid "Sleep for C<secs> seconds."
13778 #: ../fish/guestfish-actions.pod:4479
13783 #: ../fish/guestfish-actions.pod:4481
13791 #: ../fish/guestfish-actions.pod:4485 ../src/guestfs-actions.pod:6738
13792 msgid "This is the same as the C<stat(2)> system call."
13796 #: ../fish/guestfish-actions.pod:4487
13801 #: ../fish/guestfish-actions.pod:4489
13809 #: ../fish/guestfish-actions.pod:4491 ../src/guestfs-actions.pod:6752
13811 "Returns file system statistics for any mounted file system. C<path> should "
13812 "be a file or directory in the mounted file system (typically it is the mount "
13813 "point itself, but it doesn't need to be)."
13817 #: ../fish/guestfish-actions.pod:4495 ../src/guestfs-actions.pod:6756
13818 msgid "This is the same as the C<statvfs(2)> system call."
13822 #: ../fish/guestfish-actions.pod:4497
13827 #: ../fish/guestfish-actions.pod:4499
13835 #: ../fish/guestfish-actions.pod:4501 ../src/guestfs-actions.pod:6770
13837 "This runs the L<strings(1)> command on a file and returns the list of "
13838 "printable strings found."
13842 #: ../fish/guestfish-actions.pod:4507
13847 #: ../fish/guestfish-actions.pod:4509
13850 " strings-e encoding path\n"
13855 #: ../fish/guestfish-actions.pod:4511
13857 "This is like the L</strings> command, but allows you to specify the encoding "
13858 "of strings that are looked for in the source file C<path>."
13862 #: ../fish/guestfish-actions.pod:4515 ../src/guestfs-actions.pod:6793
13863 msgid "Allowed encodings are:"
13867 #: ../fish/guestfish-actions.pod:4519 ../src/guestfs-actions.pod:6797
13872 #: ../fish/guestfish-actions.pod:4521
13874 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13875 "ISO-8859-X (this is what L</strings> uses)."
13879 #: ../fish/guestfish-actions.pod:4524 ../src/guestfs-actions.pod:6802
13884 #: ../fish/guestfish-actions.pod:4526 ../src/guestfs-actions.pod:6804
13885 msgid "Single 8-bit-byte characters."
13889 #: ../fish/guestfish-actions.pod:4528 ../src/guestfs-actions.pod:6806
13894 #: ../fish/guestfish-actions.pod:4530 ../src/guestfs-actions.pod:6808
13895 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13899 #: ../fish/guestfish-actions.pod:4533 ../src/guestfs-actions.pod:6811
13900 msgid "l (lower case letter L)"
13904 #: ../fish/guestfish-actions.pod:4535 ../src/guestfs-actions.pod:6813
13906 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13907 "examining binaries in Windows guests."
13911 #: ../fish/guestfish-actions.pod:4538 ../src/guestfs-actions.pod:6816
13916 #: ../fish/guestfish-actions.pod:4540 ../src/guestfs-actions.pod:6818
13917 msgid "32-bit big endian such as UCS-4BE."
13921 #: ../fish/guestfish-actions.pod:4542 ../src/guestfs-actions.pod:6820
13926 #: ../fish/guestfish-actions.pod:4544 ../src/guestfs-actions.pod:6822
13927 msgid "32-bit little endian such as UCS-4LE."
13931 #: ../fish/guestfish-actions.pod:4548 ../src/guestfs-actions.pod:6826
13932 msgid "The returned strings are transcoded to UTF-8."
13936 #: ../fish/guestfish-actions.pod:4553
13937 msgid "swapoff-device"
13941 #: ../fish/guestfish-actions.pod:4555
13944 " swapoff-device device\n"
13949 #: ../fish/guestfish-actions.pod:4557
13951 "This command disables the libguestfs appliance swap device or partition "
13952 "named C<device>. See L</swapon-device>."
13956 #: ../fish/guestfish-actions.pod:4561
13957 msgid "swapoff-file"
13961 #: ../fish/guestfish-actions.pod:4563
13964 " swapoff-file file\n"
13969 #: ../fish/guestfish-actions.pod:4565 ../src/guestfs-actions.pod:6857
13970 msgid "This command disables the libguestfs appliance swap on file."
13974 #: ../fish/guestfish-actions.pod:4567
13975 msgid "swapoff-label"
13979 #: ../fish/guestfish-actions.pod:4569
13982 " swapoff-label label\n"
13987 #: ../fish/guestfish-actions.pod:4571 ../src/guestfs-actions.pod:6869
13989 "This command disables the libguestfs appliance swap on labeled swap "
13994 #: ../fish/guestfish-actions.pod:4574
13995 msgid "swapoff-uuid"
13999 #: ../fish/guestfish-actions.pod:4576
14002 " swapoff-uuid uuid\n"
14007 #: ../fish/guestfish-actions.pod:4578 ../src/guestfs-actions.pod:6882
14009 "This command disables the libguestfs appliance swap partition with the given "
14014 #: ../fish/guestfish-actions.pod:4581
14015 msgid "swapon-device"
14019 #: ../fish/guestfish-actions.pod:4583
14022 " swapon-device device\n"
14027 #: ../fish/guestfish-actions.pod:4585
14029 "This command enables the libguestfs appliance to use the swap device or "
14030 "partition named C<device>. The increased memory is made available for all "
14031 "commands, for example those run using L</command> or L</sh>."
14035 #: ../fish/guestfish-actions.pod:4590 ../src/guestfs-actions.pod:6900
14037 "Note that you should not swap to existing guest swap partitions unless you "
14038 "know what you are doing. They may contain hibernation information, or other "
14039 "information that the guest doesn't want you to trash. You also risk leaking "
14040 "information about the host to the guest this way. Instead, attach a new "
14041 "host device to the guest and swap on that."
14045 #: ../fish/guestfish-actions.pod:4597
14046 msgid "swapon-file"
14050 #: ../fish/guestfish-actions.pod:4599
14053 " swapon-file file\n"
14058 #: ../fish/guestfish-actions.pod:4601
14060 "This command enables swap to a file. See L</swapon-device> for other notes."
14064 #: ../fish/guestfish-actions.pod:4604
14065 msgid "swapon-label"
14069 #: ../fish/guestfish-actions.pod:4606
14072 " swapon-label label\n"
14077 #: ../fish/guestfish-actions.pod:4608
14079 "This command enables swap to a labeled swap partition. See L</swapon-"
14080 "device> for other notes."
14084 #: ../fish/guestfish-actions.pod:4611
14085 msgid "swapon-uuid"
14089 #: ../fish/guestfish-actions.pod:4613
14092 " swapon-uuid uuid\n"
14097 #: ../fish/guestfish-actions.pod:4615
14099 "This command enables swap to a swap partition with the given UUID. See L</"
14100 "swapon-device> for other notes."
14104 #: ../fish/guestfish-actions.pod:4618
14109 #: ../fish/guestfish-actions.pod:4620
14117 #: ../fish/guestfish-actions.pod:4622 ../src/guestfs-actions.pod:6955
14119 "This syncs the disk, so that any writes are flushed through to the "
14120 "underlying disk image."
14124 #: ../fish/guestfish-actions.pod:4625 ../src/guestfs-actions.pod:6958
14126 "You should always call this if you have modified a disk image, before "
14127 "closing the handle."
14131 #: ../fish/guestfish-actions.pod:4628
14136 #: ../fish/guestfish-actions.pod:4630
14144 #: ../fish/guestfish-actions.pod:4632 ../src/guestfs-actions.pod:6971
14146 "This command returns up to the last 10 lines of a file as a list of strings."
14150 #: ../fish/guestfish-actions.pod:4638
14155 #: ../fish/guestfish-actions.pod:4640
14158 " tail-n nrlines path\n"
14163 #: ../fish/guestfish-actions.pod:4642 ../src/guestfs-actions.pod:6990
14165 "If the parameter C<nrlines> is a positive number, this returns the last "
14166 "C<nrlines> lines of the file C<path>."
14170 #: ../fish/guestfish-actions.pod:4645 ../src/guestfs-actions.pod:6993
14172 "If the parameter C<nrlines> is a negative number, this returns lines from "
14173 "the file C<path>, starting with the C<-nrlines>th line."
14177 #: ../fish/guestfish-actions.pod:4653
14182 #: ../fish/guestfish-actions.pod:4655
14185 " tar-in (tarfile|-) directory\n"
14190 #: ../fish/guestfish-actions.pod:4657 ../src/guestfs-actions.pod:7014
14192 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14193 "tar file) into C<directory>."
14197 #: ../fish/guestfish-actions.pod:4660
14198 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
14202 #: ../fish/guestfish-actions.pod:4665
14207 #: ../fish/guestfish-actions.pod:4667
14210 " tar-out directory (tarfile|-)\n"
14215 #: ../fish/guestfish-actions.pod:4669 ../src/guestfs-actions.pod:7031
14217 "This command packs the contents of C<directory> and downloads it to local "
14222 #: ../fish/guestfish-actions.pod:4672
14223 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
14227 #: ../fish/guestfish-actions.pod:4677
14232 #: ../fish/guestfish-actions.pod:4679
14235 " tgz-in (tarball|-) directory\n"
14240 #: ../fish/guestfish-actions.pod:4681 ../src/guestfs-actions.pod:7048
14242 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14243 "tar file) into C<directory>."
14247 #: ../fish/guestfish-actions.pod:4684
14248 msgid "To upload an uncompressed tarball, use L</tar-in>."
14252 #: ../fish/guestfish-actions.pod:4688
14257 #: ../fish/guestfish-actions.pod:4690
14260 " tgz-out directory (tarball|-)\n"
14265 #: ../fish/guestfish-actions.pod:4692 ../src/guestfs-actions.pod:7064
14267 "This command packs the contents of C<directory> and downloads it to local "
14272 #: ../fish/guestfish-actions.pod:4695
14273 msgid "To download an uncompressed tarball, use L</tar-out>."
14277 #: ../fish/guestfish-actions.pod:4699
14282 #: ../fish/guestfish-actions.pod:4701
14290 #: ../fish/guestfish-actions.pod:4703 ../src/guestfs-actions.pod:7079
14292 "Touch acts like the L<touch(1)> command. It can be used to update the "
14293 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14298 #: ../fish/guestfish-actions.pod:4707 ../src/guestfs-actions.pod:7083
14300 "This command only works on regular files, and will fail on other file types "
14301 "such as directories, symbolic links, block special etc."
14305 #: ../fish/guestfish-actions.pod:4710
14310 #: ../fish/guestfish-actions.pod:4712
14318 #: ../fish/guestfish-actions.pod:4714 ../src/guestfs-actions.pod:7096
14320 "This command truncates C<path> to a zero-length file. The file must exist "
14325 #: ../fish/guestfish-actions.pod:4717
14326 msgid "truncate-size"
14330 #: ../fish/guestfish-actions.pod:4719
14333 " truncate-size path size\n"
14338 #: ../fish/guestfish-actions.pod:4721 ../src/guestfs-actions.pod:7110
14340 "This command truncates C<path> to size C<size> bytes. The file must exist "
14345 #: ../fish/guestfish-actions.pod:4724
14347 "If the current file size is less than C<size> then the file is extended to "
14348 "the required size with zero bytes. This creates a sparse file (ie. disk "
14349 "blocks are not allocated for the file until you write to it). To create a "
14350 "non-sparse file of zeroes, use L</fallocate64> instead."
14354 #: ../fish/guestfish-actions.pod:4730
14359 #: ../fish/guestfish-actions.pod:4732
14362 " tune2fs-l device\n"
14367 #: ../fish/guestfish-actions.pod:4734 ../src/guestfs-actions.pod:7129
14369 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14374 #: ../fish/guestfish-actions.pod:4737 ../src/guestfs-actions.pod:7132
14376 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14377 "for more details. The list of fields returned isn't clearly defined, and "
14378 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14379 "and the filesystem itself."
14383 #: ../fish/guestfish-actions.pod:4742
14388 #: ../fish/guestfish-actions.pod:4744
14391 " txz-in (tarball|-) directory\n"
14396 #: ../fish/guestfish-actions.pod:4746 ../src/guestfs-actions.pod:7152
14398 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14399 "tar file) into C<directory>."
14403 #: ../fish/guestfish-actions.pod:4751
14408 #: ../fish/guestfish-actions.pod:4753
14411 " txz-out directory (tarball|-)\n"
14416 #: ../fish/guestfish-actions.pod:4755 ../src/guestfs-actions.pod:7166
14418 "This command packs the contents of C<directory> and downloads it to local "
14419 "file C<tarball> (as an xz compressed tar archive)."
14423 #: ../fish/guestfish-actions.pod:4760
14428 #: ../fish/guestfish-actions.pod:4762
14436 #: ../fish/guestfish-actions.pod:4764 ../src/guestfs-actions.pod:7179
14438 "This function sets the mask used for creating new files and device nodes to "
14443 #: ../fish/guestfish-actions.pod:4767 ../src/guestfs-actions.pod:7182
14445 "Typical umask values would be C<022> which creates new files with "
14446 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14447 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14451 #: ../fish/guestfish-actions.pod:4772 ../src/guestfs-actions.pod:7187
14453 "The default umask is C<022>. This is important because it means that "
14454 "directories and device nodes will be created with C<0644> or C<0755> mode "
14455 "even if you specify C<0777>."
14459 #: ../fish/guestfish-actions.pod:4776
14460 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
14464 #: ../fish/guestfish-actions.pod:4779 ../src/guestfs-actions.pod:7194
14465 msgid "This call returns the previous umask."
14469 #: ../fish/guestfish-actions.pod:4781
14474 #: ../fish/guestfish-actions.pod:4783
14479 #: ../fish/guestfish-actions.pod:4785
14482 " umount pathordevice\n"
14487 #: ../fish/guestfish-actions.pod:4787 ../src/guestfs-actions.pod:7206
14489 "This unmounts the given filesystem. The filesystem may be specified either "
14490 "by its mountpoint (path) or the device which contains the filesystem."
14494 #: ../fish/guestfish-actions.pod:4791
14499 #: ../fish/guestfish-actions.pod:4793
14500 msgid "unmount-all"
14504 #: ../fish/guestfish-actions.pod:4795
14512 #: ../fish/guestfish-actions.pod:4797 ../src/guestfs-actions.pod:7219
14513 msgid "This unmounts all mounted filesystems."
14517 #: ../fish/guestfish-actions.pod:4799 ../src/guestfs-actions.pod:7221
14518 msgid "Some internal mounts are not unmounted by this call."
14522 #: ../fish/guestfish-actions.pod:4801
14527 #: ../fish/guestfish-actions.pod:4803
14530 " upload (filename|-) remotefilename\n"
14535 #: ../fish/guestfish-actions.pod:4805 ../fish/guestfish-actions.pod:4818
14536 #: ../src/guestfs-actions.pod:7234 ../src/guestfs-actions.pod:7258
14537 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14541 #: ../fish/guestfish-actions.pod:4810
14542 msgid "See also L</download>."
14546 #: ../fish/guestfish-actions.pod:4814
14547 msgid "upload-offset"
14551 #: ../fish/guestfish-actions.pod:4816
14554 " upload-offset (filename|-) remotefilename offset\n"
14559 #: ../fish/guestfish-actions.pod:4821 ../src/guestfs-actions.pod:7261
14561 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14562 "The intention is to overwrite parts of existing files or devices, although "
14563 "if a non-existant file is specified then it is created with a \"hole\" "
14564 "before C<offset>. The size of the data written is implicit in the size of "
14565 "the source C<filename>."
14569 #: ../fish/guestfish-actions.pod:4828
14571 "Note that there is no limit on the amount of data that can be uploaded with "
14572 "this call, unlike with L</pwrite>, and this call always writes the full "
14573 "amount unless an error occurs."
14577 #: ../fish/guestfish-actions.pod:4833
14578 msgid "See also L</upload>, L</pwrite>."
14582 #: ../fish/guestfish-actions.pod:4837
14587 #: ../fish/guestfish-actions.pod:4839
14590 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
14595 #: ../fish/guestfish-actions.pod:4841 ../src/guestfs-actions.pod:7294
14596 msgid "This command sets the timestamps of a file with nanosecond precision."
14600 #: ../fish/guestfish-actions.pod:4844 ../src/guestfs-actions.pod:7297
14602 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14607 #: ../fish/guestfish-actions.pod:4847 ../src/guestfs-actions.pod:7300
14609 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14610 "nanoseconds from the epoch."
14614 #: ../fish/guestfish-actions.pod:4850 ../src/guestfs-actions.pod:7303
14616 "If the C<*nsecs> field contains the special value C<-1> then the "
14617 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14618 "ignored in this case)."
14622 #: ../fish/guestfish-actions.pod:4854 ../src/guestfs-actions.pod:7307
14624 "If the C<*nsecs> field contains the special value C<-2> then the "
14625 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14630 #: ../fish/guestfish-actions.pod:4858
14635 #: ../fish/guestfish-actions.pod:4860
14643 #: ../fish/guestfish-actions.pod:4862 ../src/guestfs-actions.pod:7320
14645 "Return the libguestfs version number that the program is linked against."
14649 #: ../fish/guestfish-actions.pod:4865 ../src/guestfs-actions.pod:7323
14651 "Note that because of dynamic linking this is not necessarily the version of "
14652 "libguestfs that you compiled against. You can compile the program, and then "
14653 "at runtime dynamically link against a completely different C<libguestfs.so> "
14658 #: ../fish/guestfish-actions.pod:4870 ../src/guestfs-actions.pod:7328
14660 "This call was added in version C<1.0.58>. In previous versions of "
14661 "libguestfs there was no way to get the version number. From C code you can "
14662 "use dynamic linker functions to find out if this symbol exists (if it "
14663 "doesn't, then it's an earlier version)."
14667 #: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7334
14669 "The call returns a structure with four elements. The first three (C<major>, "
14670 "C<minor> and C<release>) are numbers and correspond to the usual version "
14671 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14672 "but may be used for distro-specific information."
14676 #: ../fish/guestfish-actions.pod:4882 ../src/guestfs-actions.pod:7340
14678 "To construct the original version string: C<$major.$minor.$release$extra>"
14682 #: ../fish/guestfish-actions.pod:4885 ../src/guestfs-actions.pod:7343
14683 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14687 #: ../fish/guestfish-actions.pod:4887
14689 "I<Note:> Don't use this call to test for availability of features. In "
14690 "enterprise distributions we backport features from later versions into "
14691 "earlier versions, making this an unreliable way to test for features. Use "
14692 "L</available> instead."
14696 #: ../fish/guestfish-actions.pod:4893
14701 #: ../fish/guestfish-actions.pod:4895
14704 " vfs-label device\n"
14709 #: ../fish/guestfish-actions.pod:4897 ../src/guestfs-actions.pod:7363
14710 msgid "This returns the filesystem label of the filesystem on C<device>."
14714 #: ../fish/guestfish-actions.pod:4900 ../src/guestfs-actions.pod:7366
14715 msgid "If the filesystem is unlabeled, this returns the empty string."
14719 #: ../fish/guestfish-actions.pod:4902
14720 msgid "To find a filesystem from the label, use L</findfs-label>."
14724 #: ../fish/guestfish-actions.pod:4904
14729 #: ../fish/guestfish-actions.pod:4906
14732 " vfs-type device\n"
14737 #: ../fish/guestfish-actions.pod:4908 ../src/guestfs-actions.pod:7381
14739 "This command gets the filesystem type corresponding to the filesystem on "
14744 #: ../fish/guestfish-actions.pod:4911 ../src/guestfs-actions.pod:7384
14746 "For most filesystems, the result is the name of the Linux VFS module which "
14747 "would be used to mount this filesystem if you mounted it without specifying "
14748 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14752 #: ../fish/guestfish-actions.pod:4916
14757 #: ../fish/guestfish-actions.pod:4918
14760 " vfs-uuid device\n"
14765 #: ../fish/guestfish-actions.pod:4920 ../src/guestfs-actions.pod:7400
14766 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14770 #: ../fish/guestfish-actions.pod:4923 ../src/guestfs-actions.pod:7403
14771 msgid "If the filesystem does not have a UUID, this returns the empty string."
14775 #: ../fish/guestfish-actions.pod:4925
14776 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
14780 #: ../fish/guestfish-actions.pod:4927
14781 msgid "vg-activate"
14785 #: ../fish/guestfish-actions.pod:4929
14788 " vg-activate true|false 'volgroups ...'\n"
14793 #: ../fish/guestfish-actions.pod:4931 ../src/guestfs-actions.pod:7419
14795 "This command activates or (if C<activate> is false) deactivates all logical "
14796 "volumes in the listed volume groups C<volgroups>."
14800 #: ../fish/guestfish-actions.pod:4934 ../src/guestfs-actions.pod:7422
14801 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14805 #: ../fish/guestfish-actions.pod:4936 ../src/guestfs-actions.pod:7424
14807 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14808 "activated or deactivated."
14812 #: ../fish/guestfish-actions.pod:4939
14813 msgid "vg-activate-all"
14817 #: ../fish/guestfish-actions.pod:4941
14820 " vg-activate-all true|false\n"
14825 #: ../fish/guestfish-actions.pod:4943 ../src/guestfs-actions.pod:7437
14827 "This command activates or (if C<activate> is false) deactivates all logical "
14828 "volumes in all volume groups."
14832 #: ../fish/guestfish-actions.pod:4946 ../src/guestfs-actions.pod:7440
14833 msgid "This command is the same as running C<vgchange -a y|n>"
14837 #: ../fish/guestfish-actions.pod:4948
14842 #: ../fish/guestfish-actions.pod:4950
14845 " vgcreate volgroup 'physvols ...'\n"
14850 #: ../fish/guestfish-actions.pod:4952 ../src/guestfs-actions.pod:7453
14852 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14853 "of physical volumes C<physvols>."
14857 #: ../fish/guestfish-actions.pod:4955
14862 #: ../fish/guestfish-actions.pod:4957
14865 " vglvuuids vgname\n"
14870 #: ../fish/guestfish-actions.pod:4959 ../src/guestfs-actions.pod:7466
14872 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14873 "volumes created in this volume group."
14877 #: ../fish/guestfish-actions.pod:4962
14879 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
14880 "logical volumes and volume groups."
14884 #: ../fish/guestfish-actions.pod:4965
14885 msgid "See also L</vgpvuuids>."
14889 #: ../fish/guestfish-actions.pod:4967
14894 #: ../fish/guestfish-actions.pod:4969
14897 " vgpvuuids vgname\n"
14902 #: ../fish/guestfish-actions.pod:4971 ../src/guestfs-actions.pod:7486
14904 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14905 "volumes that this volume group resides on."
14909 #: ../fish/guestfish-actions.pod:4974
14911 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
14912 "physical volumes and volume groups."
14916 #: ../fish/guestfish-actions.pod:4977
14917 msgid "See also L</vglvuuids>."
14921 #: ../fish/guestfish-actions.pod:4979
14926 #: ../fish/guestfish-actions.pod:4981
14929 " vgremove vgname\n"
14934 #: ../fish/guestfish-actions.pod:4983 ../src/guestfs-actions.pod:7506
14935 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14939 #: ../fish/guestfish-actions.pod:4985 ../src/guestfs-actions.pod:7508
14941 "This also forcibly removes all logical volumes in the volume group (if any)."
14945 #: ../fish/guestfish-actions.pod:4988
14950 #: ../fish/guestfish-actions.pod:4990
14953 " vgrename volgroup newvolgroup\n"
14958 #: ../fish/guestfish-actions.pod:4992 ../src/guestfs-actions.pod:7522
14959 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14963 #: ../fish/guestfish-actions.pod:4994
14968 #: ../fish/guestfish-actions.pod:4996
14976 #: ../fish/guestfish-actions.pod:4998 ../src/guestfs-actions.pod:7533
14978 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
14983 #: ../fish/guestfish-actions.pod:5001 ../src/guestfs-actions.pod:7536
14985 "This returns a list of just the volume group names that were detected (eg. "
14990 #: ../fish/guestfish-actions.pod:5004
14991 msgid "See also L</vgs-full>."
14995 #: ../fish/guestfish-actions.pod:5006
15000 #: ../fish/guestfish-actions.pod:5008
15008 #: ../fish/guestfish-actions.pod:5010 ../src/guestfs-actions.pod:7552
15010 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15011 "> command. The \"full\" version includes all fields."
15015 #: ../fish/guestfish-actions.pod:5013
15020 #: ../fish/guestfish-actions.pod:5015
15028 #: ../fish/guestfish-actions.pod:5017 ../src/guestfs-actions.pod:7566
15030 "This rescans all block devices and rebuilds the list of LVM physical "
15031 "volumes, volume groups and logical volumes."
15035 #: ../fish/guestfish-actions.pod:5020
15040 #: ../fish/guestfish-actions.pod:5022
15048 #: ../fish/guestfish-actions.pod:5024 ../src/guestfs-actions.pod:7579
15049 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15053 #: ../fish/guestfish-actions.pod:5026
15058 #: ../fish/guestfish-actions.pod:5028
15066 #: ../fish/guestfish-actions.pod:5030 ../src/guestfs-actions.pod:7619
15068 "This command counts the characters in a file, using the C<wc -c> external "
15073 #: ../fish/guestfish-actions.pod:5033
15078 #: ../fish/guestfish-actions.pod:5035
15086 #: ../fish/guestfish-actions.pod:5037 ../src/guestfs-actions.pod:7632
15088 "This command counts the lines in a file, using the C<wc -l> external command."
15092 #: ../fish/guestfish-actions.pod:5040
15097 #: ../fish/guestfish-actions.pod:5042
15105 #: ../fish/guestfish-actions.pod:5044 ../src/guestfs-actions.pod:7645
15107 "This command counts the words in a file, using the C<wc -w> external command."
15111 #: ../fish/guestfish-actions.pod:5047
15116 #: ../fish/guestfish-actions.pod:5049
15119 " write path content\n"
15124 #: ../fish/guestfish-actions.pod:5051 ../src/guestfs-actions.pod:7660
15126 "This call creates a file called C<path>. The content of the file is the "
15127 "string C<content> (which can contain any 8 bit data)."
15131 #: ../fish/guestfish-actions.pod:5054
15132 msgid "See also L</write-append>."
15136 #: ../fish/guestfish-actions.pod:5059
15137 msgid "write-append"
15141 #: ../fish/guestfish-actions.pod:5061
15144 " write-append path content\n"
15149 #: ../fish/guestfish-actions.pod:5063 ../src/guestfs-actions.pod:7680
15151 "This call appends C<content> to the end of file C<path>. If C<path> does "
15152 "not exist, then a new file is created."
15156 #: ../fish/guestfish-actions.pod:5066
15157 msgid "See also L</write>."
15161 #: ../fish/guestfish-actions.pod:5071
15166 #: ../fish/guestfish-actions.pod:5073
15169 " write-file path content size\n"
15174 #: ../fish/guestfish-actions.pod:5075 ../src/guestfs-actions.pod:7707
15176 "This call creates a file called C<path>. The contents of the file is the "
15177 "string C<content> (which can contain any 8 bit data), with length C<size>."
15181 #: ../fish/guestfish-actions.pod:5079 ../src/guestfs-actions.pod:7711
15183 "As a special case, if C<size> is C<0> then the length is calculated using "
15184 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15188 #: ../fish/guestfish-actions.pod:5083 ../src/guestfs-actions.pod:7715
15190 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15191 "I<not> work, even if the length is specified."
15195 #: ../fish/guestfish-actions.pod:5089
15197 "I<This function is deprecated.> In new code, use the L</write> call instead."
15201 #: ../fish/guestfish-actions.pod:5096
15206 #: ../fish/guestfish-actions.pod:5098
15209 " zegrep regex path\n"
15214 #: ../fish/guestfish-actions.pod:5100 ../src/guestfs-actions.pod:7732
15216 "This calls the external C<zegrep> program and returns the matching lines."
15220 #: ../fish/guestfish-actions.pod:5106
15225 #: ../fish/guestfish-actions.pod:5108
15228 " zegrepi regex path\n"
15233 #: ../fish/guestfish-actions.pod:5110 ../src/guestfs-actions.pod:7751
15235 "This calls the external C<zegrep -i> program and returns the matching lines."
15239 #: ../fish/guestfish-actions.pod:5116
15244 #: ../fish/guestfish-actions.pod:5118
15252 #: ../fish/guestfish-actions.pod:5120 ../src/guestfs-actions.pod:7769
15253 msgid "This command writes zeroes over the first few blocks of C<device>."
15257 #: ../fish/guestfish-actions.pod:5122 ../src/guestfs-actions.pod:7771
15259 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15260 "securely wipe the device). It should be sufficient to remove any partition "
15261 "tables, filesystem superblocks and so on."
15265 #: ../fish/guestfish-actions.pod:5126 ../fish/guestfish-actions.pod:5141
15266 #: ../src/guestfs-actions.pod:7775 ../src/guestfs-actions.pod:7801
15268 "If blocks are already zero, then this command avoids writing zeroes. This "
15269 "prevents the underlying device from becoming non-sparse or growing "
15274 #: ../fish/guestfish-actions.pod:5130
15275 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
15279 #: ../fish/guestfish-actions.pod:5133
15280 msgid "zero-device"
15284 #: ../fish/guestfish-actions.pod:5135
15287 " zero-device device\n"
15292 #: ../fish/guestfish-actions.pod:5137
15294 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
15295 "which just zeroes the first few blocks of a device."
15299 #: ../fish/guestfish-actions.pod:5148
15304 #: ../fish/guestfish-actions.pod:5150
15307 " zerofree device\n"
15312 #: ../fish/guestfish-actions.pod:5152 ../src/guestfs-actions.pod:7823
15314 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15315 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15316 "possible to compress the filesystem more effectively."
15320 #: ../fish/guestfish-actions.pod:5157 ../src/guestfs-actions.pod:7828
15321 msgid "You should B<not> run this program if the filesystem is mounted."
15325 #: ../fish/guestfish-actions.pod:5160 ../src/guestfs-actions.pod:7831
15327 "It is possible that using this program can damage the filesystem or data on "
15332 #: ../fish/guestfish-actions.pod:5163
15337 #: ../fish/guestfish-actions.pod:5165
15340 " zfgrep pattern path\n"
15345 #: ../fish/guestfish-actions.pod:5167 ../src/guestfs-actions.pod:7845
15347 "This calls the external C<zfgrep> program and returns the matching lines."
15351 #: ../fish/guestfish-actions.pod:5173
15356 #: ../fish/guestfish-actions.pod:5175
15359 " zfgrepi pattern path\n"
15364 #: ../fish/guestfish-actions.pod:5177 ../src/guestfs-actions.pod:7864
15366 "This calls the external C<zfgrep -i> program and returns the matching lines."
15370 #: ../fish/guestfish-actions.pod:5183
15375 #: ../fish/guestfish-actions.pod:5185
15378 " zfile meth path\n"
15383 #: ../fish/guestfish-actions.pod:5187 ../src/guestfs-actions.pod:7890
15385 "This command runs C<file> after first decompressing C<path> using C<method>."
15389 #: ../fish/guestfish-actions.pod:5190 ../src/guestfs-actions.pod:7893
15390 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15394 #: ../fish/guestfish-actions.pod:5192
15396 "Since 1.0.63, use L</file> instead which can now process compressed files."
15400 #: ../fish/guestfish-actions.pod:5195
15402 "I<This function is deprecated.> In new code, use the L</file> call instead."
15406 #: ../fish/guestfish-actions.pod:5202
15411 #: ../fish/guestfish-actions.pod:5204
15414 " zgrep regex path\n"
15419 #: ../fish/guestfish-actions.pod:5206 ../src/guestfs-actions.pod:7910
15421 "This calls the external C<zgrep> program and returns the matching lines."
15425 #: ../fish/guestfish-actions.pod:5212
15430 #: ../fish/guestfish-actions.pod:5214
15433 " zgrepi regex path\n"
15438 #: ../fish/guestfish-actions.pod:5216 ../src/guestfs-actions.pod:7929
15440 "This calls the external C<zgrep -i> program and returns the matching lines."
15444 #: ../fish/guestfish-commands.pod:1
15449 #: ../fish/guestfish-commands.pod:3
15454 #: ../fish/guestfish-commands.pod:5
15457 " alloc filename size\n"
15462 #: ../fish/guestfish-commands.pod:7
15464 "This creates an empty (zeroed) file of the given size, and then adds so it "
15465 "can be further examined."
15469 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:193
15470 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
15474 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:195
15475 msgid "Size can be specified using standard suffixes, eg. C<1M>."
15479 #: ../fish/guestfish-commands.pod:14
15481 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
15482 "image, see L</PREPARED DISK IMAGES>."
15486 #: ../fish/guestfish-commands.pod:17
15491 #: ../fish/guestfish-commands.pod:19
15494 " copy-in local [local ...] /remotedir\n"
15499 #: ../fish/guestfish-commands.pod:21
15501 "C<copy-in> copies local files or directories recursively into the disk "
15502 "image, placing them in the directory called C</remotedir> (which must "
15503 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
15504 "other commands as necessary."
15508 #: ../fish/guestfish-commands.pod:26
15510 "Multiple local files and directories can be specified, but the last "
15511 "parameter must always be a remote directory. Wildcards cannot be used."
15515 #: ../fish/guestfish-commands.pod:30
15520 #: ../fish/guestfish-commands.pod:32
15523 " copy-out remote [remote ...] localdir\n"
15528 #: ../fish/guestfish-commands.pod:34
15530 "C<copy-out> copies remote files or directories recursively out of the disk "
15531 "image, placing them on the host disk in a local directory called C<localdir> "
15532 "(which must exist). This guestfish meta-command turns into a sequence of L</"
15533 "download>, L</tar-out> and other commands as necessary."
15537 #: ../fish/guestfish-commands.pod:40
15539 "Multiple remote files and directories can be specified, but the last "
15540 "parameter must always be a local directory. To download to the current "
15541 "directory, use C<.> as in:"
15545 #: ../fish/guestfish-commands.pod:44
15548 " copy-out /home .\n"
15553 #: ../fish/guestfish-commands.pod:46
15555 "Wildcards cannot be used in the ordinary command, but you can use them with "
15556 "the help of L</glob> like this:"
15560 #: ../fish/guestfish-commands.pod:49
15563 " glob copy-out /home/* .\n"
15568 #: ../fish/guestfish-commands.pod:51
15573 #: ../fish/guestfish-commands.pod:53
15576 " display filename\n"
15581 #: ../fish/guestfish-commands.pod:55
15583 "Use C<display> (a graphical display program) to display an image file. It "
15584 "downloads the file, and runs C<display> on it."
15588 #: ../fish/guestfish-commands.pod:58
15590 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
15591 "environment variable. For example to use the GNOME display program:"
15595 #: ../fish/guestfish-commands.pod:61
15598 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
15603 #: ../fish/guestfish-commands.pod:63
15604 msgid "See also L<display(1)>."
15608 #: ../fish/guestfish-commands.pod:65
15613 #: ../fish/guestfish-commands.pod:67
15616 " echo [params ...]\n"
15621 #: ../fish/guestfish-commands.pod:69
15622 msgid "This echos the parameters to the terminal."
15626 #: ../fish/guestfish-commands.pod:71
15631 #: ../fish/guestfish-commands.pod:73
15636 #: ../fish/guestfish-commands.pod:75
15641 #: ../fish/guestfish-commands.pod:77
15649 #: ../fish/guestfish-commands.pod:79
15651 "This is used to edit a file. It downloads the file, edits it locally using "
15652 "your editor, then uploads the result."
15656 #: ../fish/guestfish-commands.pod:82
15658 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
15659 "or C<emacs> you will get those corresponding editors."
15663 #: ../fish/guestfish-commands.pod:86
15668 #: ../fish/guestfish-commands.pod:88
15671 " glob command args...\n"
15676 #: ../fish/guestfish-commands.pod:90
15678 "Expand wildcards in any paths in the args list, and run C<command> "
15679 "repeatedly on each matching path."
15683 #: ../fish/guestfish-commands.pod:93
15684 msgid "See L</WILDCARDS AND GLOBBING>."
15688 #: ../fish/guestfish-commands.pod:95
15693 #: ../fish/guestfish-commands.pod:97
15696 " hexedit <filename|device>\n"
15697 " hexedit <filename|device> <max>\n"
15698 " hexedit <filename|device> <start> <max>\n"
15703 #: ../fish/guestfish-commands.pod:101
15705 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
15710 #: ../fish/guestfish-commands.pod:104
15712 "This command works by downloading potentially the whole file or device, "
15713 "editing it locally, then uploading it. If the file or device is large, you "
15714 "have to specify which part you wish to edit by using C<max> and/or C<start> "
15715 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
15716 "usual modifiers allowed such as C<1M> (1 megabyte)."
15720 #: ../fish/guestfish-commands.pod:111
15721 msgid "For example to edit the first few sectors of a disk you might do:"
15725 #: ../fish/guestfish-commands.pod:114
15728 " hexedit /dev/sda 1M\n"
15733 #: ../fish/guestfish-commands.pod:116
15735 "which would allow you to edit anywhere within the first megabyte of the disk."
15739 #: ../fish/guestfish-commands.pod:119
15740 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
15744 #: ../fish/guestfish-commands.pod:121
15747 " hexedit /dev/sda1 0x400 0x400\n"
15752 #: ../fish/guestfish-commands.pod:123
15753 msgid "(assuming the superblock is in the standard location)."
15757 #: ../fish/guestfish-commands.pod:125
15759 "This command requires the external L<hexedit(1)> program. You can specify "
15760 "another program to use by setting the C<HEXEDITOR> environment variable."
15764 #: ../fish/guestfish-commands.pod:129
15765 msgid "See also L</hexdump>."
15769 #: ../fish/guestfish-commands.pod:131
15774 #: ../fish/guestfish-commands.pod:133
15782 #: ../fish/guestfish-commands.pod:135
15784 "Change the local directory, ie. the current directory of guestfish itself."
15788 #: ../fish/guestfish-commands.pod:138
15789 msgid "Note that C<!cd> won't do what you might expect."
15793 #: ../fish/guestfish-commands.pod:140
15798 #: ../fish/guestfish-commands.pod:142
15803 #: ../fish/guestfish-commands.pod:144
15811 #: ../fish/guestfish-commands.pod:146
15812 msgid "Opens the manual page for guestfish."
15816 #: ../fish/guestfish-commands.pod:148
15821 #: ../fish/guestfish-commands.pod:150
15826 #: ../fish/guestfish-commands.pod:152
15834 #: ../fish/guestfish-commands.pod:154
15842 #: ../fish/guestfish-commands.pod:156
15843 msgid "This is used to view a file."
15847 #: ../fish/guestfish-commands.pod:158
15849 "The default viewer is C<$PAGER>. However if you use the alternate command "
15850 "C<less> you will get the C<less> command specifically."
15854 #: ../fish/guestfish-commands.pod:161
15859 #: ../fish/guestfish-commands.pod:163
15867 #: ../fish/guestfish-commands.pod:165
15869 "Close and reopen the libguestfs handle. It is not necessary to use this "
15870 "normally, because the handle is closed properly when guestfish exits. "
15871 "However this is occasionally useful for testing."
15875 #: ../fish/guestfish-commands.pod:169
15880 #: ../fish/guestfish-commands.pod:171
15883 " setenv VAR value\n"
15888 #: ../fish/guestfish-commands.pod:173
15889 msgid "Set the environment variable C<VAR> to the string C<value>."
15893 #: ../fish/guestfish-commands.pod:175
15895 "To print the value of an environment variable use a shell command such as:"
15899 #: ../fish/guestfish-commands.pod:178
15907 #: ../fish/guestfish-commands.pod:180
15912 #: ../fish/guestfish-commands.pod:182
15915 " sparse filename size\n"
15920 #: ../fish/guestfish-commands.pod:184
15922 "This creates an empty sparse file of the given size, and then adds so it can "
15923 "be further examined."
15927 #: ../fish/guestfish-commands.pod:187
15929 "In all respects it works the same as the L</alloc> command, except that the "
15930 "image file is allocated sparsely, which means that disk blocks are not "
15931 "assigned to the file until they are needed. Sparse disk files only use "
15932 "space when written to, but they are slower and there is a danger you could "
15933 "run out of real disk space during a write operation."
15937 #: ../fish/guestfish-commands.pod:197
15942 #: ../fish/guestfish-commands.pod:199
15950 #: ../fish/guestfish-commands.pod:201
15952 "This command returns a list of the optional groups known to the daemon, and "
15953 "indicates which ones are supported by this build of the libguestfs appliance."
15957 #: ../fish/guestfish-commands.pod:205
15958 msgid "See also L<guestfs(3)/AVAILABILITY>."
15962 #: ../fish/guestfish-commands.pod:207
15967 #: ../fish/guestfish-commands.pod:209
15970 " time command args...\n"
15975 #: ../fish/guestfish-commands.pod:211
15977 "Run the command as usual, but print the elapsed time afterwards. This can "
15978 "be useful for benchmarking operations."
15982 #: ../fish/guestfish-commands.pod:214
15987 #: ../fish/guestfish-commands.pod:216
15995 #: ../fish/guestfish-commands.pod:218
15996 msgid "Remove C<VAR> from the environment."
16000 #: ../fish/guestfish.pod:5
16001 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16005 #: ../fish/guestfish.pod:9
16008 " guestfish [--options] [commands]\n"
16013 #: ../fish/guestfish.pod:11
16021 #: ../fish/guestfish.pod:13
16024 " guestfish [--ro|--rw] -a disk.img\n"
16029 #: ../fish/guestfish.pod:15
16032 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16037 #: ../fish/guestfish.pod:17
16040 " guestfish -d libvirt-domain\n"
16045 #: ../fish/guestfish.pod:19
16048 " guestfish [--ro|--rw] -a disk.img -i\n"
16053 #: ../fish/guestfish.pod:21
16056 " guestfish -d libvirt-domain -i\n"
16061 #: ../fish/guestfish.pod:25
16063 "Using guestfish in read/write mode on live virtual machines can be "
16064 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16065 "option to use guestfish safely if the disk image or virtual machine might be "
16070 #: ../fish/guestfish.pod:32
16072 "Guestfish is a shell and command-line tool for examining and modifying "
16073 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16074 "functionality of the guestfs API, see L<guestfs(3)>."
16078 #: ../fish/guestfish.pod:36
16080 "Guestfish gives you structured access to the libguestfs API, from shell "
16081 "scripts or the command line or interactively. If you want to rescue a "
16082 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16087 #: ../fish/guestfish.pod:43
16088 msgid "As an interactive shell"
16092 #: ../fish/guestfish.pod:45
16100 #: ../fish/guestfish.pod:47
16103 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16104 " editing virtual machine filesystems.\n"
16109 #: ../fish/guestfish.pod:50
16112 " Type: 'help' for a list of commands\n"
16113 " 'man' to read the manual\n"
16114 " 'quit' to quit the shell\n"
16119 #: ../fish/guestfish.pod:54
16122 " ><fs> add-ro disk.img\n"
16124 " ><fs> list-filesystems\n"
16125 " /dev/sda1: ext4\n"
16126 " /dev/vg_guest/lv_root: ext4\n"
16127 " /dev/vg_guest/lv_swap: swap\n"
16128 " ><fs> mount /dev/vg_guest/lv_root /\n"
16129 " ><fs> cat /etc/fstab\n"
16131 " # Created by anaconda\n"
16138 #: ../fish/guestfish.pod:67
16139 msgid "From shell scripts"
16143 #: ../fish/guestfish.pod:69
16144 msgid "Create a new C</etc/motd> file in a guest or disk image:"
16148 #: ../fish/guestfish.pod:71
16151 " guestfish <<_EOF_\n"
16154 " mount /dev/vg_guest/lv_root /\n"
16155 " write /etc/motd \"Welcome, new users\"\n"
16161 #: ../fish/guestfish.pod:78
16162 msgid "List the LVM logical volumes in a disk image:"
16166 #: ../fish/guestfish.pod:80
16169 " guestfish -a disk.img --ro <<_EOF_\n"
16177 #: ../fish/guestfish.pod:85
16178 msgid "List all the filesystems in a disk image:"
16182 #: ../fish/guestfish.pod:87
16185 " guestfish -a disk.img --ro <<_EOF_\n"
16187 " list-filesystems\n"
16193 #: ../fish/guestfish.pod:92
16194 msgid "On one command line"
16198 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
16199 msgid "Update C</etc/resolv.conf> in a guest:"
16203 #: ../fish/guestfish.pod:96
16207 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16208 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16213 #: ../fish/guestfish.pod:100
16214 msgid "Edit C</boot/grub/grub.conf> interactively:"
16218 #: ../fish/guestfish.pod:102
16221 " guestfish --rw --add disk.img \\\n"
16222 " --mount /dev/vg_guest/lv_root \\\n"
16223 " --mount /dev/sda1:/boot \\\n"
16224 " edit /boot/grub/grub.conf\n"
16229 #: ../fish/guestfish.pod:107
16230 msgid "Mount disks automatically"
16234 #: ../fish/guestfish.pod:109
16236 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
16240 #: ../fish/guestfish.pod:112
16243 " guestfish --ro -a disk.img -i cat /etc/group\n"
16248 #: ../fish/guestfish.pod:114
16251 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16256 #: ../fish/guestfish.pod:116
16257 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16261 #: ../fish/guestfish.pod:118
16264 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16269 #: ../fish/guestfish.pod:120
16270 msgid "As a script interpreter"
16274 #: ../fish/guestfish.pod:122
16275 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16279 #: ../fish/guestfish.pod:124
16282 " #!/usr/bin/guestfish -f\n"
16283 " sparse test1.img 100M\n"
16285 " part-disk /dev/sda mbr\n"
16286 " mkfs ext2 /dev/sda1\n"
16291 #: ../fish/guestfish.pod:130
16292 msgid "Start with a prepared disk"
16296 #: ../fish/guestfish.pod:132
16298 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16299 "single ext2-formatted partition:"
16303 #: ../fish/guestfish.pod:135
16306 " guestfish -N fs\n"
16311 #: ../fish/guestfish.pod:137
16312 msgid "To list what is available do:"
16316 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1009
16319 " guestfish -N help | less\n"
16324 #: ../fish/guestfish.pod:141
16325 msgid "Remote control"
16329 #: ../fish/guestfish.pod:143
16332 " eval \"`guestfish --listen`\"\n"
16333 " guestfish --remote add-ro disk.img\n"
16334 " guestfish --remote run\n"
16335 " guestfish --remote lvs\n"
16340 #: ../fish/guestfish.pod:154
16341 msgid "Displays general help on options."
16345 #: ../fish/guestfish.pod:158
16346 msgid "B<--cmd-help>"
16350 #: ../fish/guestfish.pod:160
16351 msgid "Lists all available guestfish commands."
16355 #: ../fish/guestfish.pod:162
16360 #: ../fish/guestfish.pod:164
16361 msgid "B<--cmd-help cmd>"
16365 #: ../fish/guestfish.pod:166
16366 msgid "Displays detailed help on a single command C<cmd>."
16370 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:87
16371 msgid "B<-a image>"
16375 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:89
16376 msgid "B<--add image>"
16380 #: ../fish/guestfish.pod:172
16381 msgid "Add a block device or virtual machine image to the shell."
16385 #: ../fish/guestfish.pod:177
16387 "Using this flag is mostly equivalent to using the C<add> command, with "
16388 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
16389 "the I<--format=...> flag was given."
16393 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:100
16395 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16396 "URI to use. The default is to use the default libvirt connection."
16400 #: ../fish/guestfish.pod:189
16405 #: ../fish/guestfish.pod:191
16407 "If using the I<--listen> option and a csh-like shell, use this option. See "
16408 "section L</REMOTE CONTROL AND CSH> below."
16412 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:104
16413 msgid "B<-d libvirt-domain>"
16417 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:106
16418 msgid "B<--domain libvirt-domain>"
16422 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:108
16424 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16425 "used, then any libvirt domain can be used. However in write mode, only "
16426 "libvirt domains which are shut down can be named here."
16430 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:112
16431 msgid "Domain UUIDs can be used instead of names."
16435 #: ../fish/guestfish.pod:204
16437 "Using this flag is mostly equivalent to using the C<add-domain> command, "
16438 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
16439 "if the I<--format:...> flag was given."
16443 #: ../fish/guestfish.pod:208
16448 #: ../fish/guestfish.pod:210
16449 msgid "B<--no-dest-paths>"
16453 #: ../fish/guestfish.pod:212
16455 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16456 "to hit the tab key to complete paths on the guest filesystem, but this "
16457 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16458 "allow this feature to be disabled."
16462 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:128
16464 "When prompting for keys and passphrases, guestfish normally turns echoing "
16465 "off so you cannot see what you are typing. If you are not worried about "
16466 "Tempest attacks and there is no one else in the room you can specify this "
16467 "flag to see what you are typing."
16471 #: ../fish/guestfish.pod:224
16476 #: ../fish/guestfish.pod:226
16477 msgid "B<--file file>"
16481 #: ../fish/guestfish.pod:228
16482 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16486 #: ../fish/guestfish.pod:231
16489 " #!/usr/bin/guestfish -f\n"
16494 #: ../fish/guestfish.pod:244
16497 " guestfish --format=raw -a disk.img\n"
16502 #: ../fish/guestfish.pod:248
16505 " guestfish --format=raw -a disk.img --format -a another.img\n"
16510 #: ../fish/guestfish.pod:253
16512 "If you have untrusted raw-format guest disk images, you should use this "
16513 "option to specify the disk format. This avoids a possible security problem "
16514 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16518 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:157
16519 msgid "B<--inspector>"
16523 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:159
16525 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16526 "system and mount filesystems as they would be mounted on the real virtual "
16531 #: ../fish/guestfish.pod:266
16532 msgid "Typical usage is either:"
16536 #: ../fish/guestfish.pod:268
16539 " guestfish -d myguest -i\n"
16544 #: ../fish/guestfish.pod:270
16545 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16549 #: ../fish/guestfish.pod:272
16552 " guestfish --ro -d myguest -i\n"
16557 #: ../fish/guestfish.pod:274
16558 msgid "(for active domains, readonly), or specify the block device directly:"
16562 #: ../fish/guestfish.pod:276
16565 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16570 #: ../fish/guestfish.pod:278
16572 "Note that the command line syntax changed slightly over older versions of "
16573 "guestfish. You can still use the old syntax:"
16577 #: ../fish/guestfish.pod:281
16580 " guestfish [--ro] -i disk.img\n"
16585 #: ../fish/guestfish.pod:283
16588 " guestfish [--ro] -i libvirt-domain\n"
16593 #: ../fish/guestfish.pod:285
16595 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
16596 "then using other commands to mount the filesystems that were found."
16600 #: ../fish/guestfish.pod:294
16601 msgid "B<--listen>"
16605 #: ../fish/guestfish.pod:296
16607 "Fork into the background and listen for remote commands. See section L</"
16608 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16612 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:168
16617 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:170
16619 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
16620 "ATTACHING TO RUNNING DAEMONS>)."
16624 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:173
16625 msgid "B<-m dev[:mountpoint[:options]]>"
16629 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:175
16630 msgid "B<--mount dev[:mountpoint[:options]]>"
16634 #: ../fish/guestfish.pod:308
16635 msgid "Mount the named partition or logical volume on the given mountpoint."
16639 #: ../fish/guestfish.pod:310
16640 msgid "If the mountpoint is omitted, it defaults to C</>."
16644 #: ../fish/guestfish.pod:312
16645 msgid "You have to mount something on C</> before most commands will work."
16649 #: ../fish/guestfish.pod:314
16651 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16656 #: ../fish/guestfish.pod:317
16658 "If you don't know what filesystems a disk image contains, you can either run "
16659 "guestfish without this option, then list the partitions, filesystems and LVs "
16660 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
16661 "commands), or you can use the L<virt-filesystems(1)> program."
16665 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:183
16667 "The third (and rarely used) part of the mount parameter is the list of mount "
16668 "options used to mount the underlying filesystem. If this is not given, then "
16669 "the mount options are either the empty string or C<ro> (the latter if the "
16670 "I<--ro> flag is used). By specifying the mount options, you override this "
16671 "default choice. Probably the only time you would use this is to enable ACLs "
16672 "and/or extended attributes if the filesystem can support them:"
16676 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:191
16679 " -m /dev/sda1:/:acl,user_xattr\n"
16684 #: ../fish/guestfish.pod:333
16685 msgid "Using this flag is equivalent to using the C<mount-options> command."
16689 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:193
16690 #: ../resize/virt-resize.pod:352
16695 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:195
16696 msgid "B<--no-sync>"
16700 #: ../fish/guestfish.pod:339
16702 "Disable autosync. This is enabled by default. See the discussion of "
16703 "autosync in the L<guestfs(3)> manpage."
16707 #: ../fish/guestfish.pod:342
16712 #: ../fish/guestfish.pod:344
16713 msgid "B<--new type>"
16717 #: ../fish/guestfish.pod:346
16722 #: ../fish/guestfish.pod:348
16724 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16725 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16726 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16731 #: ../fish/guestfish.pod:353
16732 msgid "B<--progress-bars>"
16736 #: ../fish/guestfish.pod:355
16737 msgid "Enable progress bars, even when guestfish is used non-interactively."
16741 #: ../fish/guestfish.pod:357
16743 "Progress bars are enabled by default when guestfish is used as an "
16744 "interactive shell."
16748 #: ../fish/guestfish.pod:360
16749 msgid "B<--no-progress-bars>"
16753 #: ../fish/guestfish.pod:362
16754 msgid "Disable progress bars."
16758 #: ../fish/guestfish.pod:364
16759 msgid "B<--remote[=pid]>"
16763 #: ../fish/guestfish.pod:366
16765 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16766 "CONTROL GUESTFISH OVER A SOCKET> below."
16770 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:239
16771 #: ../rescue/virt-rescue.pod:161
16776 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:241
16777 #: ../rescue/virt-rescue.pod:163
16782 #: ../fish/guestfish.pod:373
16784 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16785 "mounts are done read-only."
16789 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
16791 "The option must always be used if the disk image or virtual machine might be "
16792 "running, and is generally recommended in cases where you don't need write "
16793 "access to the disk."
16797 #: ../fish/guestfish.pod:380
16799 "Note that prepared disk images created with I<-N> are not affected by this "
16800 "option. Also commands like C<add> are not affected - you have to specify "
16801 "the C<readonly:true> option explicitly if you need it."
16805 #: ../fish/guestfish.pod:384
16806 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
16810 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:253
16811 #: ../rescue/virt-rescue.pod:173
16812 msgid "B<--selinux>"
16816 #: ../fish/guestfish.pod:388
16817 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16821 #: ../fish/guestfish.pod:394
16823 "Enable very verbose messages. This is particularly useful if you find a bug."
16827 #: ../fish/guestfish.pod:401
16828 msgid "Display the guestfish / libguestfs version number and exit."
16832 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:269
16833 #: ../rescue/virt-rescue.pod:190
16838 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:271
16839 #: ../rescue/virt-rescue.pod:192
16844 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:273
16846 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16847 "mounts are done read-write."
16851 #: ../fish/guestfish.pod:410
16852 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
16856 #: ../fish/guestfish.pod:414
16857 msgid "Echo each command before executing it."
16861 #: ../fish/guestfish.pod:418
16862 msgid "COMMANDS ON COMMAND LINE"
16866 #: ../fish/guestfish.pod:420
16868 "Any additional (non-option) arguments are treated as commands to execute."
16872 #: ../fish/guestfish.pod:423
16874 "Commands to execute should be separated by a colon (C<:>), where the colon "
16875 "is a separate parameter. Thus:"
16879 #: ../fish/guestfish.pod:426
16882 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16887 #: ../fish/guestfish.pod:428
16889 "If there are no additional arguments, then we enter a shell, either an "
16890 "interactive shell with a prompt (if the input is a terminal) or a non-"
16891 "interactive shell."
16895 #: ../fish/guestfish.pod:432
16897 "In either command line mode or non-interactive shell, the first command that "
16898 "gives an error causes the whole shell to exit. In interactive mode (with a "
16899 "prompt) if a command fails, you can continue to enter commands."
16903 #: ../fish/guestfish.pod:437
16904 msgid "USING launch (OR run)"
16908 #: ../fish/guestfish.pod:439
16910 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16911 "then launch it, then mount any disks you need, and finally issue actions/"
16912 "commands. So the general order of the day is:"
16916 #: ../fish/guestfish.pod:447
16917 msgid "add or -a/--add"
16921 #: ../fish/guestfish.pod:451
16922 msgid "launch (aka run)"
16926 #: ../fish/guestfish.pod:455
16927 msgid "mount or -m/--mount"
16931 #: ../fish/guestfish.pod:459
16932 msgid "any other commands"
16936 #: ../fish/guestfish.pod:463
16938 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16939 "guest before mounting or performing any other commands."
16943 #: ../fish/guestfish.pod:466
16945 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16946 "I<--new> options were given then C<run> is done automatically, simply "
16947 "because guestfish can't perform the action you asked for without doing this."
16951 #: ../fish/guestfish.pod:471
16952 msgid "OPENING DISKS FOR READ AND WRITE"
16956 #: ../fish/guestfish.pod:473
16958 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
16959 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
16960 "I<-i> and I<-m> open disk images read-only or for writing."
16964 #: ../fish/guestfish.pod:478
16966 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
16967 "opening disk images supplied on the command line for write. To open a disk "
16968 "image read-only you have to do I<-a image --ro>."
16972 #: ../fish/guestfish.pod:482
16974 "This matters: If you accidentally open a live VM disk image writable then "
16975 "you will cause irreversible disk corruption."
16979 #: ../fish/guestfish.pod:485
16981 "In a future libguestfs we intend to change the default the other way. Disk "
16982 "images will be opened read-only. You will have to either specify "
16983 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
16984 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
16985 "access for disk images specified by those other command line options."
16989 #: ../fish/guestfish.pod:492
16991 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
16992 "which does nothing (it is already the default). However it is highly "
16993 "recommended that you use this option to indicate that you need write access, "
16994 "and prepare your scripts for the day when this option will be required for "
16999 #: ../fish/guestfish.pod:498
17001 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17002 "other libguestfs program apart from guestfish and guestmount."
17006 #: ../fish/guestfish.pod:501
17011 #: ../fish/guestfish.pod:503
17013 "You can quote ordinary parameters using either single or double quotes. For "
17018 #: ../fish/guestfish.pod:506
17021 " add \"file with a space.img\"\n"
17026 #: ../fish/guestfish.pod:508
17029 " rm '/file name'\n"
17034 #: ../fish/guestfish.pod:510
17042 #: ../fish/guestfish.pod:512
17044 "A few commands require a list of strings to be passed. For these, use a "
17045 "whitespace-separated list, enclosed in quotes. Strings containing "
17046 "whitespace to be passed through must be enclosed in single quotes. A "
17047 "literal single quote must be escaped with a backslash."
17051 #: ../fish/guestfish.pod:517
17054 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17055 " command \"/bin/echo 'foo bar'\"\n"
17056 " command \"/bin/echo \\'foo\\'\"\n"
17061 #: ../fish/guestfish.pod:521
17062 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
17066 #: ../fish/guestfish.pod:523
17068 "In double-quoted arguments (only) use backslash to insert special characters:"
17072 #: ../fish/guestfish.pod:528
17077 #: ../fish/guestfish.pod:530
17078 msgid "Alert (bell) character."
17082 #: ../fish/guestfish.pod:532
17087 #: ../fish/guestfish.pod:534
17088 msgid "Backspace character."
17092 #: ../fish/guestfish.pod:536
17097 #: ../fish/guestfish.pod:538
17098 msgid "Form feed character."
17102 #: ../fish/guestfish.pod:540
17107 #: ../fish/guestfish.pod:542
17108 msgid "Newline character."
17112 #: ../fish/guestfish.pod:544
17117 #: ../fish/guestfish.pod:546
17118 msgid "Carriage return character."
17122 #: ../fish/guestfish.pod:548
17127 #: ../fish/guestfish.pod:550
17128 msgid "Horizontal tab character."
17132 #: ../fish/guestfish.pod:552
17137 #: ../fish/guestfish.pod:554
17138 msgid "Vertical tab character."
17142 #: ../fish/guestfish.pod:556
17147 #: ../fish/guestfish.pod:558
17148 msgid "A literal double quote character."
17152 #: ../fish/guestfish.pod:560
17157 #: ../fish/guestfish.pod:562
17159 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
17164 #: ../fish/guestfish.pod:565
17169 #: ../fish/guestfish.pod:567
17171 "A character with hex value I<hh>. There must be precisely 2 hex digits."
17175 #: ../fish/guestfish.pod:570
17177 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
17182 #: ../fish/guestfish.pod:573
17187 #: ../fish/guestfish.pod:575
17188 msgid "A literal backslash character."
17192 #: ../fish/guestfish.pod:579
17193 msgid "OPTIONAL ARGUMENTS"
17197 #: ../fish/guestfish.pod:581
17199 "Some commands take optional arguments. These arguments appear in this "
17200 "documentation as C<[argname:..]>. You can use them as in these examples:"
17204 #: ../fish/guestfish.pod:585
17207 " add-drive-opts filename\n"
17212 #: ../fish/guestfish.pod:587
17215 " add-drive-opts filename readonly:true\n"
17220 #: ../fish/guestfish.pod:589
17223 " add-drive-opts filename format:qcow2 readonly:false\n"
17228 #: ../fish/guestfish.pod:591
17230 "Each optional argument can appear at most once. All optional arguments must "
17231 "appear after the required ones."
17235 #: ../fish/guestfish.pod:594
17240 #: ../fish/guestfish.pod:596
17242 "This section applies to all commands which can take integers as parameters."
17246 #: ../fish/guestfish.pod:599
17247 msgid "SIZE SUFFIX"
17251 #: ../fish/guestfish.pod:601
17253 "When the command takes a parameter measured in bytes, you can use one of the "
17254 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17258 #: ../fish/guestfish.pod:607
17259 msgid "B<k> or B<K> or B<KiB>"
17263 #: ../fish/guestfish.pod:609
17264 msgid "The size in kilobytes (multiplied by 1024)."
17268 #: ../fish/guestfish.pod:611
17273 #: ../fish/guestfish.pod:613
17274 msgid "The size in SI 1000 byte units."
17278 #: ../fish/guestfish.pod:615
17279 msgid "B<M> or B<MiB>"
17283 #: ../fish/guestfish.pod:617
17284 msgid "The size in megabytes (multiplied by 1048576)."
17288 #: ../fish/guestfish.pod:619
17293 #: ../fish/guestfish.pod:621
17294 msgid "The size in SI 1000000 byte units."
17298 #: ../fish/guestfish.pod:623
17299 msgid "B<G> or B<GiB>"
17303 #: ../fish/guestfish.pod:625
17304 msgid "The size in gigabytes (multiplied by 2**30)."
17308 #: ../fish/guestfish.pod:627
17313 #: ../fish/guestfish.pod:629
17314 msgid "The size in SI 10**9 byte units."
17318 #: ../fish/guestfish.pod:631
17319 msgid "B<T> or B<TiB>"
17323 #: ../fish/guestfish.pod:633
17324 msgid "The size in terabytes (multiplied by 2**40)."
17328 #: ../fish/guestfish.pod:635
17333 #: ../fish/guestfish.pod:637
17334 msgid "The size in SI 10**12 byte units."
17338 #: ../fish/guestfish.pod:639
17339 msgid "B<P> or B<PiB>"
17343 #: ../fish/guestfish.pod:641
17344 msgid "The size in petabytes (multiplied by 2**50)."
17348 #: ../fish/guestfish.pod:643
17353 #: ../fish/guestfish.pod:645
17354 msgid "The size in SI 10**15 byte units."
17358 #: ../fish/guestfish.pod:647
17359 msgid "B<E> or B<EiB>"
17363 #: ../fish/guestfish.pod:649
17364 msgid "The size in exabytes (multiplied by 2**60)."
17368 #: ../fish/guestfish.pod:651
17373 #: ../fish/guestfish.pod:653
17374 msgid "The size in SI 10**18 byte units."
17378 #: ../fish/guestfish.pod:655
17379 msgid "B<Z> or B<ZiB>"
17383 #: ../fish/guestfish.pod:657
17384 msgid "The size in zettabytes (multiplied by 2**70)."
17388 #: ../fish/guestfish.pod:659
17393 #: ../fish/guestfish.pod:661
17394 msgid "The size in SI 10**21 byte units."
17398 #: ../fish/guestfish.pod:663
17399 msgid "B<Y> or B<YiB>"
17403 #: ../fish/guestfish.pod:665
17404 msgid "The size in yottabytes (multiplied by 2**80)."
17408 #: ../fish/guestfish.pod:667
17413 #: ../fish/guestfish.pod:669
17414 msgid "The size in SI 10**24 byte units."
17418 #: ../fish/guestfish.pod:675
17421 " truncate-size /file 1G\n"
17426 #: ../fish/guestfish.pod:677
17427 msgid "would truncate the file to 1 gigabyte."
17431 #: ../fish/guestfish.pod:679
17433 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
17434 "the parameter to L</memsize> is specified in megabytes already). Adding a "
17435 "suffix will probably not do what you expect."
17439 #: ../fish/guestfish.pod:683
17440 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17444 #: ../fish/guestfish.pod:685
17446 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17447 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17451 #: ../fish/guestfish.pod:688
17454 " 1234 decimal number 1234\n"
17455 " 02322 octal number, equivalent to decimal 1234\n"
17456 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17461 #: ../fish/guestfish.pod:692
17463 "When using the C<chmod> command, you almost always want to specify an octal "
17464 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17465 "L<chmod(1)> program):"
17469 #: ../fish/guestfish.pod:696
17472 " chmod 0777 /public # OK\n"
17473 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17478 #: ../fish/guestfish.pod:699
17480 "Commands that return numbers usually print them in decimal, but some "
17481 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17482 "octal, preceeded by C<0>)."
17486 #: ../fish/guestfish.pod:703
17487 msgid "WILDCARDS AND GLOBBING"
17491 #: ../fish/guestfish.pod:705
17493 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17494 "(globbing) by default. So for example the following will not do what you "
17499 #: ../fish/guestfish.pod:709
17507 #: ../fish/guestfish.pod:711
17509 "Assuming you don't have a directory called literally C</home/*> then the "
17510 "above command will return an error."
17514 #: ../fish/guestfish.pod:714
17515 msgid "To perform wildcard expansion, use the C<glob> command."
17519 #: ../fish/guestfish.pod:716
17522 " glob rm-rf /home/*\n"
17527 #: ../fish/guestfish.pod:718
17529 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17530 "many times), equivalent to:"
17534 #: ../fish/guestfish.pod:721
17537 " rm-rf /home/jim\n"
17538 " rm-rf /home/joe\n"
17539 " rm-rf /home/mary\n"
17544 #: ../fish/guestfish.pod:725
17545 msgid "C<glob> only works on simple guest paths and not on device names."
17549 #: ../fish/guestfish.pod:727
17551 "If you have several parameters, each containing a wildcard, then glob will "
17552 "perform a Cartesian product."
17556 #: ../fish/guestfish.pod:730
17561 #: ../fish/guestfish.pod:732
17563 "Any line which starts with a I<#> character is treated as a comment and "
17564 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17565 "a command. For example:"
17569 #: ../fish/guestfish.pod:736
17572 " # this is a comment\n"
17573 " # this is a comment\n"
17574 " foo # NOT a comment\n"
17579 #: ../fish/guestfish.pod:740
17580 msgid "Blank lines are also ignored."
17584 #: ../fish/guestfish.pod:742
17585 msgid "RUNNING COMMANDS LOCALLY"
17589 #: ../fish/guestfish.pod:744
17591 "Any line which starts with a I<!> character is treated as a command sent to "
17592 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17596 #: ../fish/guestfish.pod:748
17600 " tgz-out /remote local/remote-data.tar.gz\n"
17605 #: ../fish/guestfish.pod:751
17607 "will create a directory C<local> on the host, and then export the contents "
17608 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17609 "(See C<tgz-out>)."
17613 #: ../fish/guestfish.pod:755
17615 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17616 "effect, due to the way that subprocesses work in Unix."
17620 #: ../fish/guestfish.pod:758
17621 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
17625 #: ../fish/guestfish.pod:760
17627 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
17628 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
17629 "and executed as guestfish commands."
17633 #: ../fish/guestfish.pod:764
17635 "Thus you can use shell script to construct arbitrary guestfish commands "
17636 "which are then parsed by guestfish."
17640 #: ../fish/guestfish.pod:767
17642 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
17643 "through C</foo.100>) using guestfish commands alone. However this is simple "
17644 "if we use a shell script to create the guestfish commands for us:"
17648 #: ../fish/guestfish.pod:772
17651 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
17656 #: ../fish/guestfish.pod:774
17657 msgid "or with names like C</foo.001>:"
17661 #: ../fish/guestfish.pod:776
17664 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
17669 #: ../fish/guestfish.pod:778
17671 "When using guestfish interactively it can be helpful to just run the shell "
17672 "script first (ie. remove the initial C<E<lt>> character so it is just an "
17673 "ordinary I<!> local command), see what guestfish commands it would run, and "
17674 "when you are happy with those prepend the C<E<lt>> character to run the "
17675 "guestfish commands for real."
17679 #: ../fish/guestfish.pod:784
17684 #: ../fish/guestfish.pod:786
17686 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17687 "command (a guestfish command) to the second command (any host command). For "
17692 #: ../fish/guestfish.pod:790
17695 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17700 #: ../fish/guestfish.pod:792
17702 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17703 "program). The above command would list all accounts in the guest filesystem "
17704 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17708 #: ../fish/guestfish.pod:797
17711 " hexdump /bin/ls | head\n"
17712 " list-devices | tail -1\n"
17713 " tgz-out / - | tar ztf -\n"
17718 #: ../fish/guestfish.pod:801
17720 "The space before the pipe symbol is required, any space after the pipe "
17721 "symbol is optional. Everything after the pipe symbol is just passed "
17722 "straight to the host shell, so it can contain redirections, globs and "
17723 "anything else that makes sense on the host side."
17727 #: ../fish/guestfish.pod:806
17729 "To use a literal argument which begins with a pipe symbol, you have to quote "
17734 #: ../fish/guestfish.pod:809
17742 #: ../fish/guestfish.pod:811
17743 msgid "HOME DIRECTORIES"
17747 #: ../fish/guestfish.pod:813
17749 "If a parameter starts with the character C<~> then the tilde may be expanded "
17750 "as a home directory path (either C<~> for the current user's home directory, "
17751 "or C<~user> for another user)."
17755 #: ../fish/guestfish.pod:817
17757 "Note that home directory expansion happens for users known I<on the host>, "
17758 "not in the guest filesystem."
17762 #: ../fish/guestfish.pod:820
17764 "To use a literal argument which begins with a tilde, you have to quote it, "
17769 #: ../fish/guestfish.pod:823
17777 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:519
17778 msgid "ENCRYPTED DISKS"
17782 #: ../fish/guestfish.pod:827
17784 "Libguestfs has some support for Linux guests encrypted according to the "
17785 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17786 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
17787 "LUKS is supported."
17791 #: ../fish/guestfish.pod:832
17792 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17796 #: ../fish/guestfish.pod:834
17799 " ><fs> vfs-type /dev/sda2\n"
17805 #: ../fish/guestfish.pod:837
17807 "Then open those devices using L</luks-open>. This creates a device-mapper "
17808 "device called C</dev/mapper/luksdev>."
17812 #: ../fish/guestfish.pod:840
17815 " ><fs> luks-open /dev/sda2 luksdev\n"
17816 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17821 #: ../fish/guestfish.pod:843
17823 "Finally you have to tell LVM to scan for volume groups on the newly created "
17828 #: ../fish/guestfish.pod:846
17832 " vg-activate-all true\n"
17837 #: ../fish/guestfish.pod:849
17838 msgid "The logical volume(s) can now be mounted in the usual way."
17842 #: ../fish/guestfish.pod:851
17844 "Before closing a LUKS device you must unmount any logical volumes on it and "
17845 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17846 "one. Then you can close the mapper device:"
17850 #: ../fish/guestfish.pod:855
17853 " vg-activate false /dev/VG\n"
17854 " luks-close /dev/mapper/luksdev\n"
17859 #: ../fish/guestfish.pod:860
17861 "If a path is prefixed with C<win:> then you can use Windows-style drive "
17862 "letters and paths (with some limitations). The following commands are "
17867 #: ../fish/guestfish.pod:864
17870 " file /WINDOWS/system32/config/system.LOG\n"
17875 #: ../fish/guestfish.pod:866
17878 " file win:\\windows\\system32\\config\\system.log\n"
17883 #: ../fish/guestfish.pod:868
17886 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
17891 #: ../fish/guestfish.pod:870
17893 "The parameter is rewritten \"behind the scenes\" by looking up the position "
17894 "where the drive is mounted, prepending that to the path, changing all "
17895 "backslash characters to forward slash, then resolving the result using L</"
17896 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
17897 "the parameter might be rewritten like this:"
17901 #: ../fish/guestfish.pod:876
17904 " win:e:\\foo\\bar => /e/FOO/bar\n"
17909 #: ../fish/guestfish.pod:878
17910 msgid "This only works in argument positions that expect a path."
17914 #: ../fish/guestfish.pod:880
17915 msgid "UPLOADING AND DOWNLOADING FILES"
17919 #: ../fish/guestfish.pod:882
17921 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17922 "others which upload from or download to a local file, you can use the "
17923 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17927 #: ../fish/guestfish.pod:886
17935 #: ../fish/guestfish.pod:888
17937 "reads stdin and creates from that a file C</foo> in the disk image, and:"
17941 #: ../fish/guestfish.pod:891
17944 " tar-out /etc - | tar tf -\n"
17949 #: ../fish/guestfish.pod:893
17951 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17952 "command (see L</PIPES>)."
17956 #: ../fish/guestfish.pod:896
17958 "When using C<-> to read from stdin, the input is read up to the end of "
17959 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17960 "some arbitrary end marker:"
17964 #: ../fish/guestfish.pod:900
17967 " upload -<<END /foo\n"
17976 #: ../fish/guestfish.pod:906
17978 "Any string of characters can be used instead of C<END>. The end marker must "
17979 "appear on a line of its own, without any preceeding or following characters "
17980 "(not even spaces)."
17984 #: ../fish/guestfish.pod:910
17986 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17987 "upload local files (so-called \"FileIn\" parameters in the generator)."
17991 #: ../fish/guestfish.pod:913
17992 msgid "EXIT ON ERROR BEHAVIOUR"
17996 #: ../fish/guestfish.pod:915
17998 "By default, guestfish will ignore any errors when in interactive mode (ie. "
17999 "taking commands from a human over a tty), and will exit on the first error "
18000 "in non-interactive mode (scripts, commands given on the command line)."
18004 #: ../fish/guestfish.pod:920
18006 "If you prefix a command with a I<-> character, then that command will not "
18007 "cause guestfish to exit, even if that (one) command returns an error."
18011 #: ../fish/guestfish.pod:924
18012 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18016 #: ../fish/guestfish.pod:926
18018 "Guestfish can be remote-controlled over a socket. This is useful "
18019 "particularly in shell scripts where you want to make several different "
18020 "changes to a filesystem, but you don't want the overhead of starting up a "
18021 "guestfish process each time."
18025 #: ../fish/guestfish.pod:931
18026 msgid "Start a guestfish server process using:"
18030 #: ../fish/guestfish.pod:933
18033 " eval \"`guestfish --listen`\"\n"
18038 #: ../fish/guestfish.pod:935
18039 msgid "and then send it commands by doing:"
18043 #: ../fish/guestfish.pod:937
18046 " guestfish --remote cmd [...]\n"
18051 #: ../fish/guestfish.pod:939
18052 msgid "To cause the server to exit, send it the exit command:"
18056 #: ../fish/guestfish.pod:943
18058 "Note that the server will normally exit if there is an error in a command. "
18059 "You can change this in the usual way. See section L</EXIT ON ERROR "
18064 #: ../fish/guestfish.pod:947
18065 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18069 #: ../fish/guestfish.pod:949
18071 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18072 "is how the I<--remote> option knows where to send the commands. You can "
18073 "have several guestfish listener processes running using:"
18077 #: ../fish/guestfish.pod:953
18080 " eval \"`guestfish --listen`\"\n"
18081 " pid1=$GUESTFISH_PID\n"
18082 " eval \"`guestfish --listen`\"\n"
18083 " pid2=$GUESTFISH_PID\n"
18085 " guestfish --remote=$pid1 cmd\n"
18086 " guestfish --remote=$pid2 cmd\n"
18091 #: ../fish/guestfish.pod:961
18092 msgid "REMOTE CONTROL AND CSH"
18096 #: ../fish/guestfish.pod:963
18098 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18103 #: ../fish/guestfish.pod:966
18106 " eval \"`guestfish --listen --csh`\"\n"
18111 #: ../fish/guestfish.pod:968
18112 msgid "REMOTE CONTROL DETAILS"
18116 #: ../fish/guestfish.pod:970
18118 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18119 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18120 "and C<$PID> is the process ID of the server."
18124 #: ../fish/guestfish.pod:974
18125 msgid "Guestfish client and server versions must match exactly."
18129 #: ../fish/guestfish.pod:976
18130 msgid "REMOTE CONTROL RUN COMMAND HANGING"
18134 #: ../fish/guestfish.pod:978
18136 "Using the C<run> (or C<launch>) command remotely in a command substitution "
18137 "context hangs, ie. don't do (note the backquotes):"
18141 #: ../fish/guestfish.pod:981
18144 " a=`guestfish --remote run`\n"
18149 #: ../fish/guestfish.pod:983
18151 "Since the C<run> command produces no output on stdout, this is not useful "
18152 "anyway. For further information see L<https://bugzilla.redhat.com/show_bug."
18157 #: ../fish/guestfish.pod:987
18158 msgid "PREPARED DISK IMAGES"
18162 #: ../fish/guestfish.pod:989
18164 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18165 "preformatted disk images that guestfish can make for you to save typing. "
18166 "This is particularly useful for testing purposes. This option is used "
18167 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18168 "can be mixed with I<-a>)."
18172 #: ../fish/guestfish.pod:995
18174 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18175 "the second and so on. Existing files in the current directory are "
18180 #: ../fish/guestfish.pod:999
18182 "The type briefly describes how the disk should be sized, partitioned, how "
18183 "filesystem(s) should be created, and how content should be added. "
18184 "Optionally the type can be followed by extra parameters, separated by C<:> "
18185 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18186 "allocated disk, containing a single partition, with the partition formatted "
18187 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18192 #: ../fish/guestfish.pod:1007
18193 msgid "To list the available types and any extra parameters they take, run:"
18197 #: ../fish/guestfish.pod:1011
18199 "Note that the prepared filesystem is not mounted. You would usually have to "
18200 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18204 #: ../fish/guestfish.pod:1015
18206 "If any I<-N> or I<--new> options are given, the guest is automatically "
18211 #: ../fish/guestfish.pod:1020
18212 msgid "Create a 100MB disk with an ext4-formatted partition:"
18216 #: ../fish/guestfish.pod:1022
18219 " guestfish -N fs:ext4\n"
18224 #: ../fish/guestfish.pod:1024
18225 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18229 #: ../fish/guestfish.pod:1026
18232 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18237 #: ../fish/guestfish.pod:1028
18238 msgid "Create a blank 200MB disk:"
18242 #: ../fish/guestfish.pod:1030
18245 " guestfish -N disk:200M\n"
18250 #: ../fish/guestfish.pod:1032
18251 msgid "PROGRESS BARS"
18255 #: ../fish/guestfish.pod:1034
18257 "Some (not all) long-running commands send progress notification messages as "
18258 "they are running. Guestfish turns these messages into progress bars."
18262 #: ../fish/guestfish.pod:1038
18264 "When a command that supports progress bars takes longer than two seconds to "
18265 "run, and if progress bars are enabled, then you will see one appearing below "
18270 #: ../fish/guestfish.pod:1042
18273 " ><fs> copy-size /large-file /another-file 2048M\n"
18274 " / 10% [#####-----------------------------------------] 00:30\n"
18279 #: ../fish/guestfish.pod:1045
18281 "The spinner on the left hand side moves round once for every progress "
18282 "notification received from the backend. This is a (reasonably) golden "
18283 "assurance that the command is \"doing something\" even if the progress bar "
18284 "is not moving, because the command is able to send the progress "
18285 "notifications. When the bar reaches 100% and the command finishes, the "
18286 "spinner disappears."
18290 #: ../fish/guestfish.pod:1052
18292 "Progress bars are enabled by default when guestfish is used interactively. "
18293 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18294 "and you can disable them completely using I<--no-progress-bars>."
18298 #: ../fish/guestfish.pod:1057
18299 msgid "GUESTFISH COMMANDS"
18303 #: ../fish/guestfish.pod:1059
18305 "The commands in this section are guestfish convenience commands, in other "
18306 "words, they are not part of the L<guestfs(3)> API."
18310 #: ../fish/guestfish.pod:1062
18315 #: ../fish/guestfish.pod:1064
18324 #: ../fish/guestfish.pod:1067
18325 msgid "Without any parameter, this provides general help."
18329 #: ../fish/guestfish.pod:1069
18330 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18334 #: ../fish/guestfish.pod:1071
18335 msgid "quit | exit"
18339 #: ../fish/guestfish.pod:1073
18340 msgid "This exits guestfish. You can also use C<^D> key."
18344 #: ../fish/guestfish.pod:1075
18345 msgid "@FISH_COMMANDS@"
18349 #: ../fish/guestfish.pod:1077
18354 #: ../fish/guestfish.pod:1079 ../src/guestfs.pod:1475
18359 #: ../fish/guestfish.pod:1081 ../test-tool/libguestfs-test-tool.pod:77
18364 #: ../fish/guestfish.pod:1083
18366 "guestfish returns 0 if the commands completed without error, or 1 if there "
18371 #: ../fish/guestfish.pod:1090
18376 #: ../fish/guestfish.pod:1092
18378 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18383 #: ../fish/guestfish.pod:1095 ../src/guestfs.pod:2970
18384 msgid "FEBOOTSTRAP_KERNEL"
18388 #: ../fish/guestfish.pod:1097 ../src/guestfs.pod:2972
18389 msgid "FEBOOTSTRAP_MODULES"
18393 #: ../fish/guestfish.pod:1099 ../src/guestfs.pod:2974
18395 "These two environment variables allow the kernel that libguestfs uses in the "
18396 "appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
18397 "most recent host kernel is chosen. For more information about kernel "
18398 "selection, see L<febootstrap-supermin-helper(8)>. This feature is only "
18399 "available in febootstrap E<ge> 3.8."
18403 #: ../fish/guestfish.pod:1105
18404 msgid "GUESTFISH_DISPLAY_IMAGE"
18408 #: ../fish/guestfish.pod:1107
18410 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
18411 "If not set, it uses L<display(1)>."
18415 #: ../fish/guestfish.pod:1110
18416 msgid "GUESTFISH_PID"
18420 #: ../fish/guestfish.pod:1112
18422 "Used with the I<--remote> option to specify the remote guestfish process to "
18423 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18427 #: ../fish/guestfish.pod:1116
18432 #: ../fish/guestfish.pod:1118
18434 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18435 "not specified, the external L<hexedit(1)> program is used."
18439 #: ../fish/guestfish.pod:1122
18444 #: ../fish/guestfish.pod:1124
18446 "If compiled with GNU readline support, various files in the home directory "
18447 "can be used. See L</FILES>."
18451 #: ../fish/guestfish.pod:1127 ../src/guestfs.pod:2980
18452 msgid "LIBGUESTFS_APPEND"
18456 #: ../fish/guestfish.pod:1129 ../src/guestfs.pod:2982
18457 msgid "Pass additional options to the guest kernel."
18461 #: ../fish/guestfish.pod:1131 ../src/guestfs.pod:2984
18462 msgid "LIBGUESTFS_DEBUG"
18466 #: ../fish/guestfish.pod:1133
18468 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18469 "effect as using the B<-v> option."
18473 #: ../fish/guestfish.pod:1136 ../src/guestfs.pod:2989
18474 msgid "LIBGUESTFS_MEMSIZE"
18478 #: ../fish/guestfish.pod:1138 ../src/guestfs.pod:2991
18480 "Set the memory allocated to the qemu process, in megabytes. For example:"
18484 #: ../fish/guestfish.pod:1141 ../src/guestfs.pod:2994
18487 " LIBGUESTFS_MEMSIZE=700\n"
18492 #: ../fish/guestfish.pod:1143 ../src/guestfs.pod:2996
18493 msgid "LIBGUESTFS_PATH"
18497 #: ../fish/guestfish.pod:1145
18499 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18500 "the discussion of paths in L<guestfs(3)>."
18504 #: ../fish/guestfish.pod:1148 ../src/guestfs.pod:3001
18505 msgid "LIBGUESTFS_QEMU"
18509 #: ../fish/guestfish.pod:1150 ../src/guestfs.pod:3003
18511 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
18512 "which was found at compile time by the configure script is used."
18516 #: ../fish/guestfish.pod:1154 ../src/guestfs.pod:3009
18517 msgid "LIBGUESTFS_TRACE"
18521 #: ../fish/guestfish.pod:1156
18522 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18526 #: ../fish/guestfish.pod:1158
18531 #: ../fish/guestfish.pod:1160
18533 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18538 #: ../fish/guestfish.pod:1163 ../src/guestfs.pod:3014
18543 #: ../fish/guestfish.pod:1165 ../src/guestfs.pod:3016
18545 "Location of temporary directory, defaults to C</tmp> except for the cached "
18546 "supermin appliance which defaults to C</var/tmp>."
18550 #: ../fish/guestfish.pod:1168 ../src/guestfs.pod:3019
18552 "If libguestfs was compiled to use the supermin appliance then the real "
18553 "appliance is cached in this directory, shared between all handles belonging "
18554 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
18555 "use in case C</var/tmp> is not large enough."
18559 #: ../fish/guestfish.pod:1176 ../fuse/guestmount.pod:288
18560 #: ../rescue/virt-rescue.pod:269
18565 #: ../fish/guestfish.pod:1180 ../fuse/guestmount.pod:292
18566 #: ../rescue/virt-rescue.pod:273
18567 msgid "$HOME/.libguestfs-tools.rc"
18571 #: ../fish/guestfish.pod:1182 ../fuse/guestmount.pod:294
18572 #: ../rescue/virt-rescue.pod:275
18573 msgid "/etc/libguestfs-tools.conf"
18577 #: ../fish/guestfish.pod:1184 ../fuse/guestmount.pod:296
18578 #: ../rescue/virt-rescue.pod:277
18580 "This configuration file controls the default read-only or read-write mode "
18581 "(I<--ro> or I<--rw>)."
18585 #: ../fish/guestfish.pod:1187
18586 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
18590 #: ../fish/guestfish.pod:1189
18591 msgid "$HOME/.guestfish"
18595 #: ../fish/guestfish.pod:1191
18597 "If compiled with GNU readline support, then the command history is saved in "
18602 #: ../fish/guestfish.pod:1194
18603 msgid "$HOME/.inputrc"
18607 #: ../fish/guestfish.pod:1196
18608 msgid "/etc/inputrc"
18612 #: ../fish/guestfish.pod:1198
18614 "If compiled with GNU readline support, then these files can be used to "
18615 "configure readline. For further information, please see L<readline(3)/"
18616 "INITIALIZATION FILE>."
18620 #: ../fish/guestfish.pod:1202
18621 msgid "To write rules which only apply to guestfish, use:"
18625 #: ../fish/guestfish.pod:1204
18635 #: ../fish/guestfish.pod:1208
18637 "Variables that you can set in inputrc that change the behaviour of guestfish "
18638 "in useful ways include:"
18642 #: ../fish/guestfish.pod:1213
18643 msgid "completion-ignore-case (default: on)"
18647 #: ../fish/guestfish.pod:1215
18649 "By default, guestfish will ignore case when tab-completing paths on the "
18654 #: ../fish/guestfish.pod:1218
18657 " set completion-ignore-case off\n"
18662 #: ../fish/guestfish.pod:1220
18663 msgid "to make guestfish case sensitive."
18667 #: ../fish/guestfish.pod:1224
18672 #: ../fish/guestfish.pod:1226
18673 msgid "test2.img (etc)"
18677 #: ../fish/guestfish.pod:1228
18679 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
18680 "will be created in the file C<test1.img> in the current directory. The "
18681 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
18682 "the same name will be overwritten."
18686 #: ../fish/guestfish.pod:1237
18688 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
18689 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
18690 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
18691 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
18692 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
18693 ">, L<display(1)>, L<hexedit(1)>, L<febootstrap-supermin-helper(8)>."
18697 #: ../fish/guestfish.pod:1266 ../src/guestfs.pod:3105
18698 #: ../test-tool/libguestfs-test-tool.pod:99
18699 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
18703 #: ../fish/virt-copy-in.pod:5
18705 "virt-copy-in - Copy files and directories into a virtual machine disk image."
18709 #: ../fish/virt-copy-in.pod:9
18712 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
18717 #: ../fish/virt-copy-in.pod:11
18720 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
18725 #: ../fish/virt-copy-in.pod:15
18727 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
18728 "causing disk corruption. The virtual machine must be shut down before you "
18729 "use this command."
18733 #: ../fish/virt-copy-in.pod:21
18735 "C<virt-copy-in> copies files and directories from the local disk into a "
18736 "virtual machine disk image or named libvirt domain."
18740 #: ../fish/virt-copy-in.pod:24
18742 "You can give one of more filenames and directories on the command line. "
18743 "Directories are copied in recursively. The final parameter must be the "
18744 "destination directory in the disk image which must be an absolute path "
18745 "starting with a C</> character."
18749 #: ../fish/virt-copy-in.pod:33
18752 " virt-copy-in -d MyGuest resolv.conf /etc\n"
18757 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
18758 msgid "Upload a home directory to a guest:"
18762 #: ../fish/virt-copy-in.pod:37
18765 " virt-copy-in -d MyGuest skel /home\n"
18770 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28
18771 #: ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
18772 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
18776 #: ../fish/virt-copy-in.pod:41
18778 "This command is just a simple shell script wrapper around the L<guestfish(1)"
18779 "> C<copy-in> command. For anything more complex than a trivial copy, you "
18780 "are probably better off using guestfish directly."
18784 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36
18785 #: ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
18787 "Since the shell script just passes options straight to guestfish, read "
18788 "L<guestfish(1)> to see the full list of options."
18792 #: ../fish/virt-copy-in.pod:52
18794 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
18795 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18799 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55
18800 #: ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
18801 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
18805 #: ../fish/virt-copy-out.pod:5
18807 "virt-copy-out - Copy files and directories out of a virtual machine disk "
18812 #: ../fish/virt-copy-out.pod:9
18815 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
18820 #: ../fish/virt-copy-out.pod:11
18823 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
18828 #: ../fish/virt-copy-out.pod:15
18830 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
18831 "image or named libvirt domain."
18835 #: ../fish/virt-copy-out.pod:18
18837 "You can give one of more filenames and directories on the command line. "
18838 "Directories are copied out recursively."
18842 #: ../fish/virt-copy-out.pod:23
18843 msgid "Download the home directories from a virtual machine:"
18847 #: ../fish/virt-copy-out.pod:25
18851 " virt-copy-out -d MyGuest /home homes\n"
18856 #: ../fish/virt-copy-out.pod:30
18858 "This command is just a simple shell script wrapper around the L<guestfish(1)"
18859 "> C<copy-out> command. For anything more complex than a trivial copy, you "
18860 "are probably better off using guestfish directly."
18864 #: ../fish/virt-copy-out.pod:41
18866 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, L<virt-"
18867 "tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18871 #: ../fish/virt-tar-in.pod:5
18872 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
18876 #: ../fish/virt-tar-in.pod:9
18879 " virt-tar-in -a disk.img data.tar /destination\n"
18884 #: ../fish/virt-tar-in.pod:11
18887 " virt-tar-in -d domain data.tar /destination\n"
18892 #: ../fish/virt-tar-in.pod:13
18895 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
18900 #: ../fish/virt-tar-in.pod:17
18902 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
18903 "causing disk corruption. The virtual machine must be shut down before you "
18904 "use this command."
18908 #: ../fish/virt-tar-in.pod:23
18910 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
18911 "image or named libvirt domain."
18915 #: ../fish/virt-tar-in.pod:26
18917 "The first parameter is the tar file. Use C<-> to read the tar file from "
18918 "standard input. The second parameter is the absolute target directory to "
18923 #: ../fish/virt-tar-in.pod:34
18926 " virt-tar-in -d MyGuest homes.tar /home\n"
18931 #: ../fish/virt-tar-in.pod:38
18933 "This command is just a simple shell script wrapper around the L<guestfish(1)"
18934 "> C<tar-in> command. For anything more complex than a trivial copy, you are "
18935 "probably better off using guestfish directly."
18939 #: ../fish/virt-tar-in.pod:49
18941 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18942 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, L<http://libguestfs."
18947 #: ../fish/virt-tar-out.pod:5
18949 "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
18953 #: ../fish/virt-tar-out.pod:9
18956 " virt-tar-out -a disk.img /dir files.tar\n"
18961 #: ../fish/virt-tar-out.pod:11
18964 " virt-tar-out -d domain /dir files.tar\n"
18969 #: ../fish/virt-tar-out.pod:13
18972 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
18977 #: ../fish/virt-tar-out.pod:17
18979 "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
18983 #: ../fish/virt-tar-out.pod:20
18985 "The first parameter is the absolute path of the virtual machine directory. "
18986 "The second parameter is the tar file to write. Use C<-> to write to "
18991 #: ../fish/virt-tar-out.pod:26
18992 msgid "Download the home directories from a guest:"
18996 #: ../fish/virt-tar-out.pod:28
18999 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
19004 #: ../fish/virt-tar-out.pod:32
19006 "This command is just a simple shell script wrapper around the L<guestfish(1)"
19007 "> C<tar-out> command. For anything more complex than a trivial copy, you "
19008 "are probably better off using guestfish directly."
19012 #: ../fish/virt-tar-out.pod:43
19014 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
19015 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
19019 #: ../fuse/guestmount.pod:5
19021 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
19025 #: ../fuse/guestmount.pod:9
19028 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
19033 #: ../fuse/guestmount.pod:11
19036 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
19041 #: ../fuse/guestmount.pod:13
19044 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
19049 #: ../fuse/guestmount.pod:17
19051 "You must I<not> use C<guestmount> in read-write mode on live virtual "
19052 "machines. If you do this, you risk disk corruption in the VM."
19056 #: ../fuse/guestmount.pod:22
19058 "The guestmount program can be used to mount virtual machine filesystems and "
19059 "other disk images on the host. It uses libguestfs for access to the guest "
19060 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
19061 "a mountable device."
19065 #: ../fuse/guestmount.pod:27
19067 "Along with other options, you have to give at least one device (I<-a> "
19068 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
19069 "option) or use the I<-i> inspection option. How this works is better "
19070 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
19075 #: ../fuse/guestmount.pod:33
19077 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
19078 "by you, and the filesystem will not be visible to any other users unless you "
19079 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
19080 "the filesystem, use the C<fusermount -u> command."
19084 #: ../fuse/guestmount.pod:41
19086 "For a typical Windows guest which has its main filesystem on the first "
19091 #: ../fuse/guestmount.pod:44
19094 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
19099 #: ../fuse/guestmount.pod:46
19101 "For a typical Linux guest which has a /boot filesystem on the first "
19102 "partition, and the root filesystem on a logical volume:"
19106 #: ../fuse/guestmount.pod:49
19109 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
19114 #: ../fuse/guestmount.pod:51
19115 msgid "To get libguestfs to detect guest mountpoints for you:"
19119 #: ../fuse/guestmount.pod:53
19122 " guestmount -a guest.img -i --ro /mnt\n"
19127 #: ../fuse/guestmount.pod:55
19128 msgid "For a libvirt guest called \"Guest\" you could do:"
19132 #: ../fuse/guestmount.pod:57
19135 " guestmount -d Guest -i --ro /mnt\n"
19140 #: ../fuse/guestmount.pod:59
19142 "If you don't know what filesystems are contained in a guest or disk image, "
19143 "use L<virt-filesystems(1)> first:"
19147 #: ../fuse/guestmount.pod:62
19150 " virt-filesystems MyGuest\n"
19155 #: ../fuse/guestmount.pod:64
19157 "If you want to trace the libguestfs calls but without excessive debugging "
19158 "information, we recommend:"
19162 #: ../fuse/guestmount.pod:67
19165 " guestmount [...] --trace /mnt\n"
19170 #: ../fuse/guestmount.pod:69
19171 msgid "If you want to debug the program, we recommend:"
19175 #: ../fuse/guestmount.pod:71
19178 " guestmount [...] --trace --verbose /mnt\n"
19183 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68
19184 #: ../resize/virt-resize.pod:486
19189 #: ../fuse/guestmount.pod:75
19190 msgid "Other users cannot see the filesystem by default"
19194 #: ../fuse/guestmount.pod:77
19196 "If you mount a filesystem as one user (eg. root), then other users will not "
19197 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
19198 "option when mounting:"
19202 #: ../fuse/guestmount.pod:81
19205 " sudo guestmount [...] -o allow_other /mnt\n"
19210 #: ../fuse/guestmount.pod:91
19211 msgid "Add a block device or virtual machine image."
19215 #: ../fuse/guestmount.pod:114
19216 msgid "B<--dir-cache-timeout N>"
19220 #: ../fuse/guestmount.pod:116
19222 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
19223 "seconds. The readdir cache [actually, there are several semi-independent "
19224 "caches] is populated after a readdir(2) call with the stat and extended "
19225 "attributes of the files in the directory, in anticipation that they will be "
19226 "requested soon after."
19230 #: ../fuse/guestmount.pod:122
19232 "There is also a different attribute cache implemented by FUSE (see the FUSE "
19233 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
19234 "requests, only cache existing ones."
19238 #: ../fuse/guestmount.pod:142
19240 "If you have untrusted raw-format guest disk images, you should use this "
19241 "option to specify the disk format. This avoids a possible security problem "
19242 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
19243 "guestfs_add_drive_opts>."
19247 #: ../fuse/guestmount.pod:147
19248 msgid "B<--fuse-help>"
19252 #: ../fuse/guestmount.pod:149
19253 msgid "Display help on special FUSE options (see I<-o> below)."
19257 #: ../fuse/guestmount.pod:153
19258 msgid "Display brief help and exit."
19262 #: ../fuse/guestmount.pod:177
19264 "Mount the named partition or logical volume on the given mountpoint B<in the "
19265 "guest> (this has nothing to do with mountpoints in the host)."
19269 #: ../fuse/guestmount.pod:180
19271 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
19272 "something on C</>."
19276 #: ../fuse/guestmount.pod:197
19278 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
19279 "unmounted. If you specify this option, then we don't attempt to sync the "
19280 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
19284 #: ../fuse/guestmount.pod:202
19285 msgid "B<-o option>"
19289 #: ../fuse/guestmount.pod:204
19290 msgid "B<--option option>"
19294 #: ../fuse/guestmount.pod:206
19295 msgid "Pass extra options to FUSE."
19299 #: ../fuse/guestmount.pod:208
19301 "To get a list of all the extra options supported by FUSE, use the command "
19302 "below. Note that only the FUSE I<-o> options can be passed, and only some "
19303 "of them are a good idea."
19307 #: ../fuse/guestmount.pod:212
19310 " guestmount --fuse-help\n"
19315 #: ../fuse/guestmount.pod:214
19316 msgid "Some potentially useful FUSE options:"
19320 #: ../fuse/guestmount.pod:218
19321 msgid "B<-o allow_other>"
19325 #: ../fuse/guestmount.pod:220
19326 msgid "Allow other users to see the filesystem."
19330 #: ../fuse/guestmount.pod:222
19331 msgid "B<-o attr_timeout=N>"
19335 #: ../fuse/guestmount.pod:224
19336 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
19340 #: ../fuse/guestmount.pod:226
19341 msgid "B<-o kernel_cache>"
19345 #: ../fuse/guestmount.pod:228
19347 "Allow the kernel to cache files (reduces the number of reads that have to go "
19348 "through the L<guestfs(3)> API). This is generally a good idea if you can "
19349 "afford the extra memory usage."
19353 #: ../fuse/guestmount.pod:232
19354 msgid "B<-o uid=N> B<-o gid=N>"
19358 #: ../fuse/guestmount.pod:234
19360 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
19361 "the chosen values."
19365 #: ../fuse/guestmount.pod:243
19367 "Add devices and mount everything read-only. Also disallow writes and make "
19368 "the disk appear read-only to FUSE."
19372 #: ../fuse/guestmount.pod:246
19374 "This is highly recommended if you are not going to edit the guest disk. If "
19375 "the guest is running and this option is I<not> supplied, then there is a "
19376 "strong risk of disk corruption in the guest. We try to prevent this from "
19377 "happening, but it is not always possible."
19381 #: ../fuse/guestmount.pod:251 ../rescue/virt-rescue.pod:171
19382 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19386 #: ../fuse/guestmount.pod:255
19387 msgid "Enable SELinux support for the guest."
19391 #: ../fuse/guestmount.pod:261
19392 msgid "Enable verbose messages from underlying libguestfs."
19396 #: ../fuse/guestmount.pod:267
19397 msgid "Display the program version and exit."
19401 #: ../fuse/guestmount.pod:276 ../fuse/guestmount.pod:299
19402 #: ../rescue/virt-rescue.pod:197 ../rescue/virt-rescue.pod:280
19403 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19407 #: ../fuse/guestmount.pod:280
19412 #: ../fuse/guestmount.pod:282
19413 msgid "Trace libguestfs calls and entry into each FUSE function."
19417 #: ../fuse/guestmount.pod:284
19418 msgid "This also stops the daemon from forking into the background."
19422 #: ../fuse/guestmount.pod:305
19424 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
19425 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
19430 #: ../fuse/guestmount.pod:320
19431 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
19435 #: ../inspector/virt-inspector.pod:5
19437 "virt-inspector - Display operating system version and other information "
19438 "about a virtual machine"
19442 #: ../inspector/virt-inspector.pod:9
19445 " virt-inspector [--options] -d domname\n"
19450 #: ../inspector/virt-inspector.pod:11
19453 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
19458 #: ../inspector/virt-inspector.pod:15
19461 " virt-inspector domname\n"
19466 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
19469 " virt-inspector disk.img [disk.img ...]\n"
19474 #: ../inspector/virt-inspector.pod:21
19476 "B<virt-inspector> examines a virtual machine or disk image and tries to "
19477 "determine the version of the operating system and other information about "
19478 "the virtual machine."
19482 #: ../inspector/virt-inspector.pod:25
19483 msgid "Virt-inspector produces XML output for feeding into other programs."
19487 #: ../inspector/virt-inspector.pod:27
19489 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
19490 "the libvirt domain (see: C<virsh list --all>)."
19494 #: ../inspector/virt-inspector.pod:30
19496 "You can also run virt-inspector directly on disk images from a single "
19497 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
19498 "has several block devices, in which case you should list several I<-a> "
19499 "options one after another, with the first corresponding to the guest's C</"
19500 "dev/sda>, the second to the guest's C</dev/sdb> and so on."
19504 #: ../inspector/virt-inspector.pod:37
19506 "You can also run virt-inspector on install disks, live CDs, bootable USB "
19507 "keys and similar."
19511 #: ../inspector/virt-inspector.pod:40
19513 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
19514 "inspect several virtual machines, you have to run virt-inspector several "
19515 "times (for example, from a shell script for-loop)."
19519 #: ../inspector/virt-inspector.pod:45
19521 "Because virt-inspector needs direct access to guest images, it won't "
19522 "normally work over remote libvirt connections."
19526 #: ../inspector/virt-inspector.pod:48
19528 "All of the information available from virt-inspector is also available "
19529 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
19530 "The same information can also be fetched using guestfish or via libguestfs "
19531 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
19532 "WITH OTHER PROGRAMMING LANGUAGES>)."
19536 #: ../inspector/virt-inspector.pod:81
19538 "Libvirt is only used if you specify a C<domname> on the command line. If "
19539 "you specify guest block devices directly (I<-a>), then libvirt is not used "
19544 #: ../inspector/virt-inspector.pod:94
19546 "When prompting for keys and passphrases, virt-inspector normally turns "
19547 "echoing off so you cannot see what you are typing. If you are not worried "
19548 "about Tempest attacks and there is no one else in the room you can specify "
19549 "this flag to see what you are typing."
19553 #: ../inspector/virt-inspector.pod:103 ../tools/virt-list-filesystems.pl:93
19554 #: ../tools/virt-list-partitions.pl:94 ../tools/virt-tar.pl:143
19555 #: ../tools/virt-win-reg.pl:144
19557 "Specify the format of disk images given on the command line. If this is "
19558 "omitted then the format is autodetected from the content of the disk image."
19562 #: ../inspector/virt-inspector.pod:107 ../tools/virt-list-filesystems.pl:97
19563 #: ../tools/virt-list-partitions.pl:98 ../tools/virt-tar.pl:147
19564 #: ../tools/virt-win-reg.pl:148
19566 "If disk images are requested from libvirt, then this program asks libvirt "
19567 "for this information. In this case, the value of the format parameter is "
19572 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:314
19573 #: ../resize/virt-resize.pod:400 ../tools/virt-list-filesystems.pl:101
19574 #: ../tools/virt-list-partitions.pl:102 ../tools/virt-tar.pl:151
19575 #: ../tools/virt-win-reg.pl:152
19577 "If working with untrusted raw-format guest disk images, you should ensure "
19578 "the format is always specified."
19582 #: ../inspector/virt-inspector.pod:139
19583 msgid "Previous versions of virt-inspector allowed you to write either:"
19587 #: ../inspector/virt-inspector.pod:145
19590 " virt-inspector guestname\n"
19595 #: ../inspector/virt-inspector.pod:153
19600 #: ../inspector/virt-inspector.pod:155
19602 "The virt-inspector XML is described precisely in a RELAX NG schema file "
19603 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
19604 "just an overview."
19608 #: ../inspector/virt-inspector.pod:159
19610 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
19611 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
19612 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
19613 "which is vanishingly rare in real world VMs."
19617 #: ../inspector/virt-inspector.pod:164
19618 msgid "E<lt>operatingsystemE<gt>"
19622 #: ../inspector/virt-inspector.pod:166
19624 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
19625 "describe the operating system, its architecture, the descriptive \"product "
19626 "name\" string, the type of OS and so on, as in this example:"
19630 #: ../inspector/virt-inspector.pod:170
19633 " <operatingsystems>\n"
19634 " <operatingsystem>\n"
19635 " <root>/dev/sda2</root>\n"
19636 " <name>windows</name>\n"
19637 " <arch>i386</arch>\n"
19638 " <distro>windows</distro>\n"
19639 " <product_name>Windows 7 Enterprise</product_name>\n"
19640 " <product_variant>Client</product_variant>\n"
19641 " <major_version>6</major_version>\n"
19642 " <minor_version>1</minor_version>\n"
19643 " <windows_systemroot>/Windows</windows_systemroot>\n"
19644 " <format>installed</format>\n"
19649 #: ../inspector/virt-inspector.pod:183
19651 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
19652 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
19653 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
19654 "architecture. The other fields are fairly self-explanatory, but because "
19655 "these fields are taken directly from the libguestfs inspection API you can "
19656 "find precise information from L<guestfs(3)/INSPECTION>."
19660 #: ../inspector/virt-inspector.pod:191
19662 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
19663 "of view of libguestfs (block devices may have completely different names "
19664 "inside the VM itself)."
19668 #: ../inspector/virt-inspector.pod:195
19669 msgid "E<lt>mountpointsE<gt>"
19673 #: ../inspector/virt-inspector.pod:197
19675 "Un*x-like guests typically have multiple filesystems which are mounted at "
19676 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
19677 "element which looks like this:"
19681 #: ../inspector/virt-inspector.pod:201
19684 " <operatingsystems>\n"
19685 " <operatingsystem>\n"
19688 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
19689 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
19690 " </mountpoints>\n"
19695 #: ../inspector/virt-inspector.pod:209
19697 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
19698 "and may have completely different names inside the guest. Only mountable "
19699 "filesystems appear in this list, not things like swap devices."
19703 #: ../inspector/virt-inspector.pod:214
19704 msgid "E<lt>filesystemsE<gt>"
19708 #: ../inspector/virt-inspector.pod:216
19710 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
19711 "filesystems belonging to the guest, including swap and empty partitions. "
19712 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
19713 "this OS or shared with this OS and other OSes)."
19717 #: ../inspector/virt-inspector.pod:222
19718 msgid "You might see something like this:"
19722 #: ../inspector/virt-inspector.pod:224
19725 " <operatingsystems>\n"
19726 " <operatingsystem>\n"
19729 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19730 " <type>ext4</type>\n"
19731 " <label>Fedora-13-x86_64</label>\n"
19732 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
19738 #: ../inspector/virt-inspector.pod:234
19740 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
19741 "the label, and the UUID."
19745 #: ../inspector/virt-inspector.pod:237
19746 msgid "E<lt>applicationsE<gt>"
19750 #: ../inspector/virt-inspector.pod:239
19752 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
19753 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
19758 #: ../inspector/virt-inspector.pod:243
19760 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
19761 "Typical values would be C<rpm> and C<deb>."
19765 #: ../inspector/virt-inspector.pod:246
19767 "E<lt>package_managementE<gt>, if present, describes the package manager. "
19768 "Typical values include C<yum>, C<up2date> and C<apt>"
19772 #: ../inspector/virt-inspector.pod:249
19773 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
19777 #: ../inspector/virt-inspector.pod:252
19780 " <operatingsystems>\n"
19781 " <operatingsystem>\n"
19783 " <applications>\n"
19785 " <name>coreutils</name>\n"
19786 " <version>8.5</version>\n"
19787 " <release>1</release>\n"
19788 " </application>\n"
19793 #: ../inspector/virt-inspector.pod:262
19795 "The version and release fields may not be available for some types guests. "
19796 "Other fields are possible, see L<guestfs(3)/"
19797 "guestfs_inspect_list_applications>."
19801 #: ../inspector/virt-inspector.pod:266
19802 msgid "E<lt>drive_mappingsE<gt>"
19806 #: ../inspector/virt-inspector.pod:268
19808 "For operating systems like Windows which use drive letters, virt-inspector "
19809 "is able to find out how drive letters map to filesystems."
19813 #: ../inspector/virt-inspector.pod:272
19816 " <operatingsystems>\n"
19817 " <operatingsystem>\n"
19819 " <drive_mappings>\n"
19820 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
19821 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
19822 " </drive_mappings>\n"
19827 #: ../inspector/virt-inspector.pod:280
19829 "In the example above, drive C maps to the filesystem on the second partition "
19830 "on the first disk, and drive E maps to the filesystem on the first partition "
19831 "on the second disk."
19835 #: ../inspector/virt-inspector.pod:284
19837 "Note that this only covers permanent local filesystem mappings, not things "
19838 "like network shares. Furthermore NTFS volume mount points may not be listed "
19843 #: ../inspector/virt-inspector.pod:288
19844 msgid "E<lt>iconE<gt>"
19848 #: ../inspector/virt-inspector.pod:290
19850 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
19851 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
19852 "very large and high quality."
19856 #: ../inspector/virt-inspector.pod:294
19859 " <operatingsystems>\n"
19860 " <operatingsystem>\n"
19863 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
19864 " [... many lines of base64 data ...]\n"
19870 #: ../inspector/virt-inspector.pod:302
19872 "To display the icon, you have to extract it and convert the base64 data back "
19873 "to a binary file. Use an XPath query or simply an editor to extract the "
19874 "data, then use the coreutils L<base64(1)> program to do the conversion back "
19879 #: ../inspector/virt-inspector.pod:307
19882 " base64 -i -d < icon.data > icon.png\n"
19887 #: ../inspector/virt-inspector.pod:309
19888 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
19892 #: ../inspector/virt-inspector.pod:311
19894 "Virt-inspector can detect some operating system installers on install disks, "
19895 "live CDs, bootable USB keys and more."
19899 #: ../inspector/virt-inspector.pod:314
19901 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
19902 "fields may be present to indicate a live CD, network installer, or one part "
19903 "of a multipart CD. For example:"
19907 #: ../inspector/virt-inspector.pod:318
19910 " <operatingsystems>\n"
19911 " <operatingsystem>\n"
19912 " <root>/dev/sda</root>\n"
19913 " <name>linux</name>\n"
19914 " <arch>i386</arch>\n"
19915 " <distro>ubuntu</distro>\n"
19916 " <product_name>Ubuntu 10.10 "Maverick Meerkat"</product_name>\n"
19917 " <major_version>10</major_version>\n"
19918 " <minor_version>10</minor_version>\n"
19919 " <format>installer</format>\n"
19925 #: ../inspector/virt-inspector.pod:330
19926 msgid "USING XPATH"
19930 #: ../inspector/virt-inspector.pod:332
19932 "You can use the XPath query language, and/or the xpath tool, in order to "
19933 "select parts of the XML."
19937 #: ../inspector/virt-inspector.pod:337
19940 " $ virt-inspector -d Guest | xpath //filesystems\n"
19941 " Found 1 nodes:\n"
19944 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19945 " <type>ext4</type>\n"
19951 #: ../inspector/virt-inspector.pod:345
19954 " $ virt-inspector -d Guest | \\\n"
19955 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
19956 " Query didn't return a nodeset. Value: ext4\n"
19961 #: ../inspector/virt-inspector.pod:356
19962 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
19966 #: ../inspector/virt-inspector.pod:358
19968 "Early versions of libguestfs shipped with a different virt-inspector program "
19969 "written in Perl (the current version is written in C). The XML output of "
19970 "the Perl virt-inspector was different and it could also output in other "
19971 "formats like text."
19975 #: ../inspector/virt-inspector.pod:363
19977 "The old virt-inspector is no longer supported or shipped with libguestfs."
19981 #: ../inspector/virt-inspector.pod:366
19983 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
19984 "versions of virt-inspector with different names:"
19988 #: ../inspector/virt-inspector.pod:369
19991 " virt-inspector Old Perl version.\n"
19992 " virt-inspector2 New C version.\n"
19997 #: ../inspector/virt-inspector.pod:374
19999 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, L<base64(1)"
20000 ">, L<http://libguestfs.org/>."
20004 #: ../inspector/virt-inspector.pod:390
20005 msgid "Matthew Booth L<mbooth@redhat.com>"
20009 #: ../java/examples/guestfs-java.pod:5
20010 msgid "guestfs-java - How to use libguestfs from Java"
20014 #: ../java/examples/guestfs-java.pod:9
20017 " import com.redhat.et.libguestfs.*;\n"
20022 #: ../java/examples/guestfs-java.pod:11
20025 " GuestFS g = new GuestFS ();\n"
20026 " g.add_drive_opts (\"disk.img\", null);\n"
20032 #: ../java/examples/guestfs-java.pod:17
20034 "This manual page documents how to call libguestfs from the Java programming "
20035 "language. This page just documents the differences from the C API and gives "
20036 "some examples. If you are not familiar with using libguestfs, you also need "
20037 "to read L<guestfs(3)>."
20041 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
20042 msgid "CLOSING THE HANDLE"
20046 #: ../java/examples/guestfs-java.pod:24
20048 "The handle is closed when it is reaped by the garbage collector. Because "
20049 "libguestfs handles include a lot of state, it is also possible to close (and "
20050 "hence free) them explicitly by calling the C<close> method."
20054 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60
20055 #: ../python/examples/guestfs-python.pod:21
20056 #: ../ruby/examples/guestfs-ruby.pod:22
20061 #: ../java/examples/guestfs-java.pod:31
20063 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
20064 "exception. This has a single parameter which is the error message (a "
20069 #: ../java/examples/guestfs-java.pod:35
20070 msgid "Calling any method on a closed handle raises the same exception."
20074 #: ../java/examples/guestfs-java.pod:47
20076 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)"
20077 ">, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
20078 "libguestfs.org/>, L<http://caml.inria.fr/>."
20082 #: ../java/examples/guestfs-java.pod:63 ../perl/examples/guestfs-perl.pod:57
20083 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
20087 #: ../ocaml/examples/guestfs-ocaml.pod:5
20088 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
20092 #: ../ocaml/examples/guestfs-ocaml.pod:9
20093 msgid "Module style:"
20097 #: ../ocaml/examples/guestfs-ocaml.pod:11
20100 " let g = Guestfs.create () in\n"
20101 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
20102 " Guestfs.launch g;\n"
20107 #: ../ocaml/examples/guestfs-ocaml.pod:15
20108 msgid "Object-oriented style:"
20112 #: ../ocaml/examples/guestfs-ocaml.pod:17
20115 " let g = new Guestfs.guestfs () in\n"
20116 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
20122 #: ../ocaml/examples/guestfs-ocaml.pod:21
20125 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
20127 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
20132 #: ../ocaml/examples/guestfs-ocaml.pod:27
20134 "This manual page documents how to call libguestfs from the OCaml programming "
20135 "language. This page just documents the differences from the C API and gives "
20136 "some examples. If you are not familiar with using libguestfs, you also need "
20137 "to read L<guestfs(3)>."
20141 #: ../ocaml/examples/guestfs-ocaml.pod:32
20142 msgid "PROGRAMMING STYLES"
20146 #: ../ocaml/examples/guestfs-ocaml.pod:34
20148 "There are two different programming styles supported by the OCaml bindings. "
20149 "You can use a module style, with each C function mapped to an OCaml function:"
20153 #: ../ocaml/examples/guestfs-ocaml.pod:38
20156 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
20161 #: ../ocaml/examples/guestfs-ocaml.pod:40
20166 #: ../ocaml/examples/guestfs-ocaml.pod:42
20169 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
20174 #: ../ocaml/examples/guestfs-ocaml.pod:44
20176 "Alternately you can use an object-oriented style, calling methods on the "
20177 "class C<Guestfs.guestfs>:"
20181 #: ../ocaml/examples/guestfs-ocaml.pod:47
20184 " method set_verbose : bool -> unit\n"
20189 #: ../ocaml/examples/guestfs-ocaml.pod:49
20191 "The object-oriented style is usually briefer, and the minor performance "
20192 "penalty isn't noticable in the general overhead of performing libguestfs "
20197 #: ../ocaml/examples/guestfs-ocaml.pod:55
20199 "The handle is closed when it is reaped by the garbage collector. Because "
20200 "libguestfs handles include a lot of state, it is also possible to close (and "
20201 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
20206 #: ../ocaml/examples/guestfs-ocaml.pod:62
20208 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
20209 "exception. This has a single parameter which is the error message (a "
20214 #: ../ocaml/examples/guestfs-ocaml.pod:66
20216 "Calling any function/method on a closed handle raises C<Guestfs."
20217 "Handle_closed>. The single parameter is the name of the function that you "
20222 #: ../ocaml/examples/guestfs-ocaml.pod:80
20224 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-perl(3)"
20225 ">, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
20226 "libguestfs.org/>, L<http://caml.inria.fr/>."
20230 #: ../perl/examples/guestfs-perl.pod:5
20231 msgid "guestfs-perl - How to use libguestfs from Perl"
20235 #: ../perl/examples/guestfs-perl.pod:9
20238 " use Sys::Guestfs;\n"
20243 #: ../perl/examples/guestfs-perl.pod:11
20246 " my $h = Sys::Guestfs->new ();\n"
20247 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
20248 " $h->launch ();\n"
20249 " $h->mount_options ('', '/dev/sda1', '/');\n"
20250 " $h->touch ('/hello');\n"
20256 #: ../perl/examples/guestfs-perl.pod:20
20258 "This manual page documents how to call libguestfs from the Perl programming "
20259 "language. This page just documents the differences from the C API and gives "
20260 "some examples. If you are not familiar with using libguestfs, you also need "
20261 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
20265 #: ../perl/examples/guestfs-perl.pod:26
20270 #: ../perl/examples/guestfs-perl.pod:28
20272 "Errors from libguestfs functions turn into calls to C<croak> (see L<Carp(3)"
20277 #: ../perl/examples/guestfs-perl.pod:41
20279 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)"
20280 ">, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
20281 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
20285 #: ../python/examples/guestfs-python.pod:5
20286 msgid "guestfs-python - How to use libguestfs from Python"
20290 #: ../python/examples/guestfs-python.pod:9
20293 " import guestfs\n"
20294 " g = guestfs.GuestFS ()\n"
20295 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
20301 #: ../python/examples/guestfs-python.pod:16
20303 "This manual page documents how to call libguestfs from the Python "
20304 "programming language. This page just documents the differences from the C "
20305 "API and gives some examples. If you are not familiar with using libguestfs, "
20306 "you also need to read L<guestfs(3)>."
20310 #: ../python/examples/guestfs-python.pod:23
20312 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
20313 "single string argument which is the error message."
20317 #: ../python/examples/guestfs-python.pod:26
20318 msgid "MORE DOCUMENTATION"
20322 #: ../python/examples/guestfs-python.pod:28
20327 #: ../python/examples/guestfs-python.pod:30
20331 " >>> import guestfs\n"
20332 " >>> help (guestfs)\n"
20337 #: ../python/examples/guestfs-python.pod:44
20339 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
20340 ">, L<guestfs-perl(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
20341 "libguestfs.org/>."
20345 #: ../rescue/virt-rescue.pod:5
20346 msgid "virt-rescue - Run a rescue shell on a virtual machine"
20350 #: ../rescue/virt-rescue.pod:9
20353 " virt-rescue [--options] -d domname\n"
20358 #: ../rescue/virt-rescue.pod:11
20361 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
20366 #: ../rescue/virt-rescue.pod:15
20369 " virt-rescue [--options] domname\n"
20374 #: ../rescue/virt-rescue.pod:17
20377 " virt-rescue [--options] disk.img [disk.img ...]\n"
20382 #: ../rescue/virt-rescue.pod:21
20384 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
20385 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
20386 "you from doing this, but doesn't catch all cases."
20390 #: ../rescue/virt-rescue.pod:25
20392 "However if you use the I<--ro> (read only) option, then you can attach a "
20393 "shell to a live virtual machine. The results might be strange or "
20394 "inconsistent at times but you won't get disk corruption."
20398 #: ../rescue/virt-rescue.pod:31
20400 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
20401 "need for a CD. virt-rescue gives you a rescue shell and some simple "
20402 "recovery tools which you can use to examine or rescue a virtual machine or "
20407 #: ../rescue/virt-rescue.pod:36
20409 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
20410 "on disk image(s):"
20414 #: ../rescue/virt-rescue.pod:39
20417 " virt-rescue -d GuestName\n"
20422 #: ../rescue/virt-rescue.pod:41
20425 " virt-rescue --ro -a /path/to/disk.img\n"
20430 #: ../rescue/virt-rescue.pod:43
20433 " virt-rescue -a /dev/sdc\n"
20438 #: ../rescue/virt-rescue.pod:45
20439 msgid "For live VMs you I<must> use the --ro option."
20443 #: ../rescue/virt-rescue.pod:47
20445 "When you run virt-rescue on a virtual machine or disk image, you are placed "
20446 "in an interactive bash shell where you can use many ordinary Linux "
20447 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
20448 "appliance. You must mount the virtual machine's filesystems by hand. There "
20449 "is an empty directory called C</sysroot> where you can mount filesystems."
20453 #: ../rescue/virt-rescue.pod:54
20455 "In the example below, we list logical volumes, then choose one to mount "
20456 "under C</sysroot>:"
20460 #: ../rescue/virt-rescue.pod:57
20464 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
20465 " lv_root vg_f11x64 -wi-a- 8.83G\n"
20466 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
20467 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
20468 " ><rescue> ls /sysroot\n"
20473 #: ../rescue/virt-rescue.pod:64
20475 "If you don't know what filesystems are available on the virtual machine then "
20476 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
20480 #: ../rescue/virt-rescue.pod:70
20482 "Virt-rescue can be used on I<any> disk image file or device, not just a "
20483 "virtual machine. For example you can use it on a blank file if you want to "
20484 "partition that file (although we would recommend using L<guestfish(1)> "
20485 "instead as it is more suitable for this purpose). You can even use virt-"
20486 "rescue on things like SD cards."
20490 #: ../rescue/virt-rescue.pod:76
20492 "Virt-rescue does not require root. You only need to run it as root if you "
20493 "need root to open the disk image."
20497 #: ../rescue/virt-rescue.pod:79
20499 "This tool is just designed for quick interactive hacking on a virtual "
20500 "machine. For more structured access to a virtual machine disk image, you "
20501 "should use L<guestfs(3)>. To get a structured shell that you can use to "
20502 "make scripted changes to guests, use L<guestfish(1)>."
20506 #: ../rescue/virt-rescue.pod:103
20507 msgid "B<--append kernelopts>"
20511 #: ../rescue/virt-rescue.pod:105
20512 msgid "Pass additional options to the rescue kernel."
20516 #: ../rescue/virt-rescue.pod:135
20519 " virt-rescue --format=raw -a disk.img\n"
20524 #: ../rescue/virt-rescue.pod:139
20527 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
20532 #: ../rescue/virt-rescue.pod:148
20537 #: ../rescue/virt-rescue.pod:150
20538 msgid "B<--memsize MB>"
20542 #: ../rescue/virt-rescue.pod:152
20544 "Change the amount of memory allocated to the rescue system. The default is "
20545 "set by libguestfs and is small but adequate for running system tools. The "
20546 "occasional program might need more memory. The parameter is specified in "
20551 #: ../rescue/virt-rescue.pod:157
20552 msgid "B<--network>"
20556 #: ../rescue/virt-rescue.pod:159
20557 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
20561 #: ../rescue/virt-rescue.pod:165
20562 msgid "Open the image read-only."
20566 #: ../rescue/virt-rescue.pod:175
20568 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
20569 "SELINUX> before using this option."
20573 #: ../rescue/virt-rescue.pod:194
20575 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
20576 "are done read-write."
20580 #: ../rescue/virt-rescue.pod:207
20581 msgid "Previous versions of virt-rescue allowed you to write either:"
20585 #: ../rescue/virt-rescue.pod:209
20588 " virt-rescue disk.img [disk.img ...]\n"
20593 #: ../rescue/virt-rescue.pod:213
20596 " virt-rescue guestname\n"
20601 #: ../rescue/virt-rescue.pod:221
20606 #: ../rescue/virt-rescue.pod:223
20608 "Adding the I<--network> option enables QEMU user networking in the rescue "
20609 "appliance. There are some differences between user networking and ordinary "
20614 #: ../rescue/virt-rescue.pod:229
20615 msgid "ping does not work"
20619 #: ../rescue/virt-rescue.pod:231
20621 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
20622 "send the ping packets, and because virt-rescue must be able to run as non-"
20623 "root, QEMU user networking is not able to emulate the L<ping(8)> command. "
20624 "The ping command will appear to resolve addresses but will not be able to "
20625 "send or receive any packets. This does not mean that the network is not "
20630 #: ../rescue/virt-rescue.pod:238
20631 msgid "cannot receive connections"
20635 #: ../rescue/virt-rescue.pod:240
20636 msgid "QEMU user networking cannot receive incoming connections."
20640 #: ../rescue/virt-rescue.pod:242
20641 msgid "making TCP connections"
20645 #: ../rescue/virt-rescue.pod:244
20647 "The virt-rescue appliance needs to be small and so does not include many "
20648 "network tools. In particular there is no L<telnet(1)> command. You can "
20649 "make TCP connections from the shell using the magical C</dev/tcp/"
20650 "E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
20654 #: ../rescue/virt-rescue.pod:249
20657 " exec 3<>/dev/tcp/redhat.com/80\n"
20658 " echo \"GET /\" >&3\n"
20664 #: ../rescue/virt-rescue.pod:253
20665 msgid "See L<bash(1)> for more details."
20669 #: ../rescue/virt-rescue.pod:259
20671 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
20672 "ENVIRONMENT VARIABLES> for the complete list."
20676 #: ../rescue/virt-rescue.pod:286
20678 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<http://"
20679 "libguestfs.org/>."
20683 #: ../resize/virt-resize.pod:5
20684 msgid "virt-resize - Resize a virtual machine disk"
20688 #: ../resize/virt-resize.pod:9
20691 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
20692 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
20693 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
20698 #: ../resize/virt-resize.pod:15
20700 "Virt-resize is a tool which can resize a virtual machine disk, making it "
20701 "larger or smaller overall, and resizing or deleting any partitions contained "
20706 #: ../resize/virt-resize.pod:19
20708 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
20709 "not> be used on live virtual machines - for consistent results, shut the "
20710 "virtual machine down before resizing it."
20714 #: ../resize/virt-resize.pod:23
20716 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
20717 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
20721 #: ../resize/virt-resize.pod:31 ../src/guestfs.pod:469 ../src/guestfs.pod:1257
20722 #: ../src/guestfs.pod:1396 ../src/guestfs.pod:2466
20727 #: ../resize/virt-resize.pod:33
20729 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
20730 "fill the extra 5GB of space."
20734 #: ../resize/virt-resize.pod:36
20737 " virt-filesystems --long -h --all -a olddisk\n"
20742 #: ../resize/virt-resize.pod:38
20745 " truncate -r olddisk newdisk\n"
20746 " truncate -s +5G newdisk\n"
20751 #: ../resize/virt-resize.pod:41
20754 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
20755 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
20760 #: ../resize/virt-resize.pod:44 ../src/guestfs.pod:475 ../src/guestfs.pod:1261
20761 #: ../src/guestfs.pod:1400 ../src/guestfs.pod:2491
20766 #: ../resize/virt-resize.pod:46
20768 "As above, but make the /boot partition 200MB bigger, while giving the "
20769 "remaining space to /dev/sda2:"
20773 #: ../resize/virt-resize.pod:49
20776 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20777 " olddisk newdisk\n"
20782 #: ../resize/virt-resize.pod:52 ../src/guestfs.pod:486 ../src/guestfs.pod:1406
20787 #: ../resize/virt-resize.pod:54
20789 "As in the first example, but expand a logical volume as the final step. "
20790 "This is what you would typically use for Linux guests that use LVM:"
20794 #: ../resize/virt-resize.pod:58
20797 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
20798 " olddisk newdisk\n"
20803 #: ../resize/virt-resize.pod:61
20808 #: ../resize/virt-resize.pod:63
20810 "As in the first example, but the output format will be qcow2 instead of a "
20815 #: ../resize/virt-resize.pod:66
20818 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
20819 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
20824 #: ../resize/virt-resize.pod:71
20825 msgid "DETAILED USAGE"
20829 #: ../resize/virt-resize.pod:73
20830 msgid "EXPANDING A VIRTUAL MACHINE DISK"
20834 #: ../resize/virt-resize.pod:77
20835 msgid "1. Shut down the virtual machine"
20839 #: ../resize/virt-resize.pod:79
20840 msgid "2. Locate input disk image"
20844 #: ../resize/virt-resize.pod:81
20846 "Locate the input disk image (ie. the file or device on the host containing "
20847 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
20848 "dumpxml> like this to find the disk image name:"
20852 #: ../resize/virt-resize.pod:85
20855 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
20856 " Found 1 nodes:\n"
20858 " <source dev=\"/dev/vg/lv_guest\" />\n"
20863 #: ../resize/virt-resize.pod:90
20864 msgid "3. Look at current sizing"
20868 #: ../resize/virt-resize.pod:92
20869 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
20873 #: ../resize/virt-resize.pod:95
20876 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
20877 " Name Type Size Parent\n"
20878 " /dev/sda1 partition 101M /dev/sda\n"
20879 " /dev/sda2 partition 7.9G /dev/sda\n"
20880 " /dev/sda device 8.0G -\n"
20885 #: ../resize/virt-resize.pod:101
20887 "(This example is a virtual machine with an 8 GB disk which we would like to "
20888 "expand up to 10 GB)."
20892 #: ../resize/virt-resize.pod:104
20893 msgid "4. Create output disk"
20897 #: ../resize/virt-resize.pod:106
20899 "Virt-resize cannot do in-place disk modifications. You have to have space "
20900 "to store the resized output disk."
20904 #: ../resize/virt-resize.pod:109
20906 "To store the resized disk image in a file, create a file of a suitable size:"
20910 #: ../resize/virt-resize.pod:112
20913 " # rm -f outdisk\n"
20914 " # truncate -s 10G outdisk\n"
20919 #: ../resize/virt-resize.pod:115
20920 msgid "Or use L<lvcreate(1)> to create a logical volume:"
20924 #: ../resize/virt-resize.pod:117
20927 " # lvcreate -L 10G -n lv_name vg_name\n"
20932 #: ../resize/virt-resize.pod:119
20933 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
20937 #: ../resize/virt-resize.pod:121
20940 " # virsh pool-list\n"
20941 " # virsh vol-create-as poolname newvol 10G\n"
20946 #: ../resize/virt-resize.pod:124
20951 #: ../resize/virt-resize.pod:126
20953 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
20954 "file) and the output disk. The output disk is the one created in the "
20959 #: ../resize/virt-resize.pod:130
20962 " # virt-resize indisk outdisk\n"
20967 #: ../resize/virt-resize.pod:132
20969 "This command just copies disk image C<indisk> to disk image C<outdisk> "
20970 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
20971 "larger, then an extra, empty partition is created at the end of the disk "
20972 "covering the extra space. If C<outdisk> is smaller, then it will give an "
20977 #: ../resize/virt-resize.pod:138
20979 "More realistically you'd want to expand existing partitions in the disk "
20980 "image by passing extra options (for the full list see the L</OPTIONS> "
20985 #: ../resize/virt-resize.pod:142
20987 "L</--expand> is the most useful option. It expands the named partition "
20988 "within the disk to fill any extra space:"
20992 #: ../resize/virt-resize.pod:145
20995 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
21000 #: ../resize/virt-resize.pod:147
21002 "(In this case, an extra partition is I<not> created at the end of the disk, "
21003 "because there will be no unused space)."
21007 #: ../resize/virt-resize.pod:150
21009 "L</--resize> is the other commonly used option. The following would "
21010 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
21011 "rest of the available space:"
21015 #: ../resize/virt-resize.pod:154
21018 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
21019 " indisk outdisk\n"
21024 #: ../resize/virt-resize.pod:157
21026 "If the expanded partition in the image contains a filesystem or LVM PV, then "
21027 "if virt-resize knows how, it will resize the contents, the equivalent of "
21028 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
21029 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
21030 "filesystems, so you would have to online resize them after booting the guest."
21034 #: ../resize/virt-resize.pod:164
21035 msgid "Other options are covered below."
21039 #: ../resize/virt-resize.pod:166
21044 #: ../resize/virt-resize.pod:168
21045 msgid "Thoroughly test the new disk image I<before> discarding the old one."
21049 #: ../resize/virt-resize.pod:170
21050 msgid "If you are using libvirt, edit the XML to point at the new disk:"
21054 #: ../resize/virt-resize.pod:172
21057 " # virsh edit guestname\n"
21062 #: ../resize/virt-resize.pod:174
21064 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
21065 "html#elementsDisks>"
21069 #: ../resize/virt-resize.pod:177
21070 msgid "Then start up the domain with the new, resized disk:"
21074 #: ../resize/virt-resize.pod:179
21077 " # virsh start guestname\n"
21082 #: ../resize/virt-resize.pod:181
21084 "and check that it still works. See also the L</NOTES> section below for "
21085 "additional information."
21089 #: ../resize/virt-resize.pod:184
21090 msgid "7. Resize LVs etc inside the guest"
21094 #: ../resize/virt-resize.pod:186
21095 msgid "(This can also be done offline using L<guestfish(1)>)"
21099 #: ../resize/virt-resize.pod:188
21101 "Once the guest has booted you should see the new space available, at least "
21102 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
21103 "may need to resize LVs inside PVs, and also resize filesystem types that "
21104 "virt-resize does not know how to expand."
21108 #: ../resize/virt-resize.pod:195
21109 msgid "SHRINKING A VIRTUAL MACHINE DISK"
21113 #: ../resize/virt-resize.pod:197
21115 "Shrinking is somewhat more complex than expanding, and only an overview is "
21120 #: ../resize/virt-resize.pod:200
21122 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
21123 "filesystems). The user has to shrink content before passing the disk image "
21124 "to virt-resize, and virt-resize will check that the content has been shrunk "
21129 #: ../resize/virt-resize.pod:205
21130 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
21134 #: ../resize/virt-resize.pod:207
21136 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
21137 "steps 3 and 4 above to allocate a new disk image."
21141 #: ../resize/virt-resize.pod:210
21143 "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
21147 #: ../resize/virt-resize.pod:213
21148 msgid "IGNORING OR DELETING PARTITIONS"
21152 #: ../resize/virt-resize.pod:215
21154 "virt-resize also gives a convenient way to ignore or delete partitions when "
21155 "copying from the input disk to the output disk. Ignoring a partition speeds "
21156 "up the copy where you don't care about the existing contents of a "
21157 "partition. Deleting a partition removes it completely, but note that it "
21158 "also renumbers any partitions after the one which is deleted, which can "
21159 "leave some guests unbootable."
21163 #: ../resize/virt-resize.pod:222
21164 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
21168 #: ../resize/virt-resize.pod:224
21170 "If the input disk is in qcow2 format, then you may prefer that the output is "
21171 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
21172 "the fly. The output format is simply determined by the format of the empty "
21173 "output container that you provide. Thus to create qcow2 output, use:"
21177 #: ../resize/virt-resize.pod:230
21180 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
21185 #: ../resize/virt-resize.pod:232
21186 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
21190 #: ../resize/virt-resize.pod:234
21191 msgid "Similarly, to get non-sparse raw output use:"
21195 #: ../resize/virt-resize.pod:236
21198 " fallocate -l size outdisk\n"
21203 #: ../resize/virt-resize.pod:238
21205 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
21206 "dev/zero of=outdisk bs=1M count=..>)"
21210 #: ../resize/virt-resize.pod:247
21211 msgid "Display help."
21215 #: ../resize/virt-resize.pod:249
21220 #: ../resize/virt-resize.pod:251 ../tools/virt-make-fs.pl:177
21221 #: ../tools/virt-win-reg.pl:120
21226 #: ../resize/virt-resize.pod:253 ../tools/virt-win-reg.pl:122
21227 msgid "Enable debugging messages."
21231 #: ../resize/virt-resize.pod:255
21232 msgid "B<--delete part>"
21236 #: ../resize/virt-resize.pod:257
21238 "Delete the named partition. It would be more accurate to describe this as "
21239 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
21240 "the original disk image is left intact."
21244 #: ../resize/virt-resize.pod:261
21246 "Note that when you delete a partition, then anything contained in the "
21247 "partition is also deleted. Furthermore, this causes any partitions that "
21248 "come after to be I<renumbered>, which can easily make your guest unbootable."
21252 #: ../resize/virt-resize.pod:266 ../resize/virt-resize.pod:327
21253 #: ../resize/virt-resize.pod:448
21254 msgid "You can give this option multiple times."
21258 #: ../resize/virt-resize.pod:268
21259 msgid "B<--expand part>"
21263 #: ../resize/virt-resize.pod:270
21265 "Expand the named partition so it uses up all extra space (space left over "
21266 "after any other resize changes that you request have been done)."
21270 #: ../resize/virt-resize.pod:273
21272 "If virt-resize knows how, it will expand the direct content of the "
21273 "partition. For example, if the partition is an LVM PV, it will expand the "
21274 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
21275 "content it doesn't know about alone."
21279 #: ../resize/virt-resize.pod:278
21280 msgid "Currently virt-resize can resize:"
21284 #: ../resize/virt-resize.pod:284
21285 msgid "ext2, ext3 and ext4 filesystems."
21289 #: ../resize/virt-resize.pod:288
21290 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
21294 #: ../resize/virt-resize.pod:290
21296 "The filesystem must have been shut down consistently last time it was used. "
21297 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
21298 "consistency check, so at the first boot after resizing Windows will check "
21303 #: ../resize/virt-resize.pod:297
21305 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
21306 "inside the PV, but see the I<--LV-expand> option. The user could also "
21307 "resize LVs as desired after boot."
21311 #: ../resize/virt-resize.pod:303
21312 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
21316 #: ../resize/virt-resize.pod:307 ../resize/virt-resize.pod:476
21317 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
21321 #: ../resize/virt-resize.pod:309 ../tools/virt-list-filesystems.pl:91
21322 #: ../tools/virt-list-partitions.pl:92 ../tools/virt-tar.pl:141
21323 #: ../tools/virt-win-reg.pl:142
21324 msgid "B<--format> raw"
21328 #: ../resize/virt-resize.pod:311
21330 "Specify the format of the input disk image. If this flag is not given then "
21331 "it is auto-detected from the image itself."
21335 #: ../resize/virt-resize.pod:317
21337 "Note that this option I<does not> affect the output format. See L</QCOW2 "
21338 "AND NON-SPARSE RAW FORMATS>."
21342 #: ../resize/virt-resize.pod:320
21343 msgid "B<--ignore part>"
21347 #: ../resize/virt-resize.pod:322
21349 "Ignore the named partition. Effectively this means the partition is "
21350 "allocated on the destination disk, but the content is not copied across from "
21351 "the source disk. The content of the partition will be blank (all zero "
21356 #: ../resize/virt-resize.pod:329
21357 msgid "B<--LV-expand logvol>"
21361 #: ../resize/virt-resize.pod:331
21363 "This takes the logical volume and, as a final step, expands it to fill all "
21364 "the space available in its volume group. A typical usage, assuming a Linux "
21365 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
21366 "lv_root> would be:"
21370 #: ../resize/virt-resize.pod:336
21373 " virt-resize indisk outdisk \\\n"
21374 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
21379 #: ../resize/virt-resize.pod:339
21381 "This would first expand the partition (and PV), and then expand the root "
21382 "device to fill the extra space in the PV."
21386 #: ../resize/virt-resize.pod:342
21388 "The contents of the LV are also resized if virt-resize knows how to do "
21389 "that. You can stop virt-resize from trying to expand the content by using "
21390 "the option I<--no-expand-content>."
21394 #: ../resize/virt-resize.pod:346
21395 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
21399 #: ../resize/virt-resize.pod:348
21401 "You can give this option multiple times, I<but> it doesn't make sense to do "
21402 "this unless the logical volumes you specify are all in different volume "
21407 #: ../resize/virt-resize.pod:354
21408 msgid "B<--dryrun>"
21412 #: ../resize/virt-resize.pod:356
21413 msgid "Print a summary of what would be done, but don't do anything."
21417 #: ../resize/virt-resize.pod:358
21418 msgid "B<--no-copy-boot-loader>"
21422 #: ../resize/virt-resize.pod:360
21424 "By default, virt-resize copies over some sectors at the start of the disk "
21425 "(up to the beginning of the first partition). Commonly these sectors "
21426 "contain the Master Boot Record (MBR) and the boot loader, and are required "
21427 "in order for the guest to boot correctly."
21431 #: ../resize/virt-resize.pod:365
21433 "If you specify this flag, then this initial copy is not done. You may need "
21434 "to reinstall the boot loader in this case."
21438 #: ../resize/virt-resize.pod:368
21439 msgid "B<--no-extra-partition>"
21443 #: ../resize/virt-resize.pod:370
21445 "By default, virt-resize creates an extra partition if there is any extra, "
21446 "unused space after all resizing has happened. Use this option to prevent "
21447 "the extra partition from being created. If you do this then the extra space "
21448 "will be inaccessible until you run fdisk, parted, or some other partitioning "
21449 "tool in the guest."
21453 #: ../resize/virt-resize.pod:376
21455 "Note that if the surplus space is smaller than 10 MB, no extra partition "
21460 #: ../resize/virt-resize.pod:379
21461 msgid "B<--no-expand-content>"
21465 #: ../resize/virt-resize.pod:381
21467 "By default, virt-resize will try to expand the direct contents of "
21468 "partitions, if it knows how (see I<--expand> option above)."
21472 #: ../resize/virt-resize.pod:384
21474 "If you give the I<--no-expand-content> option then virt-resize will not "
21479 #: ../resize/virt-resize.pod:387
21480 msgid "B<--ntfsresize-force>"
21484 #: ../resize/virt-resize.pod:389
21486 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
21487 "the NTFS disk is marked as needing a consistency check. You have to use "
21488 "this option if you want to resize a Windows guest multiple times without "
21489 "booting into Windows between each resize."
21493 #: ../resize/virt-resize.pod:395
21494 msgid "B<--output-format> raw"
21498 #: ../resize/virt-resize.pod:397
21500 "Specify the format of the output disk image. If this flag is not given then "
21501 "it is auto-detected from the image itself."
21505 #: ../resize/virt-resize.pod:403
21507 "Note that this option I<does not create> the output format. This option "
21508 "just tells libguestfs what it is so it doesn't try to guess it. You still "
21509 "need to create the output disk with the right format. See L</QCOW2 AND NON-"
21510 "SPARSE RAW FORMATS>."
21514 #: ../resize/virt-resize.pod:408
21519 #: ../resize/virt-resize.pod:410
21524 #: ../resize/virt-resize.pod:412
21525 msgid "Don't print the summary."
21529 #: ../resize/virt-resize.pod:414
21530 msgid "B<--resize part=size>"
21534 #: ../resize/virt-resize.pod:416
21536 "Resize the named partition (expanding or shrinking it) so that it has the "
21541 #: ../resize/virt-resize.pod:419
21543 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
21544 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
21545 "size; or as a relative number or percentage. For example:"
21549 #: ../resize/virt-resize.pod:425
21552 " --resize /dev/sda2=10G\n"
21557 #: ../resize/virt-resize.pod:427
21560 " --resize /dev/sda4=90%\n"
21565 #: ../resize/virt-resize.pod:429
21568 " --resize /dev/sda2=+1G\n"
21573 #: ../resize/virt-resize.pod:431
21576 " --resize /dev/sda2=-200M\n"
21581 #: ../resize/virt-resize.pod:433
21584 " --resize /dev/sda1=+128K\n"
21589 #: ../resize/virt-resize.pod:435
21592 " --resize /dev/sda1=+10%\n"
21597 #: ../resize/virt-resize.pod:437
21600 " --resize /dev/sda1=-10%\n"
21605 #: ../resize/virt-resize.pod:439
21607 "You can increase the size of any partition. Virt-resize will expand the "
21608 "direct content of the partition if it knows how (see I<--expand> below)."
21612 #: ../resize/virt-resize.pod:443
21614 "You can only I<decrease> the size of partitions that contain filesystems or "
21615 "PVs which have already been shrunk. Virt-resize will check this has been "
21616 "done before proceeding, or else will print an error (see also I<--resize-"
21621 #: ../resize/virt-resize.pod:450
21622 msgid "B<--resize-force part=size>"
21626 #: ../resize/virt-resize.pod:452
21628 "This is the same as I<--resize> except that it will let you decrease the "
21629 "size of any partition. Generally this means you will lose any data which "
21630 "was at the end of the partition you shrink, but you may not care about that "
21631 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
21632 "as a swap partition)."
21636 #: ../resize/virt-resize.pod:458
21637 msgid "See also the I<--ignore> option."
21641 #: ../resize/virt-resize.pod:460
21642 msgid "B<--shrink part>"
21646 #: ../resize/virt-resize.pod:462
21648 "Shrink the named partition until the overall disk image fits in the "
21649 "destination. The named partition B<must> contain a filesystem or PV which "
21650 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
21651 "online tools). Virt-resize will check this and give an error if it has not "
21656 #: ../resize/virt-resize.pod:468
21658 "The amount by which the overall disk must be shrunk (after carrying out all "
21659 "other operations requested by the user) is called the \"deficit\". For "
21660 "example, a straight copy (assume no other operations) from a 5GB disk image "
21661 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
21662 "would give an error unless the user specified a partition to shrink and that "
21663 "partition had more than a gigabyte of free space."
21667 #: ../resize/virt-resize.pod:488
21668 msgid "\"Partition 1 does not end on cylinder boundary.\""
21672 #: ../resize/virt-resize.pod:490
21674 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
21675 "means the partitions will not be aligned to the ancient CHS geometry. "
21676 "However CHS geometry is meaningless for disks manufactured since the early "
21677 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
21678 "cylinders is not required by any modern operating system."
21682 #: ../resize/virt-resize.pod:497
21683 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
21687 #: ../resize/virt-resize.pod:499
21689 "In Windows Vista and later versions, Microsoft switched to using a separate "
21690 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
21691 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
21692 "the boot partition. Doing so seems to break the guest completely. However "
21693 "expanding the second partition (ie. C: drive) should work."
21697 #: ../resize/virt-resize.pod:506
21699 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
21700 "NTFS partitions have been expanded. This is just a safety check and (unless "
21701 "it find errors) is nothing to worry about."
21705 #: ../resize/virt-resize.pod:510
21706 msgid "GUEST BOOT STUCK AT \"GRUB\""
21710 #: ../resize/virt-resize.pod:512
21712 "If a Linux guest does not boot after resizing, and the boot is stuck after "
21713 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
21714 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
21715 "although we think is to do with partition alignment."
21719 #: ../resize/virt-resize.pod:517
21722 " guestfish -i -a newdisk\n"
21723 " ><fs> cat /boot/grub/device.map\n"
21724 " # check the contents of this file are sensible or\n"
21725 " # edit the file if necessary\n"
21726 " ><fs> grub-install / /dev/vda\n"
21732 #: ../resize/virt-resize.pod:524
21734 "For more flexible guest reconfiguration, including if you need to specify "
21735 "other parameters to grub-install, use L<virt-rescue(1)>."
21739 #: ../resize/virt-resize.pod:527
21740 msgid "ALTERNATIVE TOOLS"
21744 #: ../resize/virt-resize.pod:529
21746 "There are several proprietary tools for resizing partitions. We won't "
21747 "mention any here."
21751 #: ../resize/virt-resize.pod:532
21753 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
21754 "operations on disk images. They can resize and move partitions, but I don't "
21755 "think they can do anything with the contents, and they certainly don't "
21760 #: ../resize/virt-resize.pod:537
21762 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
21763 "but at a much lower level. You will probably end up hand-calculating sector "
21764 "offsets, which is something that virt-resize was designed to avoid. If you "
21765 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
21770 #: ../resize/virt-resize.pod:552
21772 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
21773 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
21774 "L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, "
21775 "L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, L<http://libguestfs.org/>."
21779 #: ../ruby/examples/guestfs-ruby.pod:5
21780 msgid "guestfs-ruby - How to use libguestfs from Ruby"
21784 #: ../ruby/examples/guestfs-ruby.pod:9
21787 " require 'guestfs'\n"
21788 " g = Guestfs::Guestfs.new()\n"
21789 " g.add_drive_opts(\"disk.img\",\n"
21790 " :readonly => 1, :format => \"raw\")\n"
21796 #: ../ruby/examples/guestfs-ruby.pod:17
21798 "This manual page documents how to call libguestfs from the Ruby programming "
21799 "language. This page just documents the differences from the C API and gives "
21800 "some examples. If you are not familiar with using libguestfs, you also need "
21801 "to read L<guestfs(3)>."
21805 #: ../ruby/examples/guestfs-ruby.pod:24
21807 "Errors from libguestfs functions are mapped into the C<Error> exception. "
21808 "This has a single parameter which is the error message (a string)."
21812 #: ../ruby/examples/guestfs-ruby.pod:38
21814 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
21815 ">, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<http://"
21816 "libguestfs.org/>."
21820 #: ../src/guestfs-actions.pod:1
21821 msgid "guestfs_add_cdrom"
21825 #: ../src/guestfs-actions.pod:3
21829 " guestfs_add_cdrom (guestfs_h *g,\n"
21830 " const char *filename);\n"
21835 #: ../src/guestfs-actions.pod:7 ../src/guestfs-actions.pod:249
21836 #: ../src/guestfs-actions.pod:270
21838 "I<This function is deprecated.> In new code, use the L</"
21839 "guestfs_add_drive_opts> call instead."
21843 #: ../src/guestfs-actions.pod:24
21845 "This call checks for the existence of C<filename>. This stops you from "
21846 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21847 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
21852 #: ../src/guestfs-actions.pod:31
21854 "If you just want to add an ISO file (often you use this as an efficient way "
21855 "to transfer large files into the guest), then you should probably use "
21856 "C<guestfs_add_drive_ro> instead."
21860 #: ../src/guestfs-actions.pod:37 ../src/guestfs-actions.pod:140
21861 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
21862 #: ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:280
21863 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
21864 #: ../src/guestfs-actions.pod:427 ../src/guestfs-actions.pod:447
21865 #: ../src/guestfs-actions.pod:461 ../src/guestfs-actions.pod:506
21866 #: ../src/guestfs-actions.pod:534 ../src/guestfs-actions.pod:552
21867 #: ../src/guestfs-actions.pod:619 ../src/guestfs-actions.pod:652
21868 #: ../src/guestfs-actions.pod:666 ../src/guestfs-actions.pod:681
21869 #: ../src/guestfs-actions.pod:780 ../src/guestfs-actions.pod:798
21870 #: ../src/guestfs-actions.pod:812 ../src/guestfs-actions.pod:826
21871 #: ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:1046
21872 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1084
21873 #: ../src/guestfs-actions.pod:1168 ../src/guestfs-actions.pod:1186
21874 #: ../src/guestfs-actions.pod:1205 ../src/guestfs-actions.pod:1219
21875 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1309
21876 #: ../src/guestfs-actions.pod:1340 ../src/guestfs-actions.pod:1365
21877 #: ../src/guestfs-actions.pod:1407 ../src/guestfs-actions.pod:1520
21878 #: ../src/guestfs-actions.pod:1547 ../src/guestfs-actions.pod:1762
21879 #: ../src/guestfs-actions.pod:1784 ../src/guestfs-actions.pod:1871
21880 #: ../src/guestfs-actions.pod:2346 ../src/guestfs-actions.pod:2490
21881 #: ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2586
21882 #: ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3641
21883 #: ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:3855
21884 #: ../src/guestfs-actions.pod:3869 ../src/guestfs-actions.pod:3882
21885 #: ../src/guestfs-actions.pod:3896 ../src/guestfs-actions.pod:3911
21886 #: ../src/guestfs-actions.pod:3947 ../src/guestfs-actions.pod:4019
21887 #: ../src/guestfs-actions.pod:4039 ../src/guestfs-actions.pod:4056
21888 #: ../src/guestfs-actions.pod:4079 ../src/guestfs-actions.pod:4102
21889 #: ../src/guestfs-actions.pod:4137 ../src/guestfs-actions.pod:4156
21890 #: ../src/guestfs-actions.pod:4175 ../src/guestfs-actions.pod:4210
21891 #: ../src/guestfs-actions.pod:4222 ../src/guestfs-actions.pod:4258
21892 #: ../src/guestfs-actions.pod:4274 ../src/guestfs-actions.pod:4287
21893 #: ../src/guestfs-actions.pod:4302 ../src/guestfs-actions.pod:4319
21894 #: ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4432
21895 #: ../src/guestfs-actions.pod:4445 ../src/guestfs-actions.pod:4496
21896 #: ../src/guestfs-actions.pod:4514 ../src/guestfs-actions.pod:4532
21897 #: ../src/guestfs-actions.pod:4548 ../src/guestfs-actions.pod:4562
21898 #: ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4593
21899 #: ../src/guestfs-actions.pod:4608 ../src/guestfs-actions.pod:4635
21900 #: ../src/guestfs-actions.pod:4698 ../src/guestfs-actions.pod:4771
21901 #: ../src/guestfs-actions.pod:4802 ../src/guestfs-actions.pod:4821
21902 #: ../src/guestfs-actions.pod:4840 ../src/guestfs-actions.pod:4852
21903 #: ../src/guestfs-actions.pod:4869 ../src/guestfs-actions.pod:4882
21904 #: ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:4912
21905 #: ../src/guestfs-actions.pod:4954 ../src/guestfs-actions.pod:4980
21906 #: ../src/guestfs-actions.pod:5019 ../src/guestfs-actions.pod:5039
21907 #: ../src/guestfs-actions.pod:5053 ../src/guestfs-actions.pod:5070
21908 #: ../src/guestfs-actions.pod:5119 ../src/guestfs-actions.pod:5172
21909 #: ../src/guestfs-actions.pod:5219 ../src/guestfs-actions.pod:5262
21910 #: ../src/guestfs-actions.pod:5290 ../src/guestfs-actions.pod:5307
21911 #: ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5465
21912 #: ../src/guestfs-actions.pod:5522 ../src/guestfs-actions.pod:5544
21913 #: ../src/guestfs-actions.pod:5562 ../src/guestfs-actions.pod:5594
21914 #: ../src/guestfs-actions.pod:5660 ../src/guestfs-actions.pod:5677
21915 #: ../src/guestfs-actions.pod:5690 ../src/guestfs-actions.pod:5704
21916 #: ../src/guestfs-actions.pod:5993 ../src/guestfs-actions.pod:6012
21917 #: ../src/guestfs-actions.pod:6031 ../src/guestfs-actions.pod:6045
21918 #: ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6071
21919 #: ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6097
21920 #: ../src/guestfs-actions.pod:6113 ../src/guestfs-actions.pod:6134
21921 #: ../src/guestfs-actions.pod:6153 ../src/guestfs-actions.pod:6172
21922 #: ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6220
21923 #: ../src/guestfs-actions.pod:6243 ../src/guestfs-actions.pod:6261
21924 #: ../src/guestfs-actions.pod:6280 ../src/guestfs-actions.pod:6301
21925 #: ../src/guestfs-actions.pod:6320 ../src/guestfs-actions.pod:6337
21926 #: ../src/guestfs-actions.pod:6356 ../src/guestfs-actions.pod:6384
21927 #: ../src/guestfs-actions.pod:6408 ../src/guestfs-actions.pod:6427
21928 #: ../src/guestfs-actions.pod:6451 ../src/guestfs-actions.pod:6470
21929 #: ../src/guestfs-actions.pod:6485 ../src/guestfs-actions.pod:6504
21930 #: ../src/guestfs-actions.pod:6548 ../src/guestfs-actions.pod:6578
21931 #: ../src/guestfs-actions.pod:6611 ../src/guestfs-actions.pod:6726
21932 #: ../src/guestfs-actions.pod:6847 ../src/guestfs-actions.pod:6859
21933 #: ../src/guestfs-actions.pod:6872 ../src/guestfs-actions.pod:6885
21934 #: ../src/guestfs-actions.pod:6907 ../src/guestfs-actions.pod:6920
21935 #: ../src/guestfs-actions.pod:6933 ../src/guestfs-actions.pod:6946
21936 #: ../src/guestfs-actions.pod:6961 ../src/guestfs-actions.pod:7020
21937 #: ../src/guestfs-actions.pod:7037 ../src/guestfs-actions.pod:7053
21938 #: ../src/guestfs-actions.pod:7069 ../src/guestfs-actions.pod:7086
21939 #: ../src/guestfs-actions.pod:7099 ../src/guestfs-actions.pod:7119
21940 #: ../src/guestfs-actions.pod:7155 ../src/guestfs-actions.pod:7169
21941 #: ../src/guestfs-actions.pod:7210 ../src/guestfs-actions.pod:7223
21942 #: ../src/guestfs-actions.pod:7241 ../src/guestfs-actions.pod:7275
21943 #: ../src/guestfs-actions.pod:7311 ../src/guestfs-actions.pod:7427
21944 #: ../src/guestfs-actions.pod:7442 ../src/guestfs-actions.pod:7456
21945 #: ../src/guestfs-actions.pod:7511 ../src/guestfs-actions.pod:7524
21946 #: ../src/guestfs-actions.pod:7569 ../src/guestfs-actions.pod:7609
21947 #: ../src/guestfs-actions.pod:7665 ../src/guestfs-actions.pod:7685
21948 #: ../src/guestfs-actions.pod:7718 ../src/guestfs-actions.pod:7782
21949 #: ../src/guestfs-actions.pod:7805 ../src/guestfs-actions.pod:7834
21950 msgid "This function returns 0 on success or -1 on error."
21954 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
21955 #: ../src/guestfs-actions.pod:1170 ../src/guestfs-actions.pod:1985
21956 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2197
21957 #: ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3648
21958 #: ../src/guestfs-actions.pod:4956 ../src/guestfs-actions.pod:6222
21959 #: ../src/guestfs-actions.pod:6339 ../src/guestfs-actions.pod:6472
21960 #: ../src/guestfs-actions.pod:6963 ../src/guestfs-actions.pod:7088
21961 #: ../src/guestfs-actions.pod:7611
21962 msgid "(Added in 0.3)"
21966 #: ../src/guestfs-actions.pod:41
21967 msgid "guestfs_add_domain"
21971 #: ../src/guestfs-actions.pod:43
21975 " guestfs_add_domain (guestfs_h *g,\n"
21976 " const char *dom,\n"
21982 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
21983 #: ../src/guestfs-actions.pod:837 ../src/guestfs-actions.pod:2831
21984 #: ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4966
21985 #: ../src/guestfs-actions.pod:5183
21987 "You may supply a list of optional arguments to this call. Use zero or more "
21988 "of the following pairs of parameters, and terminate the list with C<-1> on "
21989 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
21993 #: ../src/guestfs-actions.pod:53
21996 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
21997 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
21998 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
21999 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
22000 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
22005 #: ../src/guestfs-actions.pod:59
22007 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
22008 "It works by connecting to libvirt, requesting the domain and domain XML from "
22009 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
22014 #: ../src/guestfs-actions.pod:94
22016 "The other optional parameters are passed directly through to "
22017 "C<guestfs_add_drive_opts>."
22021 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
22022 #: ../src/guestfs-actions.pod:520 ../src/guestfs-actions.pod:698
22023 #: ../src/guestfs-actions.pod:729 ../src/guestfs-actions.pod:747
22024 #: ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:1385
22025 #: ../src/guestfs-actions.pod:1741 ../src/guestfs-actions.pod:1944
22026 #: ../src/guestfs-actions.pod:2055 ../src/guestfs-actions.pod:2106
22027 #: ../src/guestfs-actions.pod:2161 ../src/guestfs-actions.pod:2184
22028 #: ../src/guestfs-actions.pod:2477 ../src/guestfs-actions.pod:2949
22029 #: ../src/guestfs-actions.pod:2967 ../src/guestfs-actions.pod:5142
22030 #: ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5774
22031 #: ../src/guestfs-actions.pod:5800 ../src/guestfs-actions.pod:7196
22032 #: ../src/guestfs-actions.pod:7622 ../src/guestfs-actions.pod:7635
22033 #: ../src/guestfs-actions.pod:7648
22034 msgid "On error this function returns -1."
22038 #: ../src/guestfs-actions.pod:99
22039 msgid "(Added in 1.7.4)"
22043 #: ../src/guestfs-actions.pod:101
22044 msgid "guestfs_add_domain_va"
22048 #: ../src/guestfs-actions.pod:103
22052 " guestfs_add_domain_va (guestfs_h *g,\n"
22053 " const char *dom,\n"
22054 " va_list args);\n"
22059 #: ../src/guestfs-actions.pod:108
22060 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
22064 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
22065 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
22066 #: ../src/guestfs-actions.pod:876 ../src/guestfs-actions.pod:887
22067 #: ../src/guestfs-actions.pod:2915 ../src/guestfs-actions.pod:2927
22068 #: ../src/guestfs-actions.pod:4712 ../src/guestfs-actions.pod:4724
22069 #: ../src/guestfs-actions.pod:4994 ../src/guestfs-actions.pod:5006
22070 #: ../src/guestfs-actions.pod:5232 ../src/guestfs-actions.pod:5243
22071 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
22075 #: ../src/guestfs-actions.pod:112
22076 msgid "guestfs_add_domain_argv"
22080 #: ../src/guestfs-actions.pod:114
22084 " guestfs_add_domain_argv (guestfs_h *g,\n"
22085 " const char *dom,\n"
22086 " const struct guestfs_add_domain_argv *optargs);\n"
22091 #: ../src/guestfs-actions.pod:119
22092 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
22096 #: ../src/guestfs-actions.pod:123
22097 msgid "guestfs_add_drive"
22101 #: ../src/guestfs-actions.pod:125
22105 " guestfs_add_drive (guestfs_h *g,\n"
22106 " const char *filename);\n"
22111 #: ../src/guestfs-actions.pod:129
22113 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
22114 "optional parameters, so the disk is added writable, with the format being "
22115 "detected automatically."
22119 #: ../src/guestfs-actions.pod:133
22121 "Automatic detection of the format opens you up to a potential security hole "
22122 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22123 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22124 "you should think about replacing calls to this function with calls to "
22125 "C<guestfs_add_drive_opts>, and specifying the format."
22129 #: ../src/guestfs-actions.pod:144
22130 msgid "guestfs_add_drive_opts"
22134 #: ../src/guestfs-actions.pod:146
22138 " guestfs_add_drive_opts (guestfs_h *g,\n"
22139 " const char *filename,\n"
22145 #: ../src/guestfs-actions.pod:156
22148 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
22149 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
22150 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
22155 #: ../src/guestfs-actions.pod:185
22157 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
22158 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
22159 "Possible formats include C<raw> and C<qcow2>."
22163 #: ../src/guestfs-actions.pod:196
22165 "This rarely-used option lets you emulate the behaviour of the deprecated "
22166 "C<guestfs_add_drive_with_if> call (q.v.)"
22170 #: ../src/guestfs-actions.pod:203
22171 msgid "(Added in 1.5.23)"
22175 #: ../src/guestfs-actions.pod:205
22176 msgid "guestfs_add_drive_opts_va"
22180 #: ../src/guestfs-actions.pod:207
22184 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
22185 " const char *filename,\n"
22186 " va_list args);\n"
22191 #: ../src/guestfs-actions.pod:212
22192 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
22196 #: ../src/guestfs-actions.pod:216
22197 msgid "guestfs_add_drive_opts_argv"
22201 #: ../src/guestfs-actions.pod:218
22205 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
22206 " const char *filename,\n"
22207 " const struct guestfs_add_drive_opts_argv *optargs);\n"
22212 #: ../src/guestfs-actions.pod:223
22213 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
22217 #: ../src/guestfs-actions.pod:227
22218 msgid "guestfs_add_drive_ro"
22222 #: ../src/guestfs-actions.pod:229
22226 " guestfs_add_drive_ro (guestfs_h *g,\n"
22227 " const char *filename);\n"
22232 #: ../src/guestfs-actions.pod:233
22234 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
22235 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
22236 "disk is added read-only, with the format being detected automatically."
22240 #: ../src/guestfs-actions.pod:240
22241 msgid "(Added in 1.0.38)"
22245 #: ../src/guestfs-actions.pod:242
22246 msgid "guestfs_add_drive_ro_with_if"
22250 #: ../src/guestfs-actions.pod:244
22254 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
22255 " const char *filename,\n"
22256 " const char *iface);\n"
22261 #: ../src/guestfs-actions.pod:256
22263 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
22264 "QEMU interface emulation to use at run time."
22268 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
22269 #: ../src/guestfs-actions.pod:2436
22270 msgid "(Added in 1.0.84)"
22274 #: ../src/guestfs-actions.pod:263
22275 msgid "guestfs_add_drive_with_if"
22279 #: ../src/guestfs-actions.pod:265
22283 " guestfs_add_drive_with_if (guestfs_h *g,\n"
22284 " const char *filename,\n"
22285 " const char *iface);\n"
22290 #: ../src/guestfs-actions.pod:277
22292 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
22293 "QEMU interface emulation to use at run time."
22297 #: ../src/guestfs-actions.pod:284
22298 msgid "guestfs_aug_clear"
22302 #: ../src/guestfs-actions.pod:286
22306 " guestfs_aug_clear (guestfs_h *g,\n"
22307 " const char *augpath);\n"
22312 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2186
22313 msgid "(Added in 1.3.4)"
22317 #: ../src/guestfs-actions.pod:297
22318 msgid "guestfs_aug_close"
22322 #: ../src/guestfs-actions.pod:299
22326 " guestfs_aug_close (guestfs_h *g);\n"
22331 #: ../src/guestfs-actions.pod:302
22333 "Close the current Augeas handle and free up any resources used by it. After "
22334 "calling this, you have to call C<guestfs_aug_init> again before you can use "
22335 "any other Augeas functions."
22339 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
22340 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
22341 #: ../src/guestfs-actions.pod:429 ../src/guestfs-actions.pod:449
22342 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:494
22343 #: ../src/guestfs-actions.pod:508 ../src/guestfs-actions.pod:522
22344 #: ../src/guestfs-actions.pod:536 ../src/guestfs-actions.pod:554
22345 #: ../src/guestfs-actions.pod:5851
22346 msgid "(Added in 0.7)"
22350 #: ../src/guestfs-actions.pod:311
22351 msgid "guestfs_aug_defnode"
22355 #: ../src/guestfs-actions.pod:313
22358 " struct guestfs_int_bool *\n"
22359 " guestfs_aug_defnode (guestfs_h *g,\n"
22360 " const char *name,\n"
22361 " const char *expr,\n"
22362 " const char *val);\n"
22367 #: ../src/guestfs-actions.pod:322
22369 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22370 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
22371 "containing that single node."
22375 #: ../src/guestfs-actions.pod:330
22377 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
22378 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
22382 #: ../src/guestfs-actions.pod:336
22383 msgid "guestfs_aug_defvar"
22387 #: ../src/guestfs-actions.pod:338
22391 " guestfs_aug_defvar (guestfs_h *g,\n"
22392 " const char *name,\n"
22393 " const char *expr);\n"
22398 #: ../src/guestfs-actions.pod:354
22399 msgid "guestfs_aug_get"
22403 #: ../src/guestfs-actions.pod:356
22407 " guestfs_aug_get (guestfs_h *g,\n"
22408 " const char *augpath);\n"
22413 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:927
22414 #: ../src/guestfs-actions.pod:945 ../src/guestfs-actions.pod:1005
22415 #: ../src/guestfs-actions.pod:1021 ../src/guestfs-actions.pod:1124
22416 #: ../src/guestfs-actions.pod:1254 ../src/guestfs-actions.pod:1271
22417 #: ../src/guestfs-actions.pod:1290 ../src/guestfs-actions.pod:1424
22418 #: ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1724
22419 #: ../src/guestfs-actions.pod:1887 ../src/guestfs-actions.pod:1904
22420 #: ../src/guestfs-actions.pod:1971 ../src/guestfs-actions.pod:2014
22421 #: ../src/guestfs-actions.pod:2035 ../src/guestfs-actions.pod:2209
22422 #: ../src/guestfs-actions.pod:2401 ../src/guestfs-actions.pod:2605
22423 #: ../src/guestfs-actions.pod:2695 ../src/guestfs-actions.pod:2799
22424 #: ../src/guestfs-actions.pod:2818 ../src/guestfs-actions.pod:3032
22425 #: ../src/guestfs-actions.pod:3060 ../src/guestfs-actions.pod:3081
22426 #: ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3174
22427 #: ../src/guestfs-actions.pod:3194 ../src/guestfs-actions.pod:3214
22428 #: ../src/guestfs-actions.pod:3841 ../src/guestfs-actions.pod:4194
22429 #: ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4474
22430 #: ../src/guestfs-actions.pod:5380 ../src/guestfs-actions.pod:5579
22431 #: ../src/guestfs-actions.pod:5749 ../src/guestfs-actions.pod:5927
22432 #: ../src/guestfs-actions.pod:5976 ../src/guestfs-actions.pod:6632
22433 #: ../src/guestfs-actions.pod:6648 ../src/guestfs-actions.pod:6672
22434 #: ../src/guestfs-actions.pod:6696 ../src/guestfs-actions.pod:7370
22435 #: ../src/guestfs-actions.pod:7389 ../src/guestfs-actions.pod:7407
22436 #: ../src/guestfs-actions.pod:7581 ../src/guestfs-actions.pod:7898
22438 "This function returns a string, or NULL on error. I<The caller must free "
22439 "the returned string after use>."
22443 #: ../src/guestfs-actions.pod:368
22444 msgid "guestfs_aug_init"
22448 #: ../src/guestfs-actions.pod:370
22452 " guestfs_aug_init (guestfs_h *g,\n"
22453 " const char *root,\n"
22459 #: ../src/guestfs-actions.pod:379
22460 msgid "You must call this before using any other C<guestfs_aug_*> commands."
22464 #: ../src/guestfs-actions.pod:404
22466 "This option is only useful when debugging Augeas lenses. Use of this option "
22467 "may require additional memory for the libguestfs appliance. You may need to "
22468 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
22469 "C<guestfs_set_memsize>."
22473 #: ../src/guestfs-actions.pod:419
22474 msgid "Do not load the tree in C<guestfs_aug_init>."
22478 #: ../src/guestfs-actions.pod:423
22479 msgid "To close the handle, you can call C<guestfs_aug_close>."
22483 #: ../src/guestfs-actions.pod:431
22484 msgid "guestfs_aug_insert"
22488 #: ../src/guestfs-actions.pod:433
22492 " guestfs_aug_insert (guestfs_h *g,\n"
22493 " const char *augpath,\n"
22494 " const char *label,\n"
22500 #: ../src/guestfs-actions.pod:451
22501 msgid "guestfs_aug_load"
22505 #: ../src/guestfs-actions.pod:453
22509 " guestfs_aug_load (guestfs_h *g);\n"
22514 #: ../src/guestfs-actions.pod:465
22515 msgid "guestfs_aug_ls"
22519 #: ../src/guestfs-actions.pod:467
22523 " guestfs_aug_ls (guestfs_h *g,\n"
22524 " const char *augpath);\n"
22529 #: ../src/guestfs-actions.pod:471
22531 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
22532 "sorting the resulting nodes into alphabetical order."
22536 #: ../src/guestfs-actions.pod:474 ../src/guestfs-actions.pod:490
22537 #: ../src/guestfs-actions.pod:636 ../src/guestfs-actions.pod:1143
22538 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1458
22539 #: ../src/guestfs-actions.pod:1561 ../src/guestfs-actions.pod:1580
22540 #: ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:2281
22541 #: ../src/guestfs-actions.pod:2297 ../src/guestfs-actions.pod:2316
22542 #: ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2383
22543 #: ../src/guestfs-actions.pod:2454 ../src/guestfs-actions.pod:2503
22544 #: ../src/guestfs-actions.pod:2760 ../src/guestfs-actions.pod:3134
22545 #: ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3724
22546 #: ../src/guestfs-actions.pod:3741 ../src/guestfs-actions.pod:3761
22547 #: ../src/guestfs-actions.pod:3823 ../src/guestfs-actions.pod:3928
22548 #: ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:5103
22549 #: ../src/guestfs-actions.pod:5721 ../src/guestfs-actions.pod:5847
22550 #: ../src/guestfs-actions.pod:5961 ../src/guestfs-actions.pod:6712
22551 #: ../src/guestfs-actions.pod:6773 ../src/guestfs-actions.pod:6828
22552 #: ../src/guestfs-actions.pod:6974 ../src/guestfs-actions.pod:6998
22553 #: ../src/guestfs-actions.pod:7474 ../src/guestfs-actions.pod:7494
22554 #: ../src/guestfs-actions.pod:7541 ../src/guestfs-actions.pod:7735
22555 #: ../src/guestfs-actions.pod:7754 ../src/guestfs-actions.pod:7848
22556 #: ../src/guestfs-actions.pod:7867 ../src/guestfs-actions.pod:7913
22557 #: ../src/guestfs-actions.pod:7932
22559 "This function returns a NULL-terminated array of strings (like L<environ(3)"
22560 ">), or NULL if there was an error. I<The caller must free the strings and "
22561 "the array after use>."
22565 #: ../src/guestfs-actions.pod:478 ../src/guestfs-actions.pod:1068
22566 #: ../src/guestfs-actions.pod:1086 ../src/guestfs-actions.pod:1496
22567 #: ../src/guestfs-actions.pod:3488 ../src/guestfs-actions.pod:3519
22568 #: ../src/guestfs-actions.pod:4177 ../src/guestfs-actions.pod:4227
22569 #: ../src/guestfs-actions.pod:4414 ../src/guestfs-actions.pod:4447
22570 #: ../src/guestfs-actions.pod:4610 ../src/guestfs-actions.pod:5107
22571 #: ../src/guestfs-actions.pod:5662 ../src/guestfs-actions.pod:6059
22572 #: ../src/guestfs-actions.pod:6073 ../src/guestfs-actions.pod:6085
22573 #: ../src/guestfs-actions.pod:6553 ../src/guestfs-actions.pod:7212
22574 #: ../src/guestfs-actions.pod:7225 ../src/guestfs-actions.pod:7458
22575 #: ../src/guestfs-actions.pod:7723
22576 msgid "(Added in 0.8)"
22580 #: ../src/guestfs-actions.pod:480
22581 msgid "guestfs_aug_match"
22585 #: ../src/guestfs-actions.pod:482
22589 " guestfs_aug_match (guestfs_h *g,\n"
22590 " const char *augpath);\n"
22595 #: ../src/guestfs-actions.pod:496
22596 msgid "guestfs_aug_mv"
22600 #: ../src/guestfs-actions.pod:498
22604 " guestfs_aug_mv (guestfs_h *g,\n"
22605 " const char *src,\n"
22606 " const char *dest);\n"
22611 #: ../src/guestfs-actions.pod:510
22612 msgid "guestfs_aug_rm"
22616 #: ../src/guestfs-actions.pod:512
22620 " guestfs_aug_rm (guestfs_h *g,\n"
22621 " const char *augpath);\n"
22626 #: ../src/guestfs-actions.pod:524
22627 msgid "guestfs_aug_save"
22631 #: ../src/guestfs-actions.pod:526
22635 " guestfs_aug_save (guestfs_h *g);\n"
22640 #: ../src/guestfs-actions.pod:531
22642 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
22647 #: ../src/guestfs-actions.pod:538
22648 msgid "guestfs_aug_set"
22652 #: ../src/guestfs-actions.pod:540
22656 " guestfs_aug_set (guestfs_h *g,\n"
22657 " const char *augpath,\n"
22658 " const char *val);\n"
22663 #: ../src/guestfs-actions.pod:547
22665 "In the Augeas API, it is possible to clear a node by setting the value to "
22666 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22667 "this call. Instead you must use the C<guestfs_aug_clear> call."
22671 #: ../src/guestfs-actions.pod:556
22672 msgid "guestfs_available"
22676 #: ../src/guestfs-actions.pod:558
22680 " guestfs_available (guestfs_h *g,\n"
22681 " char *const *groups);\n"
22686 #: ../src/guestfs-actions.pod:566
22688 "The libguestfs groups, and the functions that those groups correspond to, "
22689 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22690 "runtime by calling C<guestfs_available_all_groups>."
22694 #: ../src/guestfs-actions.pod:590
22695 msgid "You must call C<guestfs_launch> before calling this function."
22699 #: ../src/guestfs-actions.pod:612
22701 "This call was added in version C<1.0.80>. In previous versions of "
22702 "libguestfs all you could do would be to speculatively execute a command to "
22703 "find out if the daemon implemented it. See also C<guestfs_version>."
22707 #: ../src/guestfs-actions.pod:621 ../src/guestfs-actions.pod:1241
22708 msgid "(Added in 1.0.80)"
22712 #: ../src/guestfs-actions.pod:623
22713 msgid "guestfs_available_all_groups"
22717 #: ../src/guestfs-actions.pod:625
22721 " guestfs_available_all_groups (guestfs_h *g);\n"
22726 #: ../src/guestfs-actions.pod:628
22728 "This command returns a list of all optional groups that this daemon knows "
22729 "about. Note this returns both supported and unsupported groups. To find "
22730 "out which ones the daemon can actually support you have to call "
22731 "C<guestfs_available> on each member of the returned list."
22735 #: ../src/guestfs-actions.pod:634
22736 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
22740 #: ../src/guestfs-actions.pod:640
22741 msgid "(Added in 1.3.15)"
22745 #: ../src/guestfs-actions.pod:642
22746 msgid "guestfs_base64_in"
22750 #: ../src/guestfs-actions.pod:644
22754 " guestfs_base64_in (guestfs_h *g,\n"
22755 " const char *base64file,\n"
22756 " const char *filename);\n"
22761 #: ../src/guestfs-actions.pod:654 ../src/guestfs-actions.pod:668
22762 msgid "(Added in 1.3.5)"
22766 #: ../src/guestfs-actions.pod:656
22767 msgid "guestfs_base64_out"
22771 #: ../src/guestfs-actions.pod:658
22775 " guestfs_base64_out (guestfs_h *g,\n"
22776 " const char *filename,\n"
22777 " const char *base64file);\n"
22782 #: ../src/guestfs-actions.pod:670
22783 msgid "guestfs_blockdev_flushbufs"
22787 #: ../src/guestfs-actions.pod:672
22791 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
22792 " const char *device);\n"
22797 #: ../src/guestfs-actions.pod:683 ../src/guestfs-actions.pod:700
22798 #: ../src/guestfs-actions.pod:715 ../src/guestfs-actions.pod:731
22799 #: ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:768
22800 #: ../src/guestfs-actions.pod:782 ../src/guestfs-actions.pod:800
22801 #: ../src/guestfs-actions.pod:814 ../src/guestfs-actions.pod:828
22802 msgid "(Added in 0.9.3)"
22806 #: ../src/guestfs-actions.pod:685
22807 msgid "guestfs_blockdev_getbsz"
22811 #: ../src/guestfs-actions.pod:687
22815 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
22816 " const char *device);\n"
22821 #: ../src/guestfs-actions.pod:702
22822 msgid "guestfs_blockdev_getro"
22826 #: ../src/guestfs-actions.pod:704
22830 " guestfs_blockdev_getro (guestfs_h *g,\n"
22831 " const char *device);\n"
22836 #: ../src/guestfs-actions.pod:713 ../src/guestfs-actions.pod:1479
22837 #: ../src/guestfs-actions.pod:1494 ../src/guestfs-actions.pod:1983
22838 #: ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:2066
22839 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2132
22840 #: ../src/guestfs-actions.pod:2147 ../src/guestfs-actions.pod:2172
22841 #: ../src/guestfs-actions.pod:2195 ../src/guestfs-actions.pod:3231
22842 #: ../src/guestfs-actions.pod:3247 ../src/guestfs-actions.pod:3265
22843 #: ../src/guestfs-actions.pod:3427 ../src/guestfs-actions.pod:3441
22844 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:3470
22845 #: ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3501
22846 #: ../src/guestfs-actions.pod:3517 ../src/guestfs-actions.pod:3531
22847 #: ../src/guestfs-actions.pod:3544 ../src/guestfs-actions.pod:3558
22848 #: ../src/guestfs-actions.pod:3573 ../src/guestfs-actions.pod:3588
22849 #: ../src/guestfs-actions.pod:3601 ../src/guestfs-actions.pod:3615
22850 #: ../src/guestfs-actions.pod:5344
22851 msgid "This function returns a C truth value on success or -1 on error."
22855 #: ../src/guestfs-actions.pod:717
22856 msgid "guestfs_blockdev_getsize64"
22860 #: ../src/guestfs-actions.pod:719
22864 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
22865 " const char *device);\n"
22870 #: ../src/guestfs-actions.pod:725
22871 msgid "See also C<guestfs_blockdev_getsz>."
22875 #: ../src/guestfs-actions.pod:733
22876 msgid "guestfs_blockdev_getss"
22880 #: ../src/guestfs-actions.pod:735
22884 " guestfs_blockdev_getss (guestfs_h *g,\n"
22885 " const char *device);\n"
22890 #: ../src/guestfs-actions.pod:742
22892 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
22897 #: ../src/guestfs-actions.pod:751
22898 msgid "guestfs_blockdev_getsz"
22902 #: ../src/guestfs-actions.pod:753
22906 " guestfs_blockdev_getsz (guestfs_h *g,\n"
22907 " const char *device);\n"
22912 #: ../src/guestfs-actions.pod:760
22914 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
22915 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
22919 #: ../src/guestfs-actions.pod:770
22920 msgid "guestfs_blockdev_rereadpt"
22924 #: ../src/guestfs-actions.pod:772
22928 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
22929 " const char *device);\n"
22934 #: ../src/guestfs-actions.pod:784
22935 msgid "guestfs_blockdev_setbsz"
22939 #: ../src/guestfs-actions.pod:786
22943 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
22944 " const char *device,\n"
22945 " int blocksize);\n"
22950 #: ../src/guestfs-actions.pod:802
22951 msgid "guestfs_blockdev_setro"
22955 #: ../src/guestfs-actions.pod:804
22959 " guestfs_blockdev_setro (guestfs_h *g,\n"
22960 " const char *device);\n"
22965 #: ../src/guestfs-actions.pod:816
22966 msgid "guestfs_blockdev_setrw"
22970 #: ../src/guestfs-actions.pod:818
22974 " guestfs_blockdev_setrw (guestfs_h *g,\n"
22975 " const char *device);\n"
22980 #: ../src/guestfs-actions.pod:830
22981 msgid "guestfs_btrfs_filesystem_resize"
22985 #: ../src/guestfs-actions.pod:832
22989 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
22990 " const char *mountpoint,\n"
22996 #: ../src/guestfs-actions.pod:842
22999 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
23004 #: ../src/guestfs-actions.pod:865
23005 msgid "(Added in 1.11.17)"
23009 #: ../src/guestfs-actions.pod:867
23010 msgid "guestfs_btrfs_filesystem_resize_va"
23014 #: ../src/guestfs-actions.pod:869
23018 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
23019 " const char *mountpoint,\n"
23020 " va_list args);\n"
23025 #: ../src/guestfs-actions.pod:874
23026 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
23030 #: ../src/guestfs-actions.pod:878
23031 msgid "guestfs_btrfs_filesystem_resize_argv"
23035 #: ../src/guestfs-actions.pod:880
23039 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
23040 " const char *mountpoint,\n"
23041 " const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
23046 #: ../src/guestfs-actions.pod:885
23047 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
23051 #: ../src/guestfs-actions.pod:889
23052 msgid "guestfs_case_sensitive_path"
23056 #: ../src/guestfs-actions.pod:891
23060 " guestfs_case_sensitive_path (guestfs_h *g,\n"
23061 " const char *path);\n"
23066 #: ../src/guestfs-actions.pod:917
23068 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
23069 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
23070 "how the directories were originally created under Windows)."
23074 #: ../src/guestfs-actions.pod:925
23075 msgid "See also C<guestfs_realpath>."
23079 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:7392
23080 msgid "(Added in 1.0.75)"
23084 #: ../src/guestfs-actions.pod:932
23085 msgid "guestfs_cat"
23089 #: ../src/guestfs-actions.pod:934
23093 " guestfs_cat (guestfs_h *g,\n"
23094 " const char *path);\n"
23099 #: ../src/guestfs-actions.pod:940
23101 "Note that this function cannot correctly handle binary files (specifically, "
23102 "files containing C<\\0> character which is treated as end of string). For "
23103 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
23104 "functions which have a more complex interface."
23108 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:3745
23109 #: ../src/guestfs-actions.pod:3827 ../src/guestfs-actions.pod:3844
23110 #: ../src/guestfs-actions.pod:3932 ../src/guestfs-actions.pod:4340
23111 #: ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:5725
23112 #: ../src/guestfs-actions.pod:5739 ../src/guestfs-actions.pod:7545
23113 #: ../src/guestfs-actions.pod:7559
23114 msgid "(Added in 0.4)"
23118 #: ../src/guestfs-actions.pod:953
23119 msgid "guestfs_checksum"
23123 #: ../src/guestfs-actions.pod:955
23127 " guestfs_checksum (guestfs_h *g,\n"
23128 " const char *csumtype,\n"
23129 " const char *path);\n"
23134 #: ../src/guestfs-actions.pod:1001
23135 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
23139 #: ../src/guestfs-actions.pod:1003
23140 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
23144 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1316
23145 #: ../src/guestfs-actions.pod:2163 ../src/guestfs-actions.pod:3443
23146 #: ../src/guestfs-actions.pod:3472 ../src/guestfs-actions.pod:3533
23147 #: ../src/guestfs-actions.pod:3560 ../src/guestfs-actions.pod:7248
23148 msgid "(Added in 1.0.2)"
23152 #: ../src/guestfs-actions.pod:1010
23153 msgid "guestfs_checksum_device"
23157 #: ../src/guestfs-actions.pod:1012
23161 " guestfs_checksum_device (guestfs_h *g,\n"
23162 " const char *csumtype,\n"
23163 " const char *device);\n"
23168 #: ../src/guestfs-actions.pod:1017
23170 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23171 "device named C<device>. For the types of checksums supported see the "
23172 "C<guestfs_checksum> command."
23176 #: ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:5174
23177 #: ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:5346
23178 #: ../src/guestfs-actions.pod:5364 ../src/guestfs-actions.pod:5546
23179 #: ../src/guestfs-actions.pod:7157 ../src/guestfs-actions.pod:7171
23180 #: ../src/guestfs-actions.pod:7571
23181 msgid "(Added in 1.3.2)"
23185 #: ../src/guestfs-actions.pod:1026
23186 msgid "guestfs_checksums_out"
23190 #: ../src/guestfs-actions.pod:1028
23194 " guestfs_checksums_out (guestfs_h *g,\n"
23195 " const char *csumtype,\n"
23196 " const char *directory,\n"
23197 " const char *sumsfile);\n"
23202 #: ../src/guestfs-actions.pod:1048
23203 msgid "(Added in 1.3.7)"
23207 #: ../src/guestfs-actions.pod:1050
23208 msgid "guestfs_chmod"
23212 #: ../src/guestfs-actions.pod:1052
23216 " guestfs_chmod (guestfs_h *g,\n"
23218 " const char *path);\n"
23223 #: ../src/guestfs-actions.pod:1070
23224 msgid "guestfs_chown"
23228 #: ../src/guestfs-actions.pod:1072
23232 " guestfs_chown (guestfs_h *g,\n"
23235 " const char *path);\n"
23240 #: ../src/guestfs-actions.pod:1088
23241 msgid "guestfs_command"
23245 #: ../src/guestfs-actions.pod:1090
23249 " guestfs_command (guestfs_h *g,\n"
23250 " char *const *arguments);\n"
23255 #: ../src/guestfs-actions.pod:1099
23257 "The single parameter is an argv-style list of arguments. The first element "
23258 "is the name of the program to run. Subsequent elements are parameters. The "
23259 "list must be non-empty (ie. must contain a program name). Note that the "
23260 "command runs directly, and is I<not> invoked via the shell (see "
23265 #: ../src/guestfs-actions.pod:1130 ../src/guestfs-actions.pod:1150
23266 #: ../src/guestfs-actions.pod:1615
23267 msgid "(Added in 0.9.1)"
23271 #: ../src/guestfs-actions.pod:1132
23272 msgid "guestfs_command_lines"
23276 #: ../src/guestfs-actions.pod:1134
23280 " guestfs_command_lines (guestfs_h *g,\n"
23281 " char *const *arguments);\n"
23286 #: ../src/guestfs-actions.pod:1138
23288 "This is the same as C<guestfs_command>, but splits the result into a list of "
23293 #: ../src/guestfs-actions.pod:1141
23294 msgid "See also: C<guestfs_sh_lines>"
23298 #: ../src/guestfs-actions.pod:1152
23299 msgid "guestfs_config"
23303 #: ../src/guestfs-actions.pod:1154
23307 " guestfs_config (guestfs_h *g,\n"
23308 " const char *qemuparam,\n"
23309 " const char *qemuvalue);\n"
23314 #: ../src/guestfs-actions.pod:1172
23315 msgid "guestfs_copy_size"
23319 #: ../src/guestfs-actions.pod:1174
23323 " guestfs_copy_size (guestfs_h *g,\n"
23324 " const char *src,\n"
23325 " const char *dest,\n"
23326 " int64_t size);\n"
23331 #: ../src/guestfs-actions.pod:1188 ../src/guestfs-actions.pod:1311
23332 #: ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:1387
23333 #: ../src/guestfs-actions.pod:1764 ../src/guestfs-actions.pod:1786
23334 #: ../src/guestfs-actions.pod:3643 ../src/guestfs-actions.pod:7243
23335 #: ../src/guestfs-actions.pod:7277 ../src/guestfs-actions.pod:7784
23336 #: ../src/guestfs-actions.pod:7807
23338 "This long-running command can generate progress notification messages so "
23339 "that the caller can display a progress bar or indicator. To receive these "
23340 "messages, the caller must register a progress event callback. See L<guestfs"
23341 "(3)/GUESTFS_EVENT_PROGRESS>."
23345 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:4367
23346 #: ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:7478
23347 #: ../src/guestfs-actions.pod:7498 ../src/guestfs-actions.pod:7584
23348 msgid "(Added in 1.0.87)"
23352 #: ../src/guestfs-actions.pod:1195
23357 #: ../src/guestfs-actions.pod:1197
23361 " guestfs_cp (guestfs_h *g,\n"
23362 " const char *src,\n"
23363 " const char *dest);\n"
23368 #: ../src/guestfs-actions.pod:1207 ../src/guestfs-actions.pod:1221
23369 #: ../src/guestfs-actions.pod:1293 ../src/guestfs-actions.pod:1367
23370 #: ../src/guestfs-actions.pod:1481 ../src/guestfs-actions.pod:5121
23371 #: ../src/guestfs-actions.pod:5596
23372 msgid "(Added in 1.0.18)"
23376 #: ../src/guestfs-actions.pod:1209
23377 msgid "guestfs_cp_a"
23381 #: ../src/guestfs-actions.pod:1211
23385 " guestfs_cp_a (guestfs_h *g,\n"
23386 " const char *src,\n"
23387 " const char *dest);\n"
23392 #: ../src/guestfs-actions.pod:1223
23397 #: ../src/guestfs-actions.pod:1225
23401 " guestfs_dd (guestfs_h *g,\n"
23402 " const char *src,\n"
23403 " const char *dest);\n"
23408 #: ../src/guestfs-actions.pod:1235
23410 "If the destination is a device, it must be as large or larger than the "
23411 "source file or device, otherwise the copy will fail. This command cannot do "
23412 "partial copies (see C<guestfs_copy_size>)."
23416 #: ../src/guestfs-actions.pod:1243
23421 #: ../src/guestfs-actions.pod:1245
23425 " guestfs_df (guestfs_h *g);\n"
23430 #: ../src/guestfs-actions.pod:1250 ../src/guestfs-actions.pod:1267
23432 "This command is mostly useful for interactive sessions. It is I<not> "
23433 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
23438 #: ../src/guestfs-actions.pod:1257 ../src/guestfs-actions.pod:1274
23439 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:2366
23440 #: ../src/guestfs-actions.pod:2390 ../src/guestfs-actions.pod:2458
23441 #: ../src/guestfs-actions.pod:4477 ../src/guestfs-actions.pod:5021
23442 #: ../src/guestfs-actions.pod:6981 ../src/guestfs-actions.pod:7005
23443 #: ../src/guestfs-actions.pod:7624 ../src/guestfs-actions.pod:7637
23444 #: ../src/guestfs-actions.pod:7650
23445 msgid "(Added in 1.0.54)"
23449 #: ../src/guestfs-actions.pod:1259
23450 msgid "guestfs_df_h"
23454 #: ../src/guestfs-actions.pod:1261
23458 " guestfs_df_h (guestfs_h *g);\n"
23463 #: ../src/guestfs-actions.pod:1276
23464 msgid "guestfs_dmesg"
23468 #: ../src/guestfs-actions.pod:1278
23472 " guestfs_dmesg (guestfs_h *g);\n"
23477 #: ../src/guestfs-actions.pod:1285
23479 "Another way to get the same information is to enable verbose messages with "
23480 "C<guestfs_set_verbose> or by setting the environment variable "
23481 "C<LIBGUESTFS_DEBUG=1> before running the program."
23485 #: ../src/guestfs-actions.pod:1295
23486 msgid "guestfs_download"
23490 #: ../src/guestfs-actions.pod:1297
23494 " guestfs_download (guestfs_h *g,\n"
23495 " const char *remotefilename,\n"
23496 " const char *filename);\n"
23501 #: ../src/guestfs-actions.pod:1307
23502 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
23506 #: ../src/guestfs-actions.pod:1318
23507 msgid "guestfs_download_offset"
23511 #: ../src/guestfs-actions.pod:1320
23515 " guestfs_download_offset (guestfs_h *g,\n"
23516 " const char *remotefilename,\n"
23517 " const char *filename,\n"
23518 " int64_t offset,\n"
23519 " int64_t size);\n"
23524 #: ../src/guestfs-actions.pod:1333
23526 "Note that there is no limit on the amount of data that can be downloaded "
23527 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
23528 "full amount unless an error occurs."
23532 #: ../src/guestfs-actions.pod:1338
23533 msgid "See also C<guestfs_download>, C<guestfs_pread>."
23537 #: ../src/guestfs-actions.pod:1347 ../src/guestfs-actions.pod:7282
23538 msgid "(Added in 1.5.17)"
23542 #: ../src/guestfs-actions.pod:1349
23543 msgid "guestfs_drop_caches"
23547 #: ../src/guestfs-actions.pod:1351
23551 " guestfs_drop_caches (guestfs_h *g,\n"
23552 " int whattodrop);\n"
23557 #: ../src/guestfs-actions.pod:1369
23562 #: ../src/guestfs-actions.pod:1371
23566 " guestfs_du (guestfs_h *g,\n"
23567 " const char *path);\n"
23572 #: ../src/guestfs-actions.pod:1394
23573 msgid "guestfs_e2fsck_f"
23577 #: ../src/guestfs-actions.pod:1396
23581 " guestfs_e2fsck_f (guestfs_h *g,\n"
23582 " const char *device);\n"
23587 #: ../src/guestfs-actions.pod:1404
23589 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
23590 "Normally you should use C<guestfs_fsck>."
23594 #: ../src/guestfs-actions.pod:1409
23595 msgid "(Added in 1.0.29)"
23599 #: ../src/guestfs-actions.pod:1411
23600 msgid "guestfs_echo_daemon"
23604 #: ../src/guestfs-actions.pod:1413
23608 " guestfs_echo_daemon (guestfs_h *g,\n"
23609 " char *const *words);\n"
23614 #: ../src/guestfs-actions.pod:1422
23615 msgid "See also C<guestfs_ping_daemon>."
23619 #: ../src/guestfs-actions.pod:1427 ../src/guestfs-actions.pod:2174
23620 #: ../src/guestfs-actions.pod:6453
23621 msgid "(Added in 1.0.69)"
23625 #: ../src/guestfs-actions.pod:1429
23626 msgid "guestfs_egrep"
23630 #: ../src/guestfs-actions.pod:1431
23634 " guestfs_egrep (guestfs_h *g,\n"
23635 " const char *regex,\n"
23636 " const char *path);\n"
23641 #: ../src/guestfs-actions.pod:1446 ../src/guestfs-actions.pod:1465
23642 #: ../src/guestfs-actions.pod:1522 ../src/guestfs-actions.pod:1568
23643 #: ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:2304
23644 #: ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:2479
23645 #: ../src/guestfs-actions.pod:2492 ../src/guestfs-actions.pod:2507
23646 #: ../src/guestfs-actions.pod:2553 ../src/guestfs-actions.pod:2575
23647 #: ../src/guestfs-actions.pod:2588 ../src/guestfs-actions.pod:3857
23648 #: ../src/guestfs-actions.pod:3871 ../src/guestfs-actions.pod:3884
23649 #: ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:4899
23650 #: ../src/guestfs-actions.pod:5930 ../src/guestfs-actions.pod:5979
23651 #: ../src/guestfs-actions.pod:6849 ../src/guestfs-actions.pod:6861
23652 #: ../src/guestfs-actions.pod:6874 ../src/guestfs-actions.pod:6887
23653 #: ../src/guestfs-actions.pod:6909 ../src/guestfs-actions.pod:6922
23654 #: ../src/guestfs-actions.pod:6935 ../src/guestfs-actions.pod:6948
23655 #: ../src/guestfs-actions.pod:7742 ../src/guestfs-actions.pod:7761
23656 #: ../src/guestfs-actions.pod:7855 ../src/guestfs-actions.pod:7874
23657 #: ../src/guestfs-actions.pod:7920 ../src/guestfs-actions.pod:7939
23658 msgid "(Added in 1.0.66)"
23662 #: ../src/guestfs-actions.pod:1448
23663 msgid "guestfs_egrepi"
23667 #: ../src/guestfs-actions.pod:1450
23671 " guestfs_egrepi (guestfs_h *g,\n"
23672 " const char *regex,\n"
23673 " const char *path);\n"
23678 #: ../src/guestfs-actions.pod:1467
23679 msgid "guestfs_equal"
23683 #: ../src/guestfs-actions.pod:1469
23687 " guestfs_equal (guestfs_h *g,\n"
23688 " const char *file1,\n"
23689 " const char *file2);\n"
23694 #: ../src/guestfs-actions.pod:1483
23695 msgid "guestfs_exists"
23699 #: ../src/guestfs-actions.pod:1485
23703 " guestfs_exists (guestfs_h *g,\n"
23704 " const char *path);\n"
23709 #: ../src/guestfs-actions.pod:1492
23710 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
23714 #: ../src/guestfs-actions.pod:1498
23715 msgid "guestfs_fallocate"
23719 #: ../src/guestfs-actions.pod:1500
23723 " guestfs_fallocate (guestfs_h *g,\n"
23724 " const char *path,\n"
23730 #: ../src/guestfs-actions.pod:1505
23732 "I<This function is deprecated.> In new code, use the L</guestfs_fallocate64> "
23737 #: ../src/guestfs-actions.pod:1524
23738 msgid "guestfs_fallocate64"
23742 #: ../src/guestfs-actions.pod:1526
23746 " guestfs_fallocate64 (guestfs_h *g,\n"
23747 " const char *path,\n"
23753 #: ../src/guestfs-actions.pod:1535
23755 "Note that this call allocates disk blocks for the file. To create a sparse "
23756 "file use C<guestfs_truncate_size> instead."
23760 #: ../src/guestfs-actions.pod:1538
23762 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
23763 "oversight it only allowed 30 bit lengths to be specified, effectively "
23764 "limiting the maximum size of files created through that call to 1GB."
23768 #: ../src/guestfs-actions.pod:1549
23769 msgid "(Added in 1.3.17)"
23773 #: ../src/guestfs-actions.pod:1551
23774 msgid "guestfs_fgrep"
23778 #: ../src/guestfs-actions.pod:1553
23782 " guestfs_fgrep (guestfs_h *g,\n"
23783 " const char *pattern,\n"
23784 " const char *path);\n"
23789 #: ../src/guestfs-actions.pod:1570
23790 msgid "guestfs_fgrepi"
23794 #: ../src/guestfs-actions.pod:1572
23798 " guestfs_fgrepi (guestfs_h *g,\n"
23799 " const char *pattern,\n"
23800 " const char *path);\n"
23805 #: ../src/guestfs-actions.pod:1589
23806 msgid "guestfs_file"
23810 #: ../src/guestfs-actions.pod:1591
23814 " guestfs_file (guestfs_h *g,\n"
23815 " const char *path);\n"
23820 #: ../src/guestfs-actions.pod:1609
23822 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
23823 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
23827 #: ../src/guestfs-actions.pod:1617
23828 msgid "guestfs_file_architecture"
23832 #: ../src/guestfs-actions.pod:1619
23836 " guestfs_file_architecture (guestfs_h *g,\n"
23837 " const char *filename);\n"
23842 #: ../src/guestfs-actions.pod:1727 ../src/guestfs-actions.pod:1890
23843 #: ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:2608
23844 #: ../src/guestfs-actions.pod:2698 ../src/guestfs-actions.pod:2764
23845 #: ../src/guestfs-actions.pod:2951 ../src/guestfs-actions.pod:2969
23846 #: ../src/guestfs-actions.pod:3009 ../src/guestfs-actions.pod:3084
23847 #: ../src/guestfs-actions.pod:3177 ../src/guestfs-actions.pod:3414
23848 #: ../src/guestfs-actions.pod:3546
23849 msgid "(Added in 1.5.3)"
23853 #: ../src/guestfs-actions.pod:1729
23854 msgid "guestfs_filesize"
23858 #: ../src/guestfs-actions.pod:1731
23862 " guestfs_filesize (guestfs_h *g,\n"
23863 " const char *file);\n"
23868 #: ../src/guestfs-actions.pod:1737
23870 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
23871 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
23872 "devices, use C<guestfs_blockdev_getsize64>."
23876 #: ../src/guestfs-actions.pod:1743
23877 msgid "(Added in 1.0.82)"
23881 #: ../src/guestfs-actions.pod:1745
23882 msgid "guestfs_fill"
23886 #: ../src/guestfs-actions.pod:1747
23890 " guestfs_fill (guestfs_h *g,\n"
23893 " const char *path);\n"
23898 #: ../src/guestfs-actions.pod:1757
23900 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23901 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
23902 "bytes use C<guestfs_fill_pattern>."
23906 #: ../src/guestfs-actions.pod:1769
23907 msgid "(Added in 1.0.79)"
23911 #: ../src/guestfs-actions.pod:1771
23912 msgid "guestfs_fill_pattern"
23916 #: ../src/guestfs-actions.pod:1773
23920 " guestfs_fill_pattern (guestfs_h *g,\n"
23921 " const char *pattern,\n"
23923 " const char *path);\n"
23928 #: ../src/guestfs-actions.pod:1779
23930 "This function is like C<guestfs_fill> except that it creates a new file of "
23931 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
23932 "pattern is truncated if necessary to ensure the length of the file is "
23933 "exactly C<len> bytes."
23937 #: ../src/guestfs-actions.pod:1791
23938 msgid "(Added in 1.3.12)"
23942 #: ../src/guestfs-actions.pod:1793
23943 msgid "guestfs_find"
23947 #: ../src/guestfs-actions.pod:1795
23951 " guestfs_find (guestfs_h *g,\n"
23952 " const char *directory);\n"
23957 #: ../src/guestfs-actions.pod:1811
23959 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
23963 #: ../src/guestfs-actions.pod:1824
23964 msgid "See also C<guestfs_find0>."
23968 #: ../src/guestfs-actions.pod:1833 ../src/guestfs-actions.pod:4304
23969 #: ../src/guestfs-actions.pod:6014
23970 msgid "(Added in 1.0.27)"
23974 #: ../src/guestfs-actions.pod:1835
23975 msgid "guestfs_find0"
23979 #: ../src/guestfs-actions.pod:1837
23983 " guestfs_find0 (guestfs_h *g,\n"
23984 " const char *directory,\n"
23985 " const char *files);\n"
23990 #: ../src/guestfs-actions.pod:1846
23992 "This command works the same way as C<guestfs_find> with the following "
23997 #: ../src/guestfs-actions.pod:1873
23998 msgid "(Added in 1.0.74)"
24002 #: ../src/guestfs-actions.pod:1875
24003 msgid "guestfs_findfs_label"
24007 #: ../src/guestfs-actions.pod:1877
24011 " guestfs_findfs_label (guestfs_h *g,\n"
24012 " const char *label);\n"
24017 #: ../src/guestfs-actions.pod:1885
24018 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
24022 #: ../src/guestfs-actions.pod:1892
24023 msgid "guestfs_findfs_uuid"
24027 #: ../src/guestfs-actions.pod:1894
24031 " guestfs_findfs_uuid (guestfs_h *g,\n"
24032 " const char *uuid);\n"
24037 #: ../src/guestfs-actions.pod:1902
24038 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
24042 #: ../src/guestfs-actions.pod:1909
24043 msgid "guestfs_fsck"
24047 #: ../src/guestfs-actions.pod:1911
24051 " guestfs_fsck (guestfs_h *g,\n"
24052 " const char *fstype,\n"
24053 " const char *device);\n"
24058 #: ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:7789
24059 msgid "(Added in 1.0.16)"
24063 #: ../src/guestfs-actions.pod:1948
24064 msgid "guestfs_get_append"
24068 #: ../src/guestfs-actions.pod:1950
24072 " guestfs_get_append (guestfs_h *g);\n"
24077 #: ../src/guestfs-actions.pod:1958
24079 "This function returns a string which may be NULL. There is no way to return "
24080 "an error from this function. The string is owned by the guest handle and "
24081 "must I<not> be freed."
24085 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:5692
24086 #: ../src/guestfs-actions.pod:6174 ../src/guestfs-actions.pod:6616
24087 #: ../src/guestfs-actions.pod:6635 ../src/guestfs-actions.pod:6651
24088 #: ../src/guestfs-actions.pod:6675 ../src/guestfs-actions.pod:7429
24089 #: ../src/guestfs-actions.pod:7444 ../src/guestfs-actions.pod:7836
24090 msgid "(Added in 1.0.26)"
24094 #: ../src/guestfs-actions.pod:1964
24095 msgid "guestfs_get_attach_method"
24099 #: ../src/guestfs-actions.pod:1966
24103 " guestfs_get_attach_method (guestfs_h *g);\n"
24108 #: ../src/guestfs-actions.pod:1969
24109 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
24113 #: ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:6204
24114 msgid "(Added in 1.9.8)"
24118 #: ../src/guestfs-actions.pod:1976
24119 msgid "guestfs_get_autosync"
24123 #: ../src/guestfs-actions.pod:1978
24127 " guestfs_get_autosync (guestfs_h *g);\n"
24132 #: ../src/guestfs-actions.pod:1987
24133 msgid "guestfs_get_direct"
24137 #: ../src/guestfs-actions.pod:1989
24141 " guestfs_get_direct (guestfs_h *g);\n"
24146 #: ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:6245
24147 msgid "(Added in 1.0.72)"
24151 #: ../src/guestfs-actions.pod:1998
24152 msgid "guestfs_get_e2label"
24156 #: ../src/guestfs-actions.pod:2000
24160 " guestfs_get_e2label (guestfs_h *g,\n"
24161 " const char *device);\n"
24166 #: ../src/guestfs-actions.pod:2004
24168 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_label> "
24173 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2038
24174 #: ../src/guestfs-actions.pod:6263 ../src/guestfs-actions.pod:6282
24175 msgid "(Added in 1.0.15)"
24179 #: ../src/guestfs-actions.pod:2019
24180 msgid "guestfs_get_e2uuid"
24184 #: ../src/guestfs-actions.pod:2021
24188 " guestfs_get_e2uuid (guestfs_h *g,\n"
24189 " const char *device);\n"
24194 #: ../src/guestfs-actions.pod:2025
24196 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_uuid> "
24201 #: ../src/guestfs-actions.pod:2040
24202 msgid "guestfs_get_memsize"
24206 #: ../src/guestfs-actions.pod:2042
24210 " guestfs_get_memsize (guestfs_h *g);\n"
24215 #: ../src/guestfs-actions.pod:2048
24217 "If C<guestfs_set_memsize> was not called on this handle, and if "
24218 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
24219 "value for memsize."
24223 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:4595
24224 #: ../src/guestfs-actions.pod:4804 ../src/guestfs-actions.pod:4823
24225 #: ../src/guestfs-actions.pod:4842 ../src/guestfs-actions.pod:4854
24226 #: ../src/guestfs-actions.pod:4871 ../src/guestfs-actions.pod:4884
24227 #: ../src/guestfs-actions.pod:5917 ../src/guestfs-actions.pod:6303
24228 #: ../src/guestfs-actions.pod:6583 ../src/guestfs-actions.pod:7198
24229 msgid "(Added in 1.0.55)"
24233 #: ../src/guestfs-actions.pod:2059
24234 msgid "guestfs_get_network"
24238 #: ../src/guestfs-actions.pod:2061
24242 " guestfs_get_network (guestfs_h *g);\n"
24247 #: ../src/guestfs-actions.pod:2068 ../src/guestfs-actions.pod:6322
24248 msgid "(Added in 1.5.4)"
24252 #: ../src/guestfs-actions.pod:2070
24253 msgid "guestfs_get_path"
24257 #: ../src/guestfs-actions.pod:2072
24261 " guestfs_get_path (guestfs_h *g);\n"
24266 #: ../src/guestfs-actions.pod:2080 ../src/guestfs-actions.pod:2120
24268 "This function returns a string, or NULL on error. The string is owned by "
24269 "the guest handle and must I<not> be freed."
24273 #: ../src/guestfs-actions.pod:2085
24274 msgid "guestfs_get_pgroup"
24278 #: ../src/guestfs-actions.pod:2087
24282 " guestfs_get_pgroup (guestfs_h *g);\n"
24287 #: ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:6358
24288 #: ../src/guestfs-actions.pod:7690
24289 msgid "(Added in 1.11.18)"
24293 #: ../src/guestfs-actions.pod:2096
24294 msgid "guestfs_get_pid"
24298 #: ../src/guestfs-actions.pod:2098
24302 " guestfs_get_pid (guestfs_h *g);\n"
24307 #: ../src/guestfs-actions.pod:2108
24308 msgid "(Added in 1.0.56)"
24312 #: ../src/guestfs-actions.pod:2110
24313 msgid "guestfs_get_qemu"
24317 #: ../src/guestfs-actions.pod:2112
24321 " guestfs_get_qemu (guestfs_h *g);\n"
24326 #: ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:6386
24327 msgid "(Added in 1.0.6)"
24331 #: ../src/guestfs-actions.pod:2125
24332 msgid "guestfs_get_recovery_proc"
24336 #: ../src/guestfs-actions.pod:2127
24340 " guestfs_get_recovery_proc (guestfs_h *g);\n"
24345 #: ../src/guestfs-actions.pod:2134 ../src/guestfs-actions.pod:3668
24346 #: ../src/guestfs-actions.pod:3999 ../src/guestfs-actions.pod:4402
24347 #: ../src/guestfs-actions.pod:4434 ../src/guestfs-actions.pod:5622
24348 #: ../src/guestfs-actions.pod:5965 ../src/guestfs-actions.pod:6410
24349 #: ../src/guestfs-actions.pod:7101 ../src/guestfs-actions.pod:7121
24350 #: ../src/guestfs-actions.pod:7313
24351 msgid "(Added in 1.0.77)"
24355 #: ../src/guestfs-actions.pod:2136
24356 msgid "guestfs_get_selinux"
24360 #: ../src/guestfs-actions.pod:2138
24364 " guestfs_get_selinux (guestfs_h *g);\n"
24369 #: ../src/guestfs-actions.pod:2141
24371 "This returns the current setting of the selinux flag which is passed to the "
24372 "appliance at boot time. See C<guestfs_set_selinux>."
24376 #: ../src/guestfs-actions.pod:2149 ../src/guestfs-actions.pod:2212
24377 #: ../src/guestfs-actions.pod:6429 ../src/guestfs-actions.pod:6487
24378 msgid "(Added in 1.0.67)"
24382 #: ../src/guestfs-actions.pod:2151
24383 msgid "guestfs_get_state"
24387 #: ../src/guestfs-actions.pod:2153
24391 " guestfs_get_state (guestfs_h *g);\n"
24396 #: ../src/guestfs-actions.pod:2165
24397 msgid "guestfs_get_trace"
24401 #: ../src/guestfs-actions.pod:2167
24405 " guestfs_get_trace (guestfs_h *g);\n"
24410 #: ../src/guestfs-actions.pod:2176
24411 msgid "guestfs_get_umask"
24415 #: ../src/guestfs-actions.pod:2178
24419 " guestfs_get_umask (guestfs_h *g);\n"
24424 #: ../src/guestfs-actions.pod:2181
24426 "Return the current umask. By default the umask is C<022> unless it has been "
24427 "set by calling C<guestfs_umask>."
24431 #: ../src/guestfs-actions.pod:2188
24432 msgid "guestfs_get_verbose"
24436 #: ../src/guestfs-actions.pod:2190
24440 " guestfs_get_verbose (guestfs_h *g);\n"
24445 #: ../src/guestfs-actions.pod:2199
24446 msgid "guestfs_getcon"
24450 #: ../src/guestfs-actions.pod:2201
24454 " guestfs_getcon (guestfs_h *g);\n"
24459 #: ../src/guestfs-actions.pod:2206
24461 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
24465 #: ../src/guestfs-actions.pod:2214
24466 msgid "guestfs_getxattr"
24470 #: ../src/guestfs-actions.pod:2216
24474 " guestfs_getxattr (guestfs_h *g,\n"
24475 " const char *path,\n"
24476 " const char *name,\n"
24477 " size_t *size_r);\n"
24482 #: ../src/guestfs-actions.pod:2222
24484 "Get a single extended attribute from file C<path> named C<name>. This call "
24485 "follows symlinks. If you want to lookup an extended attribute for the "
24486 "symlink itself, use C<guestfs_lgetxattr>."
24490 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:3682
24492 "Normally it is better to get all extended attributes from a file in one go "
24493 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
24494 "implementations are buggy and do not provide a way to list out attributes. "
24495 "For these filesystems (notably ntfs-3g) you have to know the names of the "
24496 "extended attributes you want in advance and call this function."
24500 #: ../src/guestfs-actions.pod:2236
24501 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
24505 #: ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2429
24506 #: ../src/guestfs-actions.pod:2899 ../src/guestfs-actions.pod:3694
24507 #: ../src/guestfs-actions.pod:5615 ../src/guestfs-actions.pod:5641
24508 #: ../src/guestfs-actions.pod:5822
24510 "This function returns a buffer, or NULL on error. The size of the returned "
24511 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
24516 #: ../src/guestfs-actions.pod:2242 ../src/guestfs-actions.pod:3698
24517 msgid "(Added in 1.7.24)"
24521 #: ../src/guestfs-actions.pod:2244
24522 msgid "guestfs_getxattrs"
24526 #: ../src/guestfs-actions.pod:2246
24529 " struct guestfs_xattr_list *\n"
24530 " guestfs_getxattrs (guestfs_h *g,\n"
24531 " const char *path);\n"
24536 #: ../src/guestfs-actions.pod:2256
24537 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
24541 #: ../src/guestfs-actions.pod:2258 ../src/guestfs-actions.pod:3710
24542 #: ../src/guestfs-actions.pod:4398
24544 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
24545 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
24549 #: ../src/guestfs-actions.pod:2262 ../src/guestfs-actions.pod:3714
24550 #: ../src/guestfs-actions.pod:3913 ../src/guestfs-actions.pod:3949
24551 #: ../src/guestfs-actions.pod:5995 ../src/guestfs-actions.pod:6506
24552 #: ../src/guestfs-actions.pod:7901
24553 msgid "(Added in 1.0.59)"
24557 #: ../src/guestfs-actions.pod:2264
24558 msgid "guestfs_glob_expand"
24562 #: ../src/guestfs-actions.pod:2266
24566 " guestfs_glob_expand (guestfs_h *g,\n"
24567 " const char *pattern);\n"
24572 #: ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:6699
24573 #: ../src/guestfs-actions.pod:6716
24574 msgid "(Added in 1.0.50)"
24578 #: ../src/guestfs-actions.pod:2287
24579 msgid "guestfs_grep"
24583 #: ../src/guestfs-actions.pod:2289
24587 " guestfs_grep (guestfs_h *g,\n"
24588 " const char *regex,\n"
24589 " const char *path);\n"
24594 #: ../src/guestfs-actions.pod:2306
24595 msgid "guestfs_grepi"
24599 #: ../src/guestfs-actions.pod:2308
24603 " guestfs_grepi (guestfs_h *g,\n"
24604 " const char *regex,\n"
24605 " const char *path);\n"
24610 #: ../src/guestfs-actions.pod:2325
24611 msgid "guestfs_grub_install"
24615 #: ../src/guestfs-actions.pod:2327
24619 " guestfs_grub_install (guestfs_h *g,\n"
24620 " const char *root,\n"
24621 " const char *device);\n"
24626 #: ../src/guestfs-actions.pod:2348
24627 msgid "(Added in 1.0.17)"
24631 #: ../src/guestfs-actions.pod:2350
24632 msgid "guestfs_head"
24636 #: ../src/guestfs-actions.pod:2352
24640 " guestfs_head (guestfs_h *g,\n"
24641 " const char *path);\n"
24646 #: ../src/guestfs-actions.pod:2368
24647 msgid "guestfs_head_n"
24651 #: ../src/guestfs-actions.pod:2370
24655 " guestfs_head_n (guestfs_h *g,\n"
24657 " const char *path);\n"
24662 #: ../src/guestfs-actions.pod:2392
24663 msgid "guestfs_hexdump"
24667 #: ../src/guestfs-actions.pod:2394
24671 " guestfs_hexdump (guestfs_h *g,\n"
24672 " const char *path);\n"
24677 #: ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:6780
24678 #: ../src/guestfs-actions.pod:6835
24679 msgid "(Added in 1.0.22)"
24683 #: ../src/guestfs-actions.pod:2409
24684 msgid "guestfs_initrd_cat"
24688 #: ../src/guestfs-actions.pod:2411
24692 " guestfs_initrd_cat (guestfs_h *g,\n"
24693 " const char *initrdpath,\n"
24694 " const char *filename,\n"
24695 " size_t *size_r);\n"
24700 #: ../src/guestfs-actions.pod:2427
24701 msgid "See also C<guestfs_initrd_list>."
24705 #: ../src/guestfs-actions.pod:2438
24706 msgid "guestfs_initrd_list"
24710 #: ../src/guestfs-actions.pod:2440
24714 " guestfs_initrd_list (guestfs_h *g,\n"
24715 " const char *path);\n"
24720 #: ../src/guestfs-actions.pod:2460
24721 msgid "guestfs_inotify_add_watch"
24725 #: ../src/guestfs-actions.pod:2462
24729 " guestfs_inotify_add_watch (guestfs_h *g,\n"
24730 " const char *path,\n"
24736 #: ../src/guestfs-actions.pod:2481
24737 msgid "guestfs_inotify_close"
24741 #: ../src/guestfs-actions.pod:2483
24745 " guestfs_inotify_close (guestfs_h *g);\n"
24750 #: ../src/guestfs-actions.pod:2494
24751 msgid "guestfs_inotify_files"
24755 #: ../src/guestfs-actions.pod:2496
24759 " guestfs_inotify_files (guestfs_h *g);\n"
24764 #: ../src/guestfs-actions.pod:2499
24766 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
24767 "returns a list of pathnames of objects that were touched. The returned "
24768 "pathnames are sorted and deduplicated."
24772 #: ../src/guestfs-actions.pod:2509
24773 msgid "guestfs_inotify_init"
24777 #: ../src/guestfs-actions.pod:2511
24781 " guestfs_inotify_init (guestfs_h *g,\n"
24782 " int maxevents);\n"
24787 #: ../src/guestfs-actions.pod:2519
24789 "C<maxevents> is the maximum number of events which will be queued up between "
24790 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
24791 "passed as C<0>, then the kernel (or previously set) default is used. For "
24792 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
24793 "throws away events, but records the fact that it threw them away by setting "
24794 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
24795 "C<guestfs_inotify_read>)."
24799 #: ../src/guestfs-actions.pod:2529
24801 "Before any events are generated, you have to add some watches to the "
24802 "internal watch list. See: C<guestfs_inotify_add_watch>, "
24803 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
24807 #: ../src/guestfs-actions.pod:2535
24809 "Queued up events should be read periodically by calling "
24810 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
24811 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
24812 "often enough then you risk the internal queue overflowing."
24816 #: ../src/guestfs-actions.pod:2542
24818 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
24819 "This also removes any watches automatically."
24823 #: ../src/guestfs-actions.pod:2555
24824 msgid "guestfs_inotify_read"
24828 #: ../src/guestfs-actions.pod:2557
24831 " struct guestfs_inotify_event_list *\n"
24832 " guestfs_inotify_read (guestfs_h *g);\n"
24837 #: ../src/guestfs-actions.pod:2571
24839 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
24840 "there was an error. I<The caller must call "
24841 "C<guestfs_free_inotify_event_list> after use>."
24845 #: ../src/guestfs-actions.pod:2577
24846 msgid "guestfs_inotify_rm_watch"
24850 #: ../src/guestfs-actions.pod:2579
24854 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
24860 #: ../src/guestfs-actions.pod:2583
24862 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
24866 #: ../src/guestfs-actions.pod:2590
24867 msgid "guestfs_inspect_get_arch"
24871 #: ../src/guestfs-actions.pod:2592
24875 " guestfs_inspect_get_arch (guestfs_h *g,\n"
24876 " const char *root);\n"
24881 #: ../src/guestfs-actions.pod:2596
24883 "This returns the architecture of the inspected operating system. The "
24884 "possible return values are listed under C<guestfs_file_architecture>."
24888 #: ../src/guestfs-actions.pod:2610
24889 msgid "guestfs_inspect_get_distro"
24893 #: ../src/guestfs-actions.pod:2612
24897 " guestfs_inspect_get_distro (guestfs_h *g,\n"
24898 " const char *root);\n"
24903 #: ../src/guestfs-actions.pod:2700
24904 msgid "guestfs_inspect_get_drive_mappings"
24908 #: ../src/guestfs-actions.pod:2702
24912 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
24913 " const char *root);\n"
24918 #: ../src/guestfs-actions.pod:2731
24920 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24921 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
24925 #: ../src/guestfs-actions.pod:2735 ../src/guestfs-actions.pod:3003
24926 #: ../src/guestfs-actions.pod:3801 ../src/guestfs-actions.pod:5083
24927 #: ../src/guestfs-actions.pod:7137
24929 "This function returns a NULL-terminated array of strings, or NULL if there "
24930 "was an error. The array of strings will always have length C<2n+1>, where "
24931 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
24932 "caller must free the strings and the array after use>."
24936 #: ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:3197
24937 msgid "(Added in 1.9.17)"
24941 #: ../src/guestfs-actions.pod:2743
24942 msgid "guestfs_inspect_get_filesystems"
24946 #: ../src/guestfs-actions.pod:2745
24950 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
24951 " const char *root);\n"
24956 #: ../src/guestfs-actions.pod:2757
24958 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24959 "C<guestfs_inspect_get_mountpoints>."
24963 #: ../src/guestfs-actions.pod:2766
24964 msgid "guestfs_inspect_get_format"
24968 #: ../src/guestfs-actions.pod:2768
24972 " guestfs_inspect_get_format (guestfs_h *g,\n"
24973 " const char *root);\n"
24978 #: ../src/guestfs-actions.pod:2802 ../src/guestfs-actions.pod:3233
24979 #: ../src/guestfs-actions.pod:3249 ../src/guestfs-actions.pod:3267
24980 #: ../src/guestfs-actions.pod:6033
24981 msgid "(Added in 1.9.4)"
24985 #: ../src/guestfs-actions.pod:2804
24986 msgid "guestfs_inspect_get_hostname"
24990 #: ../src/guestfs-actions.pod:2806
24994 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
24995 " const char *root);\n"
25000 #: ../src/guestfs-actions.pod:2821
25001 msgid "(Added in 1.7.9)"
25005 #: ../src/guestfs-actions.pod:2823
25006 msgid "guestfs_inspect_get_icon"
25010 #: ../src/guestfs-actions.pod:2825
25014 " guestfs_inspect_get_icon (guestfs_h *g,\n"
25015 " const char *root,\n"
25016 " size_t *size_r,\n"
25022 #: ../src/guestfs-actions.pod:2836
25025 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
25026 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
25031 #: ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:3728
25032 #: ../src/guestfs-actions.pod:4982
25033 msgid "(Added in 1.11.12)"
25037 #: ../src/guestfs-actions.pod:2905
25038 msgid "guestfs_inspect_get_icon_va"
25042 #: ../src/guestfs-actions.pod:2907
25046 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
25047 " const char *root,\n"
25048 " size_t *size_r,\n"
25049 " va_list args);\n"
25054 #: ../src/guestfs-actions.pod:2913
25055 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
25059 #: ../src/guestfs-actions.pod:2917
25060 msgid "guestfs_inspect_get_icon_argv"
25064 #: ../src/guestfs-actions.pod:2919
25068 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
25069 " const char *root,\n"
25070 " size_t *size_r,\n"
25071 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
25076 #: ../src/guestfs-actions.pod:2925
25077 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
25081 #: ../src/guestfs-actions.pod:2929
25082 msgid "guestfs_inspect_get_major_version"
25086 #: ../src/guestfs-actions.pod:2931
25090 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
25091 " const char *root);\n"
25096 #: ../src/guestfs-actions.pod:2953
25097 msgid "guestfs_inspect_get_minor_version"
25101 #: ../src/guestfs-actions.pod:2955
25105 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
25106 " const char *root);\n"
25111 #: ../src/guestfs-actions.pod:2964
25113 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25114 "C<guestfs_inspect_get_major_version>."
25118 #: ../src/guestfs-actions.pod:2971
25119 msgid "guestfs_inspect_get_mountpoints"
25123 #: ../src/guestfs-actions.pod:2973
25127 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
25128 " const char *root);\n"
25133 #: ../src/guestfs-actions.pod:2994
25135 "For operating systems like Windows which still use drive letters, this call "
25136 "will only return an entry for the first drive \"mounted on\" C</>. For "
25137 "information about the mapping of drive letters to partitions, see "
25138 "C<guestfs_inspect_get_drive_mappings>."
25142 #: ../src/guestfs-actions.pod:3000
25144 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25145 "C<guestfs_inspect_get_filesystems>."
25149 #: ../src/guestfs-actions.pod:3011
25150 msgid "guestfs_inspect_get_package_format"
25154 #: ../src/guestfs-actions.pod:3013
25158 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
25159 " const char *root);\n"
25164 #: ../src/guestfs-actions.pod:3017
25166 "This function and C<guestfs_inspect_get_package_management> return the "
25167 "package format and package management tool used by the inspected operating "
25168 "system. For example for Fedora these functions would return C<rpm> (package "
25169 "format) and C<yum> (package management)."
25173 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3063
25174 msgid "(Added in 1.7.5)"
25178 #: ../src/guestfs-actions.pod:3037
25179 msgid "guestfs_inspect_get_package_management"
25183 #: ../src/guestfs-actions.pod:3039
25187 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
25188 " const char *root);\n"
25193 #: ../src/guestfs-actions.pod:3043
25195 "C<guestfs_inspect_get_package_format> and this function return the package "
25196 "format and package management tool used by the inspected operating system. "
25197 "For example for Fedora these functions would return C<rpm> (package format) "
25198 "and C<yum> (package management)."
25202 #: ../src/guestfs-actions.pod:3065
25203 msgid "guestfs_inspect_get_product_name"
25207 #: ../src/guestfs-actions.pod:3067
25211 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
25212 " const char *root);\n"
25217 #: ../src/guestfs-actions.pod:3086
25218 msgid "guestfs_inspect_get_product_variant"
25222 #: ../src/guestfs-actions.pod:3088
25226 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
25227 " const char *root);\n"
25232 #: ../src/guestfs-actions.pod:3111
25234 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25235 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
25239 #: ../src/guestfs-actions.pod:3118
25240 msgid "(Added in 1.9.13)"
25244 #: ../src/guestfs-actions.pod:3120
25245 msgid "guestfs_inspect_get_roots"
25249 #: ../src/guestfs-actions.pod:3122
25253 " guestfs_inspect_get_roots (guestfs_h *g);\n"
25258 #: ../src/guestfs-actions.pod:3125
25260 "This function is a convenient way to get the list of root devices, as "
25261 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
25262 "the whole inspection process."
25266 #: ../src/guestfs-actions.pod:3129
25268 "This returns an empty list if either no root devices were found or the "
25269 "caller has not called C<guestfs_inspect_os>."
25273 #: ../src/guestfs-actions.pod:3138
25274 msgid "(Added in 1.7.3)"
25278 #: ../src/guestfs-actions.pod:3140
25279 msgid "guestfs_inspect_get_type"
25283 #: ../src/guestfs-actions.pod:3142
25287 " guestfs_inspect_get_type (guestfs_h *g,\n"
25288 " const char *root);\n"
25293 #: ../src/guestfs-actions.pod:3179
25294 msgid "guestfs_inspect_get_windows_current_control_set"
25298 #: ../src/guestfs-actions.pod:3181
25302 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
25303 " const char *root);\n"
25308 #: ../src/guestfs-actions.pod:3199
25309 msgid "guestfs_inspect_get_windows_systemroot"
25313 #: ../src/guestfs-actions.pod:3201
25317 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
25318 " const char *root);\n"
25323 #: ../src/guestfs-actions.pod:3217
25324 msgid "(Added in 1.5.25)"
25328 #: ../src/guestfs-actions.pod:3219
25329 msgid "guestfs_inspect_is_live"
25333 #: ../src/guestfs-actions.pod:3221
25337 " guestfs_inspect_is_live (guestfs_h *g,\n"
25338 " const char *root);\n"
25343 #: ../src/guestfs-actions.pod:3225
25345 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25346 "disk), then this returns true if a live image was detected on the disk."
25350 #: ../src/guestfs-actions.pod:3235
25351 msgid "guestfs_inspect_is_multipart"
25355 #: ../src/guestfs-actions.pod:3237
25359 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
25360 " const char *root);\n"
25365 #: ../src/guestfs-actions.pod:3241
25367 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25368 "disk), then this returns true if the disk is part of a set."
25372 #: ../src/guestfs-actions.pod:3251
25373 msgid "guestfs_inspect_is_netinst"
25377 #: ../src/guestfs-actions.pod:3253
25381 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
25382 " const char *root);\n"
25387 #: ../src/guestfs-actions.pod:3257
25389 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25390 "disk), then this returns true if the disk is a network installer, ie. not a "
25391 "self-contained install CD but one which is likely to require network access "
25392 "to complete the install."
25396 #: ../src/guestfs-actions.pod:3269
25397 msgid "guestfs_inspect_list_applications"
25401 #: ../src/guestfs-actions.pod:3271
25404 " struct guestfs_application_list *\n"
25405 " guestfs_inspect_list_applications (guestfs_h *g,\n"
25406 " const char *root);\n"
25411 #: ../src/guestfs-actions.pod:3277
25413 "I<Note:> This call works differently from other parts of the inspection "
25414 "API. You have to call C<guestfs_inspect_os>, then "
25415 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
25416 "this. Listing applications is a significantly more difficult operation "
25417 "which requires access to the full filesystem. Also note that unlike the "
25418 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
25419 "the libguestfs handle, this call actually reads parts of the mounted "
25420 "filesystems during the call."
25424 #: ../src/guestfs-actions.pod:3367
25426 "This function returns a C<struct guestfs_application_list *>, or NULL if "
25427 "there was an error. I<The caller must call C<guestfs_free_application_list> "
25432 #: ../src/guestfs-actions.pod:3371
25433 msgid "(Added in 1.7.8)"
25437 #: ../src/guestfs-actions.pod:3373
25438 msgid "guestfs_inspect_os"
25442 #: ../src/guestfs-actions.pod:3375
25446 " guestfs_inspect_os (guestfs_h *g);\n"
25451 #: ../src/guestfs-actions.pod:3391
25453 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
25454 "functions in order to query further information about each operating system, "
25455 "such as the name and version."
25459 #: ../src/guestfs-actions.pod:3396
25461 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
25462 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
25463 "the contents. This should be called with no disks currently mounted. The "
25464 "function may also use Augeas, so any existing Augeas handle will be closed."
25468 #: ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3739
25469 #: ../src/guestfs-actions.pod:3821
25470 msgid "See also C<guestfs_list_filesystems>."
25474 #: ../src/guestfs-actions.pod:3416
25475 msgid "guestfs_is_blockdev"
25479 #: ../src/guestfs-actions.pod:3418
25483 " guestfs_is_blockdev (guestfs_h *g,\n"
25484 " const char *path);\n"
25489 #: ../src/guestfs-actions.pod:3425 ../src/guestfs-actions.pod:3454
25490 #: ../src/guestfs-actions.pod:3484 ../src/guestfs-actions.pod:3499
25491 #: ../src/guestfs-actions.pod:3515 ../src/guestfs-actions.pod:3571
25492 #: ../src/guestfs-actions.pod:3586
25493 msgid "See also C<guestfs_stat>."
25497 #: ../src/guestfs-actions.pod:3429 ../src/guestfs-actions.pod:3458
25498 #: ../src/guestfs-actions.pod:3503 ../src/guestfs-actions.pod:3575
25499 #: ../src/guestfs-actions.pod:3590
25500 msgid "(Added in 1.5.10)"
25504 #: ../src/guestfs-actions.pod:3431
25505 msgid "guestfs_is_busy"
25509 #: ../src/guestfs-actions.pod:3433
25513 " guestfs_is_busy (guestfs_h *g);\n"
25518 #: ../src/guestfs-actions.pod:3445
25519 msgid "guestfs_is_chardev"
25523 #: ../src/guestfs-actions.pod:3447
25527 " guestfs_is_chardev (guestfs_h *g,\n"
25528 " const char *path);\n"
25533 #: ../src/guestfs-actions.pod:3460
25534 msgid "guestfs_is_config"
25538 #: ../src/guestfs-actions.pod:3462
25542 " guestfs_is_config (guestfs_h *g);\n"
25547 #: ../src/guestfs-actions.pod:3474
25548 msgid "guestfs_is_dir"
25552 #: ../src/guestfs-actions.pod:3476
25556 " guestfs_is_dir (guestfs_h *g,\n"
25557 " const char *path);\n"
25562 #: ../src/guestfs-actions.pod:3490
25563 msgid "guestfs_is_fifo"
25567 #: ../src/guestfs-actions.pod:3492
25571 " guestfs_is_fifo (guestfs_h *g,\n"
25572 " const char *path);\n"
25577 #: ../src/guestfs-actions.pod:3505
25578 msgid "guestfs_is_file"
25582 #: ../src/guestfs-actions.pod:3507
25586 " guestfs_is_file (guestfs_h *g,\n"
25587 " const char *path);\n"
25592 #: ../src/guestfs-actions.pod:3521
25593 msgid "guestfs_is_launching"
25597 #: ../src/guestfs-actions.pod:3523
25601 " guestfs_is_launching (guestfs_h *g);\n"
25606 #: ../src/guestfs-actions.pod:3535
25607 msgid "guestfs_is_lv"
25611 #: ../src/guestfs-actions.pod:3537
25615 " guestfs_is_lv (guestfs_h *g,\n"
25616 " const char *device);\n"
25621 #: ../src/guestfs-actions.pod:3548
25622 msgid "guestfs_is_ready"
25626 #: ../src/guestfs-actions.pod:3550
25630 " guestfs_is_ready (guestfs_h *g);\n"
25635 #: ../src/guestfs-actions.pod:3562
25636 msgid "guestfs_is_socket"
25640 #: ../src/guestfs-actions.pod:3564
25644 " guestfs_is_socket (guestfs_h *g,\n"
25645 " const char *path);\n"
25650 #: ../src/guestfs-actions.pod:3577
25651 msgid "guestfs_is_symlink"
25655 #: ../src/guestfs-actions.pod:3579
25659 " guestfs_is_symlink (guestfs_h *g,\n"
25660 " const char *path);\n"
25665 #: ../src/guestfs-actions.pod:3592
25666 msgid "guestfs_is_zero"
25670 #: ../src/guestfs-actions.pod:3594
25674 " guestfs_is_zero (guestfs_h *g,\n"
25675 " const char *path);\n"
25680 #: ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:3617
25681 msgid "(Added in 1.11.8)"
25685 #: ../src/guestfs-actions.pod:3605
25686 msgid "guestfs_is_zero_device"
25690 #: ../src/guestfs-actions.pod:3607
25694 " guestfs_is_zero_device (guestfs_h *g,\n"
25695 " const char *device);\n"
25700 #: ../src/guestfs-actions.pod:3619
25701 msgid "guestfs_kill_subprocess"
25705 #: ../src/guestfs-actions.pod:3621
25709 " guestfs_kill_subprocess (guestfs_h *g);\n"
25714 #: ../src/guestfs-actions.pod:3630
25715 msgid "guestfs_launch"
25719 #: ../src/guestfs-actions.pod:3632
25723 " guestfs_launch (guestfs_h *g);\n"
25728 #: ../src/guestfs-actions.pod:3650
25729 msgid "guestfs_lchown"
25733 #: ../src/guestfs-actions.pod:3652
25737 " guestfs_lchown (guestfs_h *g,\n"
25740 " const char *path);\n"
25745 #: ../src/guestfs-actions.pod:3658
25747 "Change the file owner to C<owner> and group to C<group>. This is like "
25748 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
25749 "changed, not the target."
25753 #: ../src/guestfs-actions.pod:3670
25754 msgid "guestfs_lgetxattr"
25758 #: ../src/guestfs-actions.pod:3672
25762 " guestfs_lgetxattr (guestfs_h *g,\n"
25763 " const char *path,\n"
25764 " const char *name,\n"
25765 " size_t *size_r);\n"
25770 #: ../src/guestfs-actions.pod:3692
25771 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
25775 #: ../src/guestfs-actions.pod:3700
25776 msgid "guestfs_lgetxattrs"
25780 #: ../src/guestfs-actions.pod:3702
25783 " struct guestfs_xattr_list *\n"
25784 " guestfs_lgetxattrs (guestfs_h *g,\n"
25785 " const char *path);\n"
25790 #: ../src/guestfs-actions.pod:3706
25792 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
25793 "then it returns the extended attributes of the link itself."
25797 #: ../src/guestfs-actions.pod:3716
25798 msgid "guestfs_list_9p"
25802 #: ../src/guestfs-actions.pod:3718
25806 " guestfs_list_9p (guestfs_h *g);\n"
25811 #: ../src/guestfs-actions.pod:3730
25812 msgid "guestfs_list_devices"
25816 #: ../src/guestfs-actions.pod:3732
25820 " guestfs_list_devices (guestfs_h *g);\n"
25825 #: ../src/guestfs-actions.pod:3747
25826 msgid "guestfs_list_dm_devices"
25830 #: ../src/guestfs-actions.pod:3749
25834 " guestfs_list_dm_devices (guestfs_h *g);\n"
25839 #: ../src/guestfs-actions.pod:3754
25841 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
25842 "previous call to C<guestfs_luks_open>."
25846 #: ../src/guestfs-actions.pod:3757
25848 "Device mapper devices which correspond to logical volumes are I<not> "
25849 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
25854 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:5221
25855 msgid "(Added in 1.11.15)"
25859 #: ../src/guestfs-actions.pod:3767
25860 msgid "guestfs_list_filesystems"
25864 #: ../src/guestfs-actions.pod:3769
25868 " guestfs_list_filesystems (guestfs_h *g);\n"
25873 #: ../src/guestfs-actions.pod:3789
25875 "This command runs other libguestfs commands, which might include "
25876 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
25877 "soon after launch and only when nothing is mounted."
25881 #: ../src/guestfs-actions.pod:3793
25883 "Not all of the filesystems returned will be mountable. In particular, swap "
25884 "partitions are returned in the list. Also this command does not check that "
25885 "each filesystem found is valid and mountable, and some filesystems might be "
25886 "mountable but require special options. Filesystems may not all belong to a "
25887 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
25891 #: ../src/guestfs-actions.pod:3807 ../src/guestfs-actions.pod:5582
25892 msgid "(Added in 1.5.15)"
25896 #: ../src/guestfs-actions.pod:3809
25897 msgid "guestfs_list_partitions"
25901 #: ../src/guestfs-actions.pod:3811
25905 " guestfs_list_partitions (guestfs_h *g);\n"
25910 #: ../src/guestfs-actions.pod:3818
25912 "This does not return logical volumes. For that you will need to call "
25917 #: ../src/guestfs-actions.pod:3829
25922 #: ../src/guestfs-actions.pod:3831
25926 " guestfs_ll (guestfs_h *g,\n"
25927 " const char *directory);\n"
25932 #: ../src/guestfs-actions.pod:3846
25937 #: ../src/guestfs-actions.pod:3848
25941 " guestfs_ln (guestfs_h *g,\n"
25942 " const char *target,\n"
25943 " const char *linkname);\n"
25948 #: ../src/guestfs-actions.pod:3859
25949 msgid "guestfs_ln_f"
25953 #: ../src/guestfs-actions.pod:3861
25957 " guestfs_ln_f (guestfs_h *g,\n"
25958 " const char *target,\n"
25959 " const char *linkname);\n"
25964 #: ../src/guestfs-actions.pod:3873
25965 msgid "guestfs_ln_s"
25969 #: ../src/guestfs-actions.pod:3875
25973 " guestfs_ln_s (guestfs_h *g,\n"
25974 " const char *target,\n"
25975 " const char *linkname);\n"
25980 #: ../src/guestfs-actions.pod:3886
25981 msgid "guestfs_ln_sf"
25985 #: ../src/guestfs-actions.pod:3888
25989 " guestfs_ln_sf (guestfs_h *g,\n"
25990 " const char *target,\n"
25991 " const char *linkname);\n"
25996 #: ../src/guestfs-actions.pod:3900
25997 msgid "guestfs_lremovexattr"
26001 #: ../src/guestfs-actions.pod:3902
26005 " guestfs_lremovexattr (guestfs_h *g,\n"
26006 " const char *xattr,\n"
26007 " const char *path);\n"
26012 #: ../src/guestfs-actions.pod:3907
26014 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
26015 "link, then it removes an extended attribute of the link itself."
26019 #: ../src/guestfs-actions.pod:3915
26024 #: ../src/guestfs-actions.pod:3917
26028 " guestfs_ls (guestfs_h *g,\n"
26029 " const char *directory);\n"
26034 #: ../src/guestfs-actions.pod:3925
26036 "This command is mostly useful for interactive sessions. Programs should "
26037 "probably use C<guestfs_readdir> instead."
26041 #: ../src/guestfs-actions.pod:3934
26042 msgid "guestfs_lsetxattr"
26046 #: ../src/guestfs-actions.pod:3936
26050 " guestfs_lsetxattr (guestfs_h *g,\n"
26051 " const char *xattr,\n"
26052 " const char *val,\n"
26054 " const char *path);\n"
26059 #: ../src/guestfs-actions.pod:3943
26061 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
26062 "then it sets an extended attribute of the link itself."
26066 #: ../src/guestfs-actions.pod:3951
26067 msgid "guestfs_lstat"
26071 #: ../src/guestfs-actions.pod:3953
26074 " struct guestfs_stat *\n"
26075 " guestfs_lstat (guestfs_h *g,\n"
26076 " const char *path);\n"
26081 #: ../src/guestfs-actions.pod:3959
26083 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
26084 "link, then the link is stat-ed, not the file it refers to."
26088 #: ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:6740
26090 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
26091 "error. I<The caller must call C<guestfs_free_stat> after use>."
26095 #: ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:6744
26096 #: ../src/guestfs-actions.pod:6762 ../src/guestfs-actions.pod:7143
26097 msgid "(Added in 0.9.2)"
26101 #: ../src/guestfs-actions.pod:3971
26102 msgid "guestfs_lstatlist"
26106 #: ../src/guestfs-actions.pod:3973
26109 " struct guestfs_stat_list *\n"
26110 " guestfs_lstatlist (guestfs_h *g,\n"
26111 " const char *path,\n"
26112 " char *const *names);\n"
26117 #: ../src/guestfs-actions.pod:3978
26119 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
26120 "files, where all files are in the directory C<path>. C<names> is the list "
26121 "of files from this directory."
26125 #: ../src/guestfs-actions.pod:3987
26127 "This call is intended for programs that want to efficiently list a directory "
26128 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
26129 "for a similarly efficient call for getting extended attributes. Very long "
26130 "directory listings might cause the protocol message size to be exceeded, "
26131 "causing this call to fail. The caller must split up such requests into "
26132 "smaller groups of names."
26136 #: ../src/guestfs-actions.pod:3995
26138 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
26139 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
26143 #: ../src/guestfs-actions.pod:4001
26144 msgid "guestfs_luks_add_key"
26148 #: ../src/guestfs-actions.pod:4003
26152 " guestfs_luks_add_key (guestfs_h *g,\n"
26153 " const char *device,\n"
26154 " const char *key,\n"
26155 " const char *newkey,\n"
26161 #: ../src/guestfs-actions.pod:4015
26163 "Note that if C<keyslot> already contains a key, then this command will "
26164 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
26168 #: ../src/guestfs-actions.pod:4021 ../src/guestfs-actions.pod:4061
26169 #: ../src/guestfs-actions.pod:4084 ../src/guestfs-actions.pod:4104
26170 #: ../src/guestfs-actions.pod:4139 ../src/guestfs-actions.pod:4158
26172 "This function takes a key or passphrase parameter which could contain "
26173 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
26178 #: ../src/guestfs-actions.pod:4025 ../src/guestfs-actions.pod:4065
26179 #: ../src/guestfs-actions.pod:4088 ../src/guestfs-actions.pod:4108
26180 msgid "(Added in 1.5.2)"
26184 #: ../src/guestfs-actions.pod:4027
26185 msgid "guestfs_luks_close"
26189 #: ../src/guestfs-actions.pod:4029
26193 " guestfs_luks_close (guestfs_h *g,\n"
26194 " const char *device);\n"
26199 #: ../src/guestfs-actions.pod:4033
26201 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
26202 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
26203 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
26204 "underlying block device."
26208 #: ../src/guestfs-actions.pod:4041 ../src/guestfs-actions.pod:4143
26209 #: ../src/guestfs-actions.pod:4162 ../src/guestfs-actions.pod:4212
26210 #: ../src/guestfs-actions.pod:4260
26211 msgid "(Added in 1.5.1)"
26215 #: ../src/guestfs-actions.pod:4043
26216 msgid "guestfs_luks_format"
26220 #: ../src/guestfs-actions.pod:4045
26224 " guestfs_luks_format (guestfs_h *g,\n"
26225 " const char *device,\n"
26226 " const char *key,\n"
26232 #: ../src/guestfs-actions.pod:4067
26233 msgid "guestfs_luks_format_cipher"
26237 #: ../src/guestfs-actions.pod:4069
26241 " guestfs_luks_format_cipher (guestfs_h *g,\n"
26242 " const char *device,\n"
26243 " const char *key,\n"
26245 " const char *cipher);\n"
26250 #: ../src/guestfs-actions.pod:4076
26252 "This command is the same as C<guestfs_luks_format> but it also allows you to "
26253 "set the C<cipher> used."
26257 #: ../src/guestfs-actions.pod:4090
26258 msgid "guestfs_luks_kill_slot"
26262 #: ../src/guestfs-actions.pod:4092
26266 " guestfs_luks_kill_slot (guestfs_h *g,\n"
26267 " const char *device,\n"
26268 " const char *key,\n"
26274 #: ../src/guestfs-actions.pod:4110
26275 msgid "guestfs_luks_open"
26279 #: ../src/guestfs-actions.pod:4112
26283 " guestfs_luks_open (guestfs_h *g,\n"
26284 " const char *device,\n"
26285 " const char *key,\n"
26286 " const char *mapname);\n"
26291 #: ../src/guestfs-actions.pod:4130
26293 "If this block device contains LVM volume groups, then calling "
26294 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
26299 #: ../src/guestfs-actions.pod:4134
26300 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
26304 #: ../src/guestfs-actions.pod:4145
26305 msgid "guestfs_luks_open_ro"
26309 #: ../src/guestfs-actions.pod:4147
26313 " guestfs_luks_open_ro (guestfs_h *g,\n"
26314 " const char *device,\n"
26315 " const char *key,\n"
26316 " const char *mapname);\n"
26321 #: ../src/guestfs-actions.pod:4153
26323 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
26328 #: ../src/guestfs-actions.pod:4164
26329 msgid "guestfs_lvcreate"
26333 #: ../src/guestfs-actions.pod:4166
26337 " guestfs_lvcreate (guestfs_h *g,\n"
26338 " const char *logvol,\n"
26339 " const char *volgroup,\n"
26345 #: ../src/guestfs-actions.pod:4179
26346 msgid "guestfs_lvm_canonical_lv_name"
26350 #: ../src/guestfs-actions.pod:4181
26354 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
26355 " const char *lvname);\n"
26360 #: ../src/guestfs-actions.pod:4192
26361 msgid "See also C<guestfs_is_lv>."
26365 #: ../src/guestfs-actions.pod:4197
26366 msgid "(Added in 1.5.24)"
26370 #: ../src/guestfs-actions.pod:4199
26371 msgid "guestfs_lvm_clear_filter"
26375 #: ../src/guestfs-actions.pod:4201
26379 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
26384 #: ../src/guestfs-actions.pod:4204
26386 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
26387 "see every block device."
26391 #: ../src/guestfs-actions.pod:4214
26392 msgid "guestfs_lvm_remove_all"
26396 #: ../src/guestfs-actions.pod:4216
26400 " guestfs_lvm_remove_all (guestfs_h *g);\n"
26405 #: ../src/guestfs-actions.pod:4229
26406 msgid "guestfs_lvm_set_filter"
26410 #: ../src/guestfs-actions.pod:4231
26414 " guestfs_lvm_set_filter (guestfs_h *g,\n"
26415 " char *const *devices);\n"
26420 #: ../src/guestfs-actions.pod:4262
26421 msgid "guestfs_lvremove"
26425 #: ../src/guestfs-actions.pod:4264
26429 " guestfs_lvremove (guestfs_h *g,\n"
26430 " const char *device);\n"
26435 #: ../src/guestfs-actions.pod:4276 ../src/guestfs-actions.pod:5679
26436 #: ../src/guestfs-actions.pod:7513
26437 msgid "(Added in 1.0.13)"
26441 #: ../src/guestfs-actions.pod:4278
26442 msgid "guestfs_lvrename"
26446 #: ../src/guestfs-actions.pod:4280
26450 " guestfs_lvrename (guestfs_h *g,\n"
26451 " const char *logvol,\n"
26452 " const char *newlogvol);\n"
26457 #: ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:7526
26458 msgid "(Added in 1.0.83)"
26462 #: ../src/guestfs-actions.pod:4291
26463 msgid "guestfs_lvresize"
26467 #: ../src/guestfs-actions.pod:4293
26471 " guestfs_lvresize (guestfs_h *g,\n"
26472 " const char *device,\n"
26478 #: ../src/guestfs-actions.pod:4306
26479 msgid "guestfs_lvresize_free"
26483 #: ../src/guestfs-actions.pod:4308
26487 " guestfs_lvresize_free (guestfs_h *g,\n"
26488 " const char *lv,\n"
26494 #: ../src/guestfs-actions.pod:4321
26495 msgid "(Added in 1.3.3)"
26499 #: ../src/guestfs-actions.pod:4323
26500 msgid "guestfs_lvs"
26504 #: ../src/guestfs-actions.pod:4325
26508 " guestfs_lvs (guestfs_h *g);\n"
26513 #: ../src/guestfs-actions.pod:4334
26514 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
26518 #: ../src/guestfs-actions.pod:4342
26519 msgid "guestfs_lvs_full"
26523 #: ../src/guestfs-actions.pod:4344
26526 " struct guestfs_lvm_lv_list *\n"
26527 " guestfs_lvs_full (guestfs_h *g);\n"
26532 #: ../src/guestfs-actions.pod:4350
26534 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
26535 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
26539 #: ../src/guestfs-actions.pod:4356
26540 msgid "guestfs_lvuuid"
26544 #: ../src/guestfs-actions.pod:4358
26548 " guestfs_lvuuid (guestfs_h *g,\n"
26549 " const char *device);\n"
26554 #: ../src/guestfs-actions.pod:4369
26555 msgid "guestfs_lxattrlist"
26559 #: ../src/guestfs-actions.pod:4371
26562 " struct guestfs_xattr_list *\n"
26563 " guestfs_lxattrlist (guestfs_h *g,\n"
26564 " const char *path,\n"
26565 " char *const *names);\n"
26570 #: ../src/guestfs-actions.pod:4390
26572 "This call is intended for programs that want to efficiently list a directory "
26573 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
26574 "a similarly efficient call for getting standard stats. Very long directory "
26575 "listings might cause the protocol message size to be exceeded, causing this "
26576 "call to fail. The caller must split up such requests into smaller groups of "
26581 #: ../src/guestfs-actions.pod:4404
26582 msgid "guestfs_mkdir"
26586 #: ../src/guestfs-actions.pod:4406
26590 " guestfs_mkdir (guestfs_h *g,\n"
26591 " const char *path);\n"
26596 #: ../src/guestfs-actions.pod:4416
26597 msgid "guestfs_mkdir_mode"
26601 #: ../src/guestfs-actions.pod:4418
26605 " guestfs_mkdir_mode (guestfs_h *g,\n"
26606 " const char *path,\n"
26612 #: ../src/guestfs-actions.pod:4430
26613 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
26617 #: ../src/guestfs-actions.pod:4436
26618 msgid "guestfs_mkdir_p"
26622 #: ../src/guestfs-actions.pod:4438
26626 " guestfs_mkdir_p (guestfs_h *g,\n"
26627 " const char *path);\n"
26632 #: ../src/guestfs-actions.pod:4449
26633 msgid "guestfs_mkdtemp"
26637 #: ../src/guestfs-actions.pod:4451
26641 " guestfs_mkdtemp (guestfs_h *g,\n"
26642 " const char *template);\n"
26647 #: ../src/guestfs-actions.pod:4479
26648 msgid "guestfs_mke2fs_J"
26652 #: ../src/guestfs-actions.pod:4481
26656 " guestfs_mke2fs_J (guestfs_h *g,\n"
26657 " const char *fstype,\n"
26658 " int blocksize,\n"
26659 " const char *device,\n"
26660 " const char *journal);\n"
26665 #: ../src/guestfs-actions.pod:4494
26666 msgid "See also C<guestfs_mke2journal>."
26670 #: ../src/guestfs-actions.pod:4498 ../src/guestfs-actions.pod:4516
26671 #: ../src/guestfs-actions.pod:4534 ../src/guestfs-actions.pod:4550
26672 #: ../src/guestfs-actions.pod:4564 ../src/guestfs-actions.pod:4578
26673 #: ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4914
26674 msgid "(Added in 1.0.68)"
26678 #: ../src/guestfs-actions.pod:4500
26679 msgid "guestfs_mke2fs_JL"
26683 #: ../src/guestfs-actions.pod:4502
26687 " guestfs_mke2fs_JL (guestfs_h *g,\n"
26688 " const char *fstype,\n"
26689 " int blocksize,\n"
26690 " const char *device,\n"
26691 " const char *label);\n"
26696 #: ../src/guestfs-actions.pod:4512
26697 msgid "See also C<guestfs_mke2journal_L>."
26701 #: ../src/guestfs-actions.pod:4518
26702 msgid "guestfs_mke2fs_JU"
26706 #: ../src/guestfs-actions.pod:4520
26710 " guestfs_mke2fs_JU (guestfs_h *g,\n"
26711 " const char *fstype,\n"
26712 " int blocksize,\n"
26713 " const char *device,\n"
26714 " const char *uuid);\n"
26719 #: ../src/guestfs-actions.pod:4530
26720 msgid "See also C<guestfs_mke2journal_U>."
26724 #: ../src/guestfs-actions.pod:4536
26725 msgid "guestfs_mke2journal"
26729 #: ../src/guestfs-actions.pod:4538
26733 " guestfs_mke2journal (guestfs_h *g,\n"
26734 " int blocksize,\n"
26735 " const char *device);\n"
26740 #: ../src/guestfs-actions.pod:4552
26741 msgid "guestfs_mke2journal_L"
26745 #: ../src/guestfs-actions.pod:4554
26749 " guestfs_mke2journal_L (guestfs_h *g,\n"
26750 " int blocksize,\n"
26751 " const char *label,\n"
26752 " const char *device);\n"
26757 #: ../src/guestfs-actions.pod:4566
26758 msgid "guestfs_mke2journal_U"
26762 #: ../src/guestfs-actions.pod:4568
26766 " guestfs_mke2journal_U (guestfs_h *g,\n"
26767 " int blocksize,\n"
26768 " const char *uuid,\n"
26769 " const char *device);\n"
26774 #: ../src/guestfs-actions.pod:4580
26775 msgid "guestfs_mkfifo"
26779 #: ../src/guestfs-actions.pod:4582
26783 " guestfs_mkfifo (guestfs_h *g,\n"
26785 " const char *path);\n"
26790 #: ../src/guestfs-actions.pod:4587
26792 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26793 "is just a convenient wrapper around C<guestfs_mknod>."
26797 #: ../src/guestfs-actions.pod:4597
26798 msgid "guestfs_mkfs"
26802 #: ../src/guestfs-actions.pod:4599
26806 " guestfs_mkfs (guestfs_h *g,\n"
26807 " const char *fstype,\n"
26808 " const char *device);\n"
26813 #: ../src/guestfs-actions.pod:4612
26814 msgid "guestfs_mkfs_b"
26818 #: ../src/guestfs-actions.pod:4614
26822 " guestfs_mkfs_b (guestfs_h *g,\n"
26823 " const char *fstype,\n"
26824 " int blocksize,\n"
26825 " const char *device);\n"
26830 #: ../src/guestfs-actions.pod:4620
26832 "I<This function is deprecated.> In new code, use the L</guestfs_mkfs_opts> "
26837 #: ../src/guestfs-actions.pod:4627
26839 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
26840 "block size of the resulting filesystem. Supported block sizes depend on the "
26841 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26845 #: ../src/guestfs-actions.pod:4639
26846 msgid "guestfs_mkfs_opts"
26850 #: ../src/guestfs-actions.pod:4641
26854 " guestfs_mkfs_opts (guestfs_h *g,\n"
26855 " const char *fstype,\n"
26856 " const char *device,\n"
26862 #: ../src/guestfs-actions.pod:4652
26865 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
26866 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
26867 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
26868 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
26873 #: ../src/guestfs-actions.pod:4700
26874 msgid "(Added in 1.7.19)"
26878 #: ../src/guestfs-actions.pod:4702
26879 msgid "guestfs_mkfs_opts_va"
26883 #: ../src/guestfs-actions.pod:4704
26887 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
26888 " const char *fstype,\n"
26889 " const char *device,\n"
26890 " va_list args);\n"
26895 #: ../src/guestfs-actions.pod:4710
26896 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
26900 #: ../src/guestfs-actions.pod:4714
26901 msgid "guestfs_mkfs_opts_argv"
26905 #: ../src/guestfs-actions.pod:4716
26909 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
26910 " const char *fstype,\n"
26911 " const char *device,\n"
26912 " const struct guestfs_mkfs_opts_argv *optargs);\n"
26917 #: ../src/guestfs-actions.pod:4722
26918 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
26922 #: ../src/guestfs-actions.pod:4726
26923 msgid "guestfs_mkmountpoint"
26927 #: ../src/guestfs-actions.pod:4728
26931 " guestfs_mkmountpoint (guestfs_h *g,\n"
26932 " const char *exemptpath);\n"
26937 #: ../src/guestfs-actions.pod:4732
26939 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
26940 "that can be used to create extra mountpoints before mounting the first "
26945 #: ../src/guestfs-actions.pod:4756
26947 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
26948 "may get unexpected errors if you try to mix these calls. It is safest to "
26949 "manually unmount filesystems and remove mountpoints after use."
26953 #: ../src/guestfs-actions.pod:4760
26955 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
26956 "first, so for this to work for manual mountpoints, you must ensure that the "
26957 "innermost mountpoints have the longest pathnames, as in the example code "
26962 #: ../src/guestfs-actions.pod:4767
26964 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
26965 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
26966 "can also trigger these issues."
26970 #: ../src/guestfs-actions.pod:4773 ../src/guestfs-actions.pod:5089
26971 #: ../src/guestfs-actions.pod:6099
26972 msgid "(Added in 1.0.62)"
26976 #: ../src/guestfs-actions.pod:4775
26977 msgid "guestfs_mknod"
26981 #: ../src/guestfs-actions.pod:4777
26985 " guestfs_mknod (guestfs_h *g,\n"
26989 " const char *path);\n"
26994 #: ../src/guestfs-actions.pod:4792
26996 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26997 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26998 "regular file). These constants are available in the standard Linux header "
26999 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
27000 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
27001 "the appropriate constant for you."
27005 #: ../src/guestfs-actions.pod:4806
27006 msgid "guestfs_mknod_b"
27010 #: ../src/guestfs-actions.pod:4808
27014 " guestfs_mknod_b (guestfs_h *g,\n"
27018 " const char *path);\n"
27023 #: ../src/guestfs-actions.pod:4815
27025 "This call creates a block device node called C<path> with mode C<mode> and "
27026 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27027 "wrapper around C<guestfs_mknod>."
27031 #: ../src/guestfs-actions.pod:4825
27032 msgid "guestfs_mknod_c"
27036 #: ../src/guestfs-actions.pod:4827
27040 " guestfs_mknod_c (guestfs_h *g,\n"
27044 " const char *path);\n"
27049 #: ../src/guestfs-actions.pod:4834
27051 "This call creates a char device node called C<path> with mode C<mode> and "
27052 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27053 "wrapper around C<guestfs_mknod>."
27057 #: ../src/guestfs-actions.pod:4844
27058 msgid "guestfs_mkswap"
27062 #: ../src/guestfs-actions.pod:4846
27066 " guestfs_mkswap (guestfs_h *g,\n"
27067 " const char *device);\n"
27072 #: ../src/guestfs-actions.pod:4856
27073 msgid "guestfs_mkswap_L"
27077 #: ../src/guestfs-actions.pod:4858
27081 " guestfs_mkswap_L (guestfs_h *g,\n"
27082 " const char *label,\n"
27083 " const char *device);\n"
27088 #: ../src/guestfs-actions.pod:4873
27089 msgid "guestfs_mkswap_U"
27093 #: ../src/guestfs-actions.pod:4875
27097 " guestfs_mkswap_U (guestfs_h *g,\n"
27098 " const char *uuid,\n"
27099 " const char *device);\n"
27104 #: ../src/guestfs-actions.pod:4886
27105 msgid "guestfs_mkswap_file"
27109 #: ../src/guestfs-actions.pod:4888
27113 " guestfs_mkswap_file (guestfs_h *g,\n"
27114 " const char *path);\n"
27119 #: ../src/guestfs-actions.pod:4894
27121 "This command just writes a swap file signature to an existing file. To "
27122 "create the file itself, use something like C<guestfs_fallocate>."
27126 #: ../src/guestfs-actions.pod:4901
27127 msgid "guestfs_modprobe"
27131 #: ../src/guestfs-actions.pod:4903
27135 " guestfs_modprobe (guestfs_h *g,\n"
27136 " const char *modulename);\n"
27141 #: ../src/guestfs-actions.pod:4916
27142 msgid "guestfs_mount"
27146 #: ../src/guestfs-actions.pod:4918
27150 " guestfs_mount (guestfs_h *g,\n"
27151 " const char *device,\n"
27152 " const char *mountpoint);\n"
27157 #: ../src/guestfs-actions.pod:4923
27159 "I<This function is deprecated.> In new code, use the L</"
27160 "guestfs_mount_options> call instead."
27164 #: ../src/guestfs-actions.pod:4944
27166 "B<Important note:> When you use this call, the filesystem options C<sync> "
27167 "and C<noatime> are set implicitly. This was originally done because we "
27168 "thought it would improve reliability, but it turns out that I<-o sync> has a "
27169 "very large negative performance impact and negligible effect on "
27170 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
27171 "in any code that needs performance, and instead use C<guestfs_mount_options> "
27172 "(use an empty string for the first parameter if you don't want any options)."
27176 #: ../src/guestfs-actions.pod:4958
27177 msgid "guestfs_mount_9p"
27181 #: ../src/guestfs-actions.pod:4960
27185 " guestfs_mount_9p (guestfs_h *g,\n"
27186 " const char *mounttag,\n"
27187 " const char *mountpoint,\n"
27193 #: ../src/guestfs-actions.pod:4971
27196 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
27201 #: ../src/guestfs-actions.pod:4984
27202 msgid "guestfs_mount_9p_va"
27206 #: ../src/guestfs-actions.pod:4986
27210 " guestfs_mount_9p_va (guestfs_h *g,\n"
27211 " const char *mounttag,\n"
27212 " const char *mountpoint,\n"
27213 " va_list args);\n"
27218 #: ../src/guestfs-actions.pod:4992
27219 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
27223 #: ../src/guestfs-actions.pod:4996
27224 msgid "guestfs_mount_9p_argv"
27228 #: ../src/guestfs-actions.pod:4998
27232 " guestfs_mount_9p_argv (guestfs_h *g,\n"
27233 " const char *mounttag,\n"
27234 " const char *mountpoint,\n"
27235 " const struct guestfs_mount_9p_argv *optargs);\n"
27240 #: ../src/guestfs-actions.pod:5004
27241 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
27245 #: ../src/guestfs-actions.pod:5008
27246 msgid "guestfs_mount_loop"
27250 #: ../src/guestfs-actions.pod:5010
27254 " guestfs_mount_loop (guestfs_h *g,\n"
27255 " const char *file,\n"
27256 " const char *mountpoint);\n"
27261 #: ../src/guestfs-actions.pod:5023
27262 msgid "guestfs_mount_options"
27266 #: ../src/guestfs-actions.pod:5025
27270 " guestfs_mount_options (guestfs_h *g,\n"
27271 " const char *options,\n"
27272 " const char *device,\n"
27273 " const char *mountpoint);\n"
27278 #: ../src/guestfs-actions.pod:5031
27280 "This is the same as the C<guestfs_mount> command, but it allows you to set "
27281 "the mount options as for the L<mount(8)> I<-o> flag."
27285 #: ../src/guestfs-actions.pod:5041 ../src/guestfs-actions.pod:5055
27286 #: ../src/guestfs-actions.pod:5072
27287 msgid "(Added in 1.0.10)"
27291 #: ../src/guestfs-actions.pod:5043
27292 msgid "guestfs_mount_ro"
27296 #: ../src/guestfs-actions.pod:5045
27300 " guestfs_mount_ro (guestfs_h *g,\n"
27301 " const char *device,\n"
27302 " const char *mountpoint);\n"
27307 #: ../src/guestfs-actions.pod:5050
27309 "This is the same as the C<guestfs_mount> command, but it mounts the "
27310 "filesystem with the read-only (I<-o ro>) flag."
27314 #: ../src/guestfs-actions.pod:5057
27315 msgid "guestfs_mount_vfs"
27319 #: ../src/guestfs-actions.pod:5059
27323 " guestfs_mount_vfs (guestfs_h *g,\n"
27324 " const char *options,\n"
27325 " const char *vfstype,\n"
27326 " const char *device,\n"
27327 " const char *mountpoint);\n"
27332 #: ../src/guestfs-actions.pod:5066
27334 "This is the same as the C<guestfs_mount> command, but it allows you to set "
27335 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
27340 #: ../src/guestfs-actions.pod:5074
27341 msgid "guestfs_mountpoints"
27345 #: ../src/guestfs-actions.pod:5076
27349 " guestfs_mountpoints (guestfs_h *g);\n"
27354 #: ../src/guestfs-actions.pod:5079
27356 "This call is similar to C<guestfs_mounts>. That call returns a list of "
27357 "devices. This one returns a hash table (map) of device name to directory "
27358 "where the device is mounted."
27362 #: ../src/guestfs-actions.pod:5091
27363 msgid "guestfs_mounts"
27367 #: ../src/guestfs-actions.pod:5093
27371 " guestfs_mounts (guestfs_h *g);\n"
27376 #: ../src/guestfs-actions.pod:5101
27377 msgid "See also: C<guestfs_mountpoints>"
27381 #: ../src/guestfs-actions.pod:5109
27386 #: ../src/guestfs-actions.pod:5111
27390 " guestfs_mv (guestfs_h *g,\n"
27391 " const char *src,\n"
27392 " const char *dest);\n"
27397 #: ../src/guestfs-actions.pod:5123
27398 msgid "guestfs_ntfs_3g_probe"
27402 #: ../src/guestfs-actions.pod:5125
27406 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
27408 " const char *device);\n"
27413 #: ../src/guestfs-actions.pod:5144
27414 msgid "(Added in 1.0.43)"
27418 #: ../src/guestfs-actions.pod:5146
27419 msgid "guestfs_ntfsresize"
27423 #: ../src/guestfs-actions.pod:5148
27427 " guestfs_ntfsresize (guestfs_h *g,\n"
27428 " const char *device);\n"
27433 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5252
27435 "I<This function is deprecated.> In new code, use the L</"
27436 "guestfs_ntfsresize_opts> call instead."
27440 #: ../src/guestfs-actions.pod:5176
27441 msgid "guestfs_ntfsresize_opts"
27445 #: ../src/guestfs-actions.pod:5178
27449 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
27450 " const char *device,\n"
27456 #: ../src/guestfs-actions.pod:5188
27459 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
27460 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
27465 #: ../src/guestfs-actions.pod:5208
27467 "After the resize operation, the filesystem is always marked as requiring a "
27468 "consistency check (for safety). You have to boot into Windows to perform "
27469 "this check and clear this condition. If you I<don't> set the C<force> "
27470 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
27471 "times on a single filesystem without booting into Windows between each "
27476 #: ../src/guestfs-actions.pod:5223
27477 msgid "guestfs_ntfsresize_opts_va"
27481 #: ../src/guestfs-actions.pod:5225
27485 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
27486 " const char *device,\n"
27487 " va_list args);\n"
27492 #: ../src/guestfs-actions.pod:5230
27493 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
27497 #: ../src/guestfs-actions.pod:5234
27498 msgid "guestfs_ntfsresize_opts_argv"
27502 #: ../src/guestfs-actions.pod:5236
27506 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
27507 " const char *device,\n"
27508 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
27513 #: ../src/guestfs-actions.pod:5241
27514 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
27518 #: ../src/guestfs-actions.pod:5245
27519 msgid "guestfs_ntfsresize_size"
27523 #: ../src/guestfs-actions.pod:5247
27527 " guestfs_ntfsresize_size (guestfs_h *g,\n"
27528 " const char *device,\n"
27529 " int64_t size);\n"
27534 #: ../src/guestfs-actions.pod:5259
27536 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
27537 "to specify the new size (in bytes) explicitly."
27541 #: ../src/guestfs-actions.pod:5264 ../src/guestfs-actions.pod:5706
27542 #: ../src/guestfs-actions.pod:5779 ../src/guestfs-actions.pod:6047
27543 #: ../src/guestfs-actions.pod:7670
27544 msgid "(Added in 1.3.14)"
27548 #: ../src/guestfs-actions.pod:5266
27549 msgid "guestfs_part_add"
27553 #: ../src/guestfs-actions.pod:5268
27557 " guestfs_part_add (guestfs_h *g,\n"
27558 " const char *device,\n"
27559 " const char *prlogex,\n"
27560 " int64_t startsect,\n"
27561 " int64_t endsect);\n"
27566 #: ../src/guestfs-actions.pod:5275
27568 "This command adds a partition to C<device>. If there is no partition table "
27569 "on the device, call C<guestfs_part_init> first."
27573 #: ../src/guestfs-actions.pod:5287
27575 "Creating a partition which covers the whole disk is not so easy. Use "
27576 "C<guestfs_part_disk> to do that."
27580 #: ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:5330
27581 #: ../src/guestfs-actions.pod:5383 ../src/guestfs-actions.pod:5467
27582 #: ../src/guestfs-actions.pod:5505 ../src/guestfs-actions.pod:5524
27583 #: ../src/guestfs-actions.pod:5564
27584 msgid "(Added in 1.0.78)"
27588 #: ../src/guestfs-actions.pod:5294
27589 msgid "guestfs_part_del"
27593 #: ../src/guestfs-actions.pod:5296
27597 " guestfs_part_del (guestfs_h *g,\n"
27598 " const char *device,\n"
27604 #: ../src/guestfs-actions.pod:5311
27605 msgid "guestfs_part_disk"
27609 #: ../src/guestfs-actions.pod:5313
27613 " guestfs_part_disk (guestfs_h *g,\n"
27614 " const char *device,\n"
27615 " const char *parttype);\n"
27620 #: ../src/guestfs-actions.pod:5318
27622 "This command is simply a combination of C<guestfs_part_init> followed by "
27623 "C<guestfs_part_add> to create a single primary partition covering the whole "
27628 #: ../src/guestfs-actions.pod:5322
27630 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
27631 "possible values are described in C<guestfs_part_init>."
27635 #: ../src/guestfs-actions.pod:5332
27636 msgid "guestfs_part_get_bootable"
27640 #: ../src/guestfs-actions.pod:5334
27644 " guestfs_part_get_bootable (guestfs_h *g,\n"
27645 " const char *device,\n"
27651 #: ../src/guestfs-actions.pod:5342
27652 msgid "See also C<guestfs_part_set_bootable>."
27656 #: ../src/guestfs-actions.pod:5348
27657 msgid "guestfs_part_get_mbr_id"
27661 #: ../src/guestfs-actions.pod:5350
27665 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
27666 " const char *device,\n"
27672 #: ../src/guestfs-actions.pod:5358 ../src/guestfs-actions.pod:5540
27674 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
27675 "undefined results for other partition table types (see "
27676 "C<guestfs_part_get_parttype>)."
27680 #: ../src/guestfs-actions.pod:5366
27681 msgid "guestfs_part_get_parttype"
27685 #: ../src/guestfs-actions.pod:5368
27689 " guestfs_part_get_parttype (guestfs_h *g,\n"
27690 " const char *device);\n"
27695 #: ../src/guestfs-actions.pod:5375
27697 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
27698 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
27699 "possible, although unusual. See C<guestfs_part_init> for a full list."
27703 #: ../src/guestfs-actions.pod:5385
27704 msgid "guestfs_part_init"
27708 #: ../src/guestfs-actions.pod:5387
27712 " guestfs_part_init (guestfs_h *g,\n"
27713 " const char *device,\n"
27714 " const char *parttype);\n"
27719 #: ../src/guestfs-actions.pod:5396
27721 "Initially there are no partitions. Following this, you should call "
27722 "C<guestfs_part_add> for each partition required."
27726 #: ../src/guestfs-actions.pod:5469
27727 msgid "guestfs_part_list"
27731 #: ../src/guestfs-actions.pod:5471
27734 " struct guestfs_partition_list *\n"
27735 " guestfs_part_list (guestfs_h *g,\n"
27736 " const char *device);\n"
27741 #: ../src/guestfs-actions.pod:5488
27743 "Start of the partition I<in bytes>. To get sectors you have to divide by "
27744 "the device's sector size, see C<guestfs_blockdev_getss>."
27748 #: ../src/guestfs-actions.pod:5501
27750 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
27751 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
27756 #: ../src/guestfs-actions.pod:5507
27757 msgid "guestfs_part_set_bootable"
27761 #: ../src/guestfs-actions.pod:5509
27765 " guestfs_part_set_bootable (guestfs_h *g,\n"
27766 " const char *device,\n"
27768 " int bootable);\n"
27773 #: ../src/guestfs-actions.pod:5526
27774 msgid "guestfs_part_set_mbr_id"
27778 #: ../src/guestfs-actions.pod:5528
27782 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
27783 " const char *device,\n"
27790 #: ../src/guestfs-actions.pod:5548
27791 msgid "guestfs_part_set_name"
27795 #: ../src/guestfs-actions.pod:5550
27799 " guestfs_part_set_name (guestfs_h *g,\n"
27800 " const char *device,\n"
27802 " const char *name);\n"
27807 #: ../src/guestfs-actions.pod:5566
27808 msgid "guestfs_part_to_dev"
27812 #: ../src/guestfs-actions.pod:5568
27816 " guestfs_part_to_dev (guestfs_h *g,\n"
27817 " const char *partition);\n"
27822 #: ../src/guestfs-actions.pod:5576
27824 "The named partition must exist, for example as a string returned from "
27825 "C<guestfs_list_partitions>."
27829 #: ../src/guestfs-actions.pod:5584
27830 msgid "guestfs_ping_daemon"
27834 #: ../src/guestfs-actions.pod:5586
27838 " guestfs_ping_daemon (guestfs_h *g);\n"
27843 #: ../src/guestfs-actions.pod:5598
27844 msgid "guestfs_pread"
27848 #: ../src/guestfs-actions.pod:5600
27852 " guestfs_pread (guestfs_h *g,\n"
27853 " const char *path,\n"
27855 " int64_t offset,\n"
27856 " size_t *size_r);\n"
27861 #: ../src/guestfs-actions.pod:5613
27862 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
27866 #: ../src/guestfs-actions.pod:5624
27867 msgid "guestfs_pread_device"
27871 #: ../src/guestfs-actions.pod:5626
27875 " guestfs_pread_device (guestfs_h *g,\n"
27876 " const char *device,\n"
27878 " int64_t offset,\n"
27879 " size_t *size_r);\n"
27884 #: ../src/guestfs-actions.pod:5639
27885 msgid "See also C<guestfs_pread>."
27889 #: ../src/guestfs-actions.pod:5648
27890 msgid "(Added in 1.5.21)"
27894 #: ../src/guestfs-actions.pod:5650
27895 msgid "guestfs_pvcreate"
27899 #: ../src/guestfs-actions.pod:5652
27903 " guestfs_pvcreate (guestfs_h *g,\n"
27904 " const char *device);\n"
27909 #: ../src/guestfs-actions.pod:5664
27910 msgid "guestfs_pvremove"
27914 #: ../src/guestfs-actions.pod:5666
27918 " guestfs_pvremove (guestfs_h *g,\n"
27919 " const char *device);\n"
27924 #: ../src/guestfs-actions.pod:5681
27925 msgid "guestfs_pvresize"
27929 #: ../src/guestfs-actions.pod:5683
27933 " guestfs_pvresize (guestfs_h *g,\n"
27934 " const char *device);\n"
27939 #: ../src/guestfs-actions.pod:5694
27940 msgid "guestfs_pvresize_size"
27944 #: ../src/guestfs-actions.pod:5696
27948 " guestfs_pvresize_size (guestfs_h *g,\n"
27949 " const char *device,\n"
27950 " int64_t size);\n"
27955 #: ../src/guestfs-actions.pod:5701
27957 "This command is the same as C<guestfs_pvresize> except that it allows you to "
27958 "specify the new size (in bytes) explicitly."
27962 #: ../src/guestfs-actions.pod:5708
27963 msgid "guestfs_pvs"
27967 #: ../src/guestfs-actions.pod:5710
27971 " guestfs_pvs (guestfs_h *g);\n"
27976 #: ../src/guestfs-actions.pod:5719
27977 msgid "See also C<guestfs_pvs_full>."
27981 #: ../src/guestfs-actions.pod:5727
27982 msgid "guestfs_pvs_full"
27986 #: ../src/guestfs-actions.pod:5729
27989 " struct guestfs_lvm_pv_list *\n"
27990 " guestfs_pvs_full (guestfs_h *g);\n"
27995 #: ../src/guestfs-actions.pod:5735
27997 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
27998 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
28002 #: ../src/guestfs-actions.pod:5741
28003 msgid "guestfs_pvuuid"
28007 #: ../src/guestfs-actions.pod:5743
28011 " guestfs_pvuuid (guestfs_h *g,\n"
28012 " const char *device);\n"
28017 #: ../src/guestfs-actions.pod:5754
28018 msgid "guestfs_pwrite"
28022 #: ../src/guestfs-actions.pod:5756
28026 " guestfs_pwrite (guestfs_h *g,\n"
28027 " const char *path,\n"
28028 " const char *content,\n"
28029 " size_t content_size,\n"
28030 " int64_t offset);\n"
28035 #: ../src/guestfs-actions.pod:5772
28036 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
28040 #: ../src/guestfs-actions.pod:5781
28041 msgid "guestfs_pwrite_device"
28045 #: ../src/guestfs-actions.pod:5783
28049 " guestfs_pwrite_device (guestfs_h *g,\n"
28050 " const char *device,\n"
28051 " const char *content,\n"
28052 " size_t content_size,\n"
28053 " int64_t offset);\n"
28058 #: ../src/guestfs-actions.pod:5798
28059 msgid "See also C<guestfs_pwrite>."
28063 #: ../src/guestfs-actions.pod:5805
28064 msgid "(Added in 1.5.20)"
28068 #: ../src/guestfs-actions.pod:5807
28069 msgid "guestfs_read_file"
28073 #: ../src/guestfs-actions.pod:5809
28077 " guestfs_read_file (guestfs_h *g,\n"
28078 " const char *path,\n"
28079 " size_t *size_r);\n"
28084 #: ../src/guestfs-actions.pod:5817
28086 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
28087 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
28088 "function is limited in the total size of file that can be handled."
28092 #: ../src/guestfs-actions.pod:5829
28093 msgid "(Added in 1.0.63)"
28097 #: ../src/guestfs-actions.pod:5831
28098 msgid "guestfs_read_lines"
28102 #: ../src/guestfs-actions.pod:5833
28106 " guestfs_read_lines (guestfs_h *g,\n"
28107 " const char *path);\n"
28112 #: ../src/guestfs-actions.pod:5842
28114 "Note that this function cannot correctly handle binary files (specifically, "
28115 "files containing C<\\0> character which is treated as end of line). For "
28116 "those you need to use the C<guestfs_read_file> function which has a more "
28117 "complex interface."
28121 #: ../src/guestfs-actions.pod:5853
28122 msgid "guestfs_readdir"
28126 #: ../src/guestfs-actions.pod:5855
28129 " struct guestfs_dirent_list *\n"
28130 " guestfs_readdir (guestfs_h *g,\n"
28131 " const char *dir);\n"
28136 #: ../src/guestfs-actions.pod:5909
28138 "This function is primarily intended for use by programs. To get a simple "
28139 "list of names, use C<guestfs_ls>. To get a printable directory for human "
28140 "consumption, use C<guestfs_ll>."
28144 #: ../src/guestfs-actions.pod:5913
28146 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
28147 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
28151 #: ../src/guestfs-actions.pod:5919
28152 msgid "guestfs_readlink"
28156 #: ../src/guestfs-actions.pod:5921
28160 " guestfs_readlink (guestfs_h *g,\n"
28161 " const char *path);\n"
28166 #: ../src/guestfs-actions.pod:5932
28167 msgid "guestfs_readlinklist"
28171 #: ../src/guestfs-actions.pod:5934
28175 " guestfs_readlinklist (guestfs_h *g,\n"
28176 " const char *path,\n"
28177 " char *const *names);\n"
28182 #: ../src/guestfs-actions.pod:5967
28183 msgid "guestfs_realpath"
28187 #: ../src/guestfs-actions.pod:5969
28191 " guestfs_realpath (guestfs_h *g,\n"
28192 " const char *path);\n"
28197 #: ../src/guestfs-actions.pod:5981
28198 msgid "guestfs_removexattr"
28202 #: ../src/guestfs-actions.pod:5983
28206 " guestfs_removexattr (guestfs_h *g,\n"
28207 " const char *xattr,\n"
28208 " const char *path);\n"
28213 #: ../src/guestfs-actions.pod:5991
28214 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
28218 #: ../src/guestfs-actions.pod:5997
28219 msgid "guestfs_resize2fs"
28223 #: ../src/guestfs-actions.pod:5999
28227 " guestfs_resize2fs (guestfs_h *g,\n"
28228 " const char *device);\n"
28233 #: ../src/guestfs-actions.pod:6006
28235 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
28236 "C<device> before calling this command. For unknown reasons C<resize2fs> "
28237 "sometimes gives an error about this and sometimes not. In any case, it is "
28238 "always safe to call C<guestfs_e2fsck_f> before calling this function."
28242 #: ../src/guestfs-actions.pod:6016
28243 msgid "guestfs_resize2fs_M"
28247 #: ../src/guestfs-actions.pod:6018
28251 " guestfs_resize2fs_M (guestfs_h *g,\n"
28252 " const char *device);\n"
28257 #: ../src/guestfs-actions.pod:6022
28259 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
28260 "resized to its minimum size. This works like the I<-M> option to the "
28261 "C<resize2fs> command."
28265 #: ../src/guestfs-actions.pod:6026
28267 "To get the resulting size of the filesystem you should call "
28268 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
28269 "These two numbers, multiplied together, give the resulting size of the "
28270 "minimal filesystem in bytes."
28274 #: ../src/guestfs-actions.pod:6035
28275 msgid "guestfs_resize2fs_size"
28279 #: ../src/guestfs-actions.pod:6037
28283 " guestfs_resize2fs_size (guestfs_h *g,\n"
28284 " const char *device,\n"
28285 " int64_t size);\n"
28290 #: ../src/guestfs-actions.pod:6042
28292 "This command is the same as C<guestfs_resize2fs> except that it allows you "
28293 "to specify the new size (in bytes) explicitly."
28297 #: ../src/guestfs-actions.pod:6049
28302 #: ../src/guestfs-actions.pod:6051
28306 " guestfs_rm (guestfs_h *g,\n"
28307 " const char *path);\n"
28312 #: ../src/guestfs-actions.pod:6061
28313 msgid "guestfs_rm_rf"
28317 #: ../src/guestfs-actions.pod:6063
28321 " guestfs_rm_rf (guestfs_h *g,\n"
28322 " const char *path);\n"
28327 #: ../src/guestfs-actions.pod:6075
28328 msgid "guestfs_rmdir"
28332 #: ../src/guestfs-actions.pod:6077
28336 " guestfs_rmdir (guestfs_h *g,\n"
28337 " const char *path);\n"
28342 #: ../src/guestfs-actions.pod:6087
28343 msgid "guestfs_rmmountpoint"
28347 #: ../src/guestfs-actions.pod:6089
28351 " guestfs_rmmountpoint (guestfs_h *g,\n"
28352 " const char *exemptpath);\n"
28357 #: ../src/guestfs-actions.pod:6093
28359 "This calls removes a mountpoint that was previously created with "
28360 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
28364 #: ../src/guestfs-actions.pod:6101
28365 msgid "guestfs_scrub_device"
28369 #: ../src/guestfs-actions.pod:6103
28373 " guestfs_scrub_device (guestfs_h *g,\n"
28374 " const char *device);\n"
28379 #: ../src/guestfs-actions.pod:6118 ../src/guestfs-actions.pod:6136
28380 #: ../src/guestfs-actions.pod:6155
28381 msgid "(Added in 1.0.52)"
28385 #: ../src/guestfs-actions.pod:6120
28386 msgid "guestfs_scrub_file"
28390 #: ../src/guestfs-actions.pod:6122
28394 " guestfs_scrub_file (guestfs_h *g,\n"
28395 " const char *file);\n"
28400 #: ../src/guestfs-actions.pod:6138
28401 msgid "guestfs_scrub_freespace"
28405 #: ../src/guestfs-actions.pod:6140
28409 " guestfs_scrub_freespace (guestfs_h *g,\n"
28410 " const char *dir);\n"
28415 #: ../src/guestfs-actions.pod:6144
28417 "This command creates the directory C<dir> and then fills it with files until "
28418 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
28419 "and deletes them. The intention is to scrub any free space on the partition "
28420 "containing C<dir>."
28424 #: ../src/guestfs-actions.pod:6157
28425 msgid "guestfs_set_append"
28429 #: ../src/guestfs-actions.pod:6159
28433 " guestfs_set_append (guestfs_h *g,\n"
28434 " const char *append);\n"
28439 #: ../src/guestfs-actions.pod:6176
28440 msgid "guestfs_set_attach_method"
28444 #: ../src/guestfs-actions.pod:6178
28448 " guestfs_set_attach_method (guestfs_h *g,\n"
28449 " const char *attachmethod);\n"
28454 #: ../src/guestfs-actions.pod:6206
28455 msgid "guestfs_set_autosync"
28459 #: ../src/guestfs-actions.pod:6208
28463 " guestfs_set_autosync (guestfs_h *g,\n"
28464 " int autosync);\n"
28469 #: ../src/guestfs-actions.pod:6224
28470 msgid "guestfs_set_direct"
28474 #: ../src/guestfs-actions.pod:6226
28478 " guestfs_set_direct (guestfs_h *g,\n"
28484 #: ../src/guestfs-actions.pod:6234
28486 "One consequence of this is that log messages aren't caught by the library "
28487 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
28492 #: ../src/guestfs-actions.pod:6247
28493 msgid "guestfs_set_e2label"
28497 #: ../src/guestfs-actions.pod:6249
28501 " guestfs_set_e2label (guestfs_h *g,\n"
28502 " const char *device,\n"
28503 " const char *label);\n"
28508 #: ../src/guestfs-actions.pod:6258
28510 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
28511 "the existing label on a filesystem."
28515 #: ../src/guestfs-actions.pod:6265
28516 msgid "guestfs_set_e2uuid"
28520 #: ../src/guestfs-actions.pod:6267
28524 " guestfs_set_e2uuid (guestfs_h *g,\n"
28525 " const char *device,\n"
28526 " const char *uuid);\n"
28531 #: ../src/guestfs-actions.pod:6277
28533 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
28534 "the existing UUID of a filesystem."
28538 #: ../src/guestfs-actions.pod:6284
28539 msgid "guestfs_set_memsize"
28543 #: ../src/guestfs-actions.pod:6286
28547 " guestfs_set_memsize (guestfs_h *g,\n"
28553 #: ../src/guestfs-actions.pod:6290
28555 "This sets the memory size in megabytes allocated to the qemu subprocess. "
28556 "This only has any effect if called before C<guestfs_launch>."
28560 #: ../src/guestfs-actions.pod:6305
28561 msgid "guestfs_set_network"
28565 #: ../src/guestfs-actions.pod:6307
28569 " guestfs_set_network (guestfs_h *g,\n"
28575 #: ../src/guestfs-actions.pod:6317
28577 "You must call this before calling C<guestfs_launch>, otherwise it has no "
28582 #: ../src/guestfs-actions.pod:6324
28583 msgid "guestfs_set_path"
28587 #: ../src/guestfs-actions.pod:6326
28591 " guestfs_set_path (guestfs_h *g,\n"
28592 " const char *searchpath);\n"
28597 #: ../src/guestfs-actions.pod:6341
28598 msgid "guestfs_set_pgroup"
28602 #: ../src/guestfs-actions.pod:6343
28606 " guestfs_set_pgroup (guestfs_h *g,\n"
28612 #: ../src/guestfs-actions.pod:6360
28613 msgid "guestfs_set_qemu"
28617 #: ../src/guestfs-actions.pod:6362
28621 " guestfs_set_qemu (guestfs_h *g,\n"
28622 " const char *qemu);\n"
28627 #: ../src/guestfs-actions.pod:6388
28628 msgid "guestfs_set_recovery_proc"
28632 #: ../src/guestfs-actions.pod:6390
28636 " guestfs_set_recovery_proc (guestfs_h *g,\n"
28637 " int recoveryproc);\n"
28642 #: ../src/guestfs-actions.pod:6394
28644 "If this is called with the parameter C<false> then C<guestfs_launch> does "
28645 "not create a recovery process. The purpose of the recovery process is to "
28646 "stop runaway qemu processes in the case where the main program aborts "
28651 #: ../src/guestfs-actions.pod:6399
28653 "This only has any effect if called before C<guestfs_launch>, and the default "
28658 #: ../src/guestfs-actions.pod:6412
28659 msgid "guestfs_set_selinux"
28663 #: ../src/guestfs-actions.pod:6414
28667 " guestfs_set_selinux (guestfs_h *g,\n"
28673 #: ../src/guestfs-actions.pod:6431
28674 msgid "guestfs_set_trace"
28678 #: ../src/guestfs-actions.pod:6433
28682 " guestfs_set_trace (guestfs_h *g,\n"
28688 #: ../src/guestfs-actions.pod:6447
28690 "Trace messages are normally sent to C<stderr>, unless you register a "
28691 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
28695 #: ../src/guestfs-actions.pod:6455
28696 msgid "guestfs_set_verbose"
28700 #: ../src/guestfs-actions.pod:6457
28704 " guestfs_set_verbose (guestfs_h *g,\n"
28710 #: ../src/guestfs-actions.pod:6466
28712 "Verbose messages are normally sent to C<stderr>, unless you register a "
28713 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
28717 #: ../src/guestfs-actions.pod:6474
28718 msgid "guestfs_setcon"
28722 #: ../src/guestfs-actions.pod:6476
28726 " guestfs_setcon (guestfs_h *g,\n"
28727 " const char *context);\n"
28732 #: ../src/guestfs-actions.pod:6489
28733 msgid "guestfs_setxattr"
28737 #: ../src/guestfs-actions.pod:6491
28741 " guestfs_setxattr (guestfs_h *g,\n"
28742 " const char *xattr,\n"
28743 " const char *val,\n"
28745 " const char *path);\n"
28750 #: ../src/guestfs-actions.pod:6502
28751 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
28755 #: ../src/guestfs-actions.pod:6508
28756 msgid "guestfs_sfdisk"
28760 #: ../src/guestfs-actions.pod:6510
28764 " guestfs_sfdisk (guestfs_h *g,\n"
28765 " const char *device,\n"
28769 " char *const *lines);\n"
28774 #: ../src/guestfs-actions.pod:6518 ../src/guestfs-actions.pod:6562
28775 #: ../src/guestfs-actions.pod:6596
28777 "I<This function is deprecated.> In new code, use the L</guestfs_part_add> "
28782 #: ../src/guestfs-actions.pod:6545
28784 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
28788 #: ../src/guestfs-actions.pod:6555
28789 msgid "guestfs_sfdiskM"
28793 #: ../src/guestfs-actions.pod:6557
28797 " guestfs_sfdiskM (guestfs_h *g,\n"
28798 " const char *device,\n"
28799 " char *const *lines);\n"
28804 #: ../src/guestfs-actions.pod:6569
28806 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
28807 "partition sizes are specified in megabytes only (rounded to the nearest "
28808 "cylinder) and you don't need to specify the cyls, heads and sectors "
28809 "parameters which were rarely if ever used anyway."
28813 #: ../src/guestfs-actions.pod:6575
28815 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
28816 "C<guestfs_part_disk>"
28820 #: ../src/guestfs-actions.pod:6585
28821 msgid "guestfs_sfdisk_N"
28825 #: ../src/guestfs-actions.pod:6587
28829 " guestfs_sfdisk_N (guestfs_h *g,\n"
28830 " const char *device,\n"
28835 " const char *line);\n"
28840 #: ../src/guestfs-actions.pod:6606
28842 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
28843 "for the cyls/heads/sectors parameters."
28847 #: ../src/guestfs-actions.pod:6609
28848 msgid "See also: C<guestfs_part_add>"
28852 #: ../src/guestfs-actions.pod:6618
28853 msgid "guestfs_sfdisk_disk_geometry"
28857 #: ../src/guestfs-actions.pod:6620
28861 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
28862 " const char *device);\n"
28867 #: ../src/guestfs-actions.pod:6624
28869 "This displays the disk geometry of C<device> read from the partition table. "
28870 "Especially in the case where the underlying block device has been resized, "
28871 "this can be different from the kernel's idea of the geometry (see "
28872 "C<guestfs_sfdisk_kernel_geometry>)."
28876 #: ../src/guestfs-actions.pod:6637
28877 msgid "guestfs_sfdisk_kernel_geometry"
28881 #: ../src/guestfs-actions.pod:6639
28885 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
28886 " const char *device);\n"
28891 #: ../src/guestfs-actions.pod:6653
28892 msgid "guestfs_sfdisk_l"
28896 #: ../src/guestfs-actions.pod:6655
28900 " guestfs_sfdisk_l (guestfs_h *g,\n"
28901 " const char *device);\n"
28906 #: ../src/guestfs-actions.pod:6659
28908 "I<This function is deprecated.> In new code, use the L</guestfs_part_list> "
28913 #: ../src/guestfs-actions.pod:6670
28914 msgid "See also: C<guestfs_part_list>"
28918 #: ../src/guestfs-actions.pod:6677
28923 #: ../src/guestfs-actions.pod:6679
28927 " guestfs_sh (guestfs_h *g,\n"
28928 " const char *command);\n"
28933 #: ../src/guestfs-actions.pod:6686
28934 msgid "This is like C<guestfs_command>, but passes the command to:"
28938 #: ../src/guestfs-actions.pod:6694
28939 msgid "All the provisos about C<guestfs_command> apply to this call."
28943 #: ../src/guestfs-actions.pod:6701
28944 msgid "guestfs_sh_lines"
28948 #: ../src/guestfs-actions.pod:6703
28952 " guestfs_sh_lines (guestfs_h *g,\n"
28953 " const char *command);\n"
28958 #: ../src/guestfs-actions.pod:6707
28960 "This is the same as C<guestfs_sh>, but splits the result into a list of "
28965 #: ../src/guestfs-actions.pod:6710
28966 msgid "See also: C<guestfs_command_lines>"
28970 #: ../src/guestfs-actions.pod:6718
28971 msgid "guestfs_sleep"
28975 #: ../src/guestfs-actions.pod:6720
28979 " guestfs_sleep (guestfs_h *g,\n"
28985 #: ../src/guestfs-actions.pod:6728
28986 msgid "(Added in 1.0.41)"
28990 #: ../src/guestfs-actions.pod:6730 ../src/guestfs-structs.pod:109
28991 msgid "guestfs_stat"
28995 #: ../src/guestfs-actions.pod:6732
28998 " struct guestfs_stat *\n"
28999 " guestfs_stat (guestfs_h *g,\n"
29000 " const char *path);\n"
29005 #: ../src/guestfs-actions.pod:6746 ../src/guestfs-structs.pod:135
29006 msgid "guestfs_statvfs"
29010 #: ../src/guestfs-actions.pod:6748
29013 " struct guestfs_statvfs *\n"
29014 " guestfs_statvfs (guestfs_h *g,\n"
29015 " const char *path);\n"
29020 #: ../src/guestfs-actions.pod:6758
29022 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
29023 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
29027 #: ../src/guestfs-actions.pod:6764
29028 msgid "guestfs_strings"
29032 #: ../src/guestfs-actions.pod:6766
29036 " guestfs_strings (guestfs_h *g,\n"
29037 " const char *path);\n"
29042 #: ../src/guestfs-actions.pod:6782
29043 msgid "guestfs_strings_e"
29047 #: ../src/guestfs-actions.pod:6784
29051 " guestfs_strings_e (guestfs_h *g,\n"
29052 " const char *encoding,\n"
29053 " const char *path);\n"
29058 #: ../src/guestfs-actions.pod:6789
29060 "This is like the C<guestfs_strings> command, but allows you to specify the "
29061 "encoding of strings that are looked for in the source file C<path>."
29065 #: ../src/guestfs-actions.pod:6799
29067 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
29068 "ISO-8859-X (this is what C<guestfs_strings> uses)."
29072 #: ../src/guestfs-actions.pod:6837
29073 msgid "guestfs_swapoff_device"
29077 #: ../src/guestfs-actions.pod:6839
29081 " guestfs_swapoff_device (guestfs_h *g,\n"
29082 " const char *device);\n"
29087 #: ../src/guestfs-actions.pod:6843
29089 "This command disables the libguestfs appliance swap device or partition "
29090 "named C<device>. See C<guestfs_swapon_device>."
29094 #: ../src/guestfs-actions.pod:6851
29095 msgid "guestfs_swapoff_file"
29099 #: ../src/guestfs-actions.pod:6853
29103 " guestfs_swapoff_file (guestfs_h *g,\n"
29104 " const char *file);\n"
29109 #: ../src/guestfs-actions.pod:6863
29110 msgid "guestfs_swapoff_label"
29114 #: ../src/guestfs-actions.pod:6865
29118 " guestfs_swapoff_label (guestfs_h *g,\n"
29119 " const char *label);\n"
29124 #: ../src/guestfs-actions.pod:6876
29125 msgid "guestfs_swapoff_uuid"
29129 #: ../src/guestfs-actions.pod:6878
29133 " guestfs_swapoff_uuid (guestfs_h *g,\n"
29134 " const char *uuid);\n"
29139 #: ../src/guestfs-actions.pod:6889
29140 msgid "guestfs_swapon_device"
29144 #: ../src/guestfs-actions.pod:6891
29148 " guestfs_swapon_device (guestfs_h *g,\n"
29149 " const char *device);\n"
29154 #: ../src/guestfs-actions.pod:6895
29156 "This command enables the libguestfs appliance to use the swap device or "
29157 "partition named C<device>. The increased memory is made available for all "
29158 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
29162 #: ../src/guestfs-actions.pod:6911
29163 msgid "guestfs_swapon_file"
29167 #: ../src/guestfs-actions.pod:6913
29171 " guestfs_swapon_file (guestfs_h *g,\n"
29172 " const char *file);\n"
29177 #: ../src/guestfs-actions.pod:6917
29179 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
29184 #: ../src/guestfs-actions.pod:6924
29185 msgid "guestfs_swapon_label"
29189 #: ../src/guestfs-actions.pod:6926
29193 " guestfs_swapon_label (guestfs_h *g,\n"
29194 " const char *label);\n"
29199 #: ../src/guestfs-actions.pod:6930
29201 "This command enables swap to a labeled swap partition. See "
29202 "C<guestfs_swapon_device> for other notes."
29206 #: ../src/guestfs-actions.pod:6937
29207 msgid "guestfs_swapon_uuid"
29211 #: ../src/guestfs-actions.pod:6939
29215 " guestfs_swapon_uuid (guestfs_h *g,\n"
29216 " const char *uuid);\n"
29221 #: ../src/guestfs-actions.pod:6943
29223 "This command enables swap to a swap partition with the given UUID. See "
29224 "C<guestfs_swapon_device> for other notes."
29228 #: ../src/guestfs-actions.pod:6950
29229 msgid "guestfs_sync"
29233 #: ../src/guestfs-actions.pod:6952
29237 " guestfs_sync (guestfs_h *g);\n"
29242 #: ../src/guestfs-actions.pod:6965
29243 msgid "guestfs_tail"
29247 #: ../src/guestfs-actions.pod:6967
29251 " guestfs_tail (guestfs_h *g,\n"
29252 " const char *path);\n"
29257 #: ../src/guestfs-actions.pod:6983
29258 msgid "guestfs_tail_n"
29262 #: ../src/guestfs-actions.pod:6985
29266 " guestfs_tail_n (guestfs_h *g,\n"
29268 " const char *path);\n"
29273 #: ../src/guestfs-actions.pod:7007
29274 msgid "guestfs_tar_in"
29278 #: ../src/guestfs-actions.pod:7009
29282 " guestfs_tar_in (guestfs_h *g,\n"
29283 " const char *tarfile,\n"
29284 " const char *directory);\n"
29289 #: ../src/guestfs-actions.pod:7017
29291 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
29295 #: ../src/guestfs-actions.pod:7022 ../src/guestfs-actions.pod:7039
29296 #: ../src/guestfs-actions.pod:7055 ../src/guestfs-actions.pod:7071
29297 msgid "(Added in 1.0.3)"
29301 #: ../src/guestfs-actions.pod:7024
29302 msgid "guestfs_tar_out"
29306 #: ../src/guestfs-actions.pod:7026
29310 " guestfs_tar_out (guestfs_h *g,\n"
29311 " const char *directory,\n"
29312 " const char *tarfile);\n"
29317 #: ../src/guestfs-actions.pod:7034
29319 "To download a compressed tarball, use C<guestfs_tgz_out> or "
29320 "C<guestfs_txz_out>."
29324 #: ../src/guestfs-actions.pod:7041
29325 msgid "guestfs_tgz_in"
29329 #: ../src/guestfs-actions.pod:7043
29333 " guestfs_tgz_in (guestfs_h *g,\n"
29334 " const char *tarball,\n"
29335 " const char *directory);\n"
29340 #: ../src/guestfs-actions.pod:7051
29341 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
29345 #: ../src/guestfs-actions.pod:7057
29346 msgid "guestfs_tgz_out"
29350 #: ../src/guestfs-actions.pod:7059
29354 " guestfs_tgz_out (guestfs_h *g,\n"
29355 " const char *directory,\n"
29356 " const char *tarball);\n"
29361 #: ../src/guestfs-actions.pod:7067
29362 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
29366 #: ../src/guestfs-actions.pod:7073
29367 msgid "guestfs_touch"
29371 #: ../src/guestfs-actions.pod:7075
29375 " guestfs_touch (guestfs_h *g,\n"
29376 " const char *path);\n"
29381 #: ../src/guestfs-actions.pod:7090
29382 msgid "guestfs_truncate"
29386 #: ../src/guestfs-actions.pod:7092
29390 " guestfs_truncate (guestfs_h *g,\n"
29391 " const char *path);\n"
29396 #: ../src/guestfs-actions.pod:7103
29397 msgid "guestfs_truncate_size"
29401 #: ../src/guestfs-actions.pod:7105
29405 " guestfs_truncate_size (guestfs_h *g,\n"
29406 " const char *path,\n"
29407 " int64_t size);\n"
29412 #: ../src/guestfs-actions.pod:7113
29414 "If the current file size is less than C<size> then the file is extended to "
29415 "the required size with zero bytes. This creates a sparse file (ie. disk "
29416 "blocks are not allocated for the file until you write to it). To create a "
29417 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
29421 #: ../src/guestfs-actions.pod:7123
29422 msgid "guestfs_tune2fs_l"
29426 #: ../src/guestfs-actions.pod:7125
29430 " guestfs_tune2fs_l (guestfs_h *g,\n"
29431 " const char *device);\n"
29436 #: ../src/guestfs-actions.pod:7145
29437 msgid "guestfs_txz_in"
29441 #: ../src/guestfs-actions.pod:7147
29445 " guestfs_txz_in (guestfs_h *g,\n"
29446 " const char *tarball,\n"
29447 " const char *directory);\n"
29452 #: ../src/guestfs-actions.pod:7159
29453 msgid "guestfs_txz_out"
29457 #: ../src/guestfs-actions.pod:7161
29461 " guestfs_txz_out (guestfs_h *g,\n"
29462 " const char *directory,\n"
29463 " const char *tarball);\n"
29468 #: ../src/guestfs-actions.pod:7173
29469 msgid "guestfs_umask"
29473 #: ../src/guestfs-actions.pod:7175
29477 " guestfs_umask (guestfs_h *g,\n"
29483 #: ../src/guestfs-actions.pod:7191
29485 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
29486 "C<guestfs_mkdir>."
29490 #: ../src/guestfs-actions.pod:7200
29491 msgid "guestfs_umount"
29495 #: ../src/guestfs-actions.pod:7202
29499 " guestfs_umount (guestfs_h *g,\n"
29500 " const char *pathordevice);\n"
29505 #: ../src/guestfs-actions.pod:7214
29506 msgid "guestfs_umount_all"
29510 #: ../src/guestfs-actions.pod:7216
29514 " guestfs_umount_all (guestfs_h *g);\n"
29519 #: ../src/guestfs-actions.pod:7227
29520 msgid "guestfs_upload"
29524 #: ../src/guestfs-actions.pod:7229
29528 " guestfs_upload (guestfs_h *g,\n"
29529 " const char *filename,\n"
29530 " const char *remotefilename);\n"
29535 #: ../src/guestfs-actions.pod:7239
29536 msgid "See also C<guestfs_download>."
29540 #: ../src/guestfs-actions.pod:7250
29541 msgid "guestfs_upload_offset"
29545 #: ../src/guestfs-actions.pod:7252
29549 " guestfs_upload_offset (guestfs_h *g,\n"
29550 " const char *filename,\n"
29551 " const char *remotefilename,\n"
29552 " int64_t offset);\n"
29557 #: ../src/guestfs-actions.pod:7268
29559 "Note that there is no limit on the amount of data that can be uploaded with "
29560 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
29561 "full amount unless an error occurs."
29565 #: ../src/guestfs-actions.pod:7273
29566 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
29570 #: ../src/guestfs-actions.pod:7284
29571 msgid "guestfs_utimens"
29575 #: ../src/guestfs-actions.pod:7286
29579 " guestfs_utimens (guestfs_h *g,\n"
29580 " const char *path,\n"
29581 " int64_t atsecs,\n"
29582 " int64_t atnsecs,\n"
29583 " int64_t mtsecs,\n"
29584 " int64_t mtnsecs);\n"
29589 #: ../src/guestfs-actions.pod:7315 ../src/guestfs-structs.pod:175
29590 msgid "guestfs_version"
29594 #: ../src/guestfs-actions.pod:7317
29597 " struct guestfs_version *\n"
29598 " guestfs_version (guestfs_h *g);\n"
29603 #: ../src/guestfs-actions.pod:7345
29605 "I<Note:> Don't use this call to test for availability of features. In "
29606 "enterprise distributions we backport features from later versions into "
29607 "earlier versions, making this an unreliable way to test for features. Use "
29608 "C<guestfs_available> instead."
29612 #: ../src/guestfs-actions.pod:7351
29614 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
29615 "error. I<The caller must call C<guestfs_free_version> after use>."
29619 #: ../src/guestfs-actions.pod:7355
29620 msgid "(Added in 1.0.58)"
29624 #: ../src/guestfs-actions.pod:7357
29625 msgid "guestfs_vfs_label"
29629 #: ../src/guestfs-actions.pod:7359
29633 " guestfs_vfs_label (guestfs_h *g,\n"
29634 " const char *device);\n"
29639 #: ../src/guestfs-actions.pod:7368
29640 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
29644 #: ../src/guestfs-actions.pod:7373 ../src/guestfs-actions.pod:7410
29645 msgid "(Added in 1.3.18)"
29649 #: ../src/guestfs-actions.pod:7375
29650 msgid "guestfs_vfs_type"
29654 #: ../src/guestfs-actions.pod:7377
29658 " guestfs_vfs_type (guestfs_h *g,\n"
29659 " const char *device);\n"
29664 #: ../src/guestfs-actions.pod:7394
29665 msgid "guestfs_vfs_uuid"
29669 #: ../src/guestfs-actions.pod:7396
29673 " guestfs_vfs_uuid (guestfs_h *g,\n"
29674 " const char *device);\n"
29679 #: ../src/guestfs-actions.pod:7405
29680 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
29684 #: ../src/guestfs-actions.pod:7412
29685 msgid "guestfs_vg_activate"
29689 #: ../src/guestfs-actions.pod:7414
29693 " guestfs_vg_activate (guestfs_h *g,\n"
29695 " char *const *volgroups);\n"
29700 #: ../src/guestfs-actions.pod:7431
29701 msgid "guestfs_vg_activate_all"
29705 #: ../src/guestfs-actions.pod:7433
29709 " guestfs_vg_activate_all (guestfs_h *g,\n"
29710 " int activate);\n"
29715 #: ../src/guestfs-actions.pod:7446
29716 msgid "guestfs_vgcreate"
29720 #: ../src/guestfs-actions.pod:7448
29724 " guestfs_vgcreate (guestfs_h *g,\n"
29725 " const char *volgroup,\n"
29726 " char *const *physvols);\n"
29731 #: ../src/guestfs-actions.pod:7460
29732 msgid "guestfs_vglvuuids"
29736 #: ../src/guestfs-actions.pod:7462
29740 " guestfs_vglvuuids (guestfs_h *g,\n"
29741 " const char *vgname);\n"
29746 #: ../src/guestfs-actions.pod:7469
29748 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
29749 "associate logical volumes and volume groups."
29753 #: ../src/guestfs-actions.pod:7472
29754 msgid "See also C<guestfs_vgpvuuids>."
29758 #: ../src/guestfs-actions.pod:7480
29759 msgid "guestfs_vgpvuuids"
29763 #: ../src/guestfs-actions.pod:7482
29767 " guestfs_vgpvuuids (guestfs_h *g,\n"
29768 " const char *vgname);\n"
29773 #: ../src/guestfs-actions.pod:7489
29775 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
29776 "associate physical volumes and volume groups."
29780 #: ../src/guestfs-actions.pod:7492
29781 msgid "See also C<guestfs_vglvuuids>."
29785 #: ../src/guestfs-actions.pod:7500
29786 msgid "guestfs_vgremove"
29790 #: ../src/guestfs-actions.pod:7502
29794 " guestfs_vgremove (guestfs_h *g,\n"
29795 " const char *vgname);\n"
29800 #: ../src/guestfs-actions.pod:7515
29801 msgid "guestfs_vgrename"
29805 #: ../src/guestfs-actions.pod:7517
29809 " guestfs_vgrename (guestfs_h *g,\n"
29810 " const char *volgroup,\n"
29811 " const char *newvolgroup);\n"
29816 #: ../src/guestfs-actions.pod:7528
29817 msgid "guestfs_vgs"
29821 #: ../src/guestfs-actions.pod:7530
29825 " guestfs_vgs (guestfs_h *g);\n"
29830 #: ../src/guestfs-actions.pod:7539
29831 msgid "See also C<guestfs_vgs_full>."
29835 #: ../src/guestfs-actions.pod:7547
29836 msgid "guestfs_vgs_full"
29840 #: ../src/guestfs-actions.pod:7549
29843 " struct guestfs_lvm_vg_list *\n"
29844 " guestfs_vgs_full (guestfs_h *g);\n"
29849 #: ../src/guestfs-actions.pod:7555
29851 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
29852 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
29856 #: ../src/guestfs-actions.pod:7561
29857 msgid "guestfs_vgscan"
29861 #: ../src/guestfs-actions.pod:7563
29865 " guestfs_vgscan (guestfs_h *g);\n"
29870 #: ../src/guestfs-actions.pod:7573
29871 msgid "guestfs_vguuid"
29875 #: ../src/guestfs-actions.pod:7575
29879 " guestfs_vguuid (guestfs_h *g,\n"
29880 " const char *vgname);\n"
29885 #: ../src/guestfs-actions.pod:7586
29886 msgid "guestfs_wait_ready"
29890 #: ../src/guestfs-actions.pod:7588
29894 " guestfs_wait_ready (guestfs_h *g);\n"
29899 #: ../src/guestfs-actions.pod:7591
29901 "I<This function is deprecated.> In new code, use the L</guestfs_launch> call "
29906 #: ../src/guestfs-actions.pod:7598
29907 msgid "This function is a no op."
29911 #: ../src/guestfs-actions.pod:7600
29913 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
29914 "calling C<guestfs_launch> to wait for the launch to complete. However this "
29915 "is no longer necessary because C<guestfs_launch> now does the waiting."
29919 #: ../src/guestfs-actions.pod:7605
29921 "If you see any calls to this function in code then you can just remove them, "
29922 "unless you want to retain compatibility with older versions of the API."
29926 #: ../src/guestfs-actions.pod:7613
29927 msgid "guestfs_wc_c"
29931 #: ../src/guestfs-actions.pod:7615
29935 " guestfs_wc_c (guestfs_h *g,\n"
29936 " const char *path);\n"
29941 #: ../src/guestfs-actions.pod:7626
29942 msgid "guestfs_wc_l"
29946 #: ../src/guestfs-actions.pod:7628
29950 " guestfs_wc_l (guestfs_h *g,\n"
29951 " const char *path);\n"
29956 #: ../src/guestfs-actions.pod:7639
29957 msgid "guestfs_wc_w"
29961 #: ../src/guestfs-actions.pod:7641
29965 " guestfs_wc_w (guestfs_h *g,\n"
29966 " const char *path);\n"
29971 #: ../src/guestfs-actions.pod:7652
29972 msgid "guestfs_write"
29976 #: ../src/guestfs-actions.pod:7654
29980 " guestfs_write (guestfs_h *g,\n"
29981 " const char *path,\n"
29982 " const char *content,\n"
29983 " size_t content_size);\n"
29988 #: ../src/guestfs-actions.pod:7663
29989 msgid "See also C<guestfs_write_append>."
29993 #: ../src/guestfs-actions.pod:7672
29994 msgid "guestfs_write_append"
29998 #: ../src/guestfs-actions.pod:7674
30002 " guestfs_write_append (guestfs_h *g,\n"
30003 " const char *path,\n"
30004 " const char *content,\n"
30005 " size_t content_size);\n"
30010 #: ../src/guestfs-actions.pod:7683
30011 msgid "See also C<guestfs_write>."
30015 #: ../src/guestfs-actions.pod:7692
30016 msgid "guestfs_write_file"
30020 #: ../src/guestfs-actions.pod:7694
30024 " guestfs_write_file (guestfs_h *g,\n"
30025 " const char *path,\n"
30026 " const char *content,\n"
30032 #: ../src/guestfs-actions.pod:7700
30034 "I<This function is deprecated.> In new code, use the L</guestfs_write> call "
30039 #: ../src/guestfs-actions.pod:7725
30040 msgid "guestfs_zegrep"
30044 #: ../src/guestfs-actions.pod:7727
30048 " guestfs_zegrep (guestfs_h *g,\n"
30049 " const char *regex,\n"
30050 " const char *path);\n"
30055 #: ../src/guestfs-actions.pod:7744
30056 msgid "guestfs_zegrepi"
30060 #: ../src/guestfs-actions.pod:7746
30064 " guestfs_zegrepi (guestfs_h *g,\n"
30065 " const char *regex,\n"
30066 " const char *path);\n"
30071 #: ../src/guestfs-actions.pod:7763
30072 msgid "guestfs_zero"
30076 #: ../src/guestfs-actions.pod:7765
30080 " guestfs_zero (guestfs_h *g,\n"
30081 " const char *device);\n"
30086 #: ../src/guestfs-actions.pod:7779
30088 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
30089 "C<guestfs_is_zero_device>"
30093 #: ../src/guestfs-actions.pod:7791
30094 msgid "guestfs_zero_device"
30098 #: ../src/guestfs-actions.pod:7793
30102 " guestfs_zero_device (guestfs_h *g,\n"
30103 " const char *device);\n"
30108 #: ../src/guestfs-actions.pod:7797
30110 "This command writes zeroes over the entire C<device>. Compare with "
30111 "C<guestfs_zero> which just zeroes the first few blocks of a device."
30115 #: ../src/guestfs-actions.pod:7815
30116 msgid "(Added in 1.3.1)"
30120 #: ../src/guestfs-actions.pod:7817
30121 msgid "guestfs_zerofree"
30125 #: ../src/guestfs-actions.pod:7819
30129 " guestfs_zerofree (guestfs_h *g,\n"
30130 " const char *device);\n"
30135 #: ../src/guestfs-actions.pod:7838
30136 msgid "guestfs_zfgrep"
30140 #: ../src/guestfs-actions.pod:7840
30144 " guestfs_zfgrep (guestfs_h *g,\n"
30145 " const char *pattern,\n"
30146 " const char *path);\n"
30151 #: ../src/guestfs-actions.pod:7857
30152 msgid "guestfs_zfgrepi"
30156 #: ../src/guestfs-actions.pod:7859
30160 " guestfs_zfgrepi (guestfs_h *g,\n"
30161 " const char *pattern,\n"
30162 " const char *path);\n"
30167 #: ../src/guestfs-actions.pod:7876
30168 msgid "guestfs_zfile"
30172 #: ../src/guestfs-actions.pod:7878
30176 " guestfs_zfile (guestfs_h *g,\n"
30177 " const char *meth,\n"
30178 " const char *path);\n"
30183 #: ../src/guestfs-actions.pod:7883
30185 "I<This function is deprecated.> In new code, use the L</guestfs_file> call "
30190 #: ../src/guestfs-actions.pod:7895
30192 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
30197 #: ../src/guestfs-actions.pod:7903
30198 msgid "guestfs_zgrep"
30202 #: ../src/guestfs-actions.pod:7905
30206 " guestfs_zgrep (guestfs_h *g,\n"
30207 " const char *regex,\n"
30208 " const char *path);\n"
30213 #: ../src/guestfs-actions.pod:7922
30214 msgid "guestfs_zgrepi"
30218 #: ../src/guestfs-actions.pod:7924
30222 " guestfs_zgrepi (guestfs_h *g,\n"
30223 " const char *regex,\n"
30224 " const char *path);\n"
30229 #: ../src/guestfs-availability.pod:3
30234 #: ../src/guestfs-availability.pod:5
30236 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
30237 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
30238 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
30239 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
30240 "L</guestfs_aug_save> L</guestfs_aug_set>"
30244 #: ../src/guestfs-availability.pod:21
30249 #: ../src/guestfs-availability.pod:23
30250 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
30254 #: ../src/guestfs-availability.pod:26
30259 #: ../src/guestfs-availability.pod:28
30261 "The following functions: L</guestfs_inotify_add_watch> L</"
30262 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
30263 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
30267 #: ../src/guestfs-availability.pod:36
30268 msgid "B<linuxfsuuid>"
30272 #: ../src/guestfs-availability.pod:38
30274 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
30275 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
30279 #: ../src/guestfs-availability.pod:45
30280 msgid "B<linuxmodules>"
30284 #: ../src/guestfs-availability.pod:47
30285 msgid "The following functions: L</guestfs_modprobe>"
30289 #: ../src/guestfs-availability.pod:50
30290 msgid "B<linuxxattrs>"
30294 #: ../src/guestfs-availability.pod:52
30296 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
30297 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
30298 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
30299 "guestfs_setxattr>"
30303 #: ../src/guestfs-availability.pod:63
30308 #: ../src/guestfs-availability.pod:65
30310 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
30311 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
30312 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
30316 #: ../src/guestfs-availability.pod:74
30321 #: ../src/guestfs-availability.pod:76
30323 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
30324 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
30325 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
30326 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
30327 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
30328 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
30329 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
30333 #: ../src/guestfs-availability.pod:99
30338 #: ../src/guestfs-availability.pod:101
30340 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
30341 "guestfs_mknod_b> L</guestfs_mknod_c>"
30345 #: ../src/guestfs-availability.pod:107
30350 #: ../src/guestfs-availability.pod:109
30351 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
30355 #: ../src/guestfs-availability.pod:112
30356 msgid "B<ntfsprogs>"
30360 #: ../src/guestfs-availability.pod:114
30362 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
30363 "L</guestfs_ntfsresize_size>"
30367 #: ../src/guestfs-availability.pod:119
30368 msgid "B<realpath>"
30372 #: ../src/guestfs-availability.pod:121
30373 msgid "The following functions: L</guestfs_realpath>"
30377 #: ../src/guestfs-availability.pod:124
30382 #: ../src/guestfs-availability.pod:126
30384 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
30385 "guestfs_scrub_freespace>"
30389 #: ../src/guestfs-availability.pod:131
30394 #: ../src/guestfs-availability.pod:133
30395 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
30399 #: ../src/guestfs-availability.pod:137
30404 #: ../src/guestfs-availability.pod:139
30405 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
30409 #: ../src/guestfs-availability.pod:143
30410 msgid "B<zerofree>"
30414 #: ../src/guestfs-availability.pod:145
30415 msgid "The following functions: L</guestfs_zerofree>"
30419 #: ../src/guestfs-structs.pod:1
30420 msgid "guestfs_int_bool"
30424 #: ../src/guestfs-structs.pod:3
30427 " struct guestfs_int_bool {\n"
30435 #: ../src/guestfs-structs.pod:8
30438 " struct guestfs_int_bool_list {\n"
30439 " uint32_t len; /* Number of elements in list. */\n"
30440 " struct guestfs_int_bool *val; /* Elements. */\n"
30446 #: ../src/guestfs-structs.pod:13
30449 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
30450 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
30455 #: ../src/guestfs-structs.pod:16
30456 msgid "guestfs_lvm_pv"
30460 #: ../src/guestfs-structs.pod:18
30463 " struct guestfs_lvm_pv {\n"
30464 " char *pv_name;\n"
30465 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30466 " char pv_uuid[32];\n"
30468 " uint64_t pv_size;\n"
30469 " uint64_t dev_size;\n"
30470 " uint64_t pv_free;\n"
30471 " uint64_t pv_used;\n"
30472 " char *pv_attr;\n"
30473 " int64_t pv_pe_count;\n"
30474 " int64_t pv_pe_alloc_count;\n"
30475 " char *pv_tags;\n"
30476 " uint64_t pe_start;\n"
30477 " int64_t pv_mda_count;\n"
30478 " uint64_t pv_mda_free;\n"
30484 #: ../src/guestfs-structs.pod:36
30487 " struct guestfs_lvm_pv_list {\n"
30488 " uint32_t len; /* Number of elements in list. */\n"
30489 " struct guestfs_lvm_pv *val; /* Elements. */\n"
30495 #: ../src/guestfs-structs.pod:41
30498 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
30499 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
30504 #: ../src/guestfs-structs.pod:44
30505 msgid "guestfs_lvm_vg"
30509 #: ../src/guestfs-structs.pod:46
30512 " struct guestfs_lvm_vg {\n"
30513 " char *vg_name;\n"
30514 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30515 " char vg_uuid[32];\n"
30517 " char *vg_attr;\n"
30518 " uint64_t vg_size;\n"
30519 " uint64_t vg_free;\n"
30520 " char *vg_sysid;\n"
30521 " uint64_t vg_extent_size;\n"
30522 " int64_t vg_extent_count;\n"
30523 " int64_t vg_free_count;\n"
30524 " int64_t max_lv;\n"
30525 " int64_t max_pv;\n"
30526 " int64_t pv_count;\n"
30527 " int64_t lv_count;\n"
30528 " int64_t snap_count;\n"
30529 " int64_t vg_seqno;\n"
30530 " char *vg_tags;\n"
30531 " int64_t vg_mda_count;\n"
30532 " uint64_t vg_mda_free;\n"
30538 #: ../src/guestfs-structs.pod:69
30541 " struct guestfs_lvm_vg_list {\n"
30542 " uint32_t len; /* Number of elements in list. */\n"
30543 " struct guestfs_lvm_vg *val; /* Elements. */\n"
30549 #: ../src/guestfs-structs.pod:74
30552 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
30553 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
30558 #: ../src/guestfs-structs.pod:77
30559 msgid "guestfs_lvm_lv"
30563 #: ../src/guestfs-structs.pod:79
30566 " struct guestfs_lvm_lv {\n"
30567 " char *lv_name;\n"
30568 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30569 " char lv_uuid[32];\n"
30570 " char *lv_attr;\n"
30571 " int64_t lv_major;\n"
30572 " int64_t lv_minor;\n"
30573 " int64_t lv_kernel_major;\n"
30574 " int64_t lv_kernel_minor;\n"
30575 " uint64_t lv_size;\n"
30576 " int64_t seg_count;\n"
30578 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
30579 " float snap_percent;\n"
30580 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
30581 " float copy_percent;\n"
30582 " char *move_pv;\n"
30583 " char *lv_tags;\n"
30584 " char *mirror_log;\n"
30585 " char *modules;\n"
30591 #: ../src/guestfs-structs.pod:101
30594 " struct guestfs_lvm_lv_list {\n"
30595 " uint32_t len; /* Number of elements in list. */\n"
30596 " struct guestfs_lvm_lv *val; /* Elements. */\n"
30602 #: ../src/guestfs-structs.pod:106
30605 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
30606 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
30611 #: ../src/guestfs-structs.pod:111
30614 " struct guestfs_stat {\n"
30618 " int64_t nlink;\n"
30623 " int64_t blksize;\n"
30624 " int64_t blocks;\n"
30625 " int64_t atime;\n"
30626 " int64_t mtime;\n"
30627 " int64_t ctime;\n"
30633 #: ../src/guestfs-structs.pod:127
30636 " struct guestfs_stat_list {\n"
30637 " uint32_t len; /* Number of elements in list. */\n"
30638 " struct guestfs_stat *val; /* Elements. */\n"
30644 #: ../src/guestfs-structs.pod:132
30647 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
30648 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
30653 #: ../src/guestfs-structs.pod:137
30656 " struct guestfs_statvfs {\n"
30657 " int64_t bsize;\n"
30658 " int64_t frsize;\n"
30659 " int64_t blocks;\n"
30660 " int64_t bfree;\n"
30661 " int64_t bavail;\n"
30662 " int64_t files;\n"
30663 " int64_t ffree;\n"
30664 " int64_t favail;\n"
30667 " int64_t namemax;\n"
30673 #: ../src/guestfs-structs.pod:151
30676 " struct guestfs_statvfs_list {\n"
30677 " uint32_t len; /* Number of elements in list. */\n"
30678 " struct guestfs_statvfs *val; /* Elements. */\n"
30684 #: ../src/guestfs-structs.pod:156
30687 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
30688 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
30693 #: ../src/guestfs-structs.pod:159
30694 msgid "guestfs_dirent"
30698 #: ../src/guestfs-structs.pod:161
30701 " struct guestfs_dirent {\n"
30710 #: ../src/guestfs-structs.pod:167
30713 " struct guestfs_dirent_list {\n"
30714 " uint32_t len; /* Number of elements in list. */\n"
30715 " struct guestfs_dirent *val; /* Elements. */\n"
30721 #: ../src/guestfs-structs.pod:172
30724 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
30725 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
30730 #: ../src/guestfs-structs.pod:177
30733 " struct guestfs_version {\n"
30734 " int64_t major;\n"
30735 " int64_t minor;\n"
30736 " int64_t release;\n"
30743 #: ../src/guestfs-structs.pod:184
30746 " struct guestfs_version_list {\n"
30747 " uint32_t len; /* Number of elements in list. */\n"
30748 " struct guestfs_version *val; /* Elements. */\n"
30754 #: ../src/guestfs-structs.pod:189
30757 " void guestfs_free_version (struct guestfs_free_version *);\n"
30758 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
30763 #: ../src/guestfs-structs.pod:192
30764 msgid "guestfs_xattr"
30768 #: ../src/guestfs-structs.pod:194
30771 " struct guestfs_xattr {\n"
30772 " char *attrname;\n"
30773 " /* The next two fields describe a byte array. */\n"
30774 " uint32_t attrval_len;\n"
30775 " char *attrval;\n"
30781 #: ../src/guestfs-structs.pod:201
30784 " struct guestfs_xattr_list {\n"
30785 " uint32_t len; /* Number of elements in list. */\n"
30786 " struct guestfs_xattr *val; /* Elements. */\n"
30792 #: ../src/guestfs-structs.pod:206
30795 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
30796 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
30801 #: ../src/guestfs-structs.pod:209
30802 msgid "guestfs_inotify_event"
30806 #: ../src/guestfs-structs.pod:211
30809 " struct guestfs_inotify_event {\n"
30810 " int64_t in_wd;\n"
30811 " uint32_t in_mask;\n"
30812 " uint32_t in_cookie;\n"
30813 " char *in_name;\n"
30819 #: ../src/guestfs-structs.pod:218
30822 " struct guestfs_inotify_event_list {\n"
30823 " uint32_t len; /* Number of elements in list. */\n"
30824 " struct guestfs_inotify_event *val; /* Elements. */\n"
30830 #: ../src/guestfs-structs.pod:223
30833 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
30834 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
30839 #: ../src/guestfs-structs.pod:226
30840 msgid "guestfs_partition"
30844 #: ../src/guestfs-structs.pod:228
30847 " struct guestfs_partition {\n"
30848 " int32_t part_num;\n"
30849 " uint64_t part_start;\n"
30850 " uint64_t part_end;\n"
30851 " uint64_t part_size;\n"
30857 #: ../src/guestfs-structs.pod:235
30860 " struct guestfs_partition_list {\n"
30861 " uint32_t len; /* Number of elements in list. */\n"
30862 " struct guestfs_partition *val; /* Elements. */\n"
30868 #: ../src/guestfs-structs.pod:240
30871 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
30872 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
30877 #: ../src/guestfs-structs.pod:243
30878 msgid "guestfs_application"
30882 #: ../src/guestfs-structs.pod:245
30885 " struct guestfs_application {\n"
30886 " char *app_name;\n"
30887 " char *app_display_name;\n"
30888 " int32_t app_epoch;\n"
30889 " char *app_version;\n"
30890 " char *app_release;\n"
30891 " char *app_install_path;\n"
30892 " char *app_trans_path;\n"
30893 " char *app_publisher;\n"
30894 " char *app_url;\n"
30895 " char *app_source_package;\n"
30896 " char *app_summary;\n"
30897 " char *app_description;\n"
30903 #: ../src/guestfs-structs.pod:260
30906 " struct guestfs_application_list {\n"
30907 " uint32_t len; /* Number of elements in list. */\n"
30908 " struct guestfs_application *val; /* Elements. */\n"
30914 #: ../src/guestfs-structs.pod:265
30917 " void guestfs_free_application (struct guestfs_free_application *);\n"
30918 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
30923 #: ../src/guestfs.pod:5
30924 msgid "guestfs - Library for accessing and modifying virtual machine images"
30928 #: ../src/guestfs.pod:11
30931 " guestfs_h *g = guestfs_create ();\n"
30932 " guestfs_add_drive (g, \"guest.img\");\n"
30933 " guestfs_launch (g);\n"
30934 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30935 " guestfs_touch (g, \"/hello\");\n"
30936 " guestfs_umount (g, \"/\");\n"
30937 " guestfs_close (g);\n"
30942 #: ../src/guestfs.pod:25
30944 "Libguestfs is a library for accessing and modifying guest disk images. "
30945 "Amongst the things this is good for: making batch configuration changes to "
30946 "guests, getting disk used/free statistics (see also: virt-df), migrating "
30947 "between virtualization systems (see also: virt-p2v), performing partial "
30948 "backups, performing partial guest clones, cloning guests and changing "
30949 "registry/UUID/hostname info, and much else besides."
30953 #: ../src/guestfs.pod:33
30955 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
30956 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
30957 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
30962 #: ../src/guestfs.pod:38
30964 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
30965 "what filesystem is in each LV, etc.). It can also run commands in the "
30966 "context of the guest. Also you can access filesystems over FUSE."
30970 #: ../src/guestfs.pod:43
30972 "Libguestfs is a library that can be linked with C and C++ management "
30973 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
30974 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
30979 #: ../src/guestfs.pod:48
30981 "You don't need to be root to use libguestfs, although obviously you do need "
30982 "enough permissions to access the disk images."
30986 #: ../src/guestfs.pod:51
30988 "Libguestfs is a large API because it can do many things. For a gentle "
30989 "introduction, please read the L</API OVERVIEW> section next."
30993 #: ../src/guestfs.pod:54
30995 "There are also some example programs in the L<guestfs-examples(3)> manual "
31000 #: ../src/guestfs.pod:57
31001 msgid "API OVERVIEW"
31005 #: ../src/guestfs.pod:59
31007 "This section provides a gentler overview of the libguestfs API. We also try "
31008 "to group API calls together, where that may not be obvious from reading "
31009 "about the individual calls in the main section of this manual."
31013 #: ../src/guestfs.pod:64
31018 #: ../src/guestfs.pod:66
31020 "Before you can use libguestfs calls, you have to create a handle. Then you "
31021 "must add at least one disk image to the handle, followed by launching the "
31022 "handle, then performing whatever operations you want, and finally closing "
31023 "the handle. By convention we use the single letter C<g> for the name of the "
31024 "handle variable, although of course you can use any name you want."
31028 #: ../src/guestfs.pod:73
31029 msgid "The general structure of all libguestfs-using programs looks like this:"
31033 #: ../src/guestfs.pod:76
31036 " guestfs_h *g = guestfs_create ();\n"
31041 #: ../src/guestfs.pod:78
31044 " /* Call guestfs_add_drive additional times if there are\n"
31045 " * multiple disk images.\n"
31047 " guestfs_add_drive (g, \"guest.img\");\n"
31052 #: ../src/guestfs.pod:83
31055 " /* Most manipulation calls won't work until you've launched\n"
31056 " * the handle 'g'. You have to do this _after_ adding drives\n"
31057 " * and _before_ other commands.\n"
31059 " guestfs_launch (g);\n"
31064 #: ../src/guestfs.pod:89
31067 " /* Now you can examine what partitions, LVs etc are available.\n"
31069 " char **partitions = guestfs_list_partitions (g);\n"
31070 " char **logvols = guestfs_lvs (g);\n"
31075 #: ../src/guestfs.pod:94
31078 " /* To access a filesystem in the image, you must mount it.\n"
31080 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
31085 #: ../src/guestfs.pod:98
31088 " /* Now you can perform filesystem actions on the guest\n"
31091 " guestfs_touch (g, \"/hello\");\n"
31096 #: ../src/guestfs.pod:103
31099 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
31100 " * it is done automatically when you close the handle. See\n"
31101 " * discussion of autosync in this page.\n"
31103 " guestfs_sync (g);\n"
31108 #: ../src/guestfs.pod:109
31111 " /* Close the handle 'g'. */\n"
31112 " guestfs_close (g);\n"
31117 #: ../src/guestfs.pod:112
31119 "The code above doesn't include any error checking. In real code you should "
31120 "check return values carefully for errors. In general all functions that "
31121 "return integers return C<-1> on error, and all functions that return "
31122 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
31123 "how to handle errors, and consult the documentation for each function call "
31124 "below to see precisely how they return error indications. See L<guestfs-"
31125 "examples(3)> for fully worked examples."
31129 #: ../src/guestfs.pod:121
31130 msgid "DISK IMAGES"
31134 #: ../src/guestfs.pod:123
31136 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
31137 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
31138 "actual block device, or simply an empty file of zeroes that you have created "
31139 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
31144 #: ../src/guestfs.pod:129
31146 "The call you should use in modern code for adding drives is L</"
31147 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
31148 "specifying that the format is raw, do:"
31152 #: ../src/guestfs.pod:133
31155 " guestfs_add_drive_opts (g, filename,\n"
31156 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
31162 #: ../src/guestfs.pod:137
31163 msgid "You can add a disk read-only using:"
31167 #: ../src/guestfs.pod:139
31170 " guestfs_add_drive_opts (g, filename,\n"
31171 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
31172 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
31178 #: ../src/guestfs.pod:144
31180 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
31181 "libguestfs won't modify the file."
31185 #: ../src/guestfs.pod:147
31187 "Be extremely cautious if the disk image is in use, eg. if it is being used "
31188 "by a virtual machine. Adding it read-write will almost certainly cause disk "
31189 "corruption, but adding it read-only is safe."
31193 #: ../src/guestfs.pod:151
31195 "You must add at least one disk image, and you may add multiple disk images. "
31196 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
31197 "first one you added), C</dev/sdb> (for the second one you added), etc."
31201 #: ../src/guestfs.pod:156
31203 "Once L</guestfs_launch> has been called you cannot add any more images. You "
31204 "can call L</guestfs_list_devices> to get a list of the device names, in the "
31205 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
31209 #: ../src/guestfs.pod:161
31214 #: ../src/guestfs.pod:163
31216 "Before you can read or write files, create directories and so on in a disk "
31217 "image that contains filesystems, you have to mount those filesystems using "
31218 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
31219 "a disk image contains (for example) one partition with a filesystem on that "
31220 "partition, then you can mount it directly:"
31224 #: ../src/guestfs.pod:170
31227 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
31232 #: ../src/guestfs.pod:172
31234 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
31235 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
31236 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
31237 "that these are libguestfs virtual devices, and are nothing to do with host "
31242 #: ../src/guestfs.pod:178
31244 "If you are given a disk image and you don't know what it contains then you "
31245 "have to find out. Libguestfs can do that too: use L</"
31246 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
31247 "LVs, and either try mounting each to see what is mountable, or else examine "
31248 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
31249 "filesystems, use L</guestfs_list_filesystems>."
31253 #: ../src/guestfs.pod:186
31255 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
31256 "L</INSPECTION> below). But you might find it easier to look at higher level "
31257 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
31261 #: ../src/guestfs.pod:191
31263 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
31264 "several other variations of the C<guestfs_mount_*> call."
31268 #: ../src/guestfs.pod:194
31269 msgid "FILESYSTEM ACCESS AND MODIFICATION"
31273 #: ../src/guestfs.pod:196
31275 "The majority of the libguestfs API consists of fairly low-level calls for "
31276 "accessing and modifying the files, directories, symlinks etc on mounted "
31277 "filesystems. There are over a hundred such calls which you can find listed "
31278 "in detail below in this man page, and we don't even pretend to cover them "
31279 "all in this overview."
31283 #: ../src/guestfs.pod:202
31285 "Specify filenames as full paths, starting with C<\"/\"> and including the "
31290 #: ../src/guestfs.pod:205
31292 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
31293 "the file called C<\"etc/passwd\"> then you could do:"
31297 #: ../src/guestfs.pod:208
31300 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
31305 #: ../src/guestfs.pod:210
31307 "This would return C<data> as a newly allocated buffer containing the full "
31308 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
31309 "or C<NULL> if there was an error."
31313 #: ../src/guestfs.pod:214
31315 "As another example, to create a top-level directory on that filesystem "
31316 "called C<\"var\"> you would do:"
31320 #: ../src/guestfs.pod:217
31323 " guestfs_mkdir (g, \"/var\");\n"
31328 #: ../src/guestfs.pod:219
31329 msgid "To create a symlink you could do:"
31333 #: ../src/guestfs.pod:221
31336 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
31337 " \"/etc/rc3.d/S30portmap\");\n"
31342 #: ../src/guestfs.pod:224
31344 "Libguestfs will reject attempts to use relative paths and there is no "
31345 "concept of a current working directory."
31349 #: ../src/guestfs.pod:227
31351 "Libguestfs can return errors in many situations: for example if the "
31352 "filesystem isn't writable, or if a file or directory that you requested "
31353 "doesn't exist. If you are using the C API (documented here) you have to "
31354 "check for those error conditions after each call. (Other language bindings "
31355 "turn these errors into exceptions)."
31359 #: ../src/guestfs.pod:233
31361 "File writes are affected by the per-handle umask, set by calling L</"
31362 "guestfs_umask> and defaulting to 022. See L</UMASK>."
31366 #: ../src/guestfs.pod:236
31367 msgid "PARTITIONING"
31371 #: ../src/guestfs.pod:238
31373 "Libguestfs contains API calls to read, create and modify partition tables on "
31378 #: ../src/guestfs.pod:241
31380 "In the common case where you want to create a single partition covering the "
31381 "whole disk, you should use the L</guestfs_part_disk> call:"
31385 #: ../src/guestfs.pod:245
31388 " const char *parttype = \"mbr\";\n"
31389 " if (disk_is_larger_than_2TB)\n"
31390 " parttype = \"gpt\";\n"
31391 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
31396 #: ../src/guestfs.pod:250
31398 "Obviously this effectively wipes anything that was on that disk image before."
31402 #: ../src/guestfs.pod:253
31407 #: ../src/guestfs.pod:255
31409 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
31410 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
31411 "you familiarize yourself with the concepts of physical volumes, volume "
31412 "groups and logical volumes."
31416 #: ../src/guestfs.pod:260
31418 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
31419 "tldp.org/HOWTO/LVM-HOWTO/>."
31423 #: ../src/guestfs.pod:263
31424 msgid "DOWNLOADING"
31428 #: ../src/guestfs.pod:265
31430 "Use L</guestfs_cat> to download small, text only files. This call is "
31431 "limited to files which are less than 2 MB and which cannot contain any ASCII "
31432 "NUL (C<\\0>) characters. However the API is very simple to use."
31436 #: ../src/guestfs.pod:269
31438 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
31439 "bit data, since it returns a (pointer, size) pair. However it is still "
31440 "limited to \"small\" files, less than 2 MB."
31444 #: ../src/guestfs.pod:273
31446 "L</guestfs_download> can be used to download any file, with no limits on "
31447 "content or size (even files larger than 4 GB)."
31451 #: ../src/guestfs.pod:276
31453 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
31457 #: ../src/guestfs.pod:279
31462 #: ../src/guestfs.pod:281
31464 "It's often the case that you want to write a file or files to the disk image."
31468 #: ../src/guestfs.pod:284
31470 "To write a small file with fixed content, use L</guestfs_write>. To create "
31471 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
31472 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
31473 "of other functions for creating test files, for example L</guestfs_fill> and "
31474 "L</guestfs_fill_pattern>."
31478 #: ../src/guestfs.pod:290
31480 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
31481 "file content or size (even files larger than 4 GB)."
31485 #: ../src/guestfs.pod:293
31487 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
31491 #: ../src/guestfs.pod:295
31493 "However the fastest way to upload I<large numbers of arbitrary files> is to "
31494 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
31495 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
31496 "in a predictable way (eg. adding it last after all other drives) then you "
31497 "can get the device name from L</guestfs_list_devices> and mount it directly "
31498 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
31499 "portable between kernel versions, and they don't support labels or UUIDs. "
31500 "If you want to pre-build an image or you need to mount it using a label or "
31501 "UUID, use an ISO image instead."
31505 #: ../src/guestfs.pod:306
31510 #: ../src/guestfs.pod:308
31512 "There are various different commands for copying between files and devices "
31513 "and in and out of the guest filesystem. These are summarised in the table "
31518 #: ../src/guestfs.pod:314
31519 msgid "B<file> to B<file>"
31523 #: ../src/guestfs.pod:316
31525 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
31526 "directories recursively."
31530 #: ../src/guestfs.pod:319
31531 msgid "B<file or device> to B<file or device>"
31535 #: ../src/guestfs.pod:321
31537 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
31538 "devices in the guest."
31542 #: ../src/guestfs.pod:324
31543 msgid "Example: duplicate the contents of an LV:"
31547 #: ../src/guestfs.pod:326
31550 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
31555 #: ../src/guestfs.pod:328
31557 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
31558 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
31559 "guestfs_copy_size>."
31563 #: ../src/guestfs.pod:332
31564 msgid "B<file on the host> to B<file or device>"
31568 #: ../src/guestfs.pod:334
31569 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
31573 #: ../src/guestfs.pod:336
31574 msgid "B<file or device> to B<file on the host>"
31578 #: ../src/guestfs.pod:338
31579 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
31583 #: ../src/guestfs.pod:342
31584 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
31588 #: ../src/guestfs.pod:344
31590 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
31591 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
31592 "appears you can only upload and download to files. However many Un*x-like "
31593 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
31594 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
31595 "and arbitrary file descriptor N."
31599 #: ../src/guestfs.pod:352
31600 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
31604 #: ../src/guestfs.pod:355
31607 " guestfs_download (g, filename, \"/dev/stdout\");\n"
31612 #: ../src/guestfs.pod:357
31613 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
31617 #: ../src/guestfs.pod:359
31620 " char devfd[64];\n"
31621 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
31622 " guestfs_tar_out (g, \"/\", devfd);\n"
31627 #: ../src/guestfs.pod:363
31628 msgid "LISTING FILES"
31632 #: ../src/guestfs.pod:365
31634 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
31635 "L<guestfish(1)>-equivalent command C<ll>)."
31639 #: ../src/guestfs.pod:368
31641 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
31642 "programs, as a flat list of strings."
31646 #: ../src/guestfs.pod:371
31648 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
31649 "directory, plus additional information about each one. It is more "
31650 "equivalent to using the L<readdir(3)> call on a local filesystem."
31654 #: ../src/guestfs.pod:375
31656 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
31660 #: ../src/guestfs.pod:378
31661 msgid "RUNNING COMMANDS"
31665 #: ../src/guestfs.pod:380
31667 "Although libguestfs is primarily an API for manipulating files inside guest "
31668 "images, we also provide some limited facilities for running commands inside "
31673 #: ../src/guestfs.pod:384
31674 msgid "There are many limitations to this:"
31678 #: ../src/guestfs.pod:390
31680 "The kernel version that the command runs under will be different from what "
31685 #: ../src/guestfs.pod:395
31687 "If the command needs to communicate with daemons, then most likely they "
31688 "won't be running."
31692 #: ../src/guestfs.pod:400
31693 msgid "The command will be running in limited memory."
31697 #: ../src/guestfs.pod:404
31699 "The network may not be available unless you enable it (see L</"
31700 "guestfs_set_network>)."
31704 #: ../src/guestfs.pod:409
31705 msgid "Only supports Linux guests (not Windows, BSD, etc)."
31709 #: ../src/guestfs.pod:413
31711 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
31715 #: ../src/guestfs.pod:418
31717 "For SELinux guests, you may need to enable SELinux and load policy first. "
31718 "See L</SELINUX> in this manpage."
31722 #: ../src/guestfs.pod:423
31724 "I<Security:> It is not safe to run commands from untrusted, possibly "
31725 "malicious guests. These commands may attempt to exploit your program by "
31726 "sending unexpected output. They could also try to exploit the Linux kernel "
31727 "or qemu provided by the libguestfs appliance. They could use the network "
31728 "provided by the libguestfs appliance to bypass ordinary network partitions "
31729 "and firewalls. They could use the elevated privileges or different SELinux "
31730 "context of your program to their advantage."
31734 #: ../src/guestfs.pod:432
31736 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
31737 "(a script which runs when the guest next boots normally), and to have this "
31738 "script run the commands you want in the normal context of the running guest, "
31739 "network security and so on. For information about other security issues, "
31740 "see L</SECURITY>."
31744 #: ../src/guestfs.pod:440
31746 "The two main API calls to run commands are L</guestfs_command> and L</"
31747 "guestfs_sh> (there are also variations)."
31751 #: ../src/guestfs.pod:443
31753 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
31754 "shell globs, redirections, etc will work."
31758 #: ../src/guestfs.pod:446
31759 msgid "CONFIGURATION FILES"
31763 #: ../src/guestfs.pod:448
31765 "To read and write configuration files in Linux guest filesystems, we "
31766 "strongly recommend using Augeas. For example, Augeas understands how to "
31767 "read and write, say, a Linux shadow password file or X.org configuration "
31768 "file, and so avoids you having to write that code."
31772 #: ../src/guestfs.pod:453
31774 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
31775 "document Augeas itself here because there is excellent documentation on the "
31776 "L<http://augeas.net/> website."
31780 #: ../src/guestfs.pod:457
31782 "If you don't want to use Augeas (you fool!) then try calling L</"
31783 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
31788 #: ../src/guestfs.pod:461
31793 #: ../src/guestfs.pod:463
31795 "We support SELinux guests. To ensure that labeling happens correctly in "
31796 "SELinux guests, you need to enable SELinux and load the guest's policy:"
31800 #: ../src/guestfs.pod:471
31801 msgid "Before launching, do:"
31805 #: ../src/guestfs.pod:473
31808 " guestfs_set_selinux (g, 1);\n"
31813 #: ../src/guestfs.pod:477
31815 "After mounting the guest's filesystem(s), load the policy. This is best "
31816 "done by running the L<load_policy(8)> command in the guest itself:"
31820 #: ../src/guestfs.pod:481
31823 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
31828 #: ../src/guestfs.pod:483
31830 "(Older versions of C<load_policy> require you to specify the name of the "
31835 #: ../src/guestfs.pod:488
31837 "Optionally, set the security context for the API. The correct security "
31838 "context to use can only be known by inspecting the guest. As an example:"
31842 #: ../src/guestfs.pod:492
31845 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
31850 #: ../src/guestfs.pod:496
31851 msgid "This will work for running commands and editing existing files."
31855 #: ../src/guestfs.pod:498
31857 "When new files are created, you may need to label them explicitly, for "
31858 "example by running the external command C<restorecon pathname>."
31862 #: ../src/guestfs.pod:502
31867 #: ../src/guestfs.pod:504
31869 "Certain calls are affected by the current file mode creation mask (the "
31870 "\"umask\"). In particular ones which create files or directories, such as "
31871 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
31872 "either the default mode that the file is created with or modifies the mode "
31877 #: ../src/guestfs.pod:510
31879 "The default umask is C<022>, so files are created with modes such as C<0644> "
31880 "and directories with C<0755>."
31884 #: ../src/guestfs.pod:513
31886 "There are two ways to avoid being affected by umask. Either set umask to 0 "
31887 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
31888 "guestfs_chmod> after creating each file or directory."
31892 #: ../src/guestfs.pod:517
31893 msgid "For more information about umask, see L<umask(2)>."
31897 #: ../src/guestfs.pod:521
31899 "Libguestfs allows you to access Linux guests which have been encrypted using "
31900 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
31901 "standard. This includes nearly all whole disk encryption systems used by "
31902 "modern Linux guests."
31906 #: ../src/guestfs.pod:527
31908 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
31909 "returns the string C<crypto_LUKS>)."
31913 #: ../src/guestfs.pod:530
31915 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
31916 "will require the passphrase!"
31920 #: ../src/guestfs.pod:533
31922 "Opening a LUKS device creates a new device mapper device called C</dev/"
31923 "mapper/mapname> (where C<mapname> is the string you supply to L</"
31924 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
31925 "from and encrypted to the underlying block device respectively."
31929 #: ../src/guestfs.pod:539
31931 "LVM volume groups on the device can be made visible by calling L</"
31932 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
31933 "(s) can now be mounted in the usual way."
31937 #: ../src/guestfs.pod:543
31939 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
31940 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
31941 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
31942 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
31943 "underlying encrypted block device)."
31947 #: ../src/guestfs.pod:550
31952 #: ../src/guestfs.pod:552
31954 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
31955 "contains operating systems, an install CD or a live CD. (These APIs used to "
31956 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
31957 "version 1.5.3 the most frequently used part of this library has been "
31958 "rewritten in C and moved into the core code)."
31962 #: ../src/guestfs.pod:559
31964 "Add all disks belonging to the unknown virtual machine and call L</"
31965 "guestfs_launch> in the usual way."
31969 #: ../src/guestfs.pod:562
31971 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
31972 "and certain heuristics, and returns a list of operating systems that were "
31973 "found. An empty list means none were found. A single element is the root "
31974 "filesystem of the operating system. For dual- or multi-boot guests, "
31975 "multiple roots can be returned, each one corresponding to a separate "
31976 "operating system. (Multi-boot virtual machines are extremely rare in the "
31977 "world of virtualization, but since this scenario can happen, we have built "
31978 "libguestfs to deal with it.)"
31982 #: ../src/guestfs.pod:571
31984 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
31985 "to get additional details about that operating system. For example, call L</"
31986 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
31987 "Windows and Linux-based operating systems respectively."
31991 #: ../src/guestfs.pod:577
31993 "Un*x-like and Linux-based operating systems usually consist of several "
31994 "filesystems which are mounted at boot time (for example, a separate boot "
31995 "partition mounted on C</boot>). The inspection rules are able to detect how "
31996 "filesystems correspond to mount points. Call "
31997 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
31998 "hash table like this example:"
32002 #: ../src/guestfs.pod:584
32005 " /boot => /dev/sda1\n"
32006 " / => /dev/vg_guest/lv_root\n"
32007 " /usr => /dev/vg_guest/lv_usr\n"
32012 #: ../src/guestfs.pod:588
32014 "The caller can then make calls to L</guestfs_mount_options> to mount the "
32015 "filesystems as suggested."
32019 #: ../src/guestfs.pod:591
32021 "Be careful to mount filesystems in the right order (eg. C</> before C</"
32022 "usr>). Sorting the keys of the hash by length, shortest first, should work."
32026 #: ../src/guestfs.pod:595
32028 "Inspection currently only works for some common operating systems. "
32029 "Contributors are welcome to send patches for other operating systems that we "
32030 "currently cannot detect."
32034 #: ../src/guestfs.pod:599
32036 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
32037 "for more details. The L</guestfs_inspect_os> function just ignores any "
32038 "encrypted devices."
32042 #: ../src/guestfs.pod:603
32044 "A note on the implementation: The call L</guestfs_inspect_os> performs "
32045 "inspection and caches the results in the guest handle. Subsequent calls to "
32046 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
32047 "read the disks. If you change the content of the guest disks, you can redo "
32048 "inspection by calling L</guestfs_inspect_os> again. (L</"
32049 "guestfs_inspect_list_applications> works a little differently from the other "
32050 "calls and does read the disks. See documentation for that function for "
32055 #: ../src/guestfs.pod:612
32056 msgid "INSPECTING INSTALL DISKS"
32060 #: ../src/guestfs.pod:614
32062 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
32067 #: ../src/guestfs.pod:617
32069 "Call L</guestfs_inspect_get_format> to return the format of the operating "
32070 "system, which currently can be C<installed> (a regular operating system) or "
32071 "C<installer> (some sort of install disk)."
32075 #: ../src/guestfs.pod:621
32077 "Further information is available about the operating system that can be "
32078 "installed using the regular inspection APIs like L</"
32079 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
32083 #: ../src/guestfs.pod:626
32085 "Some additional information specific to installer disks is also available "
32086 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
32087 "guestfs_inspect_is_multipart> calls."
32091 #: ../src/guestfs.pod:631
32092 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
32096 #: ../src/guestfs.pod:633
32098 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
32099 "ntfs-3g.org/> driver."
32103 #: ../src/guestfs.pod:636
32104 msgid "DRIVE LETTERS AND PATHS"
32108 #: ../src/guestfs.pod:638
32110 "DOS and Windows still use drive letters, and the filesystems are always "
32111 "treated as case insensitive by Windows itself, and therefore you might find "
32112 "a Windows configuration file referring to a path like C<c:\\windows"
32113 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
32114 "might be referred to as C</WINDOWS/System32>."
32118 #: ../src/guestfs.pod:644
32120 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
32121 "L</guestfs_inspect_get_drive_mappings>)"
32125 #: ../src/guestfs.pod:647
32127 "Dealing with separator characters (backslash vs forward slash) is outside "
32128 "the scope of libguestfs, but usually a simple character replacement will "
32133 #: ../src/guestfs.pod:651
32135 "To resolve the case insensitivity of paths, call L</"
32136 "guestfs_case_sensitive_path>."
32140 #: ../src/guestfs.pod:654
32141 msgid "ACCESSING THE WINDOWS REGISTRY"
32145 #: ../src/guestfs.pod:656
32147 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
32148 "files, through the library C<hivex> which is part of the libguestfs project "
32149 "although ships as a separate tarball. You have to locate and download the "
32150 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
32151 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
32152 "reg(1)> for more help on this issue."
32156 #: ../src/guestfs.pod:664
32157 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
32161 #: ../src/guestfs.pod:666
32163 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
32164 "provide something which looks like a Linux symlink. The way it tries to do "
32165 "the rewriting is described here:"
32169 #: ../src/guestfs.pod:670
32171 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
32176 #: ../src/guestfs.pod:672
32178 "The essential problem is that ntfs-3g simply does not have enough "
32179 "information to do a correct job. NTFS links can contain drive letters and "
32180 "references to external device GUIDs that ntfs-3g has no way of resolving. "
32181 "It is almost certainly the case that libguestfs callers should ignore what "
32182 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
32186 #: ../src/guestfs.pod:679
32188 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
32189 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
32190 "attribute, and read the raw reparse data from that (you can find the format "
32191 "documented in various places around the web)."
32195 #: ../src/guestfs.pod:684
32196 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
32200 #: ../src/guestfs.pod:686
32202 "There are other useful extended attributes that can be read from ntfs-3g "
32203 "filesystems (using L</guestfs_getxattr>). See:"
32207 #: ../src/guestfs.pod:689
32209 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
32213 #: ../src/guestfs.pod:691
32214 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
32218 #: ../src/guestfs.pod:693
32220 "Although we don't want to discourage you from using the C API, we will "
32221 "mention here that the same API is also available in other languages."
32225 #: ../src/guestfs.pod:696
32227 "The API is broadly identical in all supported languages. This means that "
32228 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
32229 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
32230 "OCaml. In other words, a straightforward, predictable isomorphism between "
32235 #: ../src/guestfs.pod:702
32237 "Error messages are automatically transformed into exceptions if the language "
32242 #: ../src/guestfs.pod:705
32244 "We don't try to \"object orientify\" parts of the API in OO languages, "
32245 "although contributors are welcome to write higher level APIs above what we "
32246 "provide in their favourite languages if they wish."
32250 #: ../src/guestfs.pod:711
32255 #: ../src/guestfs.pod:713
32257 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
32258 "identical to the C API. C++ classes and exceptions are not used."
32262 #: ../src/guestfs.pod:717
32267 #: ../src/guestfs.pod:719
32269 "The C# bindings are highly experimental. Please read the warnings at the "
32270 "top of C<csharp/Libguestfs.cs>."
32274 #: ../src/guestfs.pod:722
32279 #: ../src/guestfs.pod:724
32281 "This is the only language binding that is working but incomplete. Only "
32282 "calls which return simple integers have been bound in Haskell, and we are "
32283 "looking for help to complete this binding."
32287 #: ../src/guestfs.pod:728
32292 #: ../src/guestfs.pod:730
32294 "Full documentation is contained in the Javadoc which is distributed with "
32295 "libguestfs. For examples, see L<guestfs-java(3)>."
32299 #: ../src/guestfs.pod:733
32304 #: ../src/guestfs.pod:735
32305 msgid "See L<guestfs-ocaml(3)>."
32309 #: ../src/guestfs.pod:737
32314 #: ../src/guestfs.pod:739
32315 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
32319 #: ../src/guestfs.pod:741
32324 #: ../src/guestfs.pod:743
32326 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
32327 "the php-libguestfs package for your distribution."
32331 #: ../src/guestfs.pod:746
32332 msgid "The PHP binding only works correctly on 64 bit machines."
32336 #: ../src/guestfs.pod:748
32341 #: ../src/guestfs.pod:750
32342 msgid "See L<guestfs-python(3)>."
32346 #: ../src/guestfs.pod:752
32351 #: ../src/guestfs.pod:754
32352 msgid "See L<guestfs-ruby(3)>."
32356 #: ../src/guestfs.pod:756
32357 msgid "B<shell scripts>"
32361 #: ../src/guestfs.pod:758
32362 msgid "See L<guestfish(1)>."
32366 #: ../src/guestfs.pod:762
32367 msgid "LIBGUESTFS GOTCHAS"
32371 #: ../src/guestfs.pod:764
32373 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
32374 "system [...] that works in the way it is documented but is counterintuitive "
32375 "and almost invites mistakes.\""
32379 #: ../src/guestfs.pod:768
32381 "Since we developed libguestfs and the associated tools, there are several "
32382 "things we would have designed differently, but are now stuck with for "
32383 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
32384 "release, you can expect these to change. Beware of them."
32388 #: ../src/guestfs.pod:776
32389 msgid "Autosync / forgetting to sync."
32393 #: ../src/guestfs.pod:778
32395 "I<Update:> Autosync is enabled by default for all API users starting from "
32396 "libguestfs 1.5.24. This section only applies to older versions."
32400 #: ../src/guestfs.pod:781
32402 "When modifying a filesystem from C or another language, you B<must> unmount "
32403 "all filesystems and call L</guestfs_sync> explicitly before you close the "
32404 "libguestfs handle. You can also call:"
32408 #: ../src/guestfs.pod:785
32411 " guestfs_set_autosync (g, 1);\n"
32416 #: ../src/guestfs.pod:787
32418 "to have the unmount/sync done automatically for you when the handle 'g' is "
32419 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
32423 #: ../src/guestfs.pod:791
32425 "If you forget to do this, then it is entirely possible that your changes "
32426 "won't be written out, or will be partially written, or (very rarely) that "
32427 "you'll get disk corruption."
32431 #: ../src/guestfs.pod:795
32433 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
32434 "guestfish scripts that forget to sync will work just fine, which can make "
32435 "this very puzzling if you are trying to debug a problem."
32439 #: ../src/guestfs.pod:799
32440 msgid "Mount option C<-o sync> should not be the default."
32444 #: ../src/guestfs.pod:801
32446 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
32447 "However C<-o sync> does not add any reliability benefit, but does have a "
32448 "very large performance impact."
32452 #: ../src/guestfs.pod:805
32454 "The work around is to use L</guestfs_mount_options> and set the mount "
32455 "options that you actually want to use."
32459 #: ../src/guestfs.pod:808
32460 msgid "Read-only should be the default."
32464 #: ../src/guestfs.pod:810
32466 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
32467 "specify I<--rw> if you want to make changes to the image."
32471 #: ../src/guestfs.pod:813
32472 msgid "This would reduce the potential to corrupt live VM images."
32476 #: ../src/guestfs.pod:815
32478 "Note that many filesystems change the disk when you just mount and unmount, "
32479 "even if you didn't perform any writes. You need to use L</"
32480 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
32484 #: ../src/guestfs.pod:819
32485 msgid "guestfish command line is hard to use."
32489 #: ../src/guestfs.pod:821
32491 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
32492 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
32493 "exist, so it fails. In earlier versions of guestfish the error message was "
32494 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
32495 "we should have used C<guestfish -c command> to run commands."
32499 #: ../src/guestfs.pod:828
32500 msgid "guestfish megabyte modifiers don't work right on all commands"
32504 #: ../src/guestfs.pod:830
32506 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
32507 "other modifiers). What guestfish actually does is to multiply the number "
32508 "part by the modifier part and pass the result to the C API. However this "
32509 "doesn't work for a few APIs which aren't expecting bytes, but are already "
32510 "expecting some other unit (eg. megabytes)."
32514 #: ../src/guestfs.pod:837
32515 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
32519 #: ../src/guestfs.pod:839
32522 " lvcreate LV VG 100M\n"
32527 #: ../src/guestfs.pod:841
32529 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
32530 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
32531 "megabytes * megabytes) logical volume. The error message you get from this "
32532 "is also a little obscure."
32536 #: ../src/guestfs.pod:846
32538 "This could be fixed in the generator by specially marking parameters and "
32539 "return values which take bytes or other units."
32543 #: ../src/guestfs.pod:849
32544 msgid "Ambiguity between devices and paths"
32548 #: ../src/guestfs.pod:851
32550 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
32551 "sdb2>) and a similar pathname. A file might just happen to be called "
32552 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
32556 #: ../src/guestfs.pod:856
32558 "In the current API we usually resolve this ambiguity by having two separate "
32559 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
32560 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
32561 "detecting if the path supplied begins with C</dev/>."
32565 #: ../src/guestfs.pod:862
32567 "To avoid both the ambiguity and the need to duplicate some calls, we could "
32568 "make paths/devices into structured names. One way to do this would be to "
32569 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
32570 "aspect of grub. Another way would be to use a structured type, equivalent "
32571 "to this OCaml type:"
32575 #: ../src/guestfs.pod:868
32578 " type path = Path of string | Device of int | Partition of int * int\n"
32583 #: ../src/guestfs.pod:870
32584 msgid "which would allow you to pass arguments like:"
32588 #: ../src/guestfs.pod:872
32591 " Path \"/foo/bar\"\n"
32592 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
32593 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
32594 " Path \"/dev/sdb2\" (* not a device *)\n"
32599 #: ../src/guestfs.pod:877
32601 "As you can see there are still problems to resolve even with this "
32602 "representation. Also consider how it might work in guestfish."
32606 #: ../src/guestfs.pod:882
32607 msgid "KEYS AND PASSPHRASES"
32611 #: ../src/guestfs.pod:884
32613 "Certain libguestfs calls take a parameter that contains sensitive key "
32614 "material, passed in as a C string."
32618 #: ../src/guestfs.pod:887
32620 "In the future we would hope to change the libguestfs implementation so that "
32621 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
32622 "swap. However this is I<not> done at the moment, because of the complexity "
32623 "of such an implementation."
32627 #: ../src/guestfs.pod:892
32629 "Therefore you should be aware that any key parameter you pass to libguestfs "
32630 "might end up being written out to the swap partition. If this is a concern, "
32631 "scrub the swap partition or don't use libguestfs on encrypted devices."
32635 #: ../src/guestfs.pod:897
32636 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
32640 #: ../src/guestfs.pod:899
32642 "All high-level libguestfs actions are synchronous. If you want to use "
32643 "libguestfs asynchronously then you must create a thread."
32647 #: ../src/guestfs.pod:902
32649 "Only use the handle from a single thread. Either use the handle exclusively "
32650 "from one thread, or provide your own mutex so that two threads cannot issue "
32651 "calls on the same handle at the same time."
32655 #: ../src/guestfs.pod:906
32657 "See the graphical program guestfs-browser for one possible architecture for "
32658 "multithreaded programs using libvirt and libguestfs."
32662 #: ../src/guestfs.pod:909
32667 #: ../src/guestfs.pod:911
32669 "Libguestfs needs a supermin appliance, which it finds by looking along an "
32674 #: ../src/guestfs.pod:914
32676 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
32677 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
32681 #: ../src/guestfs.pod:917
32683 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
32684 "to change the directories that libguestfs will search in. The value is a "
32685 "colon-separated list of paths. The current directory is I<not> searched "
32686 "unless the path contains an empty element or C<.>. For example "
32687 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
32688 "then C</usr/lib/guestfs>."
32692 #: ../src/guestfs.pod:924
32693 msgid "QEMU WRAPPERS"
32697 #: ../src/guestfs.pod:926
32699 "If you want to compile your own qemu, run qemu from a non-standard location, "
32700 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
32705 #: ../src/guestfs.pod:930
32707 "There is one important rule to remember: you I<must C<exec qemu>> as the "
32708 "last command in the shell script (so that qemu replaces the shell and "
32709 "becomes the direct child of the libguestfs-using program). If you don't do "
32710 "this, then the qemu process won't be cleaned up correctly."
32714 #: ../src/guestfs.pod:935
32716 "Here is an example of a wrapper, where I have built my own copy of qemu from "
32721 #: ../src/guestfs.pod:938
32725 " qemudir=/home/rjones/d/qemu\n"
32726 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
32731 #: ../src/guestfs.pod:942
32733 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
32734 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
32739 #: ../src/guestfs.pod:946
32742 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
32747 #: ../src/guestfs.pod:948
32749 "Note that libguestfs also calls qemu with the -help and -version options in "
32750 "order to determine features."
32754 #: ../src/guestfs.pod:951
32755 msgid "ATTACHING TO RUNNING DAEMONS"
32759 #: ../src/guestfs.pod:953
32761 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
32762 "babies. Use with caution."
32766 #: ../src/guestfs.pod:956
32768 "I<Note (2):> This section explains how to attach to a running daemon from a "
32769 "low level perspective. For most users, simply using virt tools such as "
32770 "L<guestfish(1)> with the I<--live> option will \"just work\"."
32774 #: ../src/guestfs.pod:960
32775 msgid "Using guestfs_set_attach_method"
32779 #: ../src/guestfs.pod:962
32781 "By calling L</guestfs_set_attach_method> you can change how the library "
32782 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
32783 "ARCHITECTURE> for some background)."
32787 #: ../src/guestfs.pod:966
32789 "The normal attach method is C<appliance>, where a small appliance is created "
32790 "containing the daemon, and then the library connects to this."
32794 #: ../src/guestfs.pod:969
32796 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
32797 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
32798 "daemon over the Unix domain socket."
32802 #: ../src/guestfs.pod:973
32804 "The normal use for this is to connect to a running virtual machine that "
32805 "contains a C<guestfsd> daemon, and send commands so you can read and write "
32806 "files inside the live virtual machine."
32810 #: ../src/guestfs.pod:977
32811 msgid "Using guestfs_add_domain with live flag"
32815 #: ../src/guestfs.pod:979
32817 "L</guestfs_add_domain> provides some help for getting the correct attach "
32818 "method. If you pass the C<live> option to this function, then (if the "
32819 "virtual machine is running) it will examine the libvirt XML looking for a "
32820 "virtio-serial channel to connect to:"
32824 #: ../src/guestfs.pod:985
32831 " <channel type='unix'>\n"
32832 " <source mode='bind' path='/path/to/socket'/>\n"
32833 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
32842 #: ../src/guestfs.pod:997
32844 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
32845 "method to C<unix:/path/to/socket>."
32849 #: ../src/guestfs.pod:1000
32851 "Some of the libguestfs tools (including guestfish) support a I<--live> "
32852 "option which is passed through to L</guestfs_add_domain> thus allowing you "
32853 "to attach to and modify live virtual machines."
32857 #: ../src/guestfs.pod:1004
32859 "The virtual machine needs to have been set up beforehand so that it has the "
32860 "virtio-serial channel and so that guestfsd is running inside it."
32864 #: ../src/guestfs.pod:1008
32865 msgid "ABI GUARANTEE"
32869 #: ../src/guestfs.pod:1010
32871 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
32872 "actions as outlined in this section. Although we will deprecate some "
32873 "actions, for example if they get replaced by newer calls, we will keep the "
32874 "old actions forever. This allows you the developer to program in confidence "
32875 "against the libguestfs API."
32879 #: ../src/guestfs.pod:1016
32880 msgid "BLOCK DEVICE NAMING"
32884 #: ../src/guestfs.pod:1018
32886 "In the kernel there is now quite a profusion of schemata for naming block "
32887 "devices (in this context, by I<block device> I mean a physical or virtual "
32888 "hard drive). The original Linux IDE driver used names starting with C</dev/"
32889 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
32890 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
32891 "for the old IDE driver (particularly for SATA devices) those devices also "
32892 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
32893 "paravirtualized drivers. This has created several different naming systems, "
32894 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
32898 #: ../src/guestfs.pod:1030
32900 "As discussed above, libguestfs uses a qemu appliance running an embedded "
32901 "Linux kernel to access block devices. We can run a variety of appliances "
32902 "based on a variety of Linux kernels."
32906 #: ../src/guestfs.pod:1034
32908 "This causes a problem for libguestfs because many API calls use device or "
32909 "partition names. Working scripts and the recipe (example) scripts that we "
32910 "make available over the internet could fail if the naming scheme changes."
32914 #: ../src/guestfs.pod:1039
32916 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
32917 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
32918 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
32919 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
32923 #: ../src/guestfs.pod:1045
32925 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
32926 "L</guestfs_list_partitions> and similar calls return the true names of the "
32927 "devices and partitions as known to the appliance."
32931 #: ../src/guestfs.pod:1050
32932 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
32936 #: ../src/guestfs.pod:1052
32938 "Usually this translation is transparent. However in some (very rare) cases "
32939 "you may need to know the exact algorithm. Such cases include where you use "
32940 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
32941 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
32945 #: ../src/guestfs.pod:1058
32947 "The algorithm is applied only to I<parameters> which are known to be either "
32948 "device or partition names. Return values from functions such as L</"
32949 "guestfs_list_devices> are never changed."
32953 #: ../src/guestfs.pod:1066
32954 msgid "Is the string a parameter which is a device or partition name?"
32958 #: ../src/guestfs.pod:1070
32959 msgid "Does the string begin with C</dev/sd>?"
32963 #: ../src/guestfs.pod:1074
32965 "Does the named device exist? If so, we use that device. However if I<not> "
32966 "then we continue with this algorithm."
32970 #: ../src/guestfs.pod:1079
32971 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
32975 #: ../src/guestfs.pod:1081
32976 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
32980 #: ../src/guestfs.pod:1083
32981 msgid "If that named device exists, use it. If not, continue."
32985 #: ../src/guestfs.pod:1087
32986 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
32990 #: ../src/guestfs.pod:1089
32991 msgid "If that named device exists, use it. If not, return an error."
32995 #: ../src/guestfs.pod:1093
32996 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
33000 #: ../src/guestfs.pod:1095
33002 "Although the standard naming scheme and automatic translation is useful for "
33003 "simple programs and guestfish scripts, for larger programs it is best not to "
33004 "rely on this mechanism."
33008 #: ../src/guestfs.pod:1099
33010 "Where possible for maximum future portability programs using libguestfs "
33011 "should use these future-proof techniques:"
33015 #: ../src/guestfs.pod:1106
33017 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
33018 "device names, and then use those names directly."
33022 #: ../src/guestfs.pod:1109
33024 "Since those device names exist by definition, they will never be translated."
33028 #: ../src/guestfs.pod:1114
33030 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
33031 "filesystem labels."
33035 #: ../src/guestfs.pod:1119
33040 #: ../src/guestfs.pod:1121
33042 "This section discusses security implications of using libguestfs, "
33043 "particularly with untrusted or malicious guests or disk images."
33047 #: ../src/guestfs.pod:1124
33048 msgid "GENERAL SECURITY CONSIDERATIONS"
33052 #: ../src/guestfs.pod:1126
33054 "Be careful with any files or data that you download from a guest (by "
33055 "\"download\" we mean not just the L</guestfs_download> command but any "
33056 "command that reads files, filenames, directories or anything else from a "
33057 "disk image). An attacker could manipulate the data to fool your program "
33058 "into doing the wrong thing. Consider cases such as:"
33062 #: ../src/guestfs.pod:1136
33063 msgid "the data (file etc) not being present"
33067 #: ../src/guestfs.pod:1140
33068 msgid "being present but empty"
33072 #: ../src/guestfs.pod:1144
33073 msgid "being much larger than normal"
33077 #: ../src/guestfs.pod:1148
33078 msgid "containing arbitrary 8 bit data"
33082 #: ../src/guestfs.pod:1152
33083 msgid "being in an unexpected character encoding"
33087 #: ../src/guestfs.pod:1156
33088 msgid "containing homoglyphs."
33092 #: ../src/guestfs.pod:1160
33093 msgid "SECURITY OF MOUNTING FILESYSTEMS"
33097 #: ../src/guestfs.pod:1162
33099 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
33100 "(VFS) module can sometimes be escalated into exploits by deliberately "
33101 "creating a malicious, malformed filesystem. These exploits are very severe "
33102 "for two reasons. Firstly there are very many filesystem drivers in the "
33103 "kernel, and many of them are infrequently used and not much developer "
33104 "attention has been paid to the code. Linux userspace helps potential "
33105 "crackers by detecting the filesystem type and automatically choosing the "
33106 "right VFS driver, even if that filesystem type is obscure or unexpected for "
33107 "the administrator. Secondly, a kernel-level exploit is like a local root "
33108 "exploit (worse in some ways), giving immediate and total access to the "
33109 "system right down to the hardware level."
33113 #: ../src/guestfs.pod:1175
33115 "That explains why you should never mount a filesystem from an untrusted "
33116 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
33117 "inside a qemu virtual machine, usually running as a non-root user. The "
33118 "attacker would need to write a filesystem which first exploited the kernel, "
33119 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
33120 "the libguestfs protocol, and finally to be as serious as the host kernel "
33121 "exploit it would need to escalate its privileges to root. This multi-step "
33122 "escalation, performed by a static piece of data, is thought to be extremely "
33123 "hard to do, although we never say 'never' about security issues."
33127 #: ../src/guestfs.pod:1186
33129 "In any case callers can reduce the attack surface by forcing the filesystem "
33130 "type when mounting (use L</guestfs_mount_vfs>)."
33134 #: ../src/guestfs.pod:1189
33135 msgid "PROTOCOL SECURITY"
33139 #: ../src/guestfs.pod:1191
33141 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
33142 "defined upper message size. However a program that uses libguestfs must "
33143 "also take care - for example you can write a program that downloads a binary "
33144 "from a disk image and executes it locally, and no amount of protocol "
33145 "security will save you from the consequences."
33149 #: ../src/guestfs.pod:1197
33150 msgid "INSPECTION SECURITY"
33154 #: ../src/guestfs.pod:1199
33156 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
33157 "directly from the guest, and these could contain any 8 bit data. Callers "
33158 "should be careful to escape these before printing them to a structured file "
33159 "(for example, use HTML escaping if creating a web page)."
33163 #: ../src/guestfs.pod:1205
33165 "Guest configuration may be altered in unusual ways by the administrator of "
33166 "the virtual machine, and may not reflect reality (particularly for untrusted "
33167 "or actively malicious guests). For example we parse the hostname from "
33168 "configuration files like C</etc/sysconfig/network> that we find in the "
33169 "guest, but the guest administrator can easily manipulate these files to "
33170 "provide the wrong hostname."
33174 #: ../src/guestfs.pod:1213
33176 "The inspection API parses guest configuration using two external libraries: "
33177 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
33178 "designed to be robust in the face of malicious data, although denial of "
33179 "service attacks are still possible, for example with oversized configuration "
33184 #: ../src/guestfs.pod:1219
33185 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
33189 #: ../src/guestfs.pod:1221
33191 "Be very cautious about running commands from the guest. By running a "
33192 "command in the guest, you are giving CPU time to a binary that you do not "
33193 "control, under the same user account as the library, albeit wrapped in qemu "
33194 "virtualization. More information and alternatives can be found in the "
33195 "section L</RUNNING COMMANDS>."
33199 #: ../src/guestfs.pod:1227
33200 msgid "CVE-2010-3851"
33204 #: ../src/guestfs.pod:1229
33205 msgid "https://bugzilla.redhat.com/642934"
33209 #: ../src/guestfs.pod:1231
33211 "This security bug concerns the automatic disk format detection that qemu "
33212 "does on disk images."
33216 #: ../src/guestfs.pod:1234
33218 "A raw disk image is just the raw bytes, there is no header. Other disk "
33219 "images like qcow2 contain a special header. Qemu deals with this by looking "
33220 "for one of the known headers, and if none is found then assuming the disk "
33221 "image must be raw."
33225 #: ../src/guestfs.pod:1239
33227 "This allows a guest which has been given a raw disk image to write some "
33228 "other header. At next boot (or when the disk image is accessed by "
33229 "libguestfs) qemu would do autodetection and think the disk image format was, "
33230 "say, qcow2 based on the header written by the guest."
33234 #: ../src/guestfs.pod:1244
33236 "This in itself would not be a problem, but qcow2 offers many features, one "
33237 "of which is to allow a disk image to refer to another image (called the "
33238 "\"backing disk\"). It does this by placing the path to the backing disk "
33239 "into the qcow2 header. This path is not validated and could point to any "
33240 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
33241 "\"holes\" in the qcow2 disk image, which of course is completely under the "
33242 "control of the attacker."
33246 #: ../src/guestfs.pod:1252
33248 "In libguestfs this is rather hard to exploit except under two circumstances:"
33252 #: ../src/guestfs.pod:1259
33253 msgid "You have enabled the network or have opened the disk in write mode."
33257 #: ../src/guestfs.pod:1263
33259 "You are also running untrusted code from the guest (see L</RUNNING "
33264 #: ../src/guestfs.pod:1268
33266 "The way to avoid this is to specify the expected disk format when adding "
33267 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
33268 "should always do this if the disk is raw format, and it's a good idea for "
33273 #: ../src/guestfs.pod:1273
33275 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
33276 "format is fetched from libvirt and passed through."
33280 #: ../src/guestfs.pod:1276
33282 "For libguestfs tools, use the I<--format> command line parameter as "
33287 #: ../src/guestfs.pod:1279
33288 msgid "CONNECTION MANAGEMENT"
33292 #: ../src/guestfs.pod:1281
33293 msgid "guestfs_h *"
33297 #: ../src/guestfs.pod:1283
33299 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
33300 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
33301 "handle and release all resources used."
33305 #: ../src/guestfs.pod:1287
33307 "For information on using multiple handles and threads, see the section L</"
33308 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
33312 #: ../src/guestfs.pod:1290
33313 msgid "guestfs_create"
33317 #: ../src/guestfs.pod:1292
33320 " guestfs_h *guestfs_create (void);\n"
33325 #: ../src/guestfs.pod:1294
33326 msgid "Create a connection handle."
33330 #: ../src/guestfs.pod:1296
33332 "On success this returns a non-NULL pointer to a handle. On error it returns "
33337 #: ../src/guestfs.pod:1299
33339 "You have to \"configure\" the handle after creating it. This includes "
33340 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
33341 "handle at least once."
33345 #: ../src/guestfs.pod:1303
33346 msgid "After configuring the handle, you have to call L</guestfs_launch>."
33350 #: ../src/guestfs.pod:1305
33352 "You may also want to configure error handling for the handle. See the L</"
33353 "ERROR HANDLING> section below."
33357 #: ../src/guestfs.pod:1308
33358 msgid "guestfs_close"
33362 #: ../src/guestfs.pod:1310
33365 " void guestfs_close (guestfs_h *g);\n"
33370 #: ../src/guestfs.pod:1312
33371 msgid "This closes the connection handle and frees up all resources used."
33375 #: ../src/guestfs.pod:1314
33377 "If autosync was set on the handle and the handle was launched, then this "
33378 "implicitly calls various functions to unmount filesystems and sync the "
33379 "disk. See L</guestfs_set_autosync> for more details."
33383 #: ../src/guestfs.pod:1318
33384 msgid "If a close callback was set on the handle, then it is called."
33388 #: ../src/guestfs.pod:1320
33389 msgid "ERROR HANDLING"
33393 #: ../src/guestfs.pod:1322
33395 "API functions can return errors. For example, almost all functions that "
33396 "return C<int> will return C<-1> to indicate an error."
33400 #: ../src/guestfs.pod:1325
33402 "Additional information is available for errors: an error message string and "
33403 "optionally an error number (errno) if the thing that failed was a system "
33408 #: ../src/guestfs.pod:1329
33410 "You can get at the additional information about the last error on the handle "
33411 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
33412 "up an error handler with L</guestfs_set_error_handler>."
33416 #: ../src/guestfs.pod:1334
33418 "When the handle is created, a default error handler is installed which "
33419 "prints the error message string to C<stderr>. For small short-running "
33420 "command line programs it is sufficient to do:"
33424 #: ../src/guestfs.pod:1338
33427 " if (guestfs_launch (g) == -1)\n"
33428 " exit (EXIT_FAILURE);\n"
33433 #: ../src/guestfs.pod:1341
33435 "since the default error handler will ensure that an error message has been "
33436 "printed to C<stderr> before the program exits."
33440 #: ../src/guestfs.pod:1344
33442 "For other programs the caller will almost certainly want to install an "
33443 "alternate error handler or do error handling in-line like this:"
33447 #: ../src/guestfs.pod:1347
33450 " /* This disables the default behaviour of printing errors\n"
33452 " guestfs_set_error_handler (g, NULL, NULL);\n"
33457 #: ../src/guestfs.pod:1351
33460 " if (guestfs_launch (g) == -1) {\n"
33461 " /* Examine the error message and print it etc. */\n"
33462 " char *msg = guestfs_last_error (g);\n"
33463 " int errnum = guestfs_last_errno (g);\n"
33464 " fprintf (stderr, \"%s\", msg);\n"
33465 " if (errnum != 0)\n"
33466 " fprintf (stderr, \": %s\", strerror (errnum));\n"
33467 " fprintf (stderr, \"\\n\");\n"
33474 #: ../src/guestfs.pod:1362
33476 "Out of memory errors are handled differently. The default action is to call "
33477 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
33478 "guestfs_set_out_of_memory_handler>."
33482 #: ../src/guestfs.pod:1366
33484 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
33485 "because there is no handle if this happens there is no way to get additional "
33486 "error information. However L</guestfs_create> is supposed to be a "
33487 "lightweight operation which can only fail because of insufficient memory (it "
33488 "returns NULL in this case)."
33492 #: ../src/guestfs.pod:1372
33493 msgid "guestfs_last_error"
33497 #: ../src/guestfs.pod:1374
33500 " const char *guestfs_last_error (guestfs_h *g);\n"
33505 #: ../src/guestfs.pod:1376
33507 "This returns the last error message that happened on C<g>. If there has not "
33508 "been an error since the handle was created, then this returns C<NULL>."
33512 #: ../src/guestfs.pod:1380
33514 "The lifetime of the returned string is until the next error occurs, or L</"
33515 "guestfs_close> is called."
33519 #: ../src/guestfs.pod:1383
33520 msgid "guestfs_last_errno"
33524 #: ../src/guestfs.pod:1385
33527 " int guestfs_last_errno (guestfs_h *g);\n"
33532 #: ../src/guestfs.pod:1387
33533 msgid "This returns the last error number (errno) that happened on C<g>."
33537 #: ../src/guestfs.pod:1389
33538 msgid "If successful, an errno integer not equal to zero is returned."
33542 #: ../src/guestfs.pod:1391
33544 "If no error, this returns 0. This call can return 0 in three situations:"
33548 #: ../src/guestfs.pod:1398
33549 msgid "There has not been any error on the handle."
33553 #: ../src/guestfs.pod:1402
33555 "There has been an error but the errno was meaningless. This corresponds to "
33556 "the case where the error did not come from a failed system call, but for "
33557 "some other reason."
33561 #: ../src/guestfs.pod:1408
33563 "There was an error from a failed system call, but for some reason the errno "
33564 "was not captured and returned. This usually indicates a bug in libguestfs."
33568 #: ../src/guestfs.pod:1414
33570 "Libguestfs tries to convert the errno from inside the applicance into a "
33571 "corresponding errno for the caller (not entirely trivial: the appliance "
33572 "might be running a completely different operating system from the library "
33573 "and error numbers are not standardized across Un*xen). If this could not be "
33574 "done, then the error is translated to C<EINVAL>. In practice this should "
33575 "only happen in very rare circumstances."
33579 #: ../src/guestfs.pod:1422
33580 msgid "guestfs_set_error_handler"
33584 #: ../src/guestfs.pod:1424
33587 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
33589 " const char *msg);\n"
33590 " void guestfs_set_error_handler (guestfs_h *g,\n"
33591 " guestfs_error_handler_cb cb,\n"
33592 " void *opaque);\n"
33597 #: ../src/guestfs.pod:1431
33599 "The callback C<cb> will be called if there is an error. The parameters "
33600 "passed to the callback are an opaque data pointer and the error message "
33605 #: ../src/guestfs.pod:1435
33607 "C<errno> is not passed to the callback. To get that the callback must call "
33608 "L</guestfs_last_errno>."
33612 #: ../src/guestfs.pod:1438
33614 "Note that the message string C<msg> is freed as soon as the callback "
33615 "function returns, so if you want to stash it somewhere you must make your "
33620 #: ../src/guestfs.pod:1442
33621 msgid "The default handler prints messages on C<stderr>."
33625 #: ../src/guestfs.pod:1444
33626 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
33630 #: ../src/guestfs.pod:1446
33631 msgid "guestfs_get_error_handler"
33635 #: ../src/guestfs.pod:1448
33638 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
33639 " void **opaque_rtn);\n"
33644 #: ../src/guestfs.pod:1451
33645 msgid "Returns the current error handler callback."
33649 #: ../src/guestfs.pod:1453
33650 msgid "guestfs_set_out_of_memory_handler"
33654 #: ../src/guestfs.pod:1455
33657 " typedef void (*guestfs_abort_cb) (void);\n"
33658 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
33659 " guestfs_abort_cb);\n"
33664 #: ../src/guestfs.pod:1459
33666 "The callback C<cb> will be called if there is an out of memory situation. "
33667 "I<Note this callback must not return>."
33671 #: ../src/guestfs.pod:1462
33672 msgid "The default is to call L<abort(3)>."
33676 #: ../src/guestfs.pod:1464
33678 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
33682 #: ../src/guestfs.pod:1467
33683 msgid "guestfs_get_out_of_memory_handler"
33687 #: ../src/guestfs.pod:1469
33690 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
33695 #: ../src/guestfs.pod:1471
33696 msgid "This returns the current out of memory handler."
33700 #: ../src/guestfs.pod:1473
33705 #: ../src/guestfs.pod:1477
33710 #: ../src/guestfs.pod:1479
33715 #: ../src/guestfs.pod:1481
33716 msgid "AVAILABILITY"
33720 #: ../src/guestfs.pod:1483
33721 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
33725 #: ../src/guestfs.pod:1485
33727 "Using L</guestfs_available> you can test availability of the following "
33728 "groups of functions. This test queries the appliance to see if the "
33729 "appliance you are currently using supports the functionality."
33733 #: ../src/guestfs.pod:1490
33734 msgid "@AVAILABILITY@"
33738 #: ../src/guestfs.pod:1492
33739 msgid "GUESTFISH supported COMMAND"
33743 #: ../src/guestfs.pod:1494
33745 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
33746 "prints out the available groups and whether they are supported by this build "
33747 "of libguestfs. Note however that you have to do C<run> first."
33751 #: ../src/guestfs.pod:1499
33752 msgid "SINGLE CALLS AT COMPILE TIME"
33756 #: ../src/guestfs.pod:1501
33758 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
33759 "function, such as:"
33763 #: ../src/guestfs.pod:1504
33766 " #define LIBGUESTFS_HAVE_DD 1\n"
33771 #: ../src/guestfs.pod:1506
33772 msgid "if L</guestfs_dd> is available."
33776 #: ../src/guestfs.pod:1508
33778 "Before version 1.5.8, if you needed to test whether a single libguestfs "
33779 "function is available at compile time, we recommended using build tools such "
33780 "as autoconf or cmake. For example in autotools you could use:"
33784 #: ../src/guestfs.pod:1513
33787 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
33788 " AC_CHECK_FUNCS([guestfs_dd])\n"
33793 #: ../src/guestfs.pod:1516
33795 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
33800 #: ../src/guestfs.pod:1519
33801 msgid "SINGLE CALLS AT RUN TIME"
33805 #: ../src/guestfs.pod:1521
33807 "Testing at compile time doesn't guarantee that a function really exists in "
33808 "the library. The reason is that you might be dynamically linked against a "
33809 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
33810 "This situation unfortunately results in a segmentation fault, which is a "
33811 "shortcoming of the C dynamic linking system itself."
33815 #: ../src/guestfs.pod:1528
33817 "You can use L<dlopen(3)> to test if a function is available at run time, as "
33818 "in this example program (note that you still need the compile time check as "
33823 #: ../src/guestfs.pod:1532
33826 " #include <stdio.h>\n"
33827 " #include <stdlib.h>\n"
33828 " #include <unistd.h>\n"
33829 " #include <dlfcn.h>\n"
33830 " #include <guestfs.h>\n"
33835 #: ../src/guestfs.pod:1538
33840 " #ifdef LIBGUESTFS_HAVE_DD\n"
33842 " int has_function;\n"
33847 #: ../src/guestfs.pod:1544
33850 " /* Test if the function guestfs_dd is really available. */\n"
33851 " dl = dlopen (NULL, RTLD_LAZY);\n"
33853 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
33854 " exit (EXIT_FAILURE);\n"
33856 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
33862 #: ../src/guestfs.pod:1553
33865 " if (!has_function)\n"
33866 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
33868 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
33869 " /* Now it's safe to call\n"
33870 " guestfs_dd (g, \"foo\", \"bar\");\n"
33874 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
33881 #: ../src/guestfs.pod:1566
33883 "You may think the above is an awful lot of hassle, and it is. There are "
33884 "other ways outside of the C linking system to ensure that this kind of "
33885 "incompatibility never arises, such as using package versioning:"
33889 #: ../src/guestfs.pod:1571
33892 " Requires: libguestfs >= 1.0.80\n"
33897 #: ../src/guestfs.pod:1573
33898 msgid "CALLS WITH OPTIONAL ARGUMENTS"
33902 #: ../src/guestfs.pod:1575
33904 "A recent feature of the API is the introduction of calls which take optional "
33905 "arguments. In C these are declared 3 ways. The main way is as a call which "
33906 "takes variable arguments (ie. C<...>), as in this example:"
33910 #: ../src/guestfs.pod:1580
33913 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
33918 #: ../src/guestfs.pod:1582
33920 "Call this with a list of optional arguments, terminated by C<-1>. So to "
33921 "call with no optional arguments specified:"
33925 #: ../src/guestfs.pod:1585
33928 " guestfs_add_drive_opts (g, filename, -1);\n"
33933 #: ../src/guestfs.pod:1587
33934 msgid "With a single optional argument:"
33938 #: ../src/guestfs.pod:1589
33941 " guestfs_add_drive_opts (g, filename,\n"
33942 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33948 #: ../src/guestfs.pod:1593
33953 #: ../src/guestfs.pod:1595
33956 " guestfs_add_drive_opts (g, filename,\n"
33957 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33958 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
33964 #: ../src/guestfs.pod:1600
33966 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
33971 #: ../src/guestfs.pod:1603
33972 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
33976 #: ../src/guestfs.pod:1605
33978 "The second variant has the same name with the suffix C<_va>, which works the "
33979 "same way but takes a C<va_list>. See the C manual for details. For the "
33980 "example function, this is declared:"
33984 #: ../src/guestfs.pod:1609
33987 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
33988 " va_list args);\n"
33993 #: ../src/guestfs.pod:1612
33994 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
33998 #: ../src/guestfs.pod:1614
34000 "The third variant is useful where you need to construct these calls. You "
34001 "pass in a structure where you fill in the optional fields. The structure "
34002 "has a bitmask as the first element which you must set to indicate which "
34003 "fields you have filled in. For our example function the structure and call "
34008 #: ../src/guestfs.pod:1620
34011 " struct guestfs_add_drive_opts_argv {\n"
34012 " uint64_t bitmask;\n"
34014 " const char *format;\n"
34017 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
34018 " const struct guestfs_add_drive_opts_argv *optargs);\n"
34023 #: ../src/guestfs.pod:1629
34024 msgid "You could call it like this:"
34028 #: ../src/guestfs.pod:1631
34031 " struct guestfs_add_drive_opts_argv optargs = {\n"
34032 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
34033 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
34034 " .readonly = 1,\n"
34035 " .format = \"qcow2\"\n"
34041 #: ../src/guestfs.pod:1638
34044 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
34049 #: ../src/guestfs.pod:1646
34050 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
34054 #: ../src/guestfs.pod:1651
34055 msgid "You do not need to fill in all fields of the structure."
34059 #: ../src/guestfs.pod:1655
34061 "There must be a one-to-one correspondence between fields of the structure "
34062 "that are filled in, and bits set in the bitmask."
34066 #: ../src/guestfs.pod:1660
34067 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
34071 #: ../src/guestfs.pod:1662
34073 "In other languages, optional arguments are expressed in the way that is "
34074 "natural for that language. We refer you to the language-specific "
34075 "documentation for more details on that."
34079 #: ../src/guestfs.pod:1666
34080 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
34084 #: ../src/guestfs.pod:1668
34085 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
34089 #: ../src/guestfs.pod:1670
34091 "B<Note:> This section documents the generic event mechanism introduced in "
34092 "libguestfs 1.10, which you should use in new code if possible. The old "
34093 "functions C<guestfs_set_log_message_callback>, "
34094 "C<guestfs_set_subprocess_quit_callback>, "
34095 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
34096 "C<guestfs_set_progress_callback> are no longer documented in this manual "
34097 "page. Because of the ABI guarantee, the old functions continue to work."
34101 #: ../src/guestfs.pod:1679
34103 "Handles generate events when certain things happen, such as log messages "
34104 "being generated, progress messages during long-running operations, or the "
34105 "handle being closed. The API calls described below let you register a "
34106 "callback to be called when events happen. You can register multiple "
34107 "callbacks (for the same, different or overlapping sets of events), and "
34108 "individually remove callbacks. If callbacks are not removed, then they "
34109 "remain in force until the handle is closed."
34113 #: ../src/guestfs.pod:1687
34115 "In the current implementation, events are only generated synchronously: that "
34116 "means that events (and hence callbacks) can only happen while you are in the "
34117 "middle of making another libguestfs call. The callback is called in the "
34122 #: ../src/guestfs.pod:1692
34124 "Events may contain a payload, usually nothing (void), an array of 64 bit "
34125 "unsigned integers, or a message buffer. Payloads are discussed later on."
34129 #: ../src/guestfs.pod:1696
34130 msgid "CLASSES OF EVENTS"
34134 #: ../src/guestfs.pod:1700
34135 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
34139 #: ../src/guestfs.pod:1703
34141 "The callback function will be called while the handle is being closed "
34142 "(synchronously from L</guestfs_close>)."
34146 #: ../src/guestfs.pod:1706
34148 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
34149 "handles that are open when the program exits. This means that this callback "
34150 "might be called indirectly from L<exit(3)>, which can cause unexpected "
34151 "problems in higher-level languages (eg. if your HLL interpreter has already "
34152 "been cleaned up by the time this is called, and if your callback then jumps "
34153 "into some HLL function)."
34157 #: ../src/guestfs.pod:1713
34159 "If no callback is registered: the handle is closed without any callback "
34164 #: ../src/guestfs.pod:1716
34165 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
34169 #: ../src/guestfs.pod:1719
34171 "The callback function will be called when the child process quits, either "
34172 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
34173 "corresponds to a transition from any state to the CONFIG state)."
34177 #: ../src/guestfs.pod:1723 ../src/guestfs.pod:1732
34178 msgid "If no callback is registered: the event is ignored."
34182 #: ../src/guestfs.pod:1725
34183 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
34187 #: ../src/guestfs.pod:1728
34189 "The callback function will be called when the child process becomes ready "
34190 "first time after it has been launched. (This corresponds to a transition "
34191 "from LAUNCHING to the READY state)."
34195 #: ../src/guestfs.pod:1734
34196 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
34200 #: ../src/guestfs.pod:1737
34202 "Some long-running operations can generate progress messages. If this "
34203 "callback is registered, then it will be called each time a progress message "
34204 "is generated (usually two seconds after the operation started, and three "
34205 "times per second thereafter until it completes, although the frequency may "
34206 "change in future versions)."
34210 #: ../src/guestfs.pod:1743
34212 "The callback receives in the payload four unsigned 64 bit numbers which are "
34213 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
34217 #: ../src/guestfs.pod:1746
34219 "The units of C<total> are not defined, although for some operations C<total> "
34220 "may relate in some way to the amount of data to be transferred (eg. in bytes "
34221 "or megabytes), and C<position> may be the portion which has been transferred."
34225 #: ../src/guestfs.pod:1751
34226 msgid "The only defined and stable parts of the API are:"
34230 #: ../src/guestfs.pod:1757
34232 "The callback can display to the user some type of progress bar or indicator "
34233 "which shows the ratio of C<position>:C<total>."
34237 #: ../src/guestfs.pod:1762
34238 msgid "0 E<lt>= C<position> E<lt>= C<total>"
34242 #: ../src/guestfs.pod:1766
34244 "If any progress notification is sent during a call, then a final progress "
34245 "notification is always sent when C<position> = C<total> (I<unless> the call "
34246 "fails with an error)."
34250 #: ../src/guestfs.pod:1770
34252 "This is to simplify caller code, so callers can easily set the progress "
34253 "indicator to \"100%\" at the end of the operation, without requiring special "
34254 "code to detect this case."
34258 #: ../src/guestfs.pod:1776
34260 "For some calls we are unable to estimate the progress of the call, but we "
34261 "can still generate progress messages to indicate activity. This is known as "
34262 "\"pulse mode\", and is directly supported by certain progress bar "
34263 "implementations (eg. GtkProgressBar)."
34267 #: ../src/guestfs.pod:1781
34269 "For these calls, zero or more progress messages are generated with "
34270 "C<position = 0> and C<total = 1>, followed by a final message with "
34271 "C<position = total = 1>."
34275 #: ../src/guestfs.pod:1785
34277 "As noted above, if the call fails with an error then the final message may "
34278 "not be generated."
34282 #: ../src/guestfs.pod:1790
34284 "The callback also receives the procedure number (C<proc_nr>) and serial "
34285 "number (C<serial>) of the call. These are only useful for debugging "
34286 "protocol issues, and the callback can normally ignore them. The callback "
34287 "may want to print these numbers in error messages or debugging messages."
34291 #: ../src/guestfs.pod:1796
34292 msgid "If no callback is registered: progress messages are discarded."
34296 #: ../src/guestfs.pod:1798
34297 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
34301 #: ../src/guestfs.pod:1801
34303 "The callback function is called whenever a log message is generated by qemu, "
34304 "the appliance kernel, guestfsd (daemon), or utility programs."
34308 #: ../src/guestfs.pod:1804
34310 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
34311 "guestfs_launch>) then additional debug messages are generated."
34315 #: ../src/guestfs.pod:1807 ../src/guestfs.pod:1821
34317 "If no callback is registered: the messages are discarded unless the verbose "
34318 "flag is set in which case they are sent to stderr. You can override the "
34319 "printing of verbose messages to stderr by setting up a callback."
34323 #: ../src/guestfs.pod:1812
34324 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
34328 #: ../src/guestfs.pod:1815
34330 "The callback function is called whenever a log message is generated by the "
34331 "library part of libguestfs."
34335 #: ../src/guestfs.pod:1818
34337 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
34338 "messages are generated."
34342 #: ../src/guestfs.pod:1826
34343 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
34347 #: ../src/guestfs.pod:1829
34349 "The callback function is called whenever a trace message is generated. This "
34350 "only applies if the trace flag (L</guestfs_set_trace>) is set."
34354 #: ../src/guestfs.pod:1832
34356 "If no callback is registered: the messages are sent to stderr. You can "
34357 "override the printing of trace messages to stderr by setting up a callback."
34361 #: ../src/guestfs.pod:1838
34362 msgid "guestfs_set_event_callback"
34366 #: ../src/guestfs.pod:1840
34369 " int guestfs_set_event_callback (guestfs_h *g,\n"
34370 " guestfs_event_callback cb,\n"
34371 " uint64_t event_bitmask,\n"
34373 " void *opaque);\n"
34378 #: ../src/guestfs.pod:1846
34380 "This function registers a callback (C<cb>) for all event classes in the "
34381 "C<event_bitmask>."
34385 #: ../src/guestfs.pod:1849
34387 "For example, to register for all log message events, you could call this "
34388 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
34389 "To register a single callback for all possible classes of events, use "
34390 "C<GUESTFS_EVENT_ALL>."
34394 #: ../src/guestfs.pod:1855
34395 msgid "C<flags> should always be passed as 0."
34399 #: ../src/guestfs.pod:1857
34401 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
34402 "it for any purpose."
34406 #: ../src/guestfs.pod:1860
34408 "The return value is the event handle (an integer) which you can use to "
34409 "delete the callback (see below)."
34413 #: ../src/guestfs.pod:1863
34415 "If there is an error, this function returns C<-1>, and sets the error in the "
34416 "handle in the usual way (see L</guestfs_last_error> etc.)"
34420 #: ../src/guestfs.pod:1866
34422 "Callbacks remain in effect until they are deleted, or until the handle is "
34427 #: ../src/guestfs.pod:1869
34429 "In the case where multiple callbacks are registered for a particular event "
34430 "class, all of the callbacks are called. The order in which multiple "
34431 "callbacks are called is not defined."
34435 #: ../src/guestfs.pod:1873
34436 msgid "guestfs_delete_event_callback"
34440 #: ../src/guestfs.pod:1875
34443 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
34448 #: ../src/guestfs.pod:1877
34450 "Delete a callback that was previously registered. C<event_handle> should be "
34451 "the integer that was returned by a previous call to "
34452 "C<guestfs_set_event_callback> on the same handle."
34456 #: ../src/guestfs.pod:1881
34457 msgid "guestfs_event_callback"
34461 #: ../src/guestfs.pod:1883
34464 " typedef void (*guestfs_event_callback) (\n"
34467 " uint64_t event,\n"
34468 " int event_handle,\n"
34470 " const char *buf, size_t buf_len,\n"
34471 " const uint64_t *array, size_t array_len);\n"
34476 #: ../src/guestfs.pod:1892
34478 "This is the type of the event callback function that you have to provide."
34482 #: ../src/guestfs.pod:1895
34484 "The basic parameters are: the handle (C<g>), the opaque user pointer "
34485 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
34486 "handle, and C<flags> which in the current API you should ignore."
34490 #: ../src/guestfs.pod:1899
34492 "The remaining parameters contain the event payload (if any). Each event may "
34493 "contain a payload, which usually relates to the event class, but for future "
34494 "proofing your code should be written to handle any payload for any event "
34499 #: ../src/guestfs.pod:1904
34501 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
34502 "there is no message buffer). Note that this message buffer can contain "
34503 "arbitrary 8 bit data, including NUL bytes."
34507 #: ../src/guestfs.pod:1908
34509 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
34510 "moment this is only used for progress messages."
34514 #: ../src/guestfs.pod:1911
34515 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
34519 #: ../src/guestfs.pod:1913
34521 "One motivation for the generic event API was to allow GUI programs to "
34522 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
34523 "unconditionally to C<stderr>."
34527 #: ../src/guestfs.pod:1917
34529 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
34530 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
34531 "messages are not events; you must capture error messages separately)."
34535 #: ../src/guestfs.pod:1922
34537 "Programs have to set up a callback to capture the classes of events of "
34542 #: ../src/guestfs.pod:1925
34546 " guestfs_set_event_callback\n"
34547 " (g, message_callback,\n"
34548 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
34549 " GUESTFS_EVENT_TRACE,\n"
34550 " 0, NULL) == -1)\n"
34551 " if (eh == -1) {\n"
34552 " // handle error in the usual way\n"
34558 #: ../src/guestfs.pod:1935
34560 "The callback can then direct messages to the appropriate place. In this "
34561 "example, messages are directed to syslog:"
34565 #: ../src/guestfs.pod:1938
34569 " message_callback (\n"
34572 " uint64_t event,\n"
34573 " int event_handle,\n"
34575 " const char *buf, size_t buf_len,\n"
34576 " const uint64_t *array, size_t array_len)\n"
34578 " const int priority = LOG_USER|LOG_INFO;\n"
34579 " if (buf_len > 0)\n"
34580 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
34586 #: ../src/guestfs.pod:1953
34587 msgid "CANCELLING LONG TRANSFERS"
34591 #: ../src/guestfs.pod:1955
34593 "Some operations can be cancelled by the caller while they are in progress. "
34594 "Currently only operations that involve uploading or downloading data can be "
34595 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
34596 "parameters in the generator)."
34600 #: ../src/guestfs.pod:1960
34601 msgid "guestfs_user_cancel"
34605 #: ../src/guestfs.pod:1962
34608 " void guestfs_user_cancel (guestfs_h *g);\n"
34613 #: ../src/guestfs.pod:1964
34615 "C<guestfs_user_cancel> cancels the current upload or download operation."
34619 #: ../src/guestfs.pod:1967
34621 "Unlike most other libguestfs calls, this function is signal safe and thread "
34622 "safe. You can call it from a signal handler or from another thread, without "
34623 "needing to do any locking."
34627 #: ../src/guestfs.pod:1971
34629 "The transfer that was in progress (if there is one) will stop shortly "
34630 "afterwards, and will return an error. The errno (see L</"
34631 "guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
34632 "out if the operation was cancelled or failed because of another error."
34636 #: ../src/guestfs.pod:1977
34638 "No cleanup is performed: for example, if a file was being uploaded then "
34639 "after cancellation there may be a partially uploaded file. It is the "
34640 "caller's responsibility to clean up if necessary."
34644 #: ../src/guestfs.pod:1981
34645 msgid "There are two common places that you might call C<guestfs_user_cancel>."
34649 #: ../src/guestfs.pod:1983
34651 "In an interactive text-based program, you might call it from a C<SIGINT> "
34652 "signal handler so that pressing C<^C> cancels the current operation. (You "
34653 "also need to call L</guestfs_set_pgroup> so that child processes don't "
34654 "receive the C<^C> signal)."
34658 #: ../src/guestfs.pod:1988
34660 "In a graphical program, when the main thread is displaying a progress bar "
34661 "with a cancel button, wire up the cancel button to call this function."
34665 #: ../src/guestfs.pod:1992
34666 msgid "PRIVATE DATA AREA"
34670 #: ../src/guestfs.pod:1994
34672 "You can attach named pieces of private data to the libguestfs handle, fetch "
34673 "them by name, and walk over them, for the lifetime of the handle. This is "
34674 "called the private data area and is only available from the C API."
34678 #: ../src/guestfs.pod:1999
34679 msgid "To attach a named piece of data, use the following call:"
34683 #: ../src/guestfs.pod:2001
34686 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
34691 #: ../src/guestfs.pod:2003
34693 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
34694 "pointer (which can be C<NULL>). Any previous item with the same key is "
34699 #: ../src/guestfs.pod:2007
34701 "You can use any C<key> you want, but your key should I<not> start with an "
34702 "underscore character. Keys beginning with an underscore character are "
34703 "reserved for internal libguestfs purposes (eg. for implementing language "
34704 "bindings). It is recommended that you prefix the key with some unique "
34705 "string to avoid collisions with other users."
34709 #: ../src/guestfs.pod:2013
34710 msgid "To retrieve the pointer, use:"
34714 #: ../src/guestfs.pod:2015
34717 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
34722 #: ../src/guestfs.pod:2017
34724 "This function returns C<NULL> if either no data is found associated with "
34725 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
34730 #: ../src/guestfs.pod:2021
34732 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
34733 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
34734 "all. In particular, libguestfs does I<not> try to free the data when the "
34735 "handle is closed. If the data must be freed, then the caller must either "
34736 "free it before calling L</guestfs_close> or must set up a close callback to "
34737 "do it (see L</GUESTFS_EVENT_CLOSE>)."
34741 #: ../src/guestfs.pod:2028
34742 msgid "To walk over all entries, use these two functions:"
34746 #: ../src/guestfs.pod:2030
34749 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
34754 #: ../src/guestfs.pod:2032
34757 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
34762 #: ../src/guestfs.pod:2034
34764 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
34765 "not have any particular meaning -- keys are not returned in any defined "
34766 "order). A pointer to the key is returned in C<*key_rtn> and the "
34767 "corresponding data pointer is returned from the function. C<NULL> is "
34768 "returned if there are no keys stored in the handle."
34772 #: ../src/guestfs.pod:2040
34774 "C<guestfs_next_private> returns the next key, pointer pair. The return "
34775 "value of this function is also C<NULL> is there are no further entries to "
34780 #: ../src/guestfs.pod:2044
34781 msgid "Notes about walking over entries:"
34785 #: ../src/guestfs.pod:2050
34787 "You must not call C<guestfs_set_private> while walking over the entries."
34791 #: ../src/guestfs.pod:2055
34793 "The handle maintains an internal iterator which is reset when you call "
34794 "C<guestfs_first_private>. This internal iterator is invalidated when you "
34795 "call C<guestfs_set_private>."
34799 #: ../src/guestfs.pod:2061
34800 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
34804 #: ../src/guestfs.pod:2063
34807 " guestfs_set_private (g, key, NULL);\n"
34812 #: ../src/guestfs.pod:2065
34813 msgid "then that C<key> is not returned when walking."
34817 #: ../src/guestfs.pod:2069
34819 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
34820 "C<guestfs_next_private> or C<guestfs_set_private>."
34824 #: ../src/guestfs.pod:2075
34826 "The following example code shows how to print all keys and data pointers "
34827 "that are associated with the handle C<g>:"
34831 #: ../src/guestfs.pod:2078
34834 " const char *key;\n"
34835 " void *data = guestfs_first_private (g, &key);\n"
34836 " while (data != NULL)\n"
34838 " printf (\"key = %s, data = %p\\n\", key, data);\n"
34839 " data = guestfs_next_private (g, &key);\n"
34845 #: ../src/guestfs.pod:2086
34847 "More commonly you are only interested in keys that begin with an application-"
34848 "specific prefix C<foo_>. Modify the loop like so:"
34852 #: ../src/guestfs.pod:2089
34855 " const char *key;\n"
34856 " void *data = guestfs_first_private (g, &key);\n"
34857 " while (data != NULL)\n"
34859 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34860 " printf (\"key = %s, data = %p\\n\", key, data);\n"
34861 " data = guestfs_next_private (g, &key);\n"
34867 #: ../src/guestfs.pod:2098
34869 "If you need to modify keys while walking, then you have to jump back to the "
34870 "beginning of the loop. For example, to delete all keys prefixed with "
34875 #: ../src/guestfs.pod:2102
34878 " const char *key;\n"
34881 " data = guestfs_first_private (g, &key);\n"
34882 " while (data != NULL)\n"
34884 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34886 " guestfs_set_private (g, key, NULL);\n"
34887 " /* note that 'key' pointer is now invalid, and so is\n"
34888 " the internal iterator */\n"
34891 " data = guestfs_next_private (g, &key);\n"
34897 #: ../src/guestfs.pod:2118
34899 "Note that the above loop is guaranteed to terminate because the keys are "
34900 "being deleted, but other manipulations of keys within the loop might not "
34901 "terminate unless you also maintain an indication of which keys have been "
34906 #: ../src/guestfs.pod:2123 ../src/guestfs.pod:2128
34911 #: ../src/guestfs.pod:2125
34913 "<!-- old anchor for the next section --> <a name="
34914 "\"state_machine_and_low_level_event_api\"/>"
34918 #: ../src/guestfs.pod:2130
34919 msgid "ARCHITECTURE"
34923 #: ../src/guestfs.pod:2132
34925 "Internally, libguestfs is implemented by running an appliance (a special "
34926 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
34927 "process of the main program."
34931 #: ../src/guestfs.pod:2136
34934 " ___________________\n"
34936 " | main program |\n"
34938 " | | child process / appliance\n"
34939 " | | __________________________\n"
34941 " +-------------------+ RPC | +-----------------+ |\n"
34942 " | libguestfs <--------------------> guestfsd | |\n"
34943 " | | | +-----------------+ |\n"
34944 " \\___________________/ | | Linux kernel | |\n"
34945 " | +--^--------------+ |\n"
34946 " \\_________|________________/\n"
34948 " _______v______\n"
34951 " | disk image |\n"
34952 " \\______________/\n"
34957 #: ../src/guestfs.pod:2156
34959 "The library, linked to the main program, creates the child process and hence "
34960 "the appliance in the L</guestfs_launch> function."
34964 #: ../src/guestfs.pod:2159
34966 "Inside the appliance is a Linux kernel and a complete stack of userspace "
34967 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
34968 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
34969 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
34970 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
34971 "attached to the qemu process which translates device access by the "
34972 "appliance's Linux kernel into accesses to the image."
34976 #: ../src/guestfs.pod:2168
34978 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
34979 "Although the disk image you are attached to might also be used by some "
34980 "virtual machine, libguestfs doesn't know or care about this. (But you will "
34981 "care if both libguestfs's qemu process and your virtual machine are trying "
34982 "to update the disk image at the same time, since these usually results in "
34983 "massive disk corruption)."
34987 #: ../src/guestfs.pod:2175
34988 msgid "STATE MACHINE"
34992 #: ../src/guestfs.pod:2177
34993 msgid "libguestfs uses a state machine to model the child process:"
34997 #: ../src/guestfs.pod:2179
35001 " guestfs_create\n"
35009 " / | \\ \\ guestfs_launch\n"
35010 " / | _\\__V______\n"
35012 " / | | LAUNCHING |\n"
35013 " / | \\___________/\n"
35015 " / | guestfs_launch\n"
35017 " ______ / __|____V\n"
35018 " / \\ ------> / \\\n"
35019 " | BUSY | | READY |\n"
35020 " \\______/ <------ \\________/\n"
35025 #: ../src/guestfs.pod:2201
35027 "The normal transitions are (1) CONFIG (when the handle is created, but there "
35028 "is no child process), (2) LAUNCHING (when the child process is booting up), "
35029 "(3) alternating between READY and BUSY as commands are issued to, and "
35030 "carried out by, the child process."
35034 #: ../src/guestfs.pod:2206
35036 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
35037 "asynchronously at any time (eg. due to some internal error), and that causes "
35038 "the state to transition back to CONFIG."
35042 #: ../src/guestfs.pod:2210
35044 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
35045 "issued when in the CONFIG state."
35049 #: ../src/guestfs.pod:2213
35051 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
35052 "L</guestfs_launch> blocks until the child process is READY to accept "
35053 "commands (or until some failure or timeout). L</guestfs_launch> internally "
35054 "moves the state from CONFIG to LAUNCHING while it is running."
35058 #: ../src/guestfs.pod:2219
35060 "API actions such as L</guestfs_mount> can only be issued when in the READY "
35061 "state. These API calls block waiting for the command to be carried out (ie. "
35062 "the state to transition to BUSY and then back to READY). There are no non-"
35063 "blocking versions, and no way to issue more than one command per handle at "
35068 #: ../src/guestfs.pod:2225
35070 "Finally, the child process sends asynchronous messages back to the main "
35071 "program, such as kernel log messages. You can register a callback to "
35072 "receive these messages."
35076 #: ../src/guestfs.pod:2229
35081 #: ../src/guestfs.pod:2231
35082 msgid "COMMUNICATION PROTOCOL"
35086 #: ../src/guestfs.pod:2233
35088 "Don't rely on using this protocol directly. This section documents how it "
35089 "currently works, but it may change at any time."
35093 #: ../src/guestfs.pod:2236
35095 "The protocol used to talk between the library and the daemon running inside "
35096 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
35097 "1014, RFC 1832, RFC 4506)."
35101 #: ../src/guestfs.pod:2240
35103 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
35104 "this file is automatically generated)."
35108 #: ../src/guestfs.pod:2243
35110 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
35111 "and C<FileOut> parameters, which are handled with very simple request/reply "
35112 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
35113 "parameters, which use the same request and reply messages, but they may also "
35114 "be followed by files sent using a chunked encoding."
35118 #: ../src/guestfs.pod:2250
35119 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
35123 #: ../src/guestfs.pod:2252
35124 msgid "For ordinary functions, the request message is:"
35128 #: ../src/guestfs.pod:2254
35131 " total length (header + arguments,\n"
35132 " but not including the length word itself)\n"
35133 " struct guestfs_message_header (encoded as XDR)\n"
35134 " struct guestfs_<foo>_args (encoded as XDR)\n"
35139 #: ../src/guestfs.pod:2259
35141 "The total length field allows the daemon to allocate a fixed size buffer "
35142 "into which it slurps the rest of the message. As a result, the total length "
35143 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
35144 "effective size of any request is limited to somewhere under this size."
35148 #: ../src/guestfs.pod:2265
35150 "Note also that many functions don't take any arguments, in which case the "
35151 "C<guestfs_I<foo>_args> is completely omitted."
35155 #: ../src/guestfs.pod:2268
35157 "The header contains the procedure number (C<guestfs_proc>) which is how the "
35158 "receiver knows what type of args structure to expect, or none at all."
35162 #: ../src/guestfs.pod:2272
35164 "For functions that take optional arguments, the optional arguments are "
35165 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
35166 "arguments. A bitmask in the header indicates which optional arguments are "
35167 "meaningful. The bitmask is also checked to see if it contains bits set "
35168 "which the daemon does not know about (eg. if more optional arguments were "
35169 "added in a later version of the library), and this causes the call to be "
35174 #: ../src/guestfs.pod:2280
35175 msgid "The reply message for ordinary functions is:"
35179 #: ../src/guestfs.pod:2282
35182 " total length (header + ret,\n"
35183 " but not including the length word itself)\n"
35184 " struct guestfs_message_header (encoded as XDR)\n"
35185 " struct guestfs_<foo>_ret (encoded as XDR)\n"
35190 #: ../src/guestfs.pod:2287
35192 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
35193 "functions that return no formal return values."
35197 #: ../src/guestfs.pod:2290
35199 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
35203 #: ../src/guestfs.pod:2293
35205 "In the case of an error, a flag is set in the header, and the reply message "
35206 "is slightly changed:"
35210 #: ../src/guestfs.pod:2296
35213 " total length (header + error,\n"
35214 " but not including the length word itself)\n"
35215 " struct guestfs_message_header (encoded as XDR)\n"
35216 " struct guestfs_message_error (encoded as XDR)\n"
35221 #: ../src/guestfs.pod:2301
35223 "The C<guestfs_message_error> structure contains the error message as a "
35228 #: ../src/guestfs.pod:2304
35229 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
35233 #: ../src/guestfs.pod:2306
35235 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
35236 "The normal request message is sent (see above). However this is followed by "
35237 "a sequence of file chunks."
35241 #: ../src/guestfs.pod:2310
35244 " total length (header + arguments,\n"
35245 " but not including the length word itself,\n"
35246 " and not including the chunks)\n"
35247 " struct guestfs_message_header (encoded as XDR)\n"
35248 " struct guestfs_<foo>_args (encoded as XDR)\n"
35249 " sequence of chunks for FileIn param #0\n"
35250 " sequence of chunks for FileIn param #1 etc.\n"
35255 #: ../src/guestfs.pod:2318
35256 msgid "The \"sequence of chunks\" is:"
35260 #: ../src/guestfs.pod:2320
35263 " length of chunk (not including length word itself)\n"
35264 " struct guestfs_chunk (encoded as XDR)\n"
35265 " length of chunk\n"
35266 " struct guestfs_chunk (encoded as XDR)\n"
35268 " length of chunk\n"
35269 " struct guestfs_chunk (with data.data_len == 0)\n"
35274 #: ../src/guestfs.pod:2328
35276 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
35277 "is set in the final chunk to indicate either successful completion or early "
35282 #: ../src/guestfs.pod:2332
35284 "At time of writing there are no functions that have more than one FileIn "
35285 "parameter. However this is (theoretically) supported, by sending the "
35286 "sequence of chunks for each FileIn parameter one after another (from left to "
35291 #: ../src/guestfs.pod:2337
35293 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
35294 "transfer. The library does this by sending a chunk with a special flag set "
35295 "to indicate cancellation. When the daemon sees this, it cancels the whole "
35296 "RPC, does I<not> send any reply, and goes back to reading the next request."
35300 #: ../src/guestfs.pod:2343
35302 "The daemon may also cancel. It does this by writing a special word "
35303 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
35304 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
35305 "cancel chunk). The special word is chosen so that even if cancellation "
35306 "happens right at the end of the transfer (after the library has finished "
35307 "writing and has started listening for the reply), the \"spurious\" cancel "
35308 "flag will not be confused with the reply message."
35312 #: ../src/guestfs.pod:2352
35314 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
35315 "limit), and also files where the size is not known in advance (eg. from "
35316 "pipes or sockets). However the chunks are rather small "
35317 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
35318 "to keep much in memory."
35322 #: ../src/guestfs.pod:2358
35323 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
35327 #: ../src/guestfs.pod:2360
35329 "The protocol for FileOut parameters is exactly the same as for FileIn "
35330 "parameters, but with the roles of daemon and library reversed."
35334 #: ../src/guestfs.pod:2363
35337 " total length (header + ret,\n"
35338 " but not including the length word itself,\n"
35339 " and not including the chunks)\n"
35340 " struct guestfs_message_header (encoded as XDR)\n"
35341 " struct guestfs_<foo>_ret (encoded as XDR)\n"
35342 " sequence of chunks for FileOut param #0\n"
35343 " sequence of chunks for FileOut param #1 etc.\n"
35348 #: ../src/guestfs.pod:2371
35349 msgid "INITIAL MESSAGE"
35353 #: ../src/guestfs.pod:2373
35355 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
35356 "which indicates that the guest and daemon is alive. This is what L</"
35357 "guestfs_launch> waits for."
35361 #: ../src/guestfs.pod:2377
35362 msgid "PROGRESS NOTIFICATION MESSAGES"
35366 #: ../src/guestfs.pod:2379
35368 "The daemon may send progress notification messages at any time. These are "
35369 "distinguished by the normal length word being replaced by "
35370 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
35374 #: ../src/guestfs.pod:2383
35376 "The library turns them into progress callbacks (see L</"
35377 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
35382 #: ../src/guestfs.pod:2387
35384 "The daemon self-limits the frequency of progress messages it sends (see "
35385 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
35390 #: ../src/guestfs.pod:2391
35391 msgid "LIBGUESTFS VERSION NUMBERS"
35395 #: ../src/guestfs.pod:2393
35397 "Since April 2010, libguestfs has started to make separate development and "
35398 "stable releases, along with corresponding branches in our git repository. "
35399 "These separate releases can be identified by version number:"
35403 #: ../src/guestfs.pod:2398
35406 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
35407 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
35413 " | `-------- sub-version\n"
35415 " `------ always '1' because we don't change the ABI\n"
35420 #: ../src/guestfs.pod:2409
35421 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
35425 #: ../src/guestfs.pod:2411
35427 "As time passes we cherry pick fixes from the development branch and backport "
35428 "those into the stable branch, the effect being that the stable branch should "
35429 "get more stable and less buggy over time. So the stable releases are ideal "
35430 "for people who don't need new features but would just like the software to "
35435 #: ../src/guestfs.pod:2417
35436 msgid "Our criteria for backporting changes are:"
35440 #: ../src/guestfs.pod:2423
35442 "Documentation changes which don't affect any code are backported unless the "
35443 "documentation refers to a future feature which is not in stable."
35447 #: ../src/guestfs.pod:2429
35449 "Bug fixes which are not controversial, fix obvious problems, and have been "
35450 "well tested are backported."
35454 #: ../src/guestfs.pod:2434
35456 "Simple rearrangements of code which shouldn't affect how it works get "
35457 "backported. This is so that the code in the two branches doesn't get too "
35458 "far out of step, allowing us to backport future fixes more easily."
35462 #: ../src/guestfs.pod:2440
35464 "We I<don't> backport new features, new APIs, new tools etc, except in one "
35465 "exceptional case: the new feature is required in order to implement an "
35466 "important bug fix."
35470 #: ../src/guestfs.pod:2446
35472 "A new stable branch starts when we think the new features in development are "
35473 "substantial and compelling enough over the current stable branch to warrant "
35474 "it. When that happens we create new stable and development versions 1.N.0 "
35475 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
35476 "stable at this point, but by backporting fixes from development, that branch "
35477 "will stabilize over time."
35481 #: ../src/guestfs.pod:2454
35482 msgid "EXTENDING LIBGUESTFS"
35486 #: ../src/guestfs.pod:2456
35487 msgid "ADDING A NEW API ACTION"
35491 #: ../src/guestfs.pod:2458
35493 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
35494 "documentation) are generated, and this makes it easy to extend the "
35499 #: ../src/guestfs.pod:2462
35500 msgid "To add a new API action there are two changes:"
35504 #: ../src/guestfs.pod:2468
35506 "You need to add a description of the call (name, parameters, return type, "
35507 "tests, documentation) to C<generator/generator_actions.ml>."
35511 #: ../src/guestfs.pod:2471
35513 "There are two sorts of API action, depending on whether the call goes "
35514 "through to the daemon in the appliance, or is serviced entirely by the "
35515 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
35516 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
35517 "an example of the latter, since a trace flag is maintained in the handle and "
35518 "all tracing is done on the library side."
35522 #: ../src/guestfs.pod:2479
35524 "Most new actions are of the first type, and get added to the "
35525 "C<daemon_functions> list. Each function has a unique procedure number used "
35526 "in the RPC protocol which is assigned to that action when we publish "
35527 "libguestfs and cannot be reused. Take the latest procedure number and "
35532 #: ../src/guestfs.pod:2485
35534 "For library-only actions of the second type, add to the "
35535 "C<non_daemon_functions> list. Since these functions are serviced by the "
35536 "library and do not travel over the RPC mechanism to the daemon, these "
35537 "functions do not need a procedure number, and so the procedure number is set "
35542 #: ../src/guestfs.pod:2493
35543 msgid "Implement the action (in C):"
35547 #: ../src/guestfs.pod:2495
35549 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
35550 "C<daemon/> directory."
35554 #: ../src/guestfs.pod:2498
35556 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
35557 "(note: double underscore) in the C<src/> directory."
35561 #: ../src/guestfs.pod:2501
35562 msgid "In either case, use another function as an example of what to do."
35566 #: ../src/guestfs.pod:2505
35567 msgid "After making these changes, use C<make> to compile."
35571 #: ../src/guestfs.pod:2507
35573 "Note that you don't need to implement the RPC, language bindings, manual "
35574 "pages or anything else. It's all automatically generated from the OCaml "
35579 #: ../src/guestfs.pod:2511
35580 msgid "ADDING TESTS FOR AN API ACTION"
35584 #: ../src/guestfs.pod:2513
35586 "You can supply zero or as many tests as you want per API call. The tests "
35587 "can either be added as part of the API description (C<generator/"
35588 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
35589 "into C<regressions/>. Note that adding a script to C<regressions/> is "
35590 "slower, so if possible use the first method."
35594 #: ../src/guestfs.pod:2519
35596 "The following describes the test environment used when you add an API test "
35597 "in C<generator_actions.ml>."
35601 #: ../src/guestfs.pod:2522
35602 msgid "The test environment has 4 block devices:"
35606 #: ../src/guestfs.pod:2526
35607 msgid "C</dev/sda> 500MB"
35611 #: ../src/guestfs.pod:2528
35612 msgid "General block device for testing."
35616 #: ../src/guestfs.pod:2530
35617 msgid "C</dev/sdb> 50MB"
35621 #: ../src/guestfs.pod:2532
35623 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
35628 #: ../src/guestfs.pod:2535
35629 msgid "C</dev/sdc> 10MB"
35633 #: ../src/guestfs.pod:2537
35634 msgid "Used in a few tests where two block devices are needed."
35638 #: ../src/guestfs.pod:2539
35639 msgid "C</dev/sdd>"
35643 #: ../src/guestfs.pod:2541
35644 msgid "ISO with fixed content (see C<images/test.iso>)."
35648 #: ../src/guestfs.pod:2545
35650 "To be able to run the tests in a reasonable amount of time, the libguestfs "
35651 "appliance and block devices are reused between tests. So don't try testing "
35652 "L</guestfs_kill_subprocess> :-x"
35656 #: ../src/guestfs.pod:2549
35658 "Each test starts with an initial scenario, selected using one of the "
35659 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
35660 "initialize the disks mentioned above in a particular way as documented in "
35661 "C<generator_types.ml>. You should not assume anything about the previous "
35662 "contents of other disks that are not initialized."
35666 #: ../src/guestfs.pod:2555
35668 "You can add a prerequisite clause to any individual test. This is a run-"
35669 "time check, which, if it fails, causes the test to be skipped. Useful if "
35670 "testing a command which might not work on all variations of libguestfs "
35671 "builds. A test that has prerequisite of C<Always> means to run "
35676 #: ../src/guestfs.pod:2561
35678 "In addition, packagers can skip individual tests by setting environment "
35679 "variables before running C<make check>."
35683 #: ../src/guestfs.pod:2564
35686 " SKIP_TEST_<CMD>_<NUM>=1\n"
35691 #: ../src/guestfs.pod:2566
35692 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
35696 #: ../src/guestfs.pod:2568
35701 #: ../src/guestfs.pod:2570
35704 " SKIP_TEST_<CMD>=1\n"
35709 #: ../src/guestfs.pod:2572
35710 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
35714 #: ../src/guestfs.pod:2574
35715 msgid "Packagers can run only certain tests by setting for example:"
35719 #: ../src/guestfs.pod:2576
35722 " TEST_ONLY=\"vfs_type zerofree\"\n"
35727 #: ../src/guestfs.pod:2578
35729 "See C<capitests/tests.c> for more details of how these environment variables "
35734 #: ../src/guestfs.pod:2581
35735 msgid "DEBUGGING NEW API ACTIONS"
35739 #: ../src/guestfs.pod:2583
35740 msgid "Test new actions work before submitting them."
35744 #: ../src/guestfs.pod:2585
35745 msgid "You can use guestfish to try out new commands."
35749 #: ../src/guestfs.pod:2587
35751 "Debugging the daemon is a problem because it runs inside a minimal "
35752 "environment. However you can fprintf messages in the daemon to stderr, and "
35753 "they will show up if you use C<guestfish -v>."
35757 #: ../src/guestfs.pod:2591
35758 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
35762 #: ../src/guestfs.pod:2593
35764 "Our C source code generally adheres to some basic code-formatting "
35765 "conventions. The existing code base is not totally consistent on this "
35766 "front, but we do prefer that contributed code be formatted similarly. In "
35767 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
35768 "indentation level, and other than that, follow the K&R style."
35772 #: ../src/guestfs.pod:2599
35774 "If you use Emacs, add the following to one of one of your start-up files (e."
35775 "g., ~/.emacs), to help ensure that you get indentation right:"
35779 #: ../src/guestfs.pod:2602
35782 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
35783 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
35784 " (add-hook 'find-file-hook\n"
35785 " '(lambda () (if (and buffer-file-name\n"
35786 " (string-match \"/libguestfs\\\\>\"\n"
35787 " (buffer-file-name))\n"
35788 " (not (string-equal mode-name \"Change Log\"))\n"
35789 " (not (string-equal mode-name \"Makefile\")))\n"
35790 " (setq indent-tabs-mode nil))))\n"
35795 #: ../src/guestfs.pod:2612
35798 " ;;; When editing C sources in libguestfs, use this style.\n"
35799 " (defun libguestfs-c-mode ()\n"
35800 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
35802 " (c-set-style \"K&R\")\n"
35803 " (setq c-indent-level 2)\n"
35804 " (setq c-basic-offset 2))\n"
35805 " (add-hook 'c-mode-hook\n"
35806 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
35807 " (buffer-file-name))\n"
35808 " (libguestfs-c-mode))))\n"
35813 #: ../src/guestfs.pod:2624
35814 msgid "Enable warnings when compiling (and fix any problems this finds):"
35818 #: ../src/guestfs.pod:2627
35821 " ./configure --enable-gcc-warnings\n"
35826 #: ../src/guestfs.pod:2629
35827 msgid "Useful targets are:"
35831 #: ../src/guestfs.pod:2631
35834 " make syntax-check # checks the syntax of the C code\n"
35835 " make check # runs the test suite\n"
35840 #: ../src/guestfs.pod:2634
35841 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
35845 #: ../src/guestfs.pod:2636
35847 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
35848 "which are used to do shell quoting."
35852 #: ../src/guestfs.pod:2641
35857 #: ../src/guestfs.pod:2643
35859 "Simple shell quoted string. Any spaces or other shell characters are "
35864 #: ../src/guestfs.pod:2646
35869 #: ../src/guestfs.pod:2648
35871 "Same as C<%Q> except the string is treated as a path which is prefixed by "
35876 #: ../src/guestfs.pod:2655
35879 " asprintf (&cmd, \"cat %R\", path);\n"
35884 #: ../src/guestfs.pod:2657
35885 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
35889 #: ../src/guestfs.pod:2659
35891 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
35892 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
35893 "they are not passed via the shell (instead, straight to exec). You probably "
35894 "want to use the C<sysroot_path()> function however."
35898 #: ../src/guestfs.pod:2665
35899 msgid "SUBMITTING YOUR NEW API ACTIONS"
35903 #: ../src/guestfs.pod:2667
35905 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
35906 "libguestfs> and CC to L<rjones@redhat.com>."
35910 #: ../src/guestfs.pod:2671
35911 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
35915 #: ../src/guestfs.pod:2673
35916 msgid "We support i18n (gettext anyhow) in the library."
35920 #: ../src/guestfs.pod:2675
35922 "However many messages come from the daemon, and we don't translate those at "
35923 "the moment. One reason is that the appliance generally has all locale files "
35924 "removed from it, because they take up a lot of space. So we'd have to readd "
35925 "some of those, as well as copying our PO files into the appliance."
35929 #: ../src/guestfs.pod:2681
35931 "Debugging messages are never translated, since they are intended for the "
35936 #: ../src/guestfs.pod:2684
35937 msgid "SOURCE CODE SUBDIRECTORIES"
35941 #: ../src/guestfs.pod:2690
35942 msgid "The libguestfs appliance, build scripts and so on."
35946 #: ../src/guestfs.pod:2692
35947 msgid "C<capitests>"
35951 #: ../src/guestfs.pod:2694
35952 msgid "Automated tests of the C API."
35956 #: ../src/guestfs.pod:2696
35961 #: ../src/guestfs.pod:2698
35963 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
35968 #: ../src/guestfs.pod:2701
35973 #: ../src/guestfs.pod:2703
35975 "Safety and liveness tests of components that libguestfs depends upon (not of "
35976 "libguestfs itself). Mainly this is for qemu and the kernel."
35980 #: ../src/guestfs.pod:2706
35985 #: ../src/guestfs.pod:2708
35986 msgid "Outside contributions, experimental parts."
35990 #: ../src/guestfs.pod:2710
35995 #: ../src/guestfs.pod:2712
35997 "The daemon that runs inside the libguestfs appliance and carries out actions."
36001 #: ../src/guestfs.pod:2715
36006 #: ../src/guestfs.pod:2717
36007 msgid "L<virt-df(1)> command and documentation."
36011 #: ../src/guestfs.pod:2719
36016 #: ../src/guestfs.pod:2721
36017 msgid "L<virt-edit(1)> command and documentation."
36021 #: ../src/guestfs.pod:2723
36022 msgid "C<examples>"
36026 #: ../src/guestfs.pod:2725
36027 msgid "C API example code."
36031 #: ../src/guestfs.pod:2727
36036 #: ../src/guestfs.pod:2729
36038 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
36039 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
36040 "L<virt-tar-out(1)>."
36044 #: ../src/guestfs.pod:2733
36049 #: ../src/guestfs.pod:2735
36051 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
36055 #: ../src/guestfs.pod:2737
36056 msgid "C<generator>"
36060 #: ../src/guestfs.pod:2739
36062 "The crucially important generator, used to automatically generate large "
36063 "amounts of boilerplate C code for things like RPC and bindings."
36067 #: ../src/guestfs.pod:2742
36072 #: ../src/guestfs.pod:2744
36073 msgid "Files used by the test suite."
36077 #: ../src/guestfs.pod:2746
36078 msgid "Some \"phony\" guest images which we test against."
36082 #: ../src/guestfs.pod:2748
36083 msgid "C<inspector>"
36087 #: ../src/guestfs.pod:2750
36088 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
36092 #: ../src/guestfs.pod:2752
36097 #: ../src/guestfs.pod:2754
36098 msgid "Logo used on the website. The fish is called Arthur by the way."
36102 #: ../src/guestfs.pod:2756
36107 #: ../src/guestfs.pod:2758
36108 msgid "M4 macros used by autoconf."
36112 #: ../src/guestfs.pod:2760
36117 #: ../src/guestfs.pod:2762
36118 msgid "Translations of simple gettext strings."
36122 #: ../src/guestfs.pod:2764
36127 #: ../src/guestfs.pod:2766
36129 "The build infrastructure and PO files for translations of manpages and POD "
36130 "files. Eventually this will be combined with the C<po> directory, but that "
36131 "is rather complicated."
36135 #: ../src/guestfs.pod:2770
36136 msgid "C<regressions>"
36140 #: ../src/guestfs.pod:2772
36141 msgid "Regression tests."
36145 #: ../src/guestfs.pod:2774
36150 #: ../src/guestfs.pod:2776
36151 msgid "L<virt-rescue(1)> command and documentation."
36155 #: ../src/guestfs.pod:2778
36160 #: ../src/guestfs.pod:2780
36161 msgid "Source code to the C library."
36165 #: ../src/guestfs.pod:2782
36170 #: ../src/guestfs.pod:2784
36171 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
36175 #: ../src/guestfs.pod:2786
36176 msgid "C<test-tool>"
36180 #: ../src/guestfs.pod:2788
36182 "Test tool for end users to test if their qemu/kernel combination will work "
36187 #: ../src/guestfs.pod:2791
36192 #: ../src/guestfs.pod:2793
36197 #: ../src/guestfs.pod:2795
36202 #: ../src/guestfs.pod:2797
36207 #: ../src/guestfs.pod:2799
36212 #: ../src/guestfs.pod:2801
36217 #: ../src/guestfs.pod:2803
36222 #: ../src/guestfs.pod:2805
36227 #: ../src/guestfs.pod:2807
36228 msgid "Language bindings."
36232 #: ../src/guestfs.pod:2811
36233 msgid "MAKING A STABLE RELEASE"
36237 #: ../src/guestfs.pod:2813
36239 "When we make a stable release, there are several steps documented here. See "
36240 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
36245 #: ../src/guestfs.pod:2821
36247 "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
36251 #: ../src/guestfs.pod:2826
36252 msgid "Finalize RELEASE-NOTES."
36256 #: ../src/guestfs.pod:2830
36257 msgid "Update ROADMAP."
36261 #: ../src/guestfs.pod:2834
36262 msgid "Run C<src/api-support/update-from-tarballs.sh>."
36266 #: ../src/guestfs.pod:2838
36267 msgid "Push and pull from Transifex."
36271 #: ../src/guestfs.pod:2840
36276 #: ../src/guestfs.pod:2842
36284 #: ../src/guestfs.pod:2844
36285 msgid "to push the latest POT files to Transifex. Then run:"
36289 #: ../src/guestfs.pod:2846
36297 #: ../src/guestfs.pod:2848
36298 msgid "which is a wrapper to pull the latest translated C<*.po> files."
36302 #: ../src/guestfs.pod:2852
36304 "Create new stable and development directories under L<http://libguestfs.org/"
36309 #: ../src/guestfs.pod:2857
36310 msgid "Create the branch in git:"
36314 #: ../src/guestfs.pod:2859
36317 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
36318 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
36319 " git branch stable-1.XX\n"
36320 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
36325 #: ../src/guestfs.pod:2866
36330 #: ../src/guestfs.pod:2868
36331 msgid "PROTOCOL LIMITS"
36335 #: ../src/guestfs.pod:2870
36337 "Internally libguestfs uses a message-based protocol to pass API calls and "
36338 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
36339 "plenty more detail about this). The maximum message size used by the "
36340 "protocol is slightly less than 4 MB. For some API calls you may need to be "
36341 "aware of this limit. The API calls which may be affected are individually "
36342 "documented, with a link back to this section of the documentation."
36346 #: ../src/guestfs.pod:2878
36348 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
36349 "a simple string. Because this string is at some point internally encoded as "
36350 "a message, the maximum size that it can return is slightly under 4 MB. If "
36351 "the requested file is larger than this then you will get an error."
36355 #: ../src/guestfs.pod:2884
36357 "In order to transfer large files into and out of the guest filesystem, you "
36358 "need to use particular calls that support this. The sections L</UPLOADING> "
36359 "and L</DOWNLOADING> document how to do this."
36363 #: ../src/guestfs.pod:2888
36365 "You might also consider mounting the disk image using our FUSE filesystem "
36366 "support (L<guestmount(1)>)."
36370 #: ../src/guestfs.pod:2891
36371 msgid "MAXIMUM NUMBER OF DISKS"
36375 #: ../src/guestfs.pod:2893
36376 msgid "When using virtio disks (the default) the current limit is B<25> disks."
36380 #: ../src/guestfs.pod:2896
36382 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
36383 "slots. However febootstrap only understands disks with names C</dev/vda> "
36384 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
36389 #: ../src/guestfs.pod:2901
36391 "We are working to substantially raise this limit in future versions but it "
36392 "requires complex changes to qemu."
36396 #: ../src/guestfs.pod:2904
36398 "In future versions of libguestfs it should also be possible to \"hot plug\" "
36399 "disks (add and remove disks after calling L</guestfs_launch>). This also "
36400 "requires changes to qemu."
36404 #: ../src/guestfs.pod:2908
36405 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
36409 #: ../src/guestfs.pod:2910
36410 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
36414 #: ../src/guestfs.pod:2912
36416 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
36417 "vda>, and C</dev/vda1> through C</dev/vda15>)."
36421 #: ../src/guestfs.pod:2915
36423 "If you attach a disk with more than 15 partitions, the extra partitions are "
36424 "ignored by libguestfs."
36428 #: ../src/guestfs.pod:2918
36429 msgid "MAXIMUM SIZE OF A DISK"
36433 #: ../src/guestfs.pod:2920
36434 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
36438 #: ../src/guestfs.pod:2922
36440 "We have tested block devices up to 1 exabyte (2**60 or "
36441 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
36446 #: ../src/guestfs.pod:2926
36448 "Although libguestfs probably does not impose any limit, the underlying host "
36449 "storage will. If you store disk images on a host ext4 filesystem, then the "
36450 "maximum size will be limited by the maximum ext4 file size (currently 16 "
36451 "TB). If you store disk images as host logical volumes then you are limited "
36452 "by the maximum size of an LV."
36456 #: ../src/guestfs.pod:2932
36458 "For the hugest disk image files, we recommend using XFS on the host for "
36463 #: ../src/guestfs.pod:2935
36464 msgid "MAXIMUM SIZE OF A PARTITION"
36468 #: ../src/guestfs.pod:2937
36470 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
36471 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
36472 "address a partition located beyond 2 TB on the disk."
36476 #: ../src/guestfs.pod:2941
36478 "It is recommended that you use GPT partitions on disks which are larger than "
36479 "this size. GPT uses 64 bit sector numbers and so can address partitions "
36480 "which are theoretically larger than the largest disk we could support."
36484 #: ../src/guestfs.pod:2946
36485 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
36489 #: ../src/guestfs.pod:2948
36491 "This depends on the filesystem type. libguestfs itself does not impose any "
36492 "known limit. Consult Wikipedia or the filesystem documentation to find out "
36493 "what these limits are."
36497 #: ../src/guestfs.pod:2952
36498 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
36502 #: ../src/guestfs.pod:2954
36504 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
36505 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
36506 "uploads and downloads."
36510 #: ../src/guestfs.pod:2958
36511 msgid "INSPECTION LIMITS"
36515 #: ../src/guestfs.pod:2960
36517 "The inspection code has several arbitrary limits on things like the size of "
36518 "Windows Registry hive it will read, and the length of product name. These "
36519 "are intended to stop a malicious guest from consuming arbitrary amounts of "
36520 "memory and disk space on the host, and should not be reached in practice. "
36521 "See the source code for more information."
36525 #: ../src/guestfs.pod:2986
36527 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
36528 "effect as calling C<guestfs_set_verbose (g, 1)>."
36532 #: ../src/guestfs.pod:2998
36534 "Set the path that libguestfs uses to search for a supermin appliance. See "
36535 "the discussion of paths in section L</PATH> above."
36539 #: ../src/guestfs.pod:3007
36540 msgid "See also L</QEMU WRAPPERS> above."
36544 #: ../src/guestfs.pod:3011
36546 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
36547 "effect as calling C<guestfs_set_trace (g, 1)>."
36551 #: ../src/guestfs.pod:3029
36553 "L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-"
36554 "perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, L<guestfish(1)>, "
36555 "L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
36556 "L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)"
36557 ">, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
36558 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
36559 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
36560 "L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<http://libguestfs.org/>."
36564 #: ../src/guestfs.pod:3059
36566 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
36567 "(8)>, L<disktype(1)>."
36571 #: ../src/guestfs.pod:3066 ../tools/virt-make-fs.pl:553
36572 #: ../tools/virt-win-reg.pl:761
36577 #: ../src/guestfs.pod:3068
36578 msgid "To get a list of bugs against libguestfs use this link:"
36582 #: ../src/guestfs.pod:3070
36584 "L<https://bugzilla.redhat.com/buglist.cgi?"
36585 "component=libguestfs&product=Virtualization+Tools>"
36589 #: ../src/guestfs.pod:3072
36590 msgid "To report a new bug against libguestfs use this link:"
36594 #: ../src/guestfs.pod:3074
36596 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
36597 "component=libguestfs&product=Virtualization+Tools>"
36601 #: ../src/guestfs.pod:3076
36602 msgid "When reporting a bug, please check:"
36606 #: ../src/guestfs.pod:3082
36607 msgid "That the bug hasn't been reported already."
36611 #: ../src/guestfs.pod:3086
36612 msgid "That you are testing a recent version."
36616 #: ../src/guestfs.pod:3090
36617 msgid "Describe the bug accurately, and give a way to reproduce it."
36621 #: ../src/guestfs.pod:3094
36623 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
36628 #: ../test-tool/libguestfs-test-tool.pod:5
36629 msgid "libguestfs-test-tool - End user tests for libguestfs"
36633 #: ../test-tool/libguestfs-test-tool.pod:9
36636 " libguestfs-test-tool [--options]\n"
36641 #: ../test-tool/libguestfs-test-tool.pod:13
36643 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
36644 "and developers, to allow them to check basic libguestfs functionality is "
36645 "working. This is needed because libguestfs occasionally breaks for reasons "
36646 "beyond our control: usually because of changes in the underlying qemu or "
36647 "kernel packages, or the host environment."
36651 #: ../test-tool/libguestfs-test-tool.pod:20
36652 msgid "If you suspect a problem in libguestfs, then just run:"
36656 #: ../test-tool/libguestfs-test-tool.pod:22
36659 " libguestfs-test-tool\n"
36664 #: ../test-tool/libguestfs-test-tool.pod:24
36665 msgid "It will print lots of diagnostic messages."
36669 #: ../test-tool/libguestfs-test-tool.pod:26
36670 msgid "If it runs to completion successfully, you will see this near the end:"
36674 #: ../test-tool/libguestfs-test-tool.pod:28
36677 " ===== TEST FINISHED OK =====\n"
36682 #: ../test-tool/libguestfs-test-tool.pod:30
36683 msgid "and the test tool will exit with code 0."
36687 #: ../test-tool/libguestfs-test-tool.pod:32
36689 "If it fails (and/or exits with non-zero error code), please paste the "
36690 "B<complete, unedited> output of the test tool into a bug report. More "
36691 "information about reporting bugs can be found on the L<http://libguestfs.org/"
36696 #: ../test-tool/libguestfs-test-tool.pod:41
36701 #: ../test-tool/libguestfs-test-tool.pod:43
36702 msgid "Display short usage information and exit."
36706 #: ../test-tool/libguestfs-test-tool.pod:45
36707 msgid "I<--qemu qemu_binary>"
36711 #: ../test-tool/libguestfs-test-tool.pod:47
36713 "If you have downloaded another qemu binary, point this option at the full "
36714 "path of the binary to try it."
36718 #: ../test-tool/libguestfs-test-tool.pod:50
36719 msgid "I<--qemudir qemu_source_dir>"
36723 #: ../test-tool/libguestfs-test-tool.pod:52
36725 "If you have compiled qemu from source, point this option at the source "
36726 "directory to try it."
36730 #: ../test-tool/libguestfs-test-tool.pod:55
36731 msgid "I<--timeout N>"
36735 #: ../test-tool/libguestfs-test-tool.pod:57
36737 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
36738 "does not usually need to be adjusted unless your machine is very slow."
36742 #: ../test-tool/libguestfs-test-tool.pod:63
36743 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
36747 #: ../test-tool/libguestfs-test-tool.pod:65
36749 "If you have compiled another version of qemu from source and would like to "
36750 "try that, then you can use the I<--qemudir> option to point to the qemu "
36751 "source directory."
36755 #: ../test-tool/libguestfs-test-tool.pod:69
36757 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
36758 "option to point to the binary."
36762 #: ../test-tool/libguestfs-test-tool.pod:72
36764 "When using an alternate qemu with libguestfs, usually you would need to "
36765 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
36766 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
36767 "use either of the I<--qemudir> or I<--qemu> options."
36771 #: ../test-tool/libguestfs-test-tool.pod:79
36773 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
36774 "I<1> if there was an error."
36778 #: ../test-tool/libguestfs-test-tool.pod:84
36780 "For the full list of environment variables which may affect libguestfs, "
36781 "please see the L<guestfs(3)> manual page."
36785 #: ../test-tool/libguestfs-test-tool.pod:89
36786 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
36790 #: ../tools/virt-list-filesystems.pl:32
36792 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
36796 #: ../tools/virt-list-filesystems.pl:36
36799 " virt-list-filesystems [--options] domname\n"
36804 #: ../tools/virt-list-filesystems.pl:38
36807 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
36812 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
36814 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
36819 #: ../tools/virt-list-filesystems.pl:45
36821 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
36822 "are contained in a virtual machine or disk image."
36826 #: ../tools/virt-list-filesystems.pl:49
36828 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
36829 "functionality. For more complex cases you should look at the L<guestfish(1)"
36834 #: ../tools/virt-list-filesystems.pl:112
36836 "With this option, C<virt-list-filesystems> displays the type of each "
36837 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
36841 #: ../tools/virt-list-filesystems.pl:119
36846 #: ../tools/virt-list-filesystems.pl:123
36848 "Normally we only show mountable filesystems. If this option is given then "
36849 "swap devices are shown too."
36853 #: ../tools/virt-list-filesystems.pl:197
36855 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
36856 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
36857 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36861 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
36862 msgid "Copyright (C) 2009 Red Hat Inc."
36866 #: ../tools/virt-list-partitions.pl:32
36868 "virt-list-partitions - List partitions in a virtual machine or disk image"
36872 #: ../tools/virt-list-partitions.pl:36
36875 " virt-list-partitions [--options] domname\n"
36880 #: ../tools/virt-list-partitions.pl:38
36883 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
36888 #: ../tools/virt-list-partitions.pl:45
36890 "C<virt-list-partitions> is a command line tool to list the partitions that "
36891 "are contained in a virtual machine or disk image. It is mainly useful as a "
36892 "first step to using L<virt-resize(1)>."
36896 #: ../tools/virt-list-partitions.pl:50
36898 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
36899 "functionality. For more complex cases you should look at the L<guestfish(1)"
36904 #: ../tools/virt-list-partitions.pl:113
36905 msgid "Show sizes in human-readable form (eg. \"1G\")."
36909 #: ../tools/virt-list-partitions.pl:123
36911 "With this option, C<virt-list-partitions> displays the type and size of each "
36912 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
36916 #: ../tools/virt-list-partitions.pl:130
36921 #: ../tools/virt-list-partitions.pl:132
36926 #: ../tools/virt-list-partitions.pl:134
36928 "Display the total size of each block device (as a separate row or rows)."
36932 #: ../tools/virt-list-partitions.pl:267
36934 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
36935 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
36936 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36940 #: ../tools/virt-list-partitions.pl:283
36941 msgid "Copyright (C) 2009-2010 Red Hat Inc."
36945 #: ../tools/virt-make-fs.pl:37
36946 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
36950 #: ../tools/virt-make-fs.pl:41
36953 " virt-make-fs [--options] input.tar output.img\n"
36958 #: ../tools/virt-make-fs.pl:43
36961 " virt-make-fs [--options] input.tar.gz output.img\n"
36966 #: ../tools/virt-make-fs.pl:45
36969 " virt-make-fs [--options] directory output.img\n"
36974 #: ../tools/virt-make-fs.pl:49
36976 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
36977 "archive or some files in a directory. It is similar to tools like L<mkisofs"
36978 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
36979 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
36980 "you want to attach these filesystems to existing virtual machines (eg. to "
36981 "import large amounts of read-only data to a VM)."
36985 #: ../tools/virt-make-fs.pl:57
36986 msgid "Basic usage is:"
36990 #: ../tools/virt-make-fs.pl:59
36993 " virt-make-fs input output\n"
36998 #: ../tools/virt-make-fs.pl:61
37000 "where C<input> is either a directory containing files that you want to add, "
37001 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
37002 "C<output> is a disk image. The input type is detected automatically. The "
37003 "output disk image defaults to a raw ext2 image unless you specify extra "
37004 "flags (see L</OPTIONS> below)."
37008 #: ../tools/virt-make-fs.pl:67
37009 msgid "EXTRA SPACE"
37013 #: ../tools/virt-make-fs.pl:69
37015 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
37016 "the files that it contains, but might have extra space. Depending on how "
37017 "you are going to use the output, you might think this extra space is wasted "
37018 "and want to minimize it, or you might want to leave space so that more files "
37019 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
37020 "but you can use the I<--size> flag to leave space in the filesystem if you "
37025 #: ../tools/virt-make-fs.pl:77
37027 "An alternative way to leave extra space but not make the output image any "
37028 "bigger is to use an alternative disk image format (instead of the default "
37029 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
37030 "image format (check your hypervisor supports this before using it). This "
37031 "allows you to choose a large I<--size> but the extra space won't actually be "
37032 "allocated in the image until you try to store something in it."
37036 #: ../tools/virt-make-fs.pl:85
37038 "Don't forget that you can also use local commands including L<resize2fs(8)> "
37039 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
37040 "to build another image from scratch."
37044 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
37045 #: ../tools/virt-make-fs.pl:142
37050 #: ../tools/virt-make-fs.pl:91
37053 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
37058 #: ../tools/virt-make-fs.pl:93
37059 msgid "FILESYSTEM TYPE"
37063 #: ../tools/virt-make-fs.pl:95
37065 "The default filesystem type is C<ext2>. Just about any filesystem type that "
37066 "libguestfs supports can be used (but I<not> read-only formats like "
37067 "ISO9660). Here are some of the more common choices:"
37071 #: ../tools/virt-make-fs.pl:101
37076 #: ../tools/virt-make-fs.pl:103
37078 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
37079 "you are not going to use the filesystem in a way that requires the journal, "
37080 "then this is just wasted overhead."
37084 #: ../tools/virt-make-fs.pl:107
37085 msgid "I<ntfs> or I<vfat>"
37089 #: ../tools/virt-make-fs.pl:109
37090 msgid "Useful if exporting data to a Windows guest."
37094 #: ../tools/virt-make-fs.pl:111
37096 "I<Note for vfat>: The tar archive or local directory must only contain files "
37097 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
37098 "program running within libguestfs is unable to change the ownership of non-"
37099 "root files, since vfat itself does not support this."
37103 #: ../tools/virt-make-fs.pl:116
37108 #: ../tools/virt-make-fs.pl:118
37110 "Lower overhead than C<ext2>, but certain limitations on filename length and "
37111 "total filesystem size."
37115 #: ../tools/virt-make-fs.pl:125
37118 " virt-make-fs --type=minix input minixfs.img\n"
37123 #: ../tools/virt-make-fs.pl:127
37124 msgid "TO PARTITION OR NOT TO PARTITION"
37128 #: ../tools/virt-make-fs.pl:129
37129 msgid "Optionally virt-make-fs can add a partition table to the output disk."
37133 #: ../tools/virt-make-fs.pl:131
37135 "Adding a partition can make the disk image more compatible with certain "
37136 "virtualized operating systems which don't expect to see a filesystem "
37137 "directly located on a block device (Linux doesn't care and will happily "
37138 "handle both types)."
37142 #: ../tools/virt-make-fs.pl:136
37144 "On the other hand, if you have a partition table then the output image is no "
37145 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
37146 "directly on a partitioned disk image. (However libguestfs tools such as "
37147 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
37151 #: ../tools/virt-make-fs.pl:144
37152 msgid "Add an MBR partition:"
37156 #: ../tools/virt-make-fs.pl:146
37159 " virt-make-fs --partition -- input disk.img\n"
37164 #: ../tools/virt-make-fs.pl:148
37166 "If the output disk image could be terabyte-sized or larger, it's better to "
37167 "use an EFI/GPT-compatible partition table:"
37171 #: ../tools/virt-make-fs.pl:151
37174 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
37179 #: ../tools/virt-make-fs.pl:179
37180 msgid "Enable debugging information."
37184 #: ../tools/virt-make-fs.pl:185
37185 msgid "B<--size=E<lt>NE<gt>>"
37189 #: ../tools/virt-make-fs.pl:187
37190 msgid "B<--size=+E<lt>NE<gt>>"
37194 #: ../tools/virt-make-fs.pl:189
37195 msgid "B<-s E<lt>NE<gt>>"
37199 #: ../tools/virt-make-fs.pl:191
37200 msgid "B<-s +E<lt>NE<gt>>"
37204 #: ../tools/virt-make-fs.pl:193
37206 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
37210 #: ../tools/virt-make-fs.pl:196
37212 "If this option is I<not> given, then the output image will be just large "
37213 "enough to contain all the files, with not much wasted space."
37217 #: ../tools/virt-make-fs.pl:199
37219 "To choose a fixed size output disk, specify an absolute number followed by b/"
37220 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
37221 "Petabytes or Exabytes. This must be large enough to contain all the input "
37222 "files, else you will get an error."
37226 #: ../tools/virt-make-fs.pl:204
37228 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
37229 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
37230 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
37231 "the input files, and (approximately) an extra 200 MB free space."
37235 #: ../tools/virt-make-fs.pl:210
37237 "Note that virt-make-fs estimates free space, and therefore will not produce "
37238 "filesystems containing precisely the free space requested. (It is much more "
37239 "expensive and time-consuming to produce a filesystem which has precisely the "
37240 "desired free space)."
37244 #: ../tools/virt-make-fs.pl:219
37245 msgid "B<--format=E<lt>fmtE<gt>>"
37249 #: ../tools/virt-make-fs.pl:221
37250 msgid "B<-F E<lt>fmtE<gt>>"
37254 #: ../tools/virt-make-fs.pl:223
37255 msgid "Choose the output disk image format."
37259 #: ../tools/virt-make-fs.pl:225
37260 msgid "The default is C<raw> (raw disk image)."
37264 #: ../tools/virt-make-fs.pl:227
37266 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
37267 "that would really make sense here is C<qcow2>."
37271 #: ../tools/virt-make-fs.pl:234
37272 msgid "B<--type=E<lt>fsE<gt>>"
37276 #: ../tools/virt-make-fs.pl:236
37277 msgid "B<-t E<lt>fsE<gt>>"
37281 #: ../tools/virt-make-fs.pl:238
37282 msgid "Choose the output filesystem type."
37286 #: ../tools/virt-make-fs.pl:240
37287 msgid "The default is C<ext2>."
37291 #: ../tools/virt-make-fs.pl:242
37293 "Any filesystem which is supported read-write by libguestfs can be used here."
37297 #: ../tools/virt-make-fs.pl:249
37298 msgid "B<--partition>"
37302 #: ../tools/virt-make-fs.pl:251
37303 msgid "B<--partition=E<lt>parttypeE<gt>>"
37307 #: ../tools/virt-make-fs.pl:253
37309 "If specified, this flag adds an MBR partition table to the output disk image."
37313 #: ../tools/virt-make-fs.pl:256
37315 "You can change the partition table type, eg. I<--partition=gpt> for large "
37320 #: ../tools/virt-make-fs.pl:259
37322 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
37323 "might consider the next parameter to be the partition type. For example:"
37327 #: ../tools/virt-make-fs.pl:263
37330 " virt-make-fs --partition input.tar ...\n"
37335 #: ../tools/virt-make-fs.pl:265
37337 "would cause virt-make-fs to think you wanted to use a partition type of "
37338 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
37339 "dash) between options and the input file argument:"
37343 #: ../tools/virt-make-fs.pl:269
37346 " virt-make-fs --partition -- input.tar ...\n"
37351 #: ../tools/virt-make-fs.pl:541
37353 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
37354 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
37355 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
37359 #: ../tools/virt-make-fs.pl:555 ../tools/virt-win-reg.pl:763
37361 "When reporting bugs, please enable debugging and capture the I<complete> "
37366 #: ../tools/virt-make-fs.pl:558
37369 " export LIBGUESTFS_DEBUG=1\n"
37370 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
37375 #: ../tools/virt-make-fs.pl:561
37377 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
37382 #: ../tools/virt-tar.pl:33
37383 msgid "virt-tar - Extract or upload files to a virtual machine"
37387 #: ../tools/virt-tar.pl:37
37390 " virt-tar [--options] -x domname directory tarball\n"
37395 #: ../tools/virt-tar.pl:39
37398 " virt-tar [--options] -u domname tarball directory\n"
37403 #: ../tools/virt-tar.pl:41
37406 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
37411 #: ../tools/virt-tar.pl:43
37414 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
37419 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
37424 #: ../tools/virt-tar.pl:47
37426 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
37427 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
37431 #: ../tools/virt-tar.pl:52
37432 msgid "Download C</home> from the VM into a local tarball:"
37436 #: ../tools/virt-tar.pl:54
37439 " virt-tar -x domname /home home.tar\n"
37444 #: ../tools/virt-tar.pl:56
37447 " virt-tar -zx domname /home home.tar.gz\n"
37452 #: ../tools/virt-tar.pl:58
37453 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
37457 #: ../tools/virt-tar.pl:60
37460 " virt-tar -u domname uploadstuff.tar /tmp\n"
37465 #: ../tools/virt-tar.pl:62
37468 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
37473 #: ../tools/virt-tar.pl:66
37475 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
37476 "virtual machines. If you do this, you risk disk corruption in the VM. "
37477 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
37481 #: ../tools/virt-tar.pl:71
37483 "You can use I<-x> (extract) on live virtual machines, but you might get "
37484 "inconsistent results or errors if there is filesystem activity inside the "
37485 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
37486 "work, but the only way to guarantee consistent results is if the virtual "
37487 "machine is shut down."
37491 #: ../tools/virt-tar.pl:79
37493 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
37494 "parts of a guest filesystem. There are many possibilities: making backups, "
37495 "uploading data files, snooping on guest activity, fixing or customizing "
37500 #: ../tools/virt-tar.pl:84
37502 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
37503 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
37504 "should look at the L<guestfish(1)> tool."
37508 #: ../tools/virt-tar.pl:88
37510 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
37511 "its contents (recursively) from the virtual machine into a local tarball. "
37512 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
37513 "virtual machine. You cannot use these two options together."
37517 #: ../tools/virt-tar.pl:94
37519 "In addition, you may need to use the I<-z> (gZip) option to enable "
37520 "compression. When uploading, you have to specify I<-z> if the upload file "
37521 "is compressed because virt-tar won't detect this on its own."
37525 #: ../tools/virt-tar.pl:98
37527 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
37528 "example it cannot do PKZip files or bzip2 compression. If you want that "
37529 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
37530 "the L<libguestfs(3)> API)."
37534 #: ../tools/virt-tar.pl:160
37535 msgid "B<--extract>"
37539 #: ../tools/virt-tar.pl:162
37540 msgid "B<--download>"
37544 #: ../tools/virt-tar.pl:164
37549 #: ../tools/virt-tar.pl:166
37550 msgid "B<--upload>"
37554 #: ../tools/virt-tar.pl:168
37556 "Use I<-x> to extract (download) a directory from a virtual machine to a "
37561 #: ../tools/virt-tar.pl:171
37563 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
37564 "Please read the L</WARNING> section above before using this option."
37568 #: ../tools/virt-tar.pl:175
37569 msgid "You must specify exactly one of these options."
37573 #: ../tools/virt-tar.pl:181
37578 #: ../tools/virt-tar.pl:183
37583 #: ../tools/virt-tar.pl:185
37584 msgid "Specify that the input or output tarball is gzip-compressed."
37588 #: ../tools/virt-tar.pl:298
37590 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
37591 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
37592 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
37597 #: ../tools/virt-win-reg.pl:37
37599 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
37603 #: ../tools/virt-win-reg.pl:41
37606 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
37611 #: ../tools/virt-win-reg.pl:43
37614 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
37619 #: ../tools/virt-win-reg.pl:45
37622 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
37627 #: ../tools/virt-win-reg.pl:47
37630 " virt-win-reg --merge domname [input.reg ...]\n"
37635 #: ../tools/virt-win-reg.pl:49
37638 " virt-win-reg [--options] disk.img ... # instead of domname\n"
37643 #: ../tools/virt-win-reg.pl:53
37645 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
37646 "virtual machines. If you do this, you I<will> get irreversible disk "
37647 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
37648 "but doesn't catch all cases."
37652 #: ../tools/virt-win-reg.pl:58
37654 "Modifying the Windows Registry is an inherently risky operation. The format "
37655 "is deliberately obscure and undocumented, and Registry changes can leave the "
37656 "system unbootable. Therefore when using the I<--merge> option, make sure "
37657 "you have a reliable backup first."
37661 #: ../tools/virt-win-reg.pl:65
37663 "This program can export and merge Windows Registry entries from a Windows "
37668 #: ../tools/virt-win-reg.pl:68
37670 "The first parameter is the libvirt guest name or the raw disk image of a "
37675 #: ../tools/virt-win-reg.pl:71
37677 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
37678 "exported (recursively). For example:"
37682 #: ../tools/virt-win-reg.pl:74
37685 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
37690 #: ../tools/virt-win-reg.pl:76
37692 "You can also display single values from within registry keys, for example:"
37696 #: ../tools/virt-win-reg.pl:79
37699 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
37700 " $ virt-win-reg Windows7 $cvkey ProductName\n"
37701 " Windows 7 Enterprise\n"
37706 #: ../tools/virt-win-reg.pl:83
37708 "With I<--merge>, you can merge a textual regedit file into the Windows "
37713 #: ../tools/virt-win-reg.pl:86
37716 " $ virt-win-reg --merge Windows7 changes.reg\n"
37721 #: ../tools/virt-win-reg.pl:90
37723 "This program is only meant for simple access to the registry. If you want "
37724 "to do complicated things with the registry, we suggest you download the "
37725 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
37726 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
37727 "L<hivexregedit(1)>."
37731 #: ../tools/virt-win-reg.pl:159
37736 #: ../tools/virt-win-reg.pl:161
37738 "In merge mode, this merges a textual regedit file into the Windows Registry "
37739 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
37740 "displays or exports Registry entries instead."
37744 #: ../tools/virt-win-reg.pl:165
37746 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
37747 "result in disk corruption. However exporting (without this flag) is always "
37752 #: ../tools/virt-win-reg.pl:173
37753 msgid "B<--encoding> UTF-16LE|ASCII"
37757 #: ../tools/virt-win-reg.pl:175
37759 "When merging (only), you may need to specify the encoding for strings to be "
37760 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
37761 "(3)/ENCODING STRINGS>."
37765 #: ../tools/virt-win-reg.pl:179
37767 "The default is to use UTF-16LE, which should work with recent versions of "
37772 #: ../tools/virt-win-reg.pl:186
37773 msgid "B<--unsafe-printable-strings>"
37777 #: ../tools/virt-win-reg.pl:188
37779 "When exporting (only), assume strings are UTF-16LE and print them as strings "
37780 "instead of hex sequences. Remove the final zero codepoint from strings if "
37785 #: ../tools/virt-win-reg.pl:192
37787 "This is unsafe and does not preserve the fidelity of strings in the original "
37788 "Registry for various reasons:"
37792 #: ../tools/virt-win-reg.pl:199
37794 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
37795 "other encodings will be corrupted by this transformation."
37799 #: ../tools/virt-win-reg.pl:204
37801 "Assumes that everything which has type 1 or 2 is really a string and that "
37802 "everything else is not a string, but the type field in real Registries is "
37807 #: ../tools/virt-win-reg.pl:210
37809 "Loses information about whether a zero codepoint followed the string in the "
37814 #: ../tools/virt-win-reg.pl:215
37816 "This all happens because the Registry itself contains no information about "
37817 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
37821 #: ../tools/virt-win-reg.pl:219
37823 "You should only use this option for quick hacking and debugging of the "
37824 "Registry contents, and I<never> use it if the output is going to be passed "
37825 "into another program or stored in another Registry."
37829 #: ../tools/virt-win-reg.pl:556
37830 msgid "SUPPORTED SYSTEMS"
37834 #: ../tools/virt-win-reg.pl:558
37836 "The program currently supports Windows NT-derived guests starting with "
37837 "Windows XP through to at least Windows 7."
37841 #: ../tools/virt-win-reg.pl:561
37842 msgid "The following Registry keys are supported:"
37846 #: ../tools/virt-win-reg.pl:565
37847 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
37851 #: ../tools/virt-win-reg.pl:567
37852 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
37856 #: ../tools/virt-win-reg.pl:569
37857 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
37861 #: ../tools/virt-win-reg.pl:571
37862 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
37866 #: ../tools/virt-win-reg.pl:573
37867 msgid "C<HKEY_USERS\\.DEFAULT>"
37871 #: ../tools/virt-win-reg.pl:575
37872 msgid "C<HKEY_USERS\\I<SID>>"
37876 #: ../tools/virt-win-reg.pl:577
37877 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
37881 #: ../tools/virt-win-reg.pl:579
37882 msgid "C<HKEY_USERS\\I<username>>"
37886 #: ../tools/virt-win-reg.pl:581
37888 "where I<username> is a local user name (this is a libguestfs extension)."
37892 #: ../tools/virt-win-reg.pl:585
37894 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
37899 #: ../tools/virt-win-reg.pl:588
37901 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
37902 "supported (there is no \"current user\")."
37906 #: ../tools/virt-win-reg.pl:591
37911 #: ../tools/virt-win-reg.pl:593
37913 "C<virt-win-reg> expects that regedit files have already been reencoded in "
37914 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
37915 "style line endings. Since Windows regedit files are often in UTF-16LE with "
37916 "Windows-style line endings, you may need to reencode the whole file before "
37917 "or after processing."
37921 #: ../tools/virt-win-reg.pl:599
37923 "To reencode a file from Windows format to Linux (before processing it with "
37924 "the I<--merge> option), you would do something like this:"
37928 #: ../tools/virt-win-reg.pl:602
37931 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
37936 #: ../tools/virt-win-reg.pl:604
37938 "To go in the opposite direction, after exporting and before sending the file "
37939 "to a Windows user, do something like this:"
37943 #: ../tools/virt-win-reg.pl:607
37946 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
37951 #: ../tools/virt-win-reg.pl:609
37952 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
37956 #: ../tools/virt-win-reg.pl:611
37958 "If you are unsure about the current encoding, use the L<file(1)> command. "
37959 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
37960 "style (CRLF) line endings, like this:"
37964 #: ../tools/virt-win-reg.pl:615
37967 " $ file software.reg\n"
37968 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
37969 " with CRLF line terminators\n"
37974 #: ../tools/virt-win-reg.pl:619
37975 msgid "This file would need conversion before you could I<--merge> it."
37979 #: ../tools/virt-win-reg.pl:621
37980 msgid "CurrentControlSet etc."
37984 #: ../tools/virt-win-reg.pl:623
37986 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
37987 "Registry at the level of the hive file, and therefore you cannot modify "
37992 #: ../tools/virt-win-reg.pl:627
37994 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
37995 "circumstances it might refer to another control set. The way to find out is "
37996 "to look at the C<HKLM\\SYSTEM\\Select> key:"
38000 #: ../tools/virt-win-reg.pl:631
38003 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
38004 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
38005 " \"Current\"=dword:00000001\n"
38006 " \"Default\"=dword:00000001\n"
38007 " \"Failed\"=dword:00000000\n"
38008 " \"LastKnownGood\"=dword:00000002\n"
38013 #: ../tools/virt-win-reg.pl:638
38014 msgid "\"Current\" is the one which Windows will choose when it boots."
38018 #: ../tools/virt-win-reg.pl:640
38020 "Similarly, other C<Current...> keys in the path may need to be replaced."
38024 #: ../tools/virt-win-reg.pl:643
38025 msgid "WINDOWS TIPS"
38029 #: ../tools/virt-win-reg.pl:645
38031 "Note that some of these tips modify the guest disk image. The guest I<must> "
38032 "be shut off, else you will get disk corruption."
38036 #: ../tools/virt-win-reg.pl:648
38037 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
38041 #: ../tools/virt-win-reg.pl:650
38043 "Prepare a DOS batch script, VBScript or executable. Upload this using "
38044 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
38045 "is uploaded into C<C:\\>:"
38049 #: ../tools/virt-win-reg.pl:654
38052 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
38057 #: ../tools/virt-win-reg.pl:656
38058 msgid "Prepare a regedit file containing the registry change:"
38062 #: ../tools/virt-win-reg.pl:658
38065 " cat > test.reg <<'EOF'\n"
38066 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
38067 " \"Test\"=\"c:\\\\test.bat\"\n"
38073 #: ../tools/virt-win-reg.pl:663
38075 "In this example we use the key C<RunOnce> which means that the script will "
38076 "run precisely once when the first user logs in. If you want it to run every "
38077 "time a user logs in, replace C<RunOnce> with C<Run>."
38081 #: ../tools/virt-win-reg.pl:667
38082 msgid "Now update the registry:"
38086 #: ../tools/virt-win-reg.pl:669
38089 " virt-win-reg --merge WindowsGuest test.reg\n"
38094 #: ../tools/virt-win-reg.pl:671
38095 msgid "INSTALLING A SERVICE"
38099 #: ../tools/virt-win-reg.pl:673
38101 "This section assumes you are familiar with Windows services, and you either "
38102 "have a program which handles the Windows Service Control Protocol directly "
38103 "or you want to run any program using a service wrapper like SrvAny or the "
38108 #: ../tools/virt-win-reg.pl:678
38110 "First upload the program and optionally the service wrapper. In this case "
38111 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
38115 #: ../tools/virt-win-reg.pl:682
38118 " guestfish -i -d WindowsGuest <<EOF\n"
38119 " upload rhsrvany.exe /rhsrvany.exe\n"
38120 " upload test.exe /test.exe\n"
38126 #: ../tools/virt-win-reg.pl:687
38128 "Prepare a regedit file containing the registry changes. In this example, "
38129 "the first registry change is needed for the service itself or the service "
38130 "wrapper (if used). The second registry change is only needed because I am "
38131 "using the RHSrvAny service wrapper."
38135 #: ../tools/virt-win-reg.pl:692
38138 " cat > service.reg <<'EOF'\n"
38139 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
38140 " \"Type\"=dword:00000010\n"
38141 " \"Start\"=dword:00000002\n"
38142 " \"ErrorControl\"=dword:00000001\n"
38143 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
38144 " \"DisplayName\"=\"RHSrvAny\"\n"
38145 " \"ObjectName\"=\"NetworkService\"\n"
38150 #: ../tools/virt-win-reg.pl:701
38153 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
38154 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
38155 " \"PWD\"=\"c:\\\\Temp\"\n"
38161 #: ../tools/virt-win-reg.pl:712
38163 "For use of C<ControlSet001> see the section above in this manual page. You "
38164 "may need to adjust this according to the control set that is in use by the "
38169 #: ../tools/virt-win-reg.pl:718
38171 "C<\"ObjectName\"> controls the privileges that the service will have. An "
38172 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
38173 "privileged account."
38177 #: ../tools/virt-win-reg.pl:724
38179 "For the meaning of the magic numbers, see this Microsoft KB article: "
38180 "L<http://support.microsoft.com/kb/103000>."
38184 #: ../tools/virt-win-reg.pl:729
38185 msgid "Update the registry:"
38189 #: ../tools/virt-win-reg.pl:731
38192 " virt-win-reg --merge WindowsGuest service.reg\n"
38197 #: ../tools/virt-win-reg.pl:735
38199 "Be careful when passing parameters containing C<\\> (backslash) in the "
38200 "shell. Usually you will have to use 'single quotes' or double backslashes "
38201 "(but not both) to protect them from the shell."
38205 #: ../tools/virt-win-reg.pl:739
38206 msgid "Paths and value names are case-insensitive."
38210 #: ../tools/virt-win-reg.pl:748
38212 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
38213 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
38214 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
38218 #: ../tools/virt-win-reg.pl:766
38221 " export LIBGUESTFS_DEBUG=1\n"
38222 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
38227 #: ../tools/virt-win-reg.pl:769
38229 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."