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-28 17:57+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:336 ../rescue/virt-rescue.pod:133
405 #: ../src/guestfs.pod:2668
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:484
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:486 ../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:488 ../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, and C<file> is the full path to the file."
640 #: ../cat/virt-cat.pod:191 ../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:352 ../rescue/virt-rescue.pod:262
643 #: ../resize/virt-resize.pod:601 ../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:193 ../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:354 ../rescue/virt-rescue.pod:264
653 #: ../resize/virt-resize.pod:603 ../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:198 ../cat/virt-filesystems.pod:372
665 #: ../cat/virt-ls.pod:490 ../df/virt-df.pod:222 ../edit/virt-edit.pod:349
666 #: ../fish/guestfish.pod:1081 ../fuse/guestmount.pod:303
667 #: ../inspector/virt-inspector.pod:375 ../resize/virt-resize.pod:608
668 #: ../test-tool/libguestfs-test-tool.pod:77
673 #: ../cat/virt-cat.pod:200 ../cat/virt-filesystems.pod:374
674 #: ../cat/virt-ls.pod:492 ../df/virt-df.pod:224 ../edit/virt-edit.pod:351
675 #: ../fuse/guestmount.pod:305 ../inspector/virt-inspector.pod:377
676 #: ../resize/virt-resize.pod:610
678 "This program returns 0 if successful, or non-zero if there was an error."
682 #: ../cat/virt-cat.pod:203 ../cat/virt-filesystems.pod:377
683 #: ../cat/virt-ls.pod:495 ../df/virt-df.pod:227 ../edit/virt-edit.pod:354
684 #: ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384
685 #: ../fish/guestfish.pod:1235 ../fish/virt-copy-in.pod:50
686 #: ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47
687 #: ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:308
688 #: ../inspector/virt-inspector.pod:380 ../java/examples/guestfs-java.pod:45
689 #: ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39
690 #: ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:284
691 #: ../resize/virt-resize.pod:613 ../ruby/examples/guestfs-ruby.pod:36
692 #: ../src/guestfs.pod:3042 ../test-tool/libguestfs-test-tool.pod:87
693 #: ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265
694 #: ../tools/virt-make-fs.pl:539 ../tools/virt-tar.pl:296
695 #: ../tools/virt-win-reg.pl:746
700 #: ../cat/virt-cat.pod:205
702 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, L<virt-"
703 "tar-out(1)>, L<http://libguestfs.org/>."
707 #: ../cat/virt-cat.pod:212 ../cat/virt-filesystems.pod:388
708 #: ../cat/virt-ls.pod:507 ../df/virt-df.pod:235 ../edit/virt-edit.pod:368
709 #: ../rescue/virt-rescue.pod:292 ../resize/virt-resize.pod:634
710 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277
711 #: ../tools/virt-make-fs.pl:564 ../tools/virt-tar.pl:311
712 #: ../tools/virt-win-reg.pl:772
717 #: ../cat/virt-cat.pod:214 ../cat/virt-filesystems.pod:390
718 #: ../cat/virt-ls.pod:509 ../df/virt-df.pod:237 ../edit/virt-edit.pod:370
719 #: ../inspector/virt-inspector.pod:395 ../rescue/virt-rescue.pod:294
720 #: ../resize/virt-resize.pod:636 ../tools/virt-list-filesystems.pl:210
721 #: ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:566
722 #: ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:774
723 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
727 #: ../cat/virt-cat.pod:216 ../cat/virt-filesystems.pod:392
728 #: ../cat/virt-ls.pod:511 ../df/virt-df.pod:239 ../edit/virt-edit.pod:372
729 #: ../examples/guestfs-examples.pod:48 ../examples/guestfs-recipes.pod:400
730 #: ../fish/guestfish.pod:1264 ../fish/virt-copy-in.pod:64
731 #: ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62
732 #: ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:323
733 #: ../inspector/virt-inspector.pod:403 ../java/examples/guestfs-java.pod:61
734 #: ../ocaml/examples/guestfs-ocaml.pod:94 ../perl/examples/guestfs-perl.pod:55
735 #: ../python/examples/guestfs-python.pod:57 ../rescue/virt-rescue.pod:296
736 #: ../resize/virt-resize.pod:638 ../ruby/examples/guestfs-ruby.pod:51
737 #: ../src/guestfs.pod:3118 ../test-tool/libguestfs-test-tool.pod:97
738 #: ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281
739 #: ../tools/virt-make-fs.pl:568 ../tools/virt-tar.pl:315
740 #: ../tools/virt-win-reg.pl:776
745 #: ../cat/virt-cat.pod:218 ../inspector/virt-inspector.pod:405
746 #: ../resize/virt-resize.pod:640
747 msgid "Copyright (C) 2010-2011 Red Hat Inc."
751 #: ../cat/virt-cat.pod:220 ../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:1269 ../fish/virt-copy-in.pod:69
754 #: ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67
755 #: ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:328
756 #: ../inspector/virt-inspector.pod:407 ../rescue/virt-rescue.pod:300
757 #: ../resize/virt-resize.pod:642 ../test-tool/libguestfs-test-tool.pod:102
758 #: ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285
759 #: ../tools/virt-make-fs.pl:572 ../tools/virt-tar.pl:319
760 #: ../tools/virt-win-reg.pl:780
762 "This program is free software; you can redistribute it and/or modify it "
763 "under the terms of the GNU General Public License as published by the Free "
764 "Software Foundation; either version 2 of the License, or (at your option) "
769 #: ../cat/virt-cat.pod:225 ../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:1274 ../fish/virt-copy-in.pod:74
772 #: ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72
773 #: ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:333
774 #: ../inspector/virt-inspector.pod:412 ../rescue/virt-rescue.pod:305
775 #: ../resize/virt-resize.pod:647 ../test-tool/libguestfs-test-tool.pod:107
776 #: ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290
777 #: ../tools/virt-make-fs.pl:577 ../tools/virt-tar.pl:324
778 #: ../tools/virt-win-reg.pl:785
780 "This program is distributed in the hope that it will be useful, but WITHOUT "
781 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
782 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
787 #: ../cat/virt-cat.pod:230 ../cat/virt-filesystems.pod:406
788 #: ../cat/virt-ls.pod:525 ../df/virt-df.pod:253 ../edit/virt-edit.pod:386
789 #: ../fish/guestfish.pod:1279 ../fish/virt-copy-in.pod:79
790 #: ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77
791 #: ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:338
792 #: ../inspector/virt-inspector.pod:417 ../rescue/virt-rescue.pod:310
793 #: ../resize/virt-resize.pod:652 ../test-tool/libguestfs-test-tool.pod:112
794 #: ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295
795 #: ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:329
796 #: ../tools/virt-win-reg.pl:790
798 "You should have received a copy of the GNU General Public License along with "
799 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
800 "Ave, Cambridge, MA 02139, USA."
804 #: ../cat/virt-filesystems.pod:5
806 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
807 "virtual machine or disk image"
811 #: ../cat/virt-filesystems.pod:9
814 " virt-filesystems [--options] -d domname\n"
819 #: ../cat/virt-filesystems.pod:11
822 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
827 #: ../cat/virt-filesystems.pod:15
829 "This tool allows you to discover filesystems, partitions, logical volumes, "
830 "and their sizes in a disk image or virtual machine. It is a replacement for "
831 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
835 #: ../cat/virt-filesystems.pod:20
837 "One use for this tool is from shell scripts to iterate over all filesystems "
842 #: ../cat/virt-filesystems.pod:23
845 " for fs in $(virt-filesystems -a disk.img); do\n"
852 #: ../cat/virt-filesystems.pod:27
854 "Another use is to list partitions before using another tool to modify those "
855 "partitions (such as L<virt-resize(1)>). If you are curious about what an "
856 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
860 #: ../cat/virt-filesystems.pod:32
862 "Various command line options control what this program displays. You need "
863 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
864 "guest respectively. If you just specify that then the program shows "
865 "filesystems found, one per line, like this:"
869 #: ../cat/virt-filesystems.pod:37
872 " $ virt-filesystems -a disk.img\n"
874 " /dev/vg_guest/lv_root\n"
879 #: ../cat/virt-filesystems.pod:41
881 "If you add I<-l> or I<--long> then the output includes extra information:"
885 #: ../cat/virt-filesystems.pod:44
888 " $ virt-filesystems -a disk.img -l\n"
889 " Name Type VFS Label Size\n"
890 " /dev/sda1 filesystem ext4 boot 524288000\n"
891 " /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
896 #: ../cat/virt-filesystems.pod:49
898 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
903 #: ../cat/virt-filesystems.pod:52
906 " $ virt-filesystems -a disk.img --extra\n"
908 " /dev/vg_guest/lv_root\n"
909 " /dev/vg_guest/lv_swap\n"
910 " /dev/vg_guest/lv_data\n"
915 #: ../cat/virt-filesystems.pod:58
917 "If you add I<--partitions> then partitions are shown instead of filesystems:"
921 #: ../cat/virt-filesystems.pod:60
924 " $ virt-filesystems -a disk.img --partitions\n"
931 #: ../cat/virt-filesystems.pod:64
933 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, I<--physical-"
934 "volumes>, I<--block-devices> to list those items."
938 #: ../cat/virt-filesystems.pod:67
940 "You can use these options in combination as well (if you want a combination "
941 "including filesystems, you have to add I<--filesystems>). Notice that some "
942 "items fall into several categories (eg. C</dev/sda1> might be both a "
943 "partition and a filesystem). These items are listed several times. To get "
944 "a list which includes absolutely everything that virt-filesystems knows "
945 "about, use the I<--all> option."
949 #: ../cat/virt-filesystems.pod:74
951 "UUIDs (because they are quite long) are not shown by default. Add the I<--"
952 "uuid> option to display device and filesystem UUIDs in the long output."
956 #: ../cat/virt-filesystems.pod:78
958 "I<--all --long --uuid> is a useful combination to display all possible "
959 "information about everything."
963 #: ../cat/virt-filesystems.pod:81
966 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
967 " Name Type VFS Label Size Parent UUID\n"
968 " /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
969 " /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
970 " /dev/sda1 partition - - 100M /dev/sda -\n"
971 " /dev/sda2 partition - - 20G /dev/sda -\n"
972 " /dev/sda device - - 20G - -\n"
977 #: ../cat/virt-filesystems.pod:89
979 "For machine-readable output, use I<--csv> to get Comma-Separated Values."
983 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
988 #: ../cat/virt-filesystems.pod:112
990 "Display everything. This is currently the same as specifying these options: "
991 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, I<--"
992 "logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may be "
993 "added to this list in future)."
997 #: ../cat/virt-filesystems.pod:117
998 msgid "See also I<--long>."
1002 #: ../cat/virt-filesystems.pod:119
1003 msgid "B<--blkdevs>"
1007 #: ../cat/virt-filesystems.pod:121
1008 msgid "B<--block-devices>"
1012 #: ../cat/virt-filesystems.pod:123
1013 msgid "Display block devices."
1017 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88
1022 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90
1024 "Write out the results in CSV format (comma-separated values). This format "
1025 "can be imported easily into databases and spreadsheets, but read L</NOTE "
1026 "ABOUT CSV FORMAT> below."
1030 #: ../cat/virt-filesystems.pod:150
1032 "When prompting for keys and passphrases, virt-filesystems normally turns "
1033 "echoing off so you cannot see what you are typing. If you are not worried "
1034 "about Tempest attacks and there is no one else in the room you can specify "
1035 "this flag to see what you are typing."
1039 #: ../cat/virt-filesystems.pod:155
1044 #: ../cat/virt-filesystems.pod:157
1046 "This causes filesystems that are not ordinary, mountable filesystems to be "
1047 "displayed. This category includes swapspace, and filesystems that are empty "
1048 "or contain unknown data."
1052 #: ../cat/virt-filesystems.pod:161
1053 msgid "This option implies I<--filesystems>."
1057 #: ../cat/virt-filesystems.pod:163
1058 msgid "B<--filesystems>"
1062 #: ../cat/virt-filesystems.pod:165
1064 "Display mountable filesystems. If no display option was selected then this "
1065 "option is implied."
1069 #: ../cat/virt-filesystems.pod:168
1070 msgid "With I<--extra>, non-mountable filesystems are shown too."
1074 #: ../cat/virt-filesystems.pod:181
1077 " virt-filesystems --format=raw -a disk.img\n"
1082 #: ../cat/virt-filesystems.pod:185
1085 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
1090 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352
1091 #: ../df/virt-df.pod:125 ../fish/guestfish.pod:156
1092 #: ../tools/virt-list-partitions.pl:109
1097 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354
1098 #: ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111
1099 msgid "B<--human-readable>"
1103 #: ../cat/virt-filesystems.pod:198
1104 msgid "In I<--long> mode, display sizes in human-readable format."
1108 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366
1109 #: ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
1114 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368
1115 #: ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
1120 #: ../cat/virt-filesystems.pod:209
1121 msgid "Display extra columns of data (\"long format\")."
1125 #: ../cat/virt-filesystems.pod:211
1126 msgid "A title row is added unless you also specify I<--no-title>."
1130 #: ../cat/virt-filesystems.pod:213
1132 "The extra columns displayed depend on what output you select, and the "
1133 "ordering of columns may change in future versions. Use the title row, I<--"
1134 "csv> output and/or L<csvtool(1)> to match columns to data in external "
1139 #: ../cat/virt-filesystems.pod:218
1141 "Use I<-h> if you want sizes to be displayed in human-readable format. The "
1142 "default is to show raw numbers of I<bytes>."
1146 #: ../cat/virt-filesystems.pod:221
1147 msgid "Use I<--uuid> to display UUIDs too."
1151 #: ../cat/virt-filesystems.pod:223
1156 #: ../cat/virt-filesystems.pod:225
1157 msgid "B<--logvols>"
1161 #: ../cat/virt-filesystems.pod:227
1162 msgid "B<--logical-volumes>"
1166 #: ../cat/virt-filesystems.pod:229
1168 "Display LVM logical volumes. In this mode, these are displayed irrespective "
1169 "of whether the LVs contain filesystems."
1173 #: ../cat/virt-filesystems.pod:232
1174 msgid "B<--no-title>"
1178 #: ../cat/virt-filesystems.pod:234
1179 msgid "In I<--long> mode, don't add a title row."
1183 #: ../cat/virt-filesystems.pod:236
1185 "Note that the order of the columns is not fixed, and may change in future "
1186 "versions of virt-filesystems, so using this option may give you unexpected "
1191 #: ../cat/virt-filesystems.pod:240
1196 #: ../cat/virt-filesystems.pod:242
1197 msgid "B<--partitions>"
1201 #: ../cat/virt-filesystems.pod:244
1203 "Display partitions. In this mode, these are displayed irrespective of "
1204 "whether the partitions contain filesystems."
1208 #: ../cat/virt-filesystems.pod:247
1213 #: ../cat/virt-filesystems.pod:249
1214 msgid "B<--physvols>"
1218 #: ../cat/virt-filesystems.pod:251
1219 msgid "B<--physical-volumes>"
1223 #: ../cat/virt-filesystems.pod:253
1224 msgid "Display LVM physical volumes."
1228 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163
1233 #: ../cat/virt-filesystems.pod:257
1238 #: ../cat/virt-filesystems.pod:259
1239 msgid "In I<--long> mode, display UUIDs as well."
1243 #: ../cat/virt-filesystems.pod:273
1248 #: ../cat/virt-filesystems.pod:275
1249 msgid "B<--volgroups>"
1253 #: ../cat/virt-filesystems.pod:277
1254 msgid "B<--volume-groups>"
1258 #: ../cat/virt-filesystems.pod:279
1259 msgid "Display LVM volume groups."
1263 #: ../cat/virt-filesystems.pod:287
1268 #: ../cat/virt-filesystems.pod:289
1270 "Note that columns in the output are subject to reordering and change in "
1271 "future versions of this tool."
1275 #: ../cat/virt-filesystems.pod:294
1280 #: ../cat/virt-filesystems.pod:296
1281 msgid "The filesystem, partition, block device or LVM name."
1285 #: ../cat/virt-filesystems.pod:298
1287 "For device and partition names these are displayed as canonical libguestfs "
1288 "names, so that for example C</dev/sda2> is the second partition on the first "
1293 #: ../cat/virt-filesystems.pod:302
1295 "If the I<--long> option is B<not> specified, then only the name column is "
1296 "shown in the output."
1300 #: ../cat/virt-filesystems.pod:305
1305 #: ../cat/virt-filesystems.pod:307
1306 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1310 #: ../cat/virt-filesystems.pod:309
1315 #: ../cat/virt-filesystems.pod:311
1317 "If there is a filesystem, then this column displays the filesystem type if "
1318 "one could be detected, eg. C<ext4>."
1322 #: ../cat/virt-filesystems.pod:314
1327 #: ../cat/virt-filesystems.pod:316
1329 "If the object has a label (used for identifying and mounting filesystems) "
1330 "then this column contains the label."
1334 #: ../cat/virt-filesystems.pod:319
1339 #: ../cat/virt-filesystems.pod:321
1341 "The size of the object in bytes. If the I<--human> option is used then the "
1342 "size is displayed in a human-readable form."
1346 #: ../cat/virt-filesystems.pod:324
1351 #: ../cat/virt-filesystems.pod:326
1353 "The parent column records the parent relationship between objects. For "
1354 "example, if the object is a partition, then this column contains the name of "
1355 "the containing device. If the object is a logical volume, then this column "
1356 "is the name of the volume group."
1360 #: ../cat/virt-filesystems.pod:331
1365 #: ../cat/virt-filesystems.pod:333
1367 "If the object has a UUID (used for identifying and mounting filesystems and "
1368 "block devices) then this column contains the UUID as a string."
1372 #: ../cat/virt-filesystems.pod:337
1373 msgid "The UUID is only displayed if the I<--uuid> option is given."
1377 #: ../cat/virt-filesystems.pod:341 ../cat/virt-ls.pod:459
1378 #: ../df/virt-df.pod:191
1379 msgid "NOTE ABOUT CSV FORMAT"
1383 #: ../cat/virt-filesystems.pod:343 ../cat/virt-ls.pod:461
1384 #: ../df/virt-df.pod:193
1386 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
1387 "should be easy to parse, but it is definitely not easy to parse."
1391 #: ../cat/virt-filesystems.pod:346 ../cat/virt-ls.pod:464
1392 #: ../df/virt-df.pod:196
1394 "Myth: Just split fields at commas. Reality: This does I<not> work "
1395 "reliably. This example has two columns:"
1399 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:467
1400 #: ../df/virt-df.pod:199
1403 " \"foo,bar\",baz\n"
1408 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:469
1409 #: ../df/virt-df.pod:201
1411 "Myth: Read the file one line at a time. Reality: This does I<not> work "
1412 "reliably. This example has one row:"
1416 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472
1417 #: ../df/virt-df.pod:204
1426 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475
1427 #: ../df/virt-df.pod:207
1429 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
1430 "packaged in major Linux distributions)."
1434 #: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478
1435 #: ../df/virt-df.pod:210
1437 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
1438 "or Python's built-in csv library)."
1442 #: ../cat/virt-filesystems.pod:363 ../cat/virt-ls.pod:481
1443 #: ../df/virt-df.pod:213
1444 msgid "Most spreadsheets and databases can import CSV directly."
1448 #: ../cat/virt-filesystems.pod:379
1450 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-list-"
1451 "filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, L<http://"
1456 #: ../cat/virt-filesystems.pod:394 ../tools/virt-make-fs.pl:570
1457 #: ../tools/virt-win-reg.pl:778
1458 msgid "Copyright (C) 2010 Red Hat Inc."
1462 #: ../cat/virt-ls.pod:5
1463 msgid "virt-ls - List files in a virtual machine"
1467 #: ../cat/virt-ls.pod:9
1470 " virt-ls [--options] -d domname directory [directory ...]\n"
1475 #: ../cat/virt-ls.pod:11
1478 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory ...]\n"
1483 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13
1488 #: ../cat/virt-ls.pod:15
1491 " virt-ls [--options] domname directory\n"
1496 #: ../cat/virt-ls.pod:17
1499 " virt-ls [--options] disk.img [disk.img ...] directory\n"
1504 #: ../cat/virt-ls.pod:21
1506 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
1507 "more from a virtual machine or disk image."
1511 #: ../cat/virt-ls.pod:24
1513 "Multiple directory names can be given, in which case the output from each is "
1518 #: ../cat/virt-ls.pod:27
1520 "To list directories from a libvirt guest use the I<-d> option to specify the "
1521 "name of the guest. For a disk image, use the I<-a> option."
1525 #: ../cat/virt-ls.pod:31
1527 "C<virt-ls> can do many simple file listings. For more complicated cases you "
1528 "may need to use L<guestfish(1)>, or write a program directly to the L<guestfs"
1533 #: ../cat/virt-ls.pod:37
1534 msgid "Get a list of all files and directories in a virtual machine:"
1538 #: ../cat/virt-ls.pod:39
1541 " virt-ls -R -d guest /\n"
1546 #: ../cat/virt-ls.pod:41
1547 msgid "List all setuid or setgid programs in a Linux virtual machine:"
1551 #: ../cat/virt-ls.pod:43
1554 " virt-ls -lR -d guest / | grep '^- [42]'\n"
1559 #: ../cat/virt-ls.pod:45
1560 msgid "List all public-writable directories in a Linux virtual machine:"
1564 #: ../cat/virt-ls.pod:47
1567 " virt-ls -lR -d guest / | grep '^d ...7'\n"
1572 #: ../cat/virt-ls.pod:49
1573 msgid "List all Unix domain sockets in a Linux virtual machine:"
1577 #: ../cat/virt-ls.pod:51
1580 " virt-ls -lR -d guest / | grep '^s'\n"
1585 #: ../cat/virt-ls.pod:53
1586 msgid "List all regular files with filenames ending in '.png':"
1590 #: ../cat/virt-ls.pod:55
1593 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
1598 #: ../cat/virt-ls.pod:57
1599 msgid "To display files larger than 10MB in home directories:"
1603 #: ../cat/virt-ls.pod:59
1606 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
1611 #: ../cat/virt-ls.pod:61
1612 msgid "Find everything modified in the last 7 days:"
1616 #: ../cat/virt-ls.pod:63
1619 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
1624 #: ../cat/virt-ls.pod:65
1625 msgid "Find regular files modified in the last 24 hours:"
1629 #: ../cat/virt-ls.pod:67
1632 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
1637 #: ../cat/virt-ls.pod:69
1638 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
1642 #: ../cat/virt-ls.pod:71
1644 "Find the differences between files in a guest and an earlier snapshot of the "
1649 #: ../cat/virt-ls.pod:74
1652 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
1653 " virt-ls -lR -a current.img / --uids --time-t > new\n"
1654 " diff -u old new | less\n"
1659 #: ../cat/virt-ls.pod:78
1661 "The commands above won't find files where the content has changed but the "
1662 "metadata (eg. file size and modification date) is the same. To do that, you "
1663 "need to add the I<--checksum> parameter to both C<virt-ls> commands. I<--"
1664 "checksum> can be quite slow since it has to read and compute a checksum of "
1665 "every regular file in the virtual machine."
1669 #: ../cat/virt-ls.pod:84
1670 msgid "OUTPUT MODES"
1674 #: ../cat/virt-ls.pod:86
1676 "C<virt-ls> has four output modes, controlled by different combinations of "
1677 "the I<-l> and I<-R> options."
1681 #: ../cat/virt-ls.pod:89
1682 msgid "SIMPLE LISTING"
1686 #: ../cat/virt-ls.pod:91
1687 msgid "A simple listing is like the ordinary L<ls(1)> command:"
1691 #: ../cat/virt-ls.pod:93
1694 " $ virt-ls -d guest /\n"
1702 #: ../cat/virt-ls.pod:98
1703 msgid "LONG LISTING"
1707 #: ../cat/virt-ls.pod:100
1709 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
1710 "(more specifically, like the C<guestfs_ll> function)."
1714 #: ../cat/virt-ls.pod:103
1717 " $ virt-ls -l -d guest /\n"
1719 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
1720 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
1726 #: ../cat/virt-ls.pod:109
1728 "Note that while this is useful for displaying a directory, do not try "
1729 "parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
1734 #: ../cat/virt-ls.pod:113
1735 msgid "RECURSIVE LISTING"
1739 #: ../cat/virt-ls.pod:115
1741 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
1742 "and directories recursively:"
1746 #: ../cat/virt-ls.pod:118
1749 " $ virt-ls -R -d guest /tmp\n"
1757 #: ../cat/virt-ls.pod:123
1759 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
1760 "converts C<\\0> characters to C<\\n>."
1764 #: ../cat/virt-ls.pod:126
1765 msgid "RECURSIVE LONG LISTING"
1769 #: ../cat/virt-ls.pod:128
1771 "Using I<-lR> options together changes the output to display directories "
1772 "recursively, with file stats, and optionally other features such as "
1773 "checksums and extended attributes."
1777 #: ../cat/virt-ls.pod:132
1779 "Most of the interesting features of C<virt-ls> are only available when using "
1784 #: ../cat/virt-ls.pod:135
1786 "The fields are normally space-separated. Filenames are B<not> quoted, so "
1787 "you cannot use the output in another program (because filenames can contain "
1788 "spaces and other unsafe characters). If the guest was untrusted and someone "
1789 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
1790 "on you by creating filenames with embedded newline characters. To B<safely> "
1791 "parse the output in another program, use the I<--csv> (Comma-Separated "
1796 #: ../cat/virt-ls.pod:143
1798 "Note that this output format is completely unrelated to the C<ls -lR> "
1803 #: ../cat/virt-ls.pod:146
1806 " $ virt-ls -lR -d guest /bin\n"
1807 " d 0555 4096 /bin\n"
1808 " - 0755 123 /bin/alsaunmute\n"
1809 " - 0755 28328 /bin/arch\n"
1810 " l 0777 4 /bin/awk -> gawk\n"
1811 " - 0755 27216 /bin/basename\n"
1812 " - 0755 943360 /bin/bash\n"
1818 #: ../cat/virt-ls.pod:155
1819 msgid "These basic fields are always shown:"
1823 #: ../cat/virt-ls.pod:159
1828 #: ../cat/virt-ls.pod:161
1830 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
1831 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
1832 "link), C<s> (socket) or C<u> (unknown)."
1836 #: ../cat/virt-ls.pod:171
1841 #: ../cat/virt-ls.pod:173
1842 msgid "The Unix permissions, displayed as a 4 digit octal number."
1846 #: ../cat/virt-ls.pod:175
1851 #: ../cat/virt-ls.pod:177
1853 "The size of the file. This is shown in bytes unless I<-h> or I<--human-"
1854 "readable> option is given, in which case this is shown as a human-readable "
1859 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4188
1864 #: ../cat/virt-ls.pod:183
1865 msgid "The full path of the file or directory."
1869 #: ../cat/virt-ls.pod:185
1874 #: ../cat/virt-ls.pod:187
1875 msgid "For symbolic links only, the link target."
1879 #: ../cat/virt-ls.pod:191
1881 "In I<-lR> mode, additional command line options enable the display of more "
1886 #: ../cat/virt-ls.pod:194
1888 "With the I<--uids> flag, these additional fields are displayed before the "
1893 #: ../cat/virt-ls.pod:199
1898 #: ../cat/virt-ls.pod:201
1903 #: ../cat/virt-ls.pod:203
1905 "The UID and GID of the owner of the file (displayed numerically). Note "
1906 "these only make sense in the context of a Unix-like guest."
1910 #: ../cat/virt-ls.pod:208
1911 msgid "With the I<--times> flag, these additional fields are displayed:"
1915 #: ../cat/virt-ls.pod:212
1920 #: ../cat/virt-ls.pod:214
1921 msgid "The time of last access."
1925 #: ../cat/virt-ls.pod:216
1930 #: ../cat/virt-ls.pod:218
1931 msgid "The time of last modification."
1935 #: ../cat/virt-ls.pod:220
1940 #: ../cat/virt-ls.pod:222
1941 msgid "The time of last status change."
1945 #: ../cat/virt-ls.pod:226
1947 "The time fields are displayed as string dates and times, unless one of the "
1948 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
1952 #: ../cat/virt-ls.pod:229
1953 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
1957 #: ../cat/virt-ls.pod:233
1962 #: ../cat/virt-ls.pod:235
1964 "The device containing the file (displayed as major:minor). This may not "
1965 "match devices as known to the guest."
1969 #: ../cat/virt-ls.pod:238
1974 #: ../cat/virt-ls.pod:240
1975 msgid "The inode number."
1979 #: ../cat/virt-ls.pod:242
1984 #: ../cat/virt-ls.pod:244
1985 msgid "The number of hard links."
1989 #: ../cat/virt-ls.pod:246
1994 #: ../cat/virt-ls.pod:248
1996 "For block and char special files, the device (displayed as major:minor)."
2000 #: ../cat/virt-ls.pod:251
2005 #: ../cat/virt-ls.pod:253
2006 msgid "The number of 512 byte blocks allocated to the file."
2010 #: ../cat/virt-ls.pod:257
2012 "With the I<--checksum> flag, the checksum of the file contents is shown "
2013 "(only for regular files). Computing file checksums can take a considerable "
2018 #: ../cat/virt-ls.pod:280
2019 msgid "B<--checksum>"
2023 #: ../cat/virt-ls.pod:282
2024 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
2028 #: ../cat/virt-ls.pod:284
2030 "Display checksum over file contents for regular files. With no argument, "
2031 "this defaults to using I<md5>. Using an argument, you can select the "
2032 "checksum type to use."
2036 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358
2037 #: ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408
2038 #: ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
2040 "This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
2045 #: ../cat/virt-ls.pod:316
2047 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
2048 "so you cannot see what you are typing. If you are not worried about Tempest "
2049 "attacks and there is no one else in the room you can specify this flag to "
2050 "see what you are typing."
2054 #: ../cat/virt-ls.pod:321
2055 msgid "B<--extra-stats>"
2059 #: ../cat/virt-ls.pod:323
2060 msgid "Display extra stats."
2064 #: ../cat/virt-ls.pod:339
2067 " virt-ls --format=raw -a disk.img /dir\n"
2072 #: ../cat/virt-ls.pod:343
2075 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
2080 #: ../cat/virt-ls.pod:356
2081 msgid "Display file sizes in human-readable format."
2085 #: ../cat/virt-ls.pod:370
2090 #: ../cat/virt-ls.pod:372
2091 msgid "B<--recursive>"
2095 #: ../cat/virt-ls.pod:374
2097 "Select the mode. With neither of these options, C<virt-ls> produces a "
2098 "simple, flat list of the files in the named directory. See L</SIMPLE "
2103 #: ../cat/virt-ls.pod:378
2105 "C<virt-ls -l> produces a \"long listing\", which shows more detail. See L</"
2110 #: ../cat/virt-ls.pod:381
2112 "C<virt-ls -R> produces a recursive list of files starting at the named "
2113 "directory. See L</RECURSIVE LISTING>."
2117 #: ../cat/virt-ls.pod:384
2119 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
2120 "parsed. See L</RECURSIVE LONG LISTING>."
2124 #: ../cat/virt-ls.pod:387
2129 #: ../cat/virt-ls.pod:389
2130 msgid "Display time fields."
2134 #: ../cat/virt-ls.pod:394
2135 msgid "B<--time-days>"
2139 #: ../cat/virt-ls.pod:396
2140 msgid "Display time fields as days before now (negative if in the future)."
2144 #: ../cat/virt-ls.pod:398
2146 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
2147 "of the file is between 0 and 86399 seconds."
2151 #: ../cat/virt-ls.pod:404
2152 msgid "B<--time-relative>"
2156 #: ../cat/virt-ls.pod:406
2157 msgid "Display time fields as seconds before now (negative if in the future)."
2161 #: ../cat/virt-ls.pod:411
2166 #: ../cat/virt-ls.pod:413
2167 msgid "Display time fields as seconds since the Unix epoch."
2171 #: ../cat/virt-ls.pod:418
2176 #: ../cat/virt-ls.pod:420
2177 msgid "Display UID and GID fields."
2181 #: ../cat/virt-ls.pod:445
2182 msgid "Previous versions of virt-ls allowed you to write either:"
2186 #: ../cat/virt-ls.pod:447
2189 " virt-ls disk.img [disk.img ...] /dir\n"
2194 #: ../cat/virt-ls.pod:451
2197 " virt-ls guestname /dir\n"
2202 #: ../cat/virt-ls.pod:497
2204 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-"
2205 "tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
2206 "L<http://libguestfs.org/>."
2210 #: ../cat/virt-ls.pod:513 ../df/virt-df.pod:241 ../edit/virt-edit.pod:374
2211 #: ../rescue/virt-rescue.pod:298
2212 msgid "Copyright (C) 2009-2011 Red Hat Inc."
2216 #: ../df/virt-df.pod:5
2217 msgid "virt-df - Display free space on virtual filesystems"
2221 #: ../df/virt-df.pod:9
2224 " virt-df [--options]\n"
2229 #: ../df/virt-df.pod:11
2232 " virt-df [--options] -d domname\n"
2237 #: ../df/virt-df.pod:13
2240 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
2245 #: ../df/virt-df.pod:17
2248 " virt-df [--options] domname\n"
2253 #: ../df/virt-df.pod:19
2256 " virt-df [--options] disk.img [disk.img ...]\n"
2261 #: ../df/virt-df.pod:23
2263 "C<virt-df> is a command line tool to display free space on virtual machine "
2264 "filesystems. Unlike other tools, it doesn't just display the size of disk "
2265 "allocated to a virtual machine, but can look inside disk images to see how "
2266 "much space is really being used."
2270 #: ../df/virt-df.pod:28
2272 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
2273 "to get a list of all active and inactive guests, and performs a C<df>-type "
2274 "operation on each one in turn, printing out the results."
2278 #: ../df/virt-df.pod:32
2280 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a C<df>-"
2281 "type operation on either the single named libvirt domain, or on the disk "
2282 "image(s) listed on the command line (which must all belong to a single VM). "
2283 "In this mode (with arguments), C<virt-df> will I<only work for a single "
2284 "guest>. If you want to run on multiple guests, then you have to invoke "
2285 "C<virt-df> multiple times."
2289 #: ../df/virt-df.pod:39
2291 "Use the I<--csv> option to get a format which can be easily parsed by other "
2292 "programs. Other options are similar to the standard L<df(1)> command."
2296 #: ../df/virt-df.pod:45
2298 "Show disk usage for a single libvirt guest called C<F14x64>. Make the "
2299 "output human-readable:"
2303 #: ../df/virt-df.pod:48
2306 " # virt-df -d F14x64 -h\n"
2307 " Filesystem Size Used Available Use%\n"
2308 " F14x64:/dev/sda1 484M 66M 393M 14%\n"
2309 " F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
2314 #: ../df/virt-df.pod:53
2315 msgid "Show disk usage for a disk image file called C<test.img>:"
2319 #: ../df/virt-df.pod:55
2322 " $ virt-df -a test1.img\n"
2323 " Filesystem 1K-blocks Used Available Use%\n"
2324 " test1.img:/dev/sda1 99099 1551 92432 2%\n"
2329 #: ../df/virt-df.pod:112
2332 " virt-df --format=raw -a disk.img\n"
2337 #: ../df/virt-df.pod:116
2340 " virt-df --format=raw -a disk.img --format -a another.img\n"
2345 #: ../df/virt-df.pod:129
2346 msgid "Print sizes in human-readable format."
2350 #: ../df/virt-df.pod:131
2351 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
2355 #: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155
2360 #: ../df/virt-df.pod:135
2365 #: ../df/virt-df.pod:137
2366 msgid "Print inodes instead of blocks."
2370 #: ../df/virt-df.pod:139
2371 msgid "B<--one-per-guest>"
2375 #: ../df/virt-df.pod:141
2377 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
2378 "disks from several guests to a single libguestfs appliance."
2382 #: ../df/virt-df.pod:144
2383 msgid "You might use this option in the following circumstances:"
2387 #: ../df/virt-df.pod:148 ../df/virt-df.pod:154 ../edit/virt-edit.pod:266
2388 #: ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276
2389 #: ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291
2390 #: ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102
2391 #: ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132
2392 #: ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227
2393 #: ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235
2394 #: ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243
2395 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
2396 #: ../fish/guestfish-actions.pod:390 ../fish/guestfish-actions.pod:398
2397 #: ../fish/guestfish-actions.pod:405 ../fish/guestfish-actions.pod:412
2398 #: ../fish/guestfish-actions.pod:1104 ../fish/guestfish-actions.pod:1108
2399 #: ../fish/guestfish-actions.pod:1112 ../fish/guestfish-actions.pod:1116
2400 #: ../fish/guestfish-actions.pod:1124 ../fish/guestfish-actions.pod:1128
2401 #: ../fish/guestfish-actions.pod:1132 ../fish/guestfish-actions.pod:1142
2402 #: ../fish/guestfish-actions.pod:1146 ../fish/guestfish-actions.pod:1150
2403 #: ../fish/guestfish-actions.pod:1240 ../fish/guestfish-actions.pod:1244
2404 #: ../fish/guestfish-actions.pod:1249 ../fish/guestfish-actions.pod:1254
2405 #: ../fish/guestfish-actions.pod:1296 ../fish/guestfish-actions.pod:1300
2406 #: ../fish/guestfish-actions.pod:1305 ../fish/guestfish-actions.pod:1938
2407 #: ../fish/guestfish-actions.pod:1944 ../fish/guestfish-actions.pod:1952
2408 #: ../fish/guestfish-actions.pod:1959 ../fish/guestfish-actions.pod:1966
2409 #: ../fish/guestfish.pod:445 ../fish/guestfish.pod:449
2410 #: ../fish/guestfish.pod:453 ../fish/guestfish.pod:457
2411 #: ../inspector/virt-inspector.pod:393 ../inspector/virt-inspector.pod:397
2412 #: ../resize/virt-resize.pod:282 ../resize/virt-resize.pod:286
2413 #: ../resize/virt-resize.pod:295 ../resize/virt-resize.pod:301
2414 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:29
2415 #: ../src/guestfs-actions.pod:588 ../src/guestfs-actions.pod:596
2416 #: ../src/guestfs-actions.pod:603 ../src/guestfs-actions.pod:610
2417 #: ../src/guestfs-actions.pod:1667 ../src/guestfs-actions.pod:1671
2418 #: ../src/guestfs-actions.pod:1675 ../src/guestfs-actions.pod:1679
2419 #: ../src/guestfs-actions.pod:1687 ../src/guestfs-actions.pod:1691
2420 #: ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1705
2421 #: ../src/guestfs-actions.pod:1709 ../src/guestfs-actions.pod:1713
2422 #: ../src/guestfs-actions.pod:1851 ../src/guestfs-actions.pod:1855
2423 #: ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1865
2424 #: ../src/guestfs-actions.pod:1926 ../src/guestfs-actions.pod:1930
2425 #: ../src/guestfs-actions.pod:1935 ../src/guestfs-actions.pod:2864
2426 #: ../src/guestfs-actions.pod:2870 ../src/guestfs-actions.pod:2878
2427 #: ../src/guestfs-actions.pod:2885 ../src/guestfs-actions.pod:2892
2428 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
2429 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
2430 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
2431 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
2432 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
2433 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
2434 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
2435 #: ../src/guestfs.pod:1644 ../src/guestfs.pod:1649 ../src/guestfs.pod:1653
2436 #: ../src/guestfs.pod:1755 ../src/guestfs.pod:1760 ../src/guestfs.pod:1764
2437 #: ../src/guestfs.pod:1774 ../src/guestfs.pod:2063 ../src/guestfs.pod:2068
2438 #: ../src/guestfs.pod:2074 ../src/guestfs.pod:2082 ../src/guestfs.pod:2436
2439 #: ../src/guestfs.pod:2442 ../src/guestfs.pod:2447 ../src/guestfs.pod:2453
2440 #: ../src/guestfs.pod:2834 ../src/guestfs.pod:2839 ../src/guestfs.pod:2843
2441 #: ../src/guestfs.pod:2847 ../src/guestfs.pod:2851 ../src/guestfs.pod:2865
2442 #: ../src/guestfs.pod:2870 ../src/guestfs.pod:3095 ../src/guestfs.pod:3099
2443 #: ../src/guestfs.pod:3103 ../src/guestfs.pod:3107
2444 #: ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202
2445 #: ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:710
2446 #: ../tools/virt-win-reg.pl:716 ../tools/virt-win-reg.pl:722
2451 #: ../df/virt-df.pod:150
2453 "If you think an untrusted guest might actively try to exploit the libguestfs "
2454 "appliance kernel, then this prevents one guest from interfering with the "
2455 "stats printed for another guest."
2459 #: ../df/virt-df.pod:156
2461 "If the kernel has a bug which stops it from accessing a filesystem in one "
2462 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
2463 "and report stats for further guests."
2467 #: ../df/virt-df.pod:165
2469 "Print UUIDs instead of names. This is useful for following a guest even "
2470 "when the guest is migrated or renamed, or when two guests happen to have the "
2475 #: ../df/virt-df.pod:169
2477 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
2478 "images, we still print the disk image name even when this option is "
2483 #: ../df/virt-df.pod:229
2485 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<http://"
2490 #: ../edit/virt-edit.pod:5
2491 msgid "virt-edit - Edit a file in a virtual machine"
2495 #: ../edit/virt-edit.pod:9
2498 " virt-edit [--options] -d domname file [file ...]\n"
2503 #: ../edit/virt-edit.pod:11
2506 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
2511 #: ../edit/virt-edit.pod:13
2514 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
2519 #: ../edit/virt-edit.pod:17
2522 " virt-edit domname file\n"
2527 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
2530 " virt-edit disk.img [disk.img ...] file\n"
2535 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23
2536 #: ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15
2537 #: ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:19
2538 #: ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51
2543 #: ../edit/virt-edit.pod:23
2545 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
2546 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
2547 "doing this, but doesn't catch all cases."
2551 #: ../edit/virt-edit.pod:29
2553 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
2554 "exists in the named virtual machine (or disk image)."
2558 #: ../edit/virt-edit.pod:32
2560 "Multiple filenames can be given, in which case they are each edited in "
2561 "turn. Each filename must be a full path, starting at the root directory "
2562 "(starting with '/')."
2566 #: ../edit/virt-edit.pod:36
2567 msgid "If you want to just view a file, use L<virt-cat(1)>."
2571 #: ../edit/virt-edit.pod:38
2573 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
2574 "USING GUESTFISH> below)."
2578 #: ../edit/virt-edit.pod:41
2580 "C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
2581 "that and much more."
2585 #: ../edit/virt-edit.pod:46
2586 msgid "Edit the named files interactively:"
2590 #: ../edit/virt-edit.pod:48
2593 " virt-edit -d mydomain /boot/grub/grub.conf\n"
2598 #: ../edit/virt-edit.pod:50
2601 " virt-edit -d mydomain /etc/passwd\n"
2606 #: ../edit/virt-edit.pod:52
2607 msgid "For Windows guests, some Windows paths are understood:"
2611 #: ../edit/virt-edit.pod:54
2614 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
2619 #: ../edit/virt-edit.pod:56
2621 "If Perl is installed, you can also edit files non-interactively (see L</NON-"
2622 "INTERACTIVE EDITING> below). To change the init default level to 5:"
2626 #: ../edit/virt-edit.pod:60
2629 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
2634 #: ../edit/virt-edit.pod:81
2635 msgid "B<-b> extension"
2639 #: ../edit/virt-edit.pod:83
2640 msgid "B<--backup> extension"
2644 #: ../edit/virt-edit.pod:85
2646 "Create a backup of the original file I<in the guest disk image>. The backup "
2647 "has the original filename with C<extension> added."
2651 #: ../edit/virt-edit.pod:88
2653 "Usually the first character of C<extension> would be a dot C<.> so you would "
2658 #: ../edit/virt-edit.pod:91
2661 " virt-edit -b .orig [etc]\n"
2666 #: ../edit/virt-edit.pod:93
2667 msgid "By default, no backup file is made."
2671 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181
2672 #: ../fuse/guestmount.pod:96 ../inspector/virt-inspector.pod:74
2673 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78
2674 #: ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
2679 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183
2680 #: ../fuse/guestmount.pod:98 ../inspector/virt-inspector.pod:76
2681 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80
2682 #: ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
2683 msgid "B<--connect URI>"
2687 #: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84
2688 #: ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134
2689 #: ../tools/virt-win-reg.pl:135
2691 "If you specify guest block devices directly, then libvirt is not used at all."
2695 #: ../edit/virt-edit.pod:114
2697 "When prompting for keys and passphrases, virt-edit normally turns echoing "
2698 "off so you cannot see what you are typing. If you are not worried about "
2699 "Tempest attacks and there is no one else in the room you can specify this "
2700 "flag to see what you are typing."
2704 #: ../edit/virt-edit.pod:119
2709 #: ../edit/virt-edit.pod:121
2710 msgid "B<--expr> EXPR"
2714 #: ../edit/virt-edit.pod:123
2716 "Instead of launching the external editor, non-interactively apply the Perl "
2717 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
2722 #: ../edit/virt-edit.pod:127
2724 "Be careful to properly quote the expression to prevent it from being altered "
2729 #: ../edit/virt-edit.pod:130
2730 msgid "Note that this option is only available when Perl 5 is installed."
2734 #: ../edit/virt-edit.pod:132
2735 msgid "B<--format> raw|qcow2|..."
2739 #: ../edit/virt-edit.pod:143
2742 " virt-edit --format=raw -a disk.img file\n"
2747 #: ../edit/virt-edit.pod:147
2750 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
2755 #: ../edit/virt-edit.pod:181
2756 msgid "Previous versions of virt-edit allowed you to write either:"
2760 #: ../edit/virt-edit.pod:187
2763 " virt-edit guestname file\n"
2768 #: ../edit/virt-edit.pod:195
2769 msgid "NON-INTERACTIVE EDITING"
2773 #: ../edit/virt-edit.pod:197
2775 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
2776 "administrator can interactively edit the file."
2780 #: ../edit/virt-edit.pod:200
2782 "There are two ways also to use C<virt-edit> from scripts in order to make "
2783 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
2784 "like this, it's less error-prone to write scripts directly using the "
2785 "libguestfs API and Augeas for configuration file editing.)"
2789 #: ../edit/virt-edit.pod:206
2791 "The first method is to temporarily set C<$EDITOR> to any script or program "
2792 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
2793 "update C<tmpfile> in place however it likes."
2797 #: ../edit/virt-edit.pod:210
2799 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
2800 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
2801 "instances of C<foo> with C<bar> in a file:"
2805 #: ../edit/virt-edit.pod:214
2808 " virt-edit -d domname filename -e 's/foo/bar/'\n"
2813 #: ../edit/virt-edit.pod:216
2815 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
2816 "For example to delete root's password you could do:"
2820 #: ../edit/virt-edit.pod:219
2823 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
2828 #: ../edit/virt-edit.pod:221
2830 "What really happens is that the snippet is evaluated as a Perl expression "
2831 "for each line of the file. The line, including the final C<\\n>, is passed "
2832 "in C<$_> and the expression should update C<$_> or leave it unchanged."
2836 #: ../edit/virt-edit.pod:226
2838 "To delete a line, set C<$_> to the empty string. For example, to delete the "
2839 "C<apache> user account from the password file you can do:"
2843 #: ../edit/virt-edit.pod:229
2846 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
2851 #: ../edit/virt-edit.pod:231
2853 "To insert a line, prepend or append it to C<$_>. However appending lines to "
2854 "the end of the file is rather difficult this way since there is no concept "
2855 "of \"last line of the file\" - your expression just doesn't get called "
2856 "again. You might want to use the first method (setting C<$EDITOR>) if you "
2861 #: ../edit/virt-edit.pod:237
2863 "The variable C<$lineno> contains the current line number. As is "
2864 "traditional, the first line in the file is number C<1>."
2868 #: ../edit/virt-edit.pod:240
2870 "The return value from the expression is ignored, but the expression may call "
2871 "C<die> in order to abort the whole program, leaving the original file "
2876 #: ../edit/virt-edit.pod:244
2878 "Remember when matching the end of a line that C<$_> may contain the final C<"
2879 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
2880 "newline then neither of these. Thus to match or substitute some text at the "
2881 "end of a line, use this regular expression:"
2885 #: ../edit/virt-edit.pod:249
2888 " /some text(\\r?\\n)?$/\n"
2893 #: ../edit/virt-edit.pod:251
2895 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
2896 "$_> itself (since that would remove all newlines from the file):"
2900 #: ../edit/virt-edit.pod:255
2903 " my $m = $_; chomp $m; $m =~ /some text$/\n"
2908 #: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
2909 msgid "WINDOWS PATHS"
2913 #: ../edit/virt-edit.pod:259
2915 "C<virt-edit> has a limited ability to understand Windows drive letters and "
2916 "paths (eg. C<E:\\foo\\bar.txt>)."
2920 #: ../edit/virt-edit.pod:262
2921 msgid "If and only if the guest is running Windows then:"
2925 #: ../edit/virt-edit.pod:268
2927 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
2928 "to the correct filesystem."
2932 #: ../edit/virt-edit.pod:273
2934 "Any backslash (C<\\>) characters in the path are replaced with forward "
2935 "slashes so that libguestfs can process it."
2939 #: ../edit/virt-edit.pod:278
2941 "The path is resolved case insensitively to locate the file that should be "
2946 #: ../edit/virt-edit.pod:283
2947 msgid "There are some known shortcomings:"
2951 #: ../edit/virt-edit.pod:289
2952 msgid "Some NTFS symbolic links may not be followed correctly."
2956 #: ../edit/virt-edit.pod:293
2957 msgid "NTFS junction points that cross filesystems are not followed."
2961 #: ../edit/virt-edit.pod:299
2963 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
2964 "C<virt-edit> doesn't work."
2968 #: ../edit/virt-edit.pod:302
2969 msgid "Using C<virt-edit> is approximately equivalent to doing:"
2973 #: ../edit/virt-edit.pod:304
2976 " guestfish --rw -i -d domname edit /file\n"
2981 #: ../edit/virt-edit.pod:306
2983 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
2988 #: ../edit/virt-edit.pod:309
2990 "The command above uses libguestfs's guest inspection feature and so does not "
2991 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
2992 "disk images that don't contain guests. To edit a file on a disk image "
2997 #: ../edit/virt-edit.pod:314
3000 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
3005 #: ../edit/virt-edit.pod:316
3007 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
3008 "the disk image to edit, and C</file> is the full path to the file."
3012 #: ../edit/virt-edit.pod:320
3014 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
3015 "C<write> or C<upload> instead:"
3019 #: ../edit/virt-edit.pod:323
3022 " guestfish --rw -i -d domname touch /newfile\n"
3027 #: ../edit/virt-edit.pod:325
3030 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
3035 #: ../edit/virt-edit.pod:327
3038 " guestfish --rw -i -d domname upload localfile /newfile\n"
3043 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1086
3044 #: ../rescue/virt-rescue.pod:257 ../src/guestfs.pod:2981
3045 #: ../test-tool/libguestfs-test-tool.pod:82
3046 msgid "ENVIRONMENT VARIABLES"
3050 #: ../edit/virt-edit.pod:333
3055 #: ../edit/virt-edit.pod:335
3057 "If set, this string is used as the editor. It may contain arguments, eg. C<"
3062 #: ../edit/virt-edit.pod:338
3063 msgid "If not set, C<vi> is used."
3067 #: ../edit/virt-edit.pod:356
3069 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
3070 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
3071 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
3075 #: ../examples/guestfs-examples.pod:5
3076 msgid "guestfs-examples - Examples of using libguestfs from C"
3080 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
3083 " #include <guestfs.h>\n"
3088 #: ../examples/guestfs-examples.pod:11
3091 " guestfs_h *g = guestfs_create ();\n"
3092 " guestfs_add_drive_ro (g, \"disk.img\");\n"
3093 " guestfs_launch (g);\n"
3098 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
3101 " cc prog.c -o prog -lguestfs\n"
3103 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
3108 #: ../examples/guestfs-examples.pod:21
3110 "This manual page contains examples of calling libguestfs from the C "
3111 "programming language. If you are not familiar with using libguestfs, you "
3112 "also need to read L<guestfs(3)>."
3116 #: ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37
3117 #: ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31
3118 #: ../python/examples/guestfs-python.pod:34
3119 #: ../ruby/examples/guestfs-ruby.pod:28
3120 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
3124 #: ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39
3125 #: ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33
3126 #: ../python/examples/guestfs-python.pod:36
3127 #: ../ruby/examples/guestfs-ruby.pod:30
3132 #: ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41
3133 #: ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35
3134 #: ../python/examples/guestfs-python.pod:38
3135 #: ../ruby/examples/guestfs-ruby.pod:32
3136 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
3140 #: ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43
3141 #: ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37
3142 #: ../python/examples/guestfs-python.pod:40
3143 #: ../ruby/examples/guestfs-ruby.pod:34
3148 #: ../examples/guestfs-examples.pod:35
3150 "L<guestfs(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
3151 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
3156 #: ../examples/guestfs-examples.pod:44 ../examples/guestfs-recipes.pod:396
3157 #: ../fish/guestfish.pod:1260 ../fish/virt-copy-in.pod:60
3158 #: ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58
3159 #: ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:319
3160 #: ../inspector/virt-inspector.pod:389 ../java/examples/guestfs-java.pod:57
3161 #: ../ocaml/examples/guestfs-ocaml.pod:90 ../perl/examples/guestfs-perl.pod:51
3162 #: ../python/examples/guestfs-python.pod:53
3163 #: ../ruby/examples/guestfs-ruby.pod:47 ../src/guestfs.pod:3114
3164 #: ../test-tool/libguestfs-test-tool.pod:93
3169 #: ../examples/guestfs-examples.pod:46 ../examples/guestfs-recipes.pod:398
3170 #: ../fish/guestfish.pod:1262 ../fish/virt-copy-in.pod:62
3171 #: ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60
3172 #: ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:321
3173 #: ../java/examples/guestfs-java.pod:59 ../ocaml/examples/guestfs-ocaml.pod:92
3174 #: ../perl/examples/guestfs-perl.pod:53
3175 #: ../python/examples/guestfs-python.pod:55
3176 #: ../ruby/examples/guestfs-ruby.pod:49 ../src/guestfs.pod:3116
3177 #: ../test-tool/libguestfs-test-tool.pod:95
3178 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3182 #: ../examples/guestfs-examples.pod:50 ../ocaml/examples/guestfs-ocaml.pod:96
3183 #: ../python/examples/guestfs-python.pod:59
3184 #: ../ruby/examples/guestfs-ruby.pod:53
3185 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
3189 #: ../examples/guestfs-examples.pod:52 ../examples/guestfs-recipes.pod:404
3190 #: ../java/examples/guestfs-java.pod:65 ../ocaml/examples/guestfs-ocaml.pod:98
3191 #: ../perl/examples/guestfs-perl.pod:59
3192 #: ../python/examples/guestfs-python.pod:61
3193 #: ../ruby/examples/guestfs-ruby.pod:55
3195 "The examples in this manual page may be freely copied, modified and "
3196 "distributed without any restrictions."
3200 #: ../examples/guestfs-examples.pod:55 ../examples/guestfs-recipes.pod:407
3201 #: ../java/examples/guestfs-java.pod:68
3202 #: ../ocaml/examples/guestfs-ocaml.pod:101
3203 #: ../perl/examples/guestfs-perl.pod:62
3204 #: ../python/examples/guestfs-python.pod:64
3205 #: ../ruby/examples/guestfs-ruby.pod:58 ../src/guestfs.pod:3123
3207 "This library is free software; you can redistribute it and/or modify it "
3208 "under the terms of the GNU Lesser General Public License as published by the "
3209 "Free Software Foundation; either version 2 of the License, or (at your "
3210 "option) any later version."
3214 #: ../examples/guestfs-examples.pod:60 ../examples/guestfs-recipes.pod:412
3215 #: ../java/examples/guestfs-java.pod:73
3216 #: ../ocaml/examples/guestfs-ocaml.pod:106
3217 #: ../perl/examples/guestfs-perl.pod:67
3218 #: ../python/examples/guestfs-python.pod:69
3219 #: ../ruby/examples/guestfs-ruby.pod:63 ../src/guestfs.pod:3128
3221 "This library is distributed in the hope that it will be useful, but WITHOUT "
3222 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3223 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3228 #: ../examples/guestfs-examples.pod:65 ../examples/guestfs-recipes.pod:417
3229 #: ../java/examples/guestfs-java.pod:78
3230 #: ../ocaml/examples/guestfs-ocaml.pod:111
3231 #: ../perl/examples/guestfs-perl.pod:72
3232 #: ../python/examples/guestfs-python.pod:74
3233 #: ../ruby/examples/guestfs-ruby.pod:68 ../src/guestfs.pod:3133
3235 "You should have received a copy of the GNU Lesser General Public License "
3236 "along with this library; if not, write to the Free Software Foundation, "
3237 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3241 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
3246 #: ../examples/guestfs-recipes.pod:5
3248 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
3249 "here. The only way which works for both sorts of output is to just write "
3250 "the URL directly. Do NOT use L<...> for URLs."
3254 #: ../examples/guestfs-recipes.pod:9
3256 "We break with tradition here and don't use ALL CAPS for the section "
3257 "headings, as this makes them much easier to read."
3261 #: ../examples/guestfs-recipes.pod:16
3262 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
3266 #: ../examples/guestfs-recipes.pod:20
3268 "This page contains recipes for and links to things you can do using "
3269 "libguestfs, L<guestfish(1)> and the virt tools."
3273 #: ../examples/guestfs-recipes.pod:23
3274 msgid "Audit a virtual machine for setuid files"
3278 #: ../examples/guestfs-recipes.pod:25
3280 "The link below contains a small program which can be used to audit a Linux "
3281 "virtual machine to see what setuid and setgid files it contains."
3285 #: ../examples/guestfs-recipes.pod:28
3287 "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-"
3292 #: ../examples/guestfs-recipes.pod:30
3293 msgid "Change the background image in a Windows XP VM"
3297 #: ../examples/guestfs-recipes.pod:32
3299 "The links below explain how to use L<guestfish(1)> to change the background "
3300 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
3301 "be substantially different for each version of Windows."
3305 #: ../examples/guestfs-recipes.pod:37
3307 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html https://"
3308 "lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
3312 #: ../examples/guestfs-recipes.pod:40
3313 msgid "Cloning a virtual machine (Linux)"
3317 #: ../examples/guestfs-recipes.pod:42
3319 "The guestfish technique described in the link below works well for most "
3320 "Linux VMs. Depending on the Linux distro you may need to change the paths "
3325 #: ../examples/guestfs-recipes.pod:46
3327 "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-"
3332 #: ../examples/guestfs-recipes.pod:48
3334 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
3339 #: ../examples/guestfs-recipes.pod:51
3340 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
3344 #: ../examples/guestfs-recipes.pod:53
3345 msgid "Cloning a virtual machine (Windows)"
3349 #: ../examples/guestfs-recipes.pod:55
3351 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
3352 "straightforward. Currently there is code in the Aeolus Oz project which "
3353 "does this (using libguestfs). As part of our review of the virt-clone tool, "
3354 "we may add sysprepping ability."
3358 #: ../examples/guestfs-recipes.pod:60
3360 "https://github.com/clalancette/oz https://www.redhat.com/archives/virt-tools-"
3361 "list/2011-May/msg00019.html"
3365 #: ../examples/guestfs-recipes.pod:63
3366 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
3370 #: ../examples/guestfs-recipes.pod:65
3371 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
3375 #: ../examples/guestfs-recipes.pod:67
3378 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
3383 #: ../examples/guestfs-recipes.pod:69
3384 msgid "To export just a subdirectory, eg. C</files>, do:"
3388 #: ../examples/guestfs-recipes.pod:71
3391 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
3396 #: ../examples/guestfs-recipes.pod:73
3397 msgid "Create empty disk images"
3401 #: ../examples/guestfs-recipes.pod:75
3403 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
3404 "The useful guide below explains the options available."
3408 #: ../examples/guestfs-recipes.pod:78
3410 "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/"
3415 #: ../examples/guestfs-recipes.pod:80
3416 msgid "Dump raw filesystem content from inside a disk image or VM"
3420 #: ../examples/guestfs-recipes.pod:82
3422 "You can use the L<guestfish(1)> C<download> command to extract the raw "
3423 "filesystem content from any filesystem in a disk image or a VM (even one "
3424 "which is encrypted or buried inside an LV):"
3428 #: ../examples/guestfs-recipes.pod:86
3431 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
3436 #: ../examples/guestfs-recipes.pod:88
3439 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
3444 #: ../examples/guestfs-recipes.pod:90
3445 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
3449 #: ../examples/guestfs-recipes.pod:92
3450 msgid "Edit grub configuration in a VM"
3454 #: ../examples/guestfs-recipes.pod:94
3455 msgid "You can use this to:"
3459 #: ../examples/guestfs-recipes.pod:100
3460 msgid "Fix a virtual machine that does not boot."
3464 #: ../examples/guestfs-recipes.pod:104
3465 msgid "Change which kernel is used to boot the VM."
3469 #: ../examples/guestfs-recipes.pod:108
3470 msgid "Change kernel command line options."
3474 #: ../examples/guestfs-recipes.pod:112
3475 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
3479 #: ../examples/guestfs-recipes.pod:114
3482 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
3487 #: ../examples/guestfs-recipes.pod:116
3489 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
3494 #: ../examples/guestfs-recipes.pod:119
3497 " virt-rescue -d BrokenGuest\n"
3502 #: ../examples/guestfs-recipes.pod:121
3503 msgid "Export any directory from a VM"
3507 #: ../examples/guestfs-recipes.pod:123
3509 "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
3513 #: ../examples/guestfs-recipes.pod:126
3516 " virt-copy-out -d Guest /home .\n"
3521 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9
3522 #: ../fish/guestfish-actions.pod:1292 ../fish/guestfish-actions.pod:1934
3523 #: ../src/guestfs-actions.pod:18 ../src/guestfs-actions.pod:1922
3524 #: ../src/guestfs-actions.pod:2860 ../src/guestfs.pod:1640
3525 #: ../tools/virt-win-reg.pl:706
3530 #: ../examples/guestfs-recipes.pod:134
3532 "The final dot of the command is not a printing error. It means we want to "
3533 "copy out to the current directory."
3537 #: ../examples/guestfs-recipes.pod:139
3538 msgid "This creates a directory called C<home> under the current directory."
3542 #: ../examples/guestfs-recipes.pod:143
3544 "If the guest is a Windows guest then you can use drive letters and "
3545 "backslashes, but you must prefix the path with C<win:> and quote it to "
3546 "protect it from the shell, like this:"
3550 #: ../examples/guestfs-recipes.pod:147
3553 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
3558 #: ../examples/guestfs-recipes.pod:149
3559 msgid "To get the output as a compressed tarball, do:"
3563 #: ../examples/guestfs-recipes.pod:151
3566 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
3571 #: ../examples/guestfs-recipes.pod:153
3573 "Although it sounds tempting, this is usually not a reliable way to get a "
3574 "backup from a running guest. See the entry in the FAQ: http://libguestfs."
3575 "org/FAQ.html#backup"
3579 #: ../examples/guestfs-recipes.pod:157
3580 msgid "Find out which user is using the most space"
3584 #: ../examples/guestfs-recipes.pod:159
3586 "This simple script examines a Linux guest to find out which user is using "
3587 "the most space in their home directory:"
3591 #: ../examples/guestfs-recipes.pod:162
3599 #: ../examples/guestfs-recipes.pod:164
3607 #: ../examples/guestfs-recipes.pod:166
3616 #: ../examples/guestfs-recipes.pod:169
3619 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
3624 #: ../examples/guestfs-recipes.pod:171
3627 " for d in $(guestfish --remote ls \"$dir\"); do\n"
3628 " echo -n \"$dir/$d\"\n"
3630 " guestfish --remote du \"$dir/$d\";\n"
3631 " done | sort -nr -k 2\n"
3636 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
3639 " guestfish --remote exit\n"
3644 #: ../examples/guestfs-recipes.pod:179
3645 msgid "Get DHCP address from a VM"
3649 #: ../examples/guestfs-recipes.pod:181
3651 "The link below explains the many different possible techniques for getting "
3652 "the last assigned DHCP address of a virtual machine."
3656 #: ../examples/guestfs-recipes.pod:184
3658 "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-"
3659 "a-virtual-machine-disk-image/#content"
3663 #: ../examples/guestfs-recipes.pod:186
3665 "In the libguestfs source examples directory you will find the latest version "
3666 "of the C<virt-dhcp-address.c> program."
3670 #: ../examples/guestfs-recipes.pod:189
3671 msgid "Get the operating system product name string"
3675 #: ../examples/guestfs-recipes.pod:191
3676 msgid "Save the following script into a file called C<product-name.sh>:"
3680 #: ../examples/guestfs-recipes.pod:193
3685 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3686 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3687 " guestfish --remote inspect-get-product-name \"$root\"\n"
3688 " guestfish --remote exit\n"
3693 #: ../examples/guestfs-recipes.pod:200
3694 msgid "Make the script executable and run it on a named guest:"
3698 #: ../examples/guestfs-recipes.pod:202
3701 " # product-name.sh RHEL60x64\n"
3702 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
3707 #: ../examples/guestfs-recipes.pod:205
3709 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
3710 "C<xpath> command line tool or from your favourite programming language:"
3714 #: ../examples/guestfs-recipes.pod:209
3717 " # virt-inspector RHEL60x64 > xml\n"
3718 " # xpath '//product_name' < xml\n"
3721 " <product_name>Red Hat Enterprise Linux Server release 6.0 (Santiago)</product_name>\n"
3726 #: ../examples/guestfs-recipes.pod:215
3727 msgid "Get the default boot kernel for a Linux VM"
3731 #: ../examples/guestfs-recipes.pod:217
3733 "The link below contains a program to print the default boot kernel for a "
3738 #: ../examples/guestfs-recipes.pod:220
3740 "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-"
3741 "kernel-for-a-vm/#content"
3745 #: ../examples/guestfs-recipes.pod:222
3747 "It uses Augeas, and the technique is generally applicable for many different "
3752 #: ../examples/guestfs-recipes.pod:229
3753 msgid "listing the user accounts in the guest"
3757 #: ../examples/guestfs-recipes.pod:233
3758 msgid "what repositories is it configured to use"
3762 #: ../examples/guestfs-recipes.pod:237
3763 msgid "what NTP servers does it connect to"
3767 #: ../examples/guestfs-recipes.pod:241
3768 msgid "what were the boot messages last time it booted"
3772 #: ../examples/guestfs-recipes.pod:245
3773 msgid "listing who was logged in recently"
3777 #: ../examples/guestfs-recipes.pod:249
3778 msgid "http://augeas.net/"
3782 #: ../examples/guestfs-recipes.pod:251
3783 msgid "Install RPMs in a guest"
3787 #: ../examples/guestfs-recipes.pod:253
3789 "The link below contains a method to install RPMs in a guest. In fact the "
3790 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
3791 "installs them next time the guest is booted. You could use this technique "
3792 "to install vital security updates in an offline guest."
3796 #: ../examples/guestfs-recipes.pod:259
3798 "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
3802 #: ../examples/guestfs-recipes.pod:261
3803 msgid "List applications installed in a VM"
3807 #: ../examples/guestfs-recipes.pod:263
3808 msgid "Save the following to a file C<list-apps.sh>:"
3812 #: ../examples/guestfs-recipes.pod:265
3817 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3818 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3819 " guestfish --remote inspect-list-applications \"$root\"\n"
3820 " guestfish --remote exit\n"
3825 #: ../examples/guestfs-recipes.pod:272
3827 "Make the file executable and then you can run it on any named virtual "
3832 #: ../examples/guestfs-recipes.pod:275
3835 " # list-apps.sh WinGuest\n"
3837 " app_name: Mozilla Firefox (3.6.12)\n"
3838 " app_display_name: Mozilla Firefox (3.6.12)\n"
3840 " app_version: 3.6.12 (en-GB)\n"
3842 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
3843 " app_trans_path:\n"
3844 " app_publisher: Mozilla\n"
3845 " app_url: http://www.mozilla.com/en-GB/\n"
3846 " app_source_package:\n"
3848 " app_description: Mozilla Firefox\n"
3851 " app_name: VLC media player\n"
3852 " app_display_name: VLC media player 1.1.5\n"
3854 " app_version: 1.1.5\n"
3856 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
3857 " app_trans_path:\n"
3858 " app_publisher: VideoLAN\n"
3859 " app_url: http://www.videolan.org/\n"
3860 " app_source_package:\n"
3862 " app_description:\n"
3868 #: ../examples/guestfs-recipes.pod:305
3870 "If you want to run the script on disk images (instead of libvirt virtual "
3871 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also L<virt-inspector(1)"
3876 #: ../examples/guestfs-recipes.pod:309
3877 msgid "List files and directories in a VM"
3881 #: ../examples/guestfs-recipes.pod:311
3882 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
3886 #: ../examples/guestfs-recipes.pod:313
3889 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
3894 #: ../examples/guestfs-recipes.pod:315
3895 msgid "List services in a Windows VM"
3899 #: ../examples/guestfs-recipes.pod:317
3901 "The link below contains a script that can be used to list out the services "
3902 "from a Windows VM, and whether those services run at boot time or are loaded "
3907 #: ../examples/guestfs-recipes.pod:321
3909 "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/"
3914 #: ../examples/guestfs-recipes.pod:323
3915 msgid "Make a disk image sparse"
3919 #: ../examples/guestfs-recipes.pod:325
3921 "The link below contains some guides for making a disk image sparse (or "
3922 "reintroducing sparseness)."
3926 #: ../examples/guestfs-recipes.pod:328
3928 "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
3932 #: ../examples/guestfs-recipes.pod:330
3933 msgid "Monitor disk usage over time"
3937 #: ../examples/guestfs-recipes.pod:332
3939 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
3940 "The link below contains a guide."
3944 #: ../examples/guestfs-recipes.pod:335
3945 msgid "http://virt-tools.org/learning/advanced-virt-df/"
3949 #: ../examples/guestfs-recipes.pod:337
3950 msgid "Reading the Windows Event Log from Windows Vista (or later)"
3954 #: ../examples/guestfs-recipes.pod:339
3956 "L<guestfish(1)> plus the tools described in the link below can be used to "
3957 "read out the Windows Event Log from any virtual machine running Windows "
3958 "Vista or a later version."
3962 #: ../examples/guestfs-recipes.pod:343
3964 "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-"
3965 "guestfish/#content"
3969 #: ../examples/guestfs-recipes.pod:345
3970 msgid "Remove root password (Linux)"
3974 #: ../examples/guestfs-recipes.pod:347
3976 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
3977 "files. One use is to remove the root password from a Linux guest:"
3981 #: ../examples/guestfs-recipes.pod:350
3984 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3989 #: ../examples/guestfs-recipes.pod:352
3990 msgid "Remove Administrator password (Windows)"
3994 #: ../examples/guestfs-recipes.pod:354
3996 "The link below contains one technique for removing the Administrator "
3997 "password from a Windows VM, or to be more precise, it gives you a command "
3998 "prompt the next time you log in which you can use to bypass any security:"
4002 #: ../examples/guestfs-recipes.pod:359
4004 "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-"
4005 "administrator-password-with-guestfish/"
4009 #: ../examples/guestfs-recipes.pod:361
4010 msgid "Unpack a live CD"
4014 #: ../examples/guestfs-recipes.pod:363
4016 "Linux live CDs often contain multiple layers of disk images wrapped like a "
4017 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
4018 "layers, as outlined in the guide below."
4022 #: ../examples/guestfs-recipes.pod:367
4024 "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-"
4029 #: ../examples/guestfs-recipes.pod:369
4030 msgid "Uploading and downloading files"
4034 #: ../examples/guestfs-recipes.pod:371
4036 "The link below contains general tips on uploading (copying in) and "
4037 "downloading (copying out) files from VMs."
4041 #: ../examples/guestfs-recipes.pod:374
4043 "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
4047 #: ../examples/guestfs-recipes.pod:376
4048 msgid "Use libguestfs tools on VMware ESX guests"
4052 #: ../examples/guestfs-recipes.pod:378
4054 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
4055 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
4059 #: ../examples/guestfs-recipes.pod:382
4061 "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-"
4066 #: ../examples/guestfs-recipes.pod:386
4068 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
4069 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby"
4070 "(3)>, L<http://libguestfs.org/>."
4074 #: ../examples/guestfs-recipes.pod:402
4075 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
4079 #: ../fish/guestfish-actions.pod:1
4084 #: ../fish/guestfish-actions.pod:3
4087 " add-cdrom filename\n"
4092 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:14
4093 msgid "This function adds a virtual CD-ROM disk image to the guest."
4097 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:16
4098 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
4102 #: ../fish/guestfish-actions.pod:15
4104 "This call checks for the existence of C<filename>. This stops you from "
4105 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4106 "and C<http:> URLs. To specify those, use the general L</config> call "
4111 #: ../fish/guestfish-actions.pod:22
4113 "If you just want to add an ISO file (often you use this as an efficient way "
4114 "to transfer large files into the guest), then you should probably use L</add-"
4115 "drive-ro> instead."
4119 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163
4120 #: ../fish/guestfish-actions.pod:177
4122 "I<This function is deprecated.> In new code, use the L</add_drive_opts> call "
4127 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166
4128 #: ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:991
4129 #: ../fish/guestfish-actions.pod:1351 ../fish/guestfish-actions.pod:1365
4130 #: ../fish/guestfish-actions.pod:3090 ../fish/guestfish-actions.pod:3297
4131 #: ../fish/guestfish-actions.pod:3411 ../fish/guestfish-actions.pod:3459
4132 #: ../fish/guestfish-actions.pod:4360 ../fish/guestfish-actions.pod:4383
4133 #: ../fish/guestfish-actions.pod:4405 ../fish/guestfish-actions.pod:4443
4134 #: ../fish/guestfish-actions.pod:5092 ../fish/guestfish-actions.pod:5198
4135 #: ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:252
4136 #: ../src/guestfs-actions.pod:273 ../src/guestfs-actions.pod:1508
4137 #: ../src/guestfs-actions.pod:2007 ../src/guestfs-actions.pod:2028
4138 #: ../src/guestfs-actions.pod:4623 ../src/guestfs-actions.pod:4926
4139 #: ../src/guestfs-actions.pod:5155 ../src/guestfs-actions.pod:5255
4140 #: ../src/guestfs-actions.pod:6521 ../src/guestfs-actions.pod:6565
4141 #: ../src/guestfs-actions.pod:6599 ../src/guestfs-actions.pod:6662
4142 #: ../src/guestfs-actions.pod:7594 ../src/guestfs-actions.pod:7703
4143 #: ../src/guestfs-actions.pod:7886
4145 "Deprecated functions will not be removed from the API, but the fact that "
4146 "they are deprecated indicates that there are problems with correct use of "
4151 #: ../fish/guestfish-actions.pod:35
4156 #: ../fish/guestfish-actions.pod:37
4161 #: ../fish/guestfish-actions.pod:39
4164 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
4169 #: ../fish/guestfish-actions.pod:41
4171 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4172 "It works by connecting to libvirt, requesting the domain and domain XML from "
4173 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
4177 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:64
4179 "The number of disks added is returned. This operation is atomic: if an "
4180 "error is returned, then no disks are added."
4184 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:67
4186 "This function does some minimal checks to make sure the libvirt domain is "
4187 "not running (unless C<readonly> is true). In a future version we will try "
4188 "to acquire the libvirt lock on each disk."
4192 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:71
4194 "Disks must be accessible locally. This often means that adding disks from a "
4195 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4196 "unless those disks are accessible via the same device path locally too."
4200 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:76
4202 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
4203 "libvirt.org/uri.html>). If this is not set then we connect to the default "
4204 "libvirt URI (or one set through an environment variable, see the libvirt "
4205 "documentation for full details)."
4209 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:82
4211 "The optional C<live> flag controls whether this call will try to connect to "
4212 "a running virtual machine C<guestfsd> process if it sees a suitable "
4213 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
4214 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
4215 "DAEMONS> for more information."
4219 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:89
4221 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
4222 "passed instead of the domain name. The C<dom> string is treated as a UUID "
4223 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
4228 #: ../fish/guestfish-actions.pod:76
4230 "The other optional parameters are passed directly through to L</add-drive-"
4235 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
4236 #: ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:1973
4237 #: ../fish/guestfish-actions.pod:3139 ../fish/guestfish-actions.pod:3312
4238 #: ../fish/guestfish-actions.pod:3447
4240 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
4244 #: ../fish/guestfish-actions.pod:81
4249 #: ../fish/guestfish-actions.pod:83
4252 " add-drive filename\n"
4257 #: ../fish/guestfish-actions.pod:85
4259 "This function is the equivalent of calling L</add-drive-opts> with no "
4260 "optional parameters, so the disk is added writable, with the format being "
4261 "detected automatically."
4265 #: ../fish/guestfish-actions.pod:89
4267 "Automatic detection of the format opens you up to a potential security hole "
4268 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4269 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4270 "you should think about replacing calls to this function with calls to L</add-"
4271 "drive-opts>, and specifying the format."
4275 #: ../fish/guestfish-actions.pod:96
4276 msgid "add-drive-opts"
4280 #: ../fish/guestfish-actions.pod:98
4285 #: ../fish/guestfish-actions.pod:100
4288 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
4293 #: ../fish/guestfish-actions.pod:102 ../src/guestfs-actions.pod:160
4295 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4296 "The first time you call this function, the disk appears as C</dev/sda>, the "
4297 "second time as C</dev/sdb>, and so on."
4301 #: ../fish/guestfish-actions.pod:107 ../src/guestfs-actions.pod:165
4303 "You don't necessarily need to be root when using libguestfs. However you "
4304 "obviously do need sufficient permissions to access the filename for whatever "
4305 "operations you want to perform (ie. read access if you just want to read the "
4306 "image or write access if you want to modify the image)."
4310 #: ../fish/guestfish-actions.pod:113 ../src/guestfs-actions.pod:171
4311 msgid "This call checks that C<filename> exists."
4315 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3101
4316 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4660
4317 msgid "The optional arguments are:"
4321 #: ../fish/guestfish-actions.pod:119 ../src/guestfs-actions.pod:177
4326 #: ../fish/guestfish-actions.pod:121 ../src/guestfs-actions.pod:179
4328 "If true then the image is treated as read-only. Writes are still allowed, "
4329 "but they are stored in a temporary snapshot overlay which is discarded at "
4330 "the end. The disk that you add is not modified."
4334 #: ../fish/guestfish-actions.pod:125 ../src/guestfs-actions.pod:183
4339 #: ../fish/guestfish-actions.pod:127
4341 "This forces the image format. If you omit this (or use L</add-drive> or L</"
4342 "add-drive-ro>) then the format is automatically detected. Possible formats "
4343 "include C<raw> and C<qcow2>."
4347 #: ../fish/guestfish-actions.pod:131 ../src/guestfs-actions.pod:189
4349 "Automatic detection of the format opens you up to a potential security hole "
4350 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4351 "RHBZ#642934. Specifying the format closes this security hole."
4355 #: ../fish/guestfish-actions.pod:136 ../src/guestfs-actions.pod:194
4360 #: ../fish/guestfish-actions.pod:138
4362 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
4363 "add-drive-with-if> call (q.v.)"
4367 #: ../fish/guestfish-actions.pod:145
4368 msgid "add-drive-ro"
4372 #: ../fish/guestfish-actions.pod:147
4377 #: ../fish/guestfish-actions.pod:149
4380 " add-drive-ro filename\n"
4385 #: ../fish/guestfish-actions.pod:151
4387 "This function is the equivalent of calling L</add-drive-opts> with the "
4388 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
4389 "is added read-only, with the format being detected automatically."
4393 #: ../fish/guestfish-actions.pod:156
4394 msgid "add-drive-ro-with-if"
4398 #: ../fish/guestfish-actions.pod:158
4401 " add-drive-ro-with-if filename iface\n"
4406 #: ../fish/guestfish-actions.pod:160
4408 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
4409 "interface emulation to use at run time."
4413 #: ../fish/guestfish-actions.pod:170
4414 msgid "add-drive-with-if"
4418 #: ../fish/guestfish-actions.pod:172
4421 " add-drive-with-if filename iface\n"
4426 #: ../fish/guestfish-actions.pod:174
4428 "This is the same as L</add-drive> but it allows you to specify the QEMU "
4429 "interface emulation to use at run time."
4433 #: ../fish/guestfish-actions.pod:184
4438 #: ../fish/guestfish-actions.pod:186
4441 " aug-clear augpath\n"
4446 #: ../fish/guestfish-actions.pod:188 ../src/guestfs-actions.pod:290
4448 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4449 "L<augtool(1)> C<clear> command."
4453 #: ../fish/guestfish-actions.pod:191
4458 #: ../fish/guestfish-actions.pod:193
4466 #: ../fish/guestfish-actions.pod:195
4468 "Close the current Augeas handle and free up any resources used by it. After "
4469 "calling this, you have to call L</aug-init> again before you can use any "
4470 "other Augeas functions."
4474 #: ../fish/guestfish-actions.pod:200
4479 #: ../fish/guestfish-actions.pod:202
4482 " aug-defnode name expr val\n"
4487 #: ../fish/guestfish-actions.pod:204 ../src/guestfs-actions.pod:319
4489 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4493 #: ../fish/guestfish-actions.pod:207
4495 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4496 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
4497 "containing that single node."
4501 #: ../fish/guestfish-actions.pod:211 ../src/guestfs-actions.pod:326
4503 "On success this returns a pair containing the number of nodes in the "
4504 "nodeset, and a boolean flag if a node was created."
4508 #: ../fish/guestfish-actions.pod:215
4513 #: ../fish/guestfish-actions.pod:217
4516 " aug-defvar name expr\n"
4521 #: ../fish/guestfish-actions.pod:219 ../src/guestfs-actions.pod:343
4523 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4524 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4528 #: ../fish/guestfish-actions.pod:223 ../src/guestfs-actions.pod:347
4530 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4531 "evaluates to something which is not a nodeset."
4535 #: ../fish/guestfish-actions.pod:226
4540 #: ../fish/guestfish-actions.pod:228
4543 " aug-get augpath\n"
4548 #: ../fish/guestfish-actions.pod:230 ../src/guestfs-actions.pod:360
4550 "Look up the value associated with C<path>. If C<path> matches exactly one "
4551 "node, the C<value> is returned."
4555 #: ../fish/guestfish-actions.pod:233
4560 #: ../fish/guestfish-actions.pod:235
4563 " aug-init root flags\n"
4568 #: ../fish/guestfish-actions.pod:237 ../src/guestfs-actions.pod:375
4570 "Create a new Augeas handle for editing configuration files. If there was "
4571 "any previous Augeas handle associated with this guestfs session, then it is "
4576 #: ../fish/guestfish-actions.pod:241
4577 msgid "You must call this before using any other L</aug-*> commands."
4581 #: ../fish/guestfish-actions.pod:244 ../src/guestfs-actions.pod:382
4583 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4587 #: ../fish/guestfish-actions.pod:247 ../src/guestfs-actions.pod:385
4589 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4590 "logical I<or> of the following integers:"
4594 #: ../fish/guestfish-actions.pod:253 ../src/guestfs-actions.pod:391
4595 msgid "C<AUG_SAVE_BACKUP> = 1"
4599 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:393
4600 msgid "Keep the original file with a C<.augsave> extension."
4604 #: ../fish/guestfish-actions.pod:257 ../src/guestfs-actions.pod:395
4605 msgid "C<AUG_SAVE_NEWFILE> = 2"
4609 #: ../fish/guestfish-actions.pod:259 ../src/guestfs-actions.pod:397
4611 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4612 "original. Overrides C<AUG_SAVE_BACKUP>."
4616 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:400
4617 msgid "C<AUG_TYPE_CHECK> = 4"
4621 #: ../fish/guestfish-actions.pod:264 ../src/guestfs-actions.pod:402
4622 msgid "Typecheck lenses."
4626 #: ../fish/guestfish-actions.pod:266
4628 "This option is only useful when debugging Augeas lenses. Use of this option "
4629 "may require additional memory for the libguestfs appliance. You may need to "
4630 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
4634 #: ../fish/guestfish-actions.pod:271 ../src/guestfs-actions.pod:409
4635 msgid "C<AUG_NO_STDINC> = 8"
4639 #: ../fish/guestfish-actions.pod:273 ../src/guestfs-actions.pod:411
4640 msgid "Do not use standard load path for modules."
4644 #: ../fish/guestfish-actions.pod:275 ../src/guestfs-actions.pod:413
4645 msgid "C<AUG_SAVE_NOOP> = 16"
4649 #: ../fish/guestfish-actions.pod:277 ../src/guestfs-actions.pod:415
4650 msgid "Make save a no-op, just record what would have been changed."
4654 #: ../fish/guestfish-actions.pod:279 ../src/guestfs-actions.pod:417
4655 msgid "C<AUG_NO_LOAD> = 32"
4659 #: ../fish/guestfish-actions.pod:281
4660 msgid "Do not load the tree in L</aug-init>."
4664 #: ../fish/guestfish-actions.pod:285
4665 msgid "To close the handle, you can call L</aug-close>."
4669 #: ../fish/guestfish-actions.pod:287 ../src/guestfs-actions.pod:425
4670 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4674 #: ../fish/guestfish-actions.pod:289
4679 #: ../fish/guestfish-actions.pod:291
4682 " aug-insert augpath label true|false\n"
4687 #: ../fish/guestfish-actions.pod:293 ../src/guestfs-actions.pod:439
4689 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4690 "or after C<path> (depending on the boolean flag C<before>)."
4694 #: ../fish/guestfish-actions.pod:297 ../src/guestfs-actions.pod:443
4696 "C<path> must match exactly one existing node in the tree, and C<label> must "
4697 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4701 #: ../fish/guestfish-actions.pod:301
4706 #: ../fish/guestfish-actions.pod:303
4714 #: ../fish/guestfish-actions.pod:305 ../src/guestfs-actions.pod:456
4715 msgid "Load files into the tree."
4719 #: ../fish/guestfish-actions.pod:307 ../src/guestfs-actions.pod:458
4720 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4724 #: ../fish/guestfish-actions.pod:310
4729 #: ../fish/guestfish-actions.pod:312
4737 #: ../fish/guestfish-actions.pod:314
4739 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
4740 "resulting nodes into alphabetical order."
4744 #: ../fish/guestfish-actions.pod:317
4749 #: ../fish/guestfish-actions.pod:319
4752 " aug-match augpath\n"
4757 #: ../fish/guestfish-actions.pod:321 ../src/guestfs-actions.pod:486
4759 "Returns a list of paths which match the path expression C<path>. The "
4760 "returned paths are sufficiently qualified so that they match exactly one "
4761 "node in the current tree."
4765 #: ../fish/guestfish-actions.pod:325
4770 #: ../fish/guestfish-actions.pod:327
4773 " aug-mv src dest\n"
4778 #: ../fish/guestfish-actions.pod:329 ../src/guestfs-actions.pod:503
4780 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4781 "C<dest> is overwritten if it exists."
4785 #: ../fish/guestfish-actions.pod:332
4790 #: ../fish/guestfish-actions.pod:334
4798 #: ../fish/guestfish-actions.pod:336 ../src/guestfs-actions.pod:516
4799 msgid "Remove C<path> and all of its children."
4803 #: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:518
4804 msgid "On success this returns the number of entries which were removed."
4808 #: ../fish/guestfish-actions.pod:340
4813 #: ../fish/guestfish-actions.pod:342
4821 #: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:529
4822 msgid "This writes all pending changes to disk."
4826 #: ../fish/guestfish-actions.pod:346
4828 "The flags which were passed to L</aug-init> affect exactly how files are "
4833 #: ../fish/guestfish-actions.pod:349
4838 #: ../fish/guestfish-actions.pod:351
4841 " aug-set augpath val\n"
4846 #: ../fish/guestfish-actions.pod:353 ../src/guestfs-actions.pod:545
4847 msgid "Set the value associated with C<path> to C<val>."
4851 #: ../fish/guestfish-actions.pod:355
4853 "In the Augeas API, it is possible to clear a node by setting the value to "
4854 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4855 "this call. Instead you must use the L</aug-clear> call."
4859 #: ../fish/guestfish-actions.pod:360
4864 #: ../fish/guestfish-actions.pod:362
4867 " available 'groups ...'\n"
4872 #: ../fish/guestfish-actions.pod:364 ../src/guestfs-actions.pod:562
4874 "This command is used to check the availability of some groups of "
4875 "functionality in the appliance, which not all builds of the libguestfs "
4876 "appliance will be able to provide."
4880 #: ../fish/guestfish-actions.pod:368
4882 "The libguestfs groups, and the functions that those groups correspond to, "
4883 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4884 "runtime by calling L</available-all-groups>."
4888 #: ../fish/guestfish-actions.pod:373 ../src/guestfs-actions.pod:571
4890 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
4891 "\"]> would check for the availability of the Linux inotify functions and "
4892 "Augeas (configuration file editing) functions."
4896 #: ../fish/guestfish-actions.pod:378 ../src/guestfs-actions.pod:576
4897 msgid "The command returns no error if I<all> requested groups are available."
4901 #: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:578
4903 "It fails with an error if one or more of the requested groups is unavailable "
4908 #: ../fish/guestfish-actions.pod:383 ../src/guestfs-actions.pod:581
4910 "If an unknown group name is included in the list of groups then an error is "
4915 #: ../fish/guestfish-actions.pod:386 ../src/guestfs-actions.pod:584
4920 #: ../fish/guestfish-actions.pod:392
4921 msgid "You must call L</launch> before calling this function."
4925 #: ../fish/guestfish-actions.pod:394 ../src/guestfs-actions.pod:592
4927 "The reason is because we don't know what groups are supported by the "
4928 "appliance/daemon until it is running and can be queried."
4932 #: ../fish/guestfish-actions.pod:400 ../src/guestfs-actions.pod:598
4934 "If a group of functions is available, this does not necessarily mean that "
4935 "they will work. You still have to check for errors when calling individual "
4936 "API functions even if they are available."
4940 #: ../fish/guestfish-actions.pod:407 ../src/guestfs-actions.pod:605
4942 "It is usually the job of distro packagers to build complete functionality "
4943 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4944 "with all requirements satisfied, will support everything."
4948 #: ../fish/guestfish-actions.pod:414
4950 "This call was added in version C<1.0.80>. In previous versions of "
4951 "libguestfs all you could do would be to speculatively execute a command to "
4952 "find out if the daemon implemented it. See also L</version>."
4956 #: ../fish/guestfish-actions.pod:421
4957 msgid "available-all-groups"
4961 #: ../fish/guestfish-actions.pod:423
4964 " available-all-groups\n"
4969 #: ../fish/guestfish-actions.pod:425
4971 "This command returns a list of all optional groups that this daemon knows "
4972 "about. Note this returns both supported and unsupported groups. To find "
4973 "out which ones the daemon can actually support you have to call L</"
4974 "available> on each member of the returned list."
4978 #: ../fish/guestfish-actions.pod:431
4979 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
4983 #: ../fish/guestfish-actions.pod:433
4988 #: ../fish/guestfish-actions.pod:435
4991 " base64-in (base64file|-) filename\n"
4996 #: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:649
4998 "This command uploads base64-encoded data from C<base64file> to C<filename>."
5002 #: ../fish/guestfish-actions.pod:440 ../fish/guestfish-actions.pod:449
5003 #: ../fish/guestfish-actions.pod:698 ../fish/guestfish-actions.pod:867
5004 #: ../fish/guestfish-actions.pod:886 ../fish/guestfish-actions.pod:1260
5005 #: ../fish/guestfish-actions.pod:4663 ../fish/guestfish-actions.pod:4675
5006 #: ../fish/guestfish-actions.pod:4686 ../fish/guestfish-actions.pod:4697
5007 #: ../fish/guestfish-actions.pod:4749 ../fish/guestfish-actions.pod:4758
5008 #: ../fish/guestfish-actions.pod:4812 ../fish/guestfish-actions.pod:4835
5009 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
5013 #: ../fish/guestfish-actions.pod:442
5018 #: ../fish/guestfish-actions.pod:444
5021 " base64-out filename (base64file|-)\n"
5026 #: ../fish/guestfish-actions.pod:446 ../src/guestfs-actions.pod:663
5028 "This command downloads the contents of C<filename>, writing it out to local "
5029 "file C<base64file> encoded as base64."
5033 #: ../fish/guestfish-actions.pod:451
5034 msgid "blockdev-flushbufs"
5038 #: ../fish/guestfish-actions.pod:453
5041 " blockdev-flushbufs device\n"
5046 #: ../fish/guestfish-actions.pod:455 ../src/guestfs-actions.pod:676
5048 "This tells the kernel to flush internal buffers associated with C<device>."
5052 #: ../fish/guestfish-actions.pod:458 ../fish/guestfish-actions.pod:469
5053 #: ../fish/guestfish-actions.pod:478 ../fish/guestfish-actions.pod:488
5054 #: ../fish/guestfish-actions.pod:500 ../fish/guestfish-actions.pod:513
5055 #: ../fish/guestfish-actions.pod:521 ../fish/guestfish-actions.pod:532
5056 #: ../fish/guestfish-actions.pod:540 ../fish/guestfish-actions.pod:548
5057 #: ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:696
5058 #: ../src/guestfs-actions.pod:711 ../src/guestfs-actions.pod:727
5059 #: ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:764
5060 #: ../src/guestfs-actions.pod:778 ../src/guestfs-actions.pod:796
5061 #: ../src/guestfs-actions.pod:810 ../src/guestfs-actions.pod:824
5062 msgid "This uses the L<blockdev(8)> command."
5066 #: ../fish/guestfish-actions.pod:460
5067 msgid "blockdev-getbsz"
5071 #: ../fish/guestfish-actions.pod:462
5074 " blockdev-getbsz device\n"
5079 #: ../fish/guestfish-actions.pod:464 ../src/guestfs-actions.pod:691
5080 msgid "This returns the block size of a device."
5084 #: ../fish/guestfish-actions.pod:466 ../fish/guestfish-actions.pod:529
5085 #: ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:793
5087 "(Note this is different from both I<size in blocks> and I<filesystem block "
5092 #: ../fish/guestfish-actions.pod:471
5093 msgid "blockdev-getro"
5097 #: ../fish/guestfish-actions.pod:473
5100 " blockdev-getro device\n"
5105 #: ../fish/guestfish-actions.pod:475 ../src/guestfs-actions.pod:708
5107 "Returns a boolean indicating if the block device is read-only (true if read-"
5108 "only, false if not)."
5112 #: ../fish/guestfish-actions.pod:480
5113 msgid "blockdev-getsize64"
5117 #: ../fish/guestfish-actions.pod:482
5120 " blockdev-getsize64 device\n"
5125 #: ../fish/guestfish-actions.pod:484 ../src/guestfs-actions.pod:723
5126 msgid "This returns the size of the device in bytes."
5130 #: ../fish/guestfish-actions.pod:486
5131 msgid "See also L</blockdev-getsz>."
5135 #: ../fish/guestfish-actions.pod:490
5136 msgid "blockdev-getss"
5140 #: ../fish/guestfish-actions.pod:492
5143 " blockdev-getss device\n"
5148 #: ../fish/guestfish-actions.pod:494 ../src/guestfs-actions.pod:739
5150 "This returns the size of sectors on a block device. Usually 512, but can be "
5151 "larger for modern devices."
5155 #: ../fish/guestfish-actions.pod:497
5157 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
5161 #: ../fish/guestfish-actions.pod:502
5162 msgid "blockdev-getsz"
5166 #: ../fish/guestfish-actions.pod:504
5169 " blockdev-getsz device\n"
5174 #: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:757
5176 "This returns the size of the device in units of 512-byte sectors (even if "
5177 "the sectorsize isn't 512 bytes ... weird)."
5181 #: ../fish/guestfish-actions.pod:509
5183 "See also L</blockdev-getss> for the real sector size of the device, and L</"
5184 "blockdev-getsize64> for the more useful I<size in bytes>."
5188 #: ../fish/guestfish-actions.pod:515
5189 msgid "blockdev-rereadpt"
5193 #: ../fish/guestfish-actions.pod:517
5196 " blockdev-rereadpt device\n"
5201 #: ../fish/guestfish-actions.pod:519 ../src/guestfs-actions.pod:776
5202 msgid "Reread the partition table on C<device>."
5206 #: ../fish/guestfish-actions.pod:523
5207 msgid "blockdev-setbsz"
5211 #: ../fish/guestfish-actions.pod:525
5214 " blockdev-setbsz device blocksize\n"
5219 #: ../fish/guestfish-actions.pod:527 ../src/guestfs-actions.pod:791
5220 msgid "This sets the block size of a device."
5224 #: ../fish/guestfish-actions.pod:534
5225 msgid "blockdev-setro"
5229 #: ../fish/guestfish-actions.pod:536
5232 " blockdev-setro device\n"
5237 #: ../fish/guestfish-actions.pod:538 ../src/guestfs-actions.pod:808
5238 msgid "Sets the block device named C<device> to read-only."
5242 #: ../fish/guestfish-actions.pod:542
5243 msgid "blockdev-setrw"
5247 #: ../fish/guestfish-actions.pod:544
5250 " blockdev-setrw device\n"
5255 #: ../fish/guestfish-actions.pod:546 ../src/guestfs-actions.pod:822
5256 msgid "Sets the block device named C<device> to read-write."
5260 #: ../fish/guestfish-actions.pod:550
5261 msgid "btrfs-filesystem-resize"
5265 #: ../fish/guestfish-actions.pod:552
5268 " btrfs-filesystem-resize mountpoint [size:..]\n"
5273 #: ../fish/guestfish-actions.pod:554 ../src/guestfs-actions.pod:844
5274 msgid "This command resizes a btrfs filesystem."
5278 #: ../fish/guestfish-actions.pod:556 ../src/guestfs-actions.pod:846
5280 "Note that unlike other resize calls, the filesystem has to be mounted and "
5281 "the parameter is the mountpoint not the device (this is a requirement of "
5286 #: ../fish/guestfish-actions.pod:560 ../fish/guestfish-actions.pod:3422
5287 #: ../src/guestfs-actions.pod:850 ../src/guestfs-actions.pod:5194
5288 msgid "The optional parameters are:"
5292 #: ../fish/guestfish-actions.pod:564 ../fish/guestfish-actions.pod:3426
5293 #: ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:5198
5298 #: ../fish/guestfish-actions.pod:566 ../src/guestfs-actions.pod:856
5300 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
5301 "resized to the maximum size."
5305 #: ../fish/guestfish-actions.pod:571 ../src/guestfs-actions.pod:861
5306 msgid "See also L<btrfs(8)>."
5310 #: ../fish/guestfish-actions.pod:575
5311 msgid "case-sensitive-path"
5315 #: ../fish/guestfish-actions.pod:577
5318 " case-sensitive-path path\n"
5323 #: ../fish/guestfish-actions.pod:579 ../src/guestfs-actions.pod:895
5325 "This can be used to resolve case insensitive paths on a filesystem which is "
5326 "case sensitive. The use case is to resolve paths which you have read from "
5327 "Windows configuration files or the Windows Registry, to the true path."
5331 #: ../fish/guestfish-actions.pod:584 ../src/guestfs-actions.pod:900
5333 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5334 "(and probably others), which is that although the underlying filesystem is "
5335 "case-insensitive, the driver exports the filesystem to Linux as case-"
5340 #: ../fish/guestfish-actions.pod:589 ../src/guestfs-actions.pod:905
5342 "One consequence of this is that special directories such as C<c:\\windows> "
5343 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5344 "precise details of how they were created. In Windows itself this would not "
5349 #: ../fish/guestfish-actions.pod:595 ../src/guestfs-actions.pod:911
5351 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5356 #: ../fish/guestfish-actions.pod:598 ../src/guestfs-actions.pod:914
5358 "This function resolves the true case of each element in the path and returns "
5359 "the case-sensitive path."
5363 #: ../fish/guestfish-actions.pod:601
5365 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
5366 "WINDOWS/system32\"> (the exact return value would depend on details of how "
5367 "the directories were originally created under Windows)."
5371 #: ../fish/guestfish-actions.pod:606 ../src/guestfs-actions.pod:922
5372 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5376 #: ../fish/guestfish-actions.pod:609
5377 msgid "See also L</realpath>."
5381 #: ../fish/guestfish-actions.pod:611
5386 #: ../fish/guestfish-actions.pod:613
5394 #: ../fish/guestfish-actions.pod:615 ../fish/guestfish-actions.pod:3842
5395 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:5837
5396 msgid "Return the contents of the file named C<path>."
5400 #: ../fish/guestfish-actions.pod:617
5402 "Note that this function cannot correctly handle binary files (specifically, "
5403 "files containing C<\\0> character which is treated as end of string). For "
5404 "those you need to use the L</read-file> or L</download> functions which have "
5405 "a more complex interface."
5409 #: ../fish/guestfish-actions.pod:622 ../fish/guestfish-actions.pod:757
5410 #: ../fish/guestfish-actions.pod:769 ../fish/guestfish-actions.pod:945
5411 #: ../fish/guestfish-actions.pod:955 ../fish/guestfish-actions.pod:1022
5412 #: ../fish/guestfish-actions.pod:1032 ../fish/guestfish-actions.pod:1224
5413 #: ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:1541
5414 #: ../fish/guestfish-actions.pod:1569 ../fish/guestfish-actions.pod:1584
5415 #: ../fish/guestfish-actions.pod:1594 ../fish/guestfish-actions.pod:1613
5416 #: ../fish/guestfish-actions.pod:3712 ../fish/guestfish-actions.pod:3727
5417 #: ../fish/guestfish-actions.pod:3803 ../fish/guestfish-actions.pod:3820
5418 #: ../fish/guestfish-actions.pod:3835 ../fish/guestfish-actions.pod:4504
5419 #: ../fish/guestfish-actions.pod:4550 ../fish/guestfish-actions.pod:4635
5420 #: ../fish/guestfish-actions.pod:4650 ../fish/guestfish-actions.pod:5056
5421 #: ../fish/guestfish-actions.pod:5068 ../fish/guestfish-actions.pod:5086
5422 #: ../fish/guestfish-actions.pod:5103 ../fish/guestfish-actions.pod:5113
5423 #: ../fish/guestfish-actions.pod:5170 ../fish/guestfish-actions.pod:5180
5424 #: ../fish/guestfish-actions.pod:5209 ../fish/guestfish-actions.pod:5219
5425 #: ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:1127
5426 #: ../src/guestfs-actions.pod:1147 ../src/guestfs-actions.pod:1443
5427 #: ../src/guestfs-actions.pod:1462 ../src/guestfs-actions.pod:1565
5428 #: ../src/guestfs-actions.pod:1584 ../src/guestfs-actions.pod:1830
5429 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:2320
5430 #: ../src/guestfs-actions.pod:2363 ../src/guestfs-actions.pod:2387
5431 #: ../src/guestfs-actions.pod:2404 ../src/guestfs-actions.pod:2433
5432 #: ../src/guestfs-actions.pod:5619 ../src/guestfs-actions.pod:5645
5433 #: ../src/guestfs-actions.pod:5776 ../src/guestfs-actions.pod:5802
5434 #: ../src/guestfs-actions.pod:5826 ../src/guestfs-actions.pod:6777
5435 #: ../src/guestfs-actions.pod:6832 ../src/guestfs-actions.pod:6978
5436 #: ../src/guestfs-actions.pod:7002 ../src/guestfs-actions.pod:7667
5437 #: ../src/guestfs-actions.pod:7687 ../src/guestfs-actions.pod:7720
5438 #: ../src/guestfs-actions.pod:7739 ../src/guestfs-actions.pod:7758
5439 #: ../src/guestfs-actions.pod:7852 ../src/guestfs-actions.pod:7871
5440 #: ../src/guestfs-actions.pod:7917 ../src/guestfs-actions.pod:7936
5442 "Because of the message protocol, there is a transfer limit of somewhere "
5443 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5447 #: ../fish/guestfish-actions.pod:625
5452 #: ../fish/guestfish-actions.pod:627
5455 " checksum csumtype path\n"
5460 #: ../fish/guestfish-actions.pod:629 ../src/guestfs-actions.pod:960
5462 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5466 #: ../fish/guestfish-actions.pod:632 ../src/guestfs-actions.pod:963
5468 "The type of checksum to compute is given by the C<csumtype> parameter which "
5469 "must have one of the following values:"
5473 #: ../fish/guestfish-actions.pod:637 ../src/guestfs-actions.pod:968
5478 #: ../fish/guestfish-actions.pod:639 ../src/guestfs-actions.pod:970
5480 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5485 #: ../fish/guestfish-actions.pod:642 ../src/guestfs-actions.pod:973
5490 #: ../fish/guestfish-actions.pod:644 ../src/guestfs-actions.pod:975
5491 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5495 #: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:977
5500 #: ../fish/guestfish-actions.pod:648 ../src/guestfs-actions.pod:979
5501 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5505 #: ../fish/guestfish-actions.pod:650 ../src/guestfs-actions.pod:981
5510 #: ../fish/guestfish-actions.pod:652 ../src/guestfs-actions.pod:983
5511 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5515 #: ../fish/guestfish-actions.pod:654 ../src/guestfs-actions.pod:985
5520 #: ../fish/guestfish-actions.pod:656 ../src/guestfs-actions.pod:987
5521 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5525 #: ../fish/guestfish-actions.pod:658 ../src/guestfs-actions.pod:989
5530 #: ../fish/guestfish-actions.pod:660 ../src/guestfs-actions.pod:991
5531 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5535 #: ../fish/guestfish-actions.pod:662 ../src/guestfs-actions.pod:993
5540 #: ../fish/guestfish-actions.pod:664 ../src/guestfs-actions.pod:995
5541 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5545 #: ../fish/guestfish-actions.pod:668 ../src/guestfs-actions.pod:999
5546 msgid "The checksum is returned as a printable string."
5550 #: ../fish/guestfish-actions.pod:670
5551 msgid "To get the checksum for a device, use L</checksum-device>."
5555 #: ../fish/guestfish-actions.pod:672
5556 msgid "To get the checksums for many files, use L</checksums-out>."
5560 #: ../fish/guestfish-actions.pod:674
5561 msgid "checksum-device"
5565 #: ../fish/guestfish-actions.pod:676
5568 " checksum-device csumtype device\n"
5573 #: ../fish/guestfish-actions.pod:678
5575 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5576 "device named C<device>. For the types of checksums supported see the L</"
5577 "checksum> command."
5581 #: ../fish/guestfish-actions.pod:682
5582 msgid "checksums-out"
5586 #: ../fish/guestfish-actions.pod:684
5589 " checksums-out csumtype directory (sumsfile|-)\n"
5594 #: ../fish/guestfish-actions.pod:686 ../src/guestfs-actions.pod:1034
5596 "This command computes the checksums of all regular files in C<directory> and "
5597 "then emits a list of those checksums to the local output file C<sumsfile>."
5601 #: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1038
5603 "This can be used for verifying the integrity of a virtual machine. However "
5604 "to be properly secure you should pay attention to the output of the checksum "
5605 "command (it uses the ones from GNU coreutils). In particular when the "
5606 "filename is not printable, coreutils uses a special backslash syntax. For "
5607 "more information, see the GNU coreutils info file."
5611 #: ../fish/guestfish-actions.pod:700
5616 #: ../fish/guestfish-actions.pod:702
5619 " chmod mode path\n"
5624 #: ../fish/guestfish-actions.pod:704 ../src/guestfs-actions.pod:1057
5626 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5631 #: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1060
5633 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5634 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5639 #: ../fish/guestfish-actions.pod:711 ../fish/guestfish-actions.pod:3065
5640 #: ../fish/guestfish-actions.pod:3204 ../fish/guestfish-actions.pod:3214
5641 #: ../fish/guestfish-actions.pod:3224 ../src/guestfs-actions.pod:1064
5642 #: ../src/guestfs-actions.pod:4591 ../src/guestfs-actions.pod:4800
5643 #: ../src/guestfs-actions.pod:4819 ../src/guestfs-actions.pod:4838
5644 msgid "The mode actually set is affected by the umask."
5648 #: ../fish/guestfish-actions.pod:713
5653 #: ../fish/guestfish-actions.pod:715
5656 " chown owner group path\n"
5661 #: ../fish/guestfish-actions.pod:717 ../src/guestfs-actions.pod:1078
5662 msgid "Change the file owner to C<owner> and group to C<group>."
5666 #: ../fish/guestfish-actions.pod:719 ../fish/guestfish-actions.pod:2500
5667 #: ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:3662
5669 "Only numeric uid and gid are supported. If you want to use names, you will "
5670 "need to locate and parse the password file yourself (Augeas support makes "
5671 "this relatively easy)."
5675 #: ../fish/guestfish-actions.pod:723
5680 #: ../fish/guestfish-actions.pod:725
5683 " command 'arguments ...'\n"
5688 #: ../fish/guestfish-actions.pod:727 ../src/guestfs-actions.pod:1094
5690 "This call runs a command from the guest filesystem. The filesystem must be "
5691 "mounted, and must contain a compatible operating system (ie. something "
5692 "Linux, with the same or compatible processor architecture)."
5696 #: ../fish/guestfish-actions.pod:732
5698 "The single parameter is an argv-style list of arguments. The first element "
5699 "is the name of the program to run. Subsequent elements are parameters. The "
5700 "list must be non-empty (ie. must contain a program name). Note that the "
5701 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
5705 #: ../fish/guestfish-actions.pod:739 ../src/guestfs-actions.pod:1106
5706 msgid "The return value is anything printed to I<stdout> by the command."
5710 #: ../fish/guestfish-actions.pod:742 ../src/guestfs-actions.pod:1109
5712 "If the command returns a non-zero exit status, then this function returns an "
5713 "error message. The error message string is the content of I<stderr> from "
5718 #: ../fish/guestfish-actions.pod:746 ../src/guestfs-actions.pod:1113
5720 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
5721 "bin>. If you require a program from another location, you should provide "
5722 "the full path in the first parameter."
5726 #: ../fish/guestfish-actions.pod:751 ../src/guestfs-actions.pod:1118
5728 "Shared libraries and data files required by the program must be available on "
5729 "filesystems which are mounted in the correct places. It is the caller's "
5730 "responsibility to ensure all filesystems that are needed are mounted at the "
5735 #: ../fish/guestfish-actions.pod:760
5736 msgid "command-lines"
5740 #: ../fish/guestfish-actions.pod:762
5743 " command-lines 'arguments ...'\n"
5748 #: ../fish/guestfish-actions.pod:764
5750 "This is the same as L</command>, but splits the result into a list of lines."
5754 #: ../fish/guestfish-actions.pod:767
5755 msgid "See also: L</sh-lines>"
5759 #: ../fish/guestfish-actions.pod:772
5764 #: ../fish/guestfish-actions.pod:774
5767 " config qemuparam qemuvalue\n"
5772 #: ../fish/guestfish-actions.pod:776 ../src/guestfs-actions.pod:1159
5774 "This can be used to add arbitrary qemu command line parameters of the form "
5775 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
5776 "setting some parameters which would interfere with parameters that we use."
5780 #: ../fish/guestfish-actions.pod:781 ../src/guestfs-actions.pod:1164
5781 msgid "The first character of C<param> string must be a C<-> (dash)."
5785 #: ../fish/guestfish-actions.pod:783 ../src/guestfs-actions.pod:1166
5786 msgid "C<value> can be NULL."
5790 #: ../fish/guestfish-actions.pod:785
5795 #: ../fish/guestfish-actions.pod:787
5798 " copy-size src dest size\n"
5803 #: ../fish/guestfish-actions.pod:789 ../src/guestfs-actions.pod:1180
5805 "This command copies exactly C<size> bytes from one source device or file "
5806 "C<src> to another destination device or file C<dest>."
5810 #: ../fish/guestfish-actions.pod:792 ../src/guestfs-actions.pod:1183
5812 "Note this will fail if the source is too short or if the destination is not "
5817 #: ../fish/guestfish-actions.pod:795
5822 #: ../fish/guestfish-actions.pod:797
5830 #: ../fish/guestfish-actions.pod:799 ../src/guestfs-actions.pod:1202
5832 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5833 "destination filename or destination directory."
5837 #: ../fish/guestfish-actions.pod:802
5842 #: ../fish/guestfish-actions.pod:804
5850 #: ../fish/guestfish-actions.pod:806 ../src/guestfs-actions.pod:1216
5852 "This copies a file or directory from C<src> to C<dest> recursively using the "
5857 #: ../fish/guestfish-actions.pod:809
5862 #: ../fish/guestfish-actions.pod:811
5870 #: ../fish/guestfish-actions.pod:813 ../src/guestfs-actions.pod:1230
5872 "This command copies from one source device or file C<src> to another "
5873 "destination device or file C<dest>. Normally you would use this to copy to "
5874 "or from a device or partition, for example to duplicate a filesystem."
5878 #: ../fish/guestfish-actions.pod:818
5880 "If the destination is a device, it must be as large or larger than the "
5881 "source file or device, otherwise the copy will fail. This command cannot do "
5882 "partial copies (see L</copy-size>)."
5886 #: ../fish/guestfish-actions.pod:822
5891 #: ../fish/guestfish-actions.pod:824
5899 #: ../fish/guestfish-actions.pod:826 ../src/guestfs-actions.pod:1248
5900 msgid "This command runs the C<df> command to report disk space used."
5904 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:839
5906 "This command is mostly useful for interactive sessions. It is I<not> "
5907 "intended that you try to parse the output string. Use L</statvfs> from "
5912 #: ../fish/guestfish-actions.pod:832
5917 #: ../fish/guestfish-actions.pod:834
5925 #: ../fish/guestfish-actions.pod:836 ../src/guestfs-actions.pod:1264
5927 "This command runs the C<df -h> command to report disk space used in human-"
5932 #: ../fish/guestfish-actions.pod:843
5937 #: ../fish/guestfish-actions.pod:845
5945 #: ../fish/guestfish-actions.pod:847 ../src/guestfs-actions.pod:1281
5947 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5948 "This is sometimes useful for extended debugging of problems."
5952 #: ../fish/guestfish-actions.pod:851
5954 "Another way to get the same information is to enable verbose messages with "
5955 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
5956 "before running the program."
5960 #: ../fish/guestfish-actions.pod:856
5965 #: ../fish/guestfish-actions.pod:858
5968 " download remotefilename (filename|-)\n"
5973 #: ../fish/guestfish-actions.pod:860 ../fish/guestfish-actions.pod:873
5974 #: ../src/guestfs-actions.pod:1302 ../src/guestfs-actions.pod:1327
5976 "Download file C<remotefilename> and save it as C<filename> on the local "
5981 #: ../fish/guestfish-actions.pod:863 ../fish/guestfish-actions.pod:4808
5982 #: ../src/guestfs-actions.pod:1305 ../src/guestfs-actions.pod:7237
5983 msgid "C<filename> can also be a named pipe."
5987 #: ../fish/guestfish-actions.pod:865
5988 msgid "See also L</upload>, L</cat>."
5992 #: ../fish/guestfish-actions.pod:869
5993 msgid "download-offset"
5997 #: ../fish/guestfish-actions.pod:871
6000 " download-offset remotefilename (filename|-) offset size\n"
6005 #: ../fish/guestfish-actions.pod:876 ../src/guestfs-actions.pod:1330
6007 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6008 "region must be within the file or device)."
6012 #: ../fish/guestfish-actions.pod:879
6014 "Note that there is no limit on the amount of data that can be downloaded "
6015 "with this call, unlike with L</pread>, and this call always reads the full "
6016 "amount unless an error occurs."
6020 #: ../fish/guestfish-actions.pod:884
6021 msgid "See also L</download>, L</pread>."
6025 #: ../fish/guestfish-actions.pod:888
6030 #: ../fish/guestfish-actions.pod:890
6033 " drop-caches whattodrop\n"
6038 #: ../fish/guestfish-actions.pod:892 ../src/guestfs-actions.pod:1355
6040 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6041 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6042 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6046 #: ../fish/guestfish-actions.pod:897 ../src/guestfs-actions.pod:1360
6047 msgid "Setting C<whattodrop> to 3 should drop everything."
6051 #: ../fish/guestfish-actions.pod:899 ../src/guestfs-actions.pod:1362
6053 "This automatically calls L<sync(2)> before the operation, so that the "
6054 "maximum guest memory is freed."
6058 #: ../fish/guestfish-actions.pod:902
6063 #: ../fish/guestfish-actions.pod:904
6071 #: ../fish/guestfish-actions.pod:906 ../src/guestfs-actions.pod:1375
6073 "This command runs the C<du -s> command to estimate file space usage for "
6078 #: ../fish/guestfish-actions.pod:909 ../src/guestfs-actions.pod:1378
6080 "C<path> can be a file or a directory. If C<path> is a directory then the "
6081 "estimate includes the contents of the directory and all subdirectories "
6086 #: ../fish/guestfish-actions.pod:913 ../src/guestfs-actions.pod:1382
6088 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6092 #: ../fish/guestfish-actions.pod:916
6097 #: ../fish/guestfish-actions.pod:918
6100 " e2fsck-f device\n"
6105 #: ../fish/guestfish-actions.pod:920 ../src/guestfs-actions.pod:1400
6107 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6108 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
6113 #: ../fish/guestfish-actions.pod:924
6115 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
6116 "should use L</fsck>."
6120 #: ../fish/guestfish-actions.pod:927
6125 #: ../fish/guestfish-actions.pod:929
6128 " echo-daemon 'words ...'\n"
6133 #: ../fish/guestfish-actions.pod:931 ../src/guestfs-actions.pod:1417
6135 "This command concatenates the list of C<words> passed with single spaces "
6136 "between them and returns the resulting string."
6140 #: ../fish/guestfish-actions.pod:934 ../src/guestfs-actions.pod:1420
6141 msgid "You can use this command to test the connection through to the daemon."
6145 #: ../fish/guestfish-actions.pod:936
6146 msgid "See also L</ping-daemon>."
6150 #: ../fish/guestfish-actions.pod:938
6155 #: ../fish/guestfish-actions.pod:940
6158 " egrep regex path\n"
6163 #: ../fish/guestfish-actions.pod:942 ../src/guestfs-actions.pod:1436
6165 "This calls the external C<egrep> program and returns the matching lines."
6169 #: ../fish/guestfish-actions.pod:948
6174 #: ../fish/guestfish-actions.pod:950
6177 " egrepi regex path\n"
6182 #: ../fish/guestfish-actions.pod:952 ../src/guestfs-actions.pod:1455
6184 "This calls the external C<egrep -i> program and returns the matching lines."
6188 #: ../fish/guestfish-actions.pod:958
6193 #: ../fish/guestfish-actions.pod:960
6196 " equal file1 file2\n"
6201 #: ../fish/guestfish-actions.pod:962 ../src/guestfs-actions.pod:1474
6203 "This compares the two files C<file1> and C<file2> and returns true if their "
6204 "content is exactly equal, or false otherwise."
6208 #: ../fish/guestfish-actions.pod:965 ../src/guestfs-actions.pod:1477
6209 msgid "The external L<cmp(1)> program is used for the comparison."
6213 #: ../fish/guestfish-actions.pod:967
6218 #: ../fish/guestfish-actions.pod:969
6226 #: ../fish/guestfish-actions.pod:971 ../src/guestfs-actions.pod:1489
6228 "This returns C<true> if and only if there is a file, directory (or anything) "
6229 "with the given C<path> name."
6233 #: ../fish/guestfish-actions.pod:974
6234 msgid "See also L</is-file>, L</is-dir>, L</stat>."
6238 #: ../fish/guestfish-actions.pod:976
6243 #: ../fish/guestfish-actions.pod:978
6246 " fallocate path len\n"
6251 #: ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:999
6252 #: ../src/guestfs-actions.pod:1512 ../src/guestfs-actions.pod:1531
6254 "This command preallocates a file (containing zero bytes) named C<path> of "
6255 "size C<len> bytes. If the file exists already, it is overwritten."
6259 #: ../fish/guestfish-actions.pod:984 ../src/guestfs-actions.pod:1516
6261 "Do not confuse this with the guestfish-specific C<alloc> command which "
6262 "allocates a file in the host and attaches it as a device."
6266 #: ../fish/guestfish-actions.pod:988
6268 "I<This function is deprecated.> In new code, use the L</fallocate64> call "
6273 #: ../fish/guestfish-actions.pod:995
6278 #: ../fish/guestfish-actions.pod:997
6281 " fallocate64 path len\n"
6286 #: ../fish/guestfish-actions.pod:1003
6288 "Note that this call allocates disk blocks for the file. To create a sparse "
6289 "file use L</truncate-size> instead."
6293 #: ../fish/guestfish-actions.pod:1006
6295 "The deprecated call L</fallocate> does the same, but owing to an oversight "
6296 "it only allowed 30 bit lengths to be specified, effectively limiting the "
6297 "maximum size of files created through that call to 1GB."
6301 #: ../fish/guestfish-actions.pod:1011 ../src/guestfs-actions.pod:1543
6303 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6304 "commands which create a file in the host and attach it as a device."
6308 #: ../fish/guestfish-actions.pod:1015
6313 #: ../fish/guestfish-actions.pod:1017
6316 " fgrep pattern path\n"
6321 #: ../fish/guestfish-actions.pod:1019 ../src/guestfs-actions.pod:1558
6323 "This calls the external C<fgrep> program and returns the matching lines."
6327 #: ../fish/guestfish-actions.pod:1025
6332 #: ../fish/guestfish-actions.pod:1027
6335 " fgrepi pattern path\n"
6340 #: ../fish/guestfish-actions.pod:1029 ../src/guestfs-actions.pod:1577
6342 "This calls the external C<fgrep -i> program and returns the matching lines."
6346 #: ../fish/guestfish-actions.pod:1035
6351 #: ../fish/guestfish-actions.pod:1037
6359 #: ../fish/guestfish-actions.pod:1039 ../src/guestfs-actions.pod:1595
6361 "This call uses the standard L<file(1)> command to determine the type or "
6362 "contents of the file."
6366 #: ../fish/guestfish-actions.pod:1042 ../src/guestfs-actions.pod:1598
6368 "This call will also transparently look inside various types of compressed "
6373 #: ../fish/guestfish-actions.pod:1045 ../src/guestfs-actions.pod:1601
6375 "The exact command which runs is C<file -zb path>. Note in particular that "
6376 "the filename is not prepended to the output (the I<-b> option)."
6380 #: ../fish/guestfish-actions.pod:1049 ../src/guestfs-actions.pod:1605
6382 "The output depends on the output of the underlying L<file(1)> command and it "
6383 "can change in future in ways beyond our control. In other words, the output "
6384 "is not guaranteed by the ABI."
6388 #: ../fish/guestfish-actions.pod:1053
6390 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
6391 "(etc), L</is-zero>."
6395 #: ../fish/guestfish-actions.pod:1056
6396 msgid "file-architecture"
6400 #: ../fish/guestfish-actions.pod:1058
6403 " file-architecture filename\n"
6408 #: ../fish/guestfish-actions.pod:1060 ../src/guestfs-actions.pod:1623
6410 "This detects the architecture of the binary C<filename>, and returns it if "
6415 #: ../fish/guestfish-actions.pod:1063 ../src/guestfs-actions.pod:1626
6416 msgid "Currently defined architectures are:"
6420 #: ../fish/guestfish-actions.pod:1067 ../src/guestfs-actions.pod:1630
6425 #: ../fish/guestfish-actions.pod:1069 ../src/guestfs-actions.pod:1632
6427 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6428 "irrespective of the precise processor requirements of the binary."
6432 #: ../fish/guestfish-actions.pod:1072 ../src/guestfs-actions.pod:1635
6437 #: ../fish/guestfish-actions.pod:1074 ../src/guestfs-actions.pod:1637
6438 msgid "64 bit x86-64."
6442 #: ../fish/guestfish-actions.pod:1076 ../src/guestfs-actions.pod:1639
6447 #: ../fish/guestfish-actions.pod:1078 ../src/guestfs-actions.pod:1641
6448 msgid "32 bit SPARC."
6452 #: ../fish/guestfish-actions.pod:1080 ../src/guestfs-actions.pod:1643
6457 #: ../fish/guestfish-actions.pod:1082 ../src/guestfs-actions.pod:1645
6458 msgid "64 bit SPARC V9 and above."
6462 #: ../fish/guestfish-actions.pod:1084 ../src/guestfs-actions.pod:1647
6467 #: ../fish/guestfish-actions.pod:1086 ../src/guestfs-actions.pod:1649
6468 msgid "Intel Itanium."
6472 #: ../fish/guestfish-actions.pod:1088 ../src/guestfs-actions.pod:1651
6477 #: ../fish/guestfish-actions.pod:1090 ../src/guestfs-actions.pod:1653
6478 msgid "32 bit Power PC."
6482 #: ../fish/guestfish-actions.pod:1092 ../src/guestfs-actions.pod:1655
6487 #: ../fish/guestfish-actions.pod:1094 ../src/guestfs-actions.pod:1657
6488 msgid "64 bit Power PC."
6492 #: ../fish/guestfish-actions.pod:1098 ../src/guestfs-actions.pod:1661
6493 msgid "Libguestfs may return other architecture strings in future."
6497 #: ../fish/guestfish-actions.pod:1100 ../src/guestfs-actions.pod:1663
6498 msgid "The function works on at least the following types of files:"
6502 #: ../fish/guestfish-actions.pod:1106 ../src/guestfs-actions.pod:1669
6503 msgid "many types of Un*x and Linux binary"
6507 #: ../fish/guestfish-actions.pod:1110 ../src/guestfs-actions.pod:1673
6508 msgid "many types of Un*x and Linux shared library"
6512 #: ../fish/guestfish-actions.pod:1114 ../src/guestfs-actions.pod:1677
6513 msgid "Windows Win32 and Win64 binaries"
6517 #: ../fish/guestfish-actions.pod:1118 ../src/guestfs-actions.pod:1681
6518 msgid "Windows Win32 and Win64 DLLs"
6522 #: ../fish/guestfish-actions.pod:1120 ../src/guestfs-actions.pod:1683
6523 msgid "Win32 binaries and DLLs return C<i386>."
6527 #: ../fish/guestfish-actions.pod:1122 ../src/guestfs-actions.pod:1685
6528 msgid "Win64 binaries and DLLs return C<x86_64>."
6532 #: ../fish/guestfish-actions.pod:1126 ../src/guestfs-actions.pod:1689
6533 msgid "Linux kernel modules"
6537 #: ../fish/guestfish-actions.pod:1130 ../src/guestfs-actions.pod:1693
6538 msgid "Linux new-style initrd images"
6542 #: ../fish/guestfish-actions.pod:1134 ../src/guestfs-actions.pod:1697
6543 msgid "some non-x86 Linux vmlinuz kernels"
6547 #: ../fish/guestfish-actions.pod:1138 ../src/guestfs-actions.pod:1701
6548 msgid "What it can't do currently:"
6552 #: ../fish/guestfish-actions.pod:1144 ../src/guestfs-actions.pod:1707
6553 msgid "static libraries (libfoo.a)"
6557 #: ../fish/guestfish-actions.pod:1148 ../src/guestfs-actions.pod:1711
6558 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6562 #: ../fish/guestfish-actions.pod:1152 ../src/guestfs-actions.pod:1715
6563 msgid "x86 Linux vmlinuz kernels"
6567 #: ../fish/guestfish-actions.pod:1154 ../src/guestfs-actions.pod:1717
6569 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6570 "compressed code, and are horribly hard to unpack. If you want to find the "
6571 "architecture of a kernel, use the architecture of the associated initrd or "
6572 "kernel module(s) instead."
6576 #: ../fish/guestfish-actions.pod:1161
6581 #: ../fish/guestfish-actions.pod:1163
6589 #: ../fish/guestfish-actions.pod:1165 ../src/guestfs-actions.pod:1735
6590 msgid "This command returns the size of C<file> in bytes."
6594 #: ../fish/guestfish-actions.pod:1167
6596 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
6597 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
6601 #: ../fish/guestfish-actions.pod:1171
6606 #: ../fish/guestfish-actions.pod:1173
6609 " fill c len path\n"
6614 #: ../fish/guestfish-actions.pod:1175 ../src/guestfs-actions.pod:1753
6616 "This command creates a new file called C<path>. The initial content of the "
6617 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
6622 #: ../fish/guestfish-actions.pod:1179
6624 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6625 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
6630 #: ../fish/guestfish-actions.pod:1184
6631 msgid "fill-pattern"
6635 #: ../fish/guestfish-actions.pod:1186
6638 " fill-pattern pattern len path\n"
6643 #: ../fish/guestfish-actions.pod:1188
6645 "This function is like L</fill> except that it creates a new file of length "
6646 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
6647 "is truncated if necessary to ensure the length of the file is exactly C<len> "
6652 #: ../fish/guestfish-actions.pod:1193
6657 #: ../fish/guestfish-actions.pod:1195
6665 #: ../fish/guestfish-actions.pod:1197 ../src/guestfs-actions.pod:1799
6667 "This command lists out all files and directories, recursively, starting at "
6668 "C<directory>. It is essentially equivalent to running the shell command "
6669 "C<find directory -print> but some post-processing happens on the output, "
6674 #: ../fish/guestfish-actions.pod:1202 ../src/guestfs-actions.pod:1804
6676 "This returns a list of strings I<without any prefix>. Thus if the directory "
6681 #: ../fish/guestfish-actions.pod:1205 ../src/guestfs-actions.pod:1807
6691 #: ../fish/guestfish-actions.pod:1209
6692 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
6696 #: ../fish/guestfish-actions.pod:1212 ../src/guestfs-actions.pod:1814
6707 #: ../fish/guestfish-actions.pod:1217 ../src/guestfs-actions.pod:1819
6708 msgid "If C<directory> is not a directory, then this command returns an error."
6712 #: ../fish/guestfish-actions.pod:1220 ../src/guestfs-actions.pod:1822
6713 msgid "The returned list is sorted."
6717 #: ../fish/guestfish-actions.pod:1222
6718 msgid "See also L</find0>."
6722 #: ../fish/guestfish-actions.pod:1227
6727 #: ../fish/guestfish-actions.pod:1229
6730 " find0 directory (files|-)\n"
6735 #: ../fish/guestfish-actions.pod:1231 ../src/guestfs-actions.pod:1842
6737 "This command lists out all files and directories, recursively, starting at "
6738 "C<directory>, placing the resulting list in the external file called "
6743 #: ../fish/guestfish-actions.pod:1235
6745 "This command works the same way as L</find> with the following exceptions:"
6749 #: ../fish/guestfish-actions.pod:1242 ../src/guestfs-actions.pod:1853
6750 msgid "The resulting list is written to an external file."
6754 #: ../fish/guestfish-actions.pod:1246 ../src/guestfs-actions.pod:1857
6756 "Items (filenames) in the result are separated by C<\\0> characters. See "
6757 "L<find(1)> option I<-print0>."
6761 #: ../fish/guestfish-actions.pod:1251 ../src/guestfs-actions.pod:1862
6762 msgid "This command is not limited in the number of names that it can return."
6766 #: ../fish/guestfish-actions.pod:1256 ../src/guestfs-actions.pod:1867
6767 msgid "The result list is not sorted."
6771 #: ../fish/guestfish-actions.pod:1262
6772 msgid "findfs-label"
6776 #: ../fish/guestfish-actions.pod:1264
6779 " findfs-label label\n"
6784 #: ../fish/guestfish-actions.pod:1266 ../src/guestfs-actions.pod:1881
6786 "This command searches the filesystems and returns the one which has the "
6787 "given label. An error is returned if no such filesystem can be found."
6791 #: ../fish/guestfish-actions.pod:1270
6792 msgid "To find the label of a filesystem, use L</vfs-label>."
6796 #: ../fish/guestfish-actions.pod:1272
6801 #: ../fish/guestfish-actions.pod:1274
6804 " findfs-uuid uuid\n"
6809 #: ../fish/guestfish-actions.pod:1276 ../src/guestfs-actions.pod:1898
6811 "This command searches the filesystems and returns the one which has the "
6812 "given UUID. An error is returned if no such filesystem can be found."
6816 #: ../fish/guestfish-actions.pod:1280
6817 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
6821 #: ../fish/guestfish-actions.pod:1282
6826 #: ../fish/guestfish-actions.pod:1284
6829 " fsck fstype device\n"
6834 #: ../fish/guestfish-actions.pod:1286 ../src/guestfs-actions.pod:1916
6836 "This runs the filesystem checker (fsck) on C<device> which should have "
6837 "filesystem type C<fstype>."
6841 #: ../fish/guestfish-actions.pod:1289 ../src/guestfs-actions.pod:1919
6843 "The returned integer is the status. See L<fsck(8)> for the list of status "
6844 "codes from C<fsck>."
6848 #: ../fish/guestfish-actions.pod:1298 ../src/guestfs-actions.pod:1928
6849 msgid "Multiple status codes can be summed together."
6853 #: ../fish/guestfish-actions.pod:1302 ../src/guestfs-actions.pod:1932
6855 "A non-zero return code can mean \"success\", for example if errors have been "
6856 "corrected on the filesystem."
6860 #: ../fish/guestfish-actions.pod:1307 ../src/guestfs-actions.pod:1937
6861 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6865 #: ../fish/guestfish-actions.pod:1312 ../src/guestfs-actions.pod:1942
6867 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6871 #: ../fish/guestfish-actions.pod:1314
6876 #: ../fish/guestfish-actions.pod:1316
6884 #: ../fish/guestfish-actions.pod:1318 ../src/guestfs-actions.pod:1953
6886 "Return the additional kernel options which are added to the guest kernel "
6891 #: ../fish/guestfish-actions.pod:1321 ../src/guestfs-actions.pod:1956
6892 msgid "If C<NULL> then no options are added."
6896 #: ../fish/guestfish-actions.pod:1323
6897 msgid "get-attach-method"
6901 #: ../fish/guestfish-actions.pod:1325
6904 " get-attach-method\n"
6909 #: ../fish/guestfish-actions.pod:1327
6910 msgid "Return the current attach method. See L</set-attach-method>."
6914 #: ../fish/guestfish-actions.pod:1329
6915 msgid "get-autosync"
6919 #: ../fish/guestfish-actions.pod:1331
6927 #: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:1981
6928 msgid "Get the autosync flag."
6932 #: ../fish/guestfish-actions.pod:1335
6937 #: ../fish/guestfish-actions.pod:1337
6945 #: ../fish/guestfish-actions.pod:1339 ../src/guestfs-actions.pod:1992
6946 msgid "Return the direct appliance mode flag."
6950 #: ../fish/guestfish-actions.pod:1341
6955 #: ../fish/guestfish-actions.pod:1343
6958 " get-e2label device\n"
6963 #: ../fish/guestfish-actions.pod:1345 ../src/guestfs-actions.pod:2011
6965 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6969 #: ../fish/guestfish-actions.pod:1348
6971 "I<This function is deprecated.> In new code, use the L</vfs_label> call "
6976 #: ../fish/guestfish-actions.pod:1355
6981 #: ../fish/guestfish-actions.pod:1357
6984 " get-e2uuid device\n"
6989 #: ../fish/guestfish-actions.pod:1359 ../src/guestfs-actions.pod:2032
6991 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6995 #: ../fish/guestfish-actions.pod:1362
6997 "I<This function is deprecated.> In new code, use the L</vfs_uuid> call "
7002 #: ../fish/guestfish-actions.pod:1369
7007 #: ../fish/guestfish-actions.pod:1371
7015 #: ../fish/guestfish-actions.pod:1373 ../src/guestfs-actions.pod:2045
7017 "This gets the memory size in megabytes allocated to the qemu subprocess."
7021 #: ../fish/guestfish-actions.pod:1376
7023 "If L</set-memsize> was not called on this handle, and if "
7024 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7025 "value for memsize."
7029 #: ../fish/guestfish-actions.pod:1380 ../fish/guestfish-actions.pod:1437
7030 #: ../fish/guestfish-actions.pod:4168 ../fish/guestfish-actions.pod:4270
7031 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2144
7032 #: ../src/guestfs-actions.pod:6298 ../src/guestfs-actions.pod:6424
7034 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7038 #: ../fish/guestfish-actions.pod:1383
7043 #: ../fish/guestfish-actions.pod:1385
7051 #: ../fish/guestfish-actions.pod:1387 ../src/guestfs-actions.pod:2064
7052 msgid "This returns the enable network flag."
7056 #: ../fish/guestfish-actions.pod:1389
7061 #: ../fish/guestfish-actions.pod:1391
7069 #: ../fish/guestfish-actions.pod:1393 ../src/guestfs-actions.pod:2075
7070 msgid "Return the current search path."
7074 #: ../fish/guestfish-actions.pod:1395 ../src/guestfs-actions.pod:2077
7076 "This is always non-NULL. If it wasn't set already, then this will return "
7081 #: ../fish/guestfish-actions.pod:1398
7086 #: ../fish/guestfish-actions.pod:1400
7094 #: ../fish/guestfish-actions.pod:1402 ../src/guestfs-actions.pod:2090
7095 msgid "This returns the process group flag."
7099 #: ../fish/guestfish-actions.pod:1404
7104 #: ../fish/guestfish-actions.pod:1406
7109 #: ../fish/guestfish-actions.pod:1408
7117 #: ../fish/guestfish-actions.pod:1410 ../src/guestfs-actions.pod:2101
7119 "Return the process ID of the qemu subprocess. If there is no qemu "
7120 "subprocess, then this will return an error."
7124 #: ../fish/guestfish-actions.pod:1413 ../src/guestfs-actions.pod:2104
7125 msgid "This is an internal call used for debugging and testing."
7129 #: ../fish/guestfish-actions.pod:1415
7134 #: ../fish/guestfish-actions.pod:1417
7142 #: ../fish/guestfish-actions.pod:1419 ../src/guestfs-actions.pod:2115
7143 msgid "Return the current qemu binary."
7147 #: ../fish/guestfish-actions.pod:1421 ../src/guestfs-actions.pod:2117
7149 "This is always non-NULL. If it wasn't set already, then this will return "
7150 "the default qemu binary name."
7154 #: ../fish/guestfish-actions.pod:1424
7155 msgid "get-recovery-proc"
7159 #: ../fish/guestfish-actions.pod:1426
7162 " get-recovery-proc\n"
7167 #: ../fish/guestfish-actions.pod:1428 ../src/guestfs-actions.pod:2130
7168 msgid "Return the recovery process enabled flag."
7172 #: ../fish/guestfish-actions.pod:1430
7177 #: ../fish/guestfish-actions.pod:1432
7185 #: ../fish/guestfish-actions.pod:1434
7187 "This returns the current setting of the selinux flag which is passed to the "
7188 "appliance at boot time. See L</set-selinux>."
7192 #: ../fish/guestfish-actions.pod:1440
7197 #: ../fish/guestfish-actions.pod:1442
7205 #: ../fish/guestfish-actions.pod:1444 ../src/guestfs-actions.pod:2156
7207 "This returns the current state as an opaque integer. This is only useful "
7208 "for printing debug and internal error messages."
7212 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2367
7213 #: ../fish/guestfish-actions.pod:2385 ../fish/guestfish-actions.pod:2423
7214 #: ../fish/guestfish-actions.pod:2439 ../src/guestfs-actions.pod:2159
7215 #: ../src/guestfs-actions.pod:3439 ../src/guestfs-actions.pod:3468
7216 #: ../src/guestfs-actions.pod:3529 ../src/guestfs-actions.pod:3556
7217 msgid "For more information on states, see L<guestfs(3)>."
7221 #: ../fish/guestfish-actions.pod:1449
7226 #: ../fish/guestfish-actions.pod:1451
7234 #: ../fish/guestfish-actions.pod:1453 ../src/guestfs-actions.pod:2170
7235 msgid "Return the command trace flag."
7239 #: ../fish/guestfish-actions.pod:1455
7244 #: ../fish/guestfish-actions.pod:1457
7252 #: ../fish/guestfish-actions.pod:1459
7254 "Return the current umask. By default the umask is C<022> unless it has been "
7255 "set by calling L</umask>."
7259 #: ../fish/guestfish-actions.pod:1462
7264 #: ../fish/guestfish-actions.pod:1464
7272 #: ../fish/guestfish-actions.pod:1466 ../src/guestfs-actions.pod:2193
7273 msgid "This returns the verbose messages flag."
7277 #: ../fish/guestfish-actions.pod:1468
7282 #: ../fish/guestfish-actions.pod:1470
7290 #: ../fish/guestfish-actions.pod:1472 ../src/guestfs-actions.pod:2204
7291 msgid "This gets the SELinux security context of the daemon."
7295 #: ../fish/guestfish-actions.pod:1474
7296 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
7300 #: ../fish/guestfish-actions.pod:1477
7305 #: ../fish/guestfish-actions.pod:1479
7308 " getxattr path name\n"
7313 #: ../fish/guestfish-actions.pod:1481
7315 "Get a single extended attribute from file C<path> named C<name>. This call "
7316 "follows symlinks. If you want to lookup an extended attribute for the "
7317 "symlink itself, use L</lgetxattr>."
7321 #: ../fish/guestfish-actions.pod:1485 ../fish/guestfish-actions.pod:2512
7323 "Normally it is better to get all extended attributes from a file in one go "
7324 "by calling L</getxattrs>. However some Linux filesystem implementations are "
7325 "buggy and do not provide a way to list out attributes. For these "
7326 "filesystems (notably ntfs-3g) you have to know the names of the extended "
7327 "attributes you want in advance and call this function."
7331 #: ../fish/guestfish-actions.pod:1492 ../fish/guestfish-actions.pod:2519
7332 #: ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:3689
7334 "Extended attribute values are blobs of binary data. If there is no extended "
7335 "attribute named C<name>, this returns an error."
7339 #: ../fish/guestfish-actions.pod:1495
7340 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
7344 #: ../fish/guestfish-actions.pod:1497
7349 #: ../fish/guestfish-actions.pod:1499
7357 #: ../fish/guestfish-actions.pod:1501 ../src/guestfs-actions.pod:2250
7359 "This call lists the extended attributes of the file or directory C<path>."
7363 #: ../fish/guestfish-actions.pod:1504 ../src/guestfs-actions.pod:2253
7365 "At the system call level, this is a combination of the L<listxattr(2)> and "
7366 "L<getxattr(2)> calls."
7370 #: ../fish/guestfish-actions.pod:1507
7371 msgid "See also: L</lgetxattrs>, L<attr(5)>."
7375 #: ../fish/guestfish-actions.pod:1509
7380 #: ../fish/guestfish-actions.pod:1511
7383 " glob-expand pattern\n"
7388 #: ../fish/guestfish-actions.pod:1513 ../src/guestfs-actions.pod:2270
7390 "This command searches for all the pathnames matching C<pattern> according to "
7391 "the wildcard expansion rules used by the shell."
7395 #: ../fish/guestfish-actions.pod:1517 ../src/guestfs-actions.pod:2274
7397 "If no paths match, then this returns an empty list (note: not an error)."
7401 #: ../fish/guestfish-actions.pod:1520 ../src/guestfs-actions.pod:2277
7403 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
7404 "GLOB_BRACE>. See that manual page for more details."
7408 #: ../fish/guestfish-actions.pod:1524
7413 #: ../fish/guestfish-actions.pod:1526
7416 " grep regex path\n"
7421 #: ../fish/guestfish-actions.pod:1528 ../src/guestfs-actions.pod:2294
7422 msgid "This calls the external C<grep> program and returns the matching lines."
7426 #: ../fish/guestfish-actions.pod:1534
7431 #: ../fish/guestfish-actions.pod:1536
7434 " grepi regex path\n"
7439 #: ../fish/guestfish-actions.pod:1538 ../src/guestfs-actions.pod:2313
7441 "This calls the external C<grep -i> program and returns the matching lines."
7445 #: ../fish/guestfish-actions.pod:1544
7446 msgid "grub-install"
7450 #: ../fish/guestfish-actions.pod:1546
7453 " grub-install root device\n"
7458 #: ../fish/guestfish-actions.pod:1548 ../src/guestfs-actions.pod:2332
7460 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7461 "the root directory being C<root>."
7465 #: ../fish/guestfish-actions.pod:1551 ../src/guestfs-actions.pod:2335
7467 "Note: If grub-install reports the error \"No suitable drive was found in the "
7468 "generated device map.\" it may be that you need to create a C</boot/grub/"
7469 "device.map> file first that contains the mapping between grub device names "
7470 "and Linux device names. It is usually sufficient to create a file "
7475 #: ../fish/guestfish-actions.pod:1558 ../src/guestfs-actions.pod:2342
7483 #: ../fish/guestfish-actions.pod:1560 ../src/guestfs-actions.pod:2344
7484 msgid "replacing C</dev/vda> with the name of the installation device."
7488 #: ../fish/guestfish-actions.pod:1562
7493 #: ../fish/guestfish-actions.pod:1564
7501 #: ../fish/guestfish-actions.pod:1566 ../src/guestfs-actions.pod:2356
7503 "This command returns up to the first 10 lines of a file as a list of strings."
7507 #: ../fish/guestfish-actions.pod:1572
7512 #: ../fish/guestfish-actions.pod:1574
7515 " head-n nrlines path\n"
7520 #: ../fish/guestfish-actions.pod:1576 ../src/guestfs-actions.pod:2375
7522 "If the parameter C<nrlines> is a positive number, this returns the first "
7523 "C<nrlines> lines of the file C<path>."
7527 #: ../fish/guestfish-actions.pod:1579 ../src/guestfs-actions.pod:2378
7529 "If the parameter C<nrlines> is a negative number, this returns lines from "
7530 "the file C<path>, excluding the last C<nrlines> lines."
7534 #: ../fish/guestfish-actions.pod:1582 ../fish/guestfish-actions.pod:4648
7535 #: ../src/guestfs-actions.pod:2381 ../src/guestfs-actions.pod:6996
7536 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7540 #: ../fish/guestfish-actions.pod:1587
7545 #: ../fish/guestfish-actions.pod:1589
7553 #: ../fish/guestfish-actions.pod:1591 ../src/guestfs-actions.pod:2398
7555 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
7556 "readable, canonical hex dump of the file."
7560 #: ../fish/guestfish-actions.pod:1597
7565 #: ../fish/guestfish-actions.pod:1599
7568 " initrd-cat initrdpath filename\n"
7573 #: ../fish/guestfish-actions.pod:1601 ../src/guestfs-actions.pod:2417
7575 "This command unpacks the file C<filename> from the initrd file called "
7576 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7581 #: ../fish/guestfish-actions.pod:1605 ../src/guestfs-actions.pod:2421
7583 "For example, in guestfish you could use the following command to examine the "
7584 "boot script (usually called C</init>) contained in a Linux initrd or "
7589 #: ../fish/guestfish-actions.pod:1609 ../src/guestfs-actions.pod:2425
7592 " initrd-cat /boot/initrd-<version>.img init\n"
7597 #: ../fish/guestfish-actions.pod:1611
7598 msgid "See also L</initrd-list>."
7602 #: ../fish/guestfish-actions.pod:1616
7607 #: ../fish/guestfish-actions.pod:1618
7610 " initrd-list path\n"
7615 #: ../fish/guestfish-actions.pod:1620 ../src/guestfs-actions.pod:2444
7616 msgid "This command lists out files contained in an initrd."
7620 #: ../fish/guestfish-actions.pod:1622 ../src/guestfs-actions.pod:2446
7622 "The files are listed without any initial C</> character. The files are "
7623 "listed in the order they appear (not necessarily alphabetical). Directory "
7624 "names are listed as separate items."
7628 #: ../fish/guestfish-actions.pod:1626 ../src/guestfs-actions.pod:2450
7630 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7631 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7636 #: ../fish/guestfish-actions.pod:1630
7637 msgid "inotify-add-watch"
7641 #: ../fish/guestfish-actions.pod:1632
7644 " inotify-add-watch path mask\n"
7649 #: ../fish/guestfish-actions.pod:1634 ../src/guestfs-actions.pod:2467
7650 msgid "Watch C<path> for the events listed in C<mask>."
7654 #: ../fish/guestfish-actions.pod:1636 ../src/guestfs-actions.pod:2469
7656 "Note that if C<path> is a directory then events within that directory are "
7657 "watched, but this does I<not> happen recursively (in subdirectories)."
7661 #: ../fish/guestfish-actions.pod:1640 ../src/guestfs-actions.pod:2473
7663 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7664 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7668 #: ../fish/guestfish-actions.pod:1644
7669 msgid "inotify-close"
7673 #: ../fish/guestfish-actions.pod:1646
7681 #: ../fish/guestfish-actions.pod:1648 ../src/guestfs-actions.pod:2486
7683 "This closes the inotify handle which was previously opened by inotify_init. "
7684 "It removes all watches, throws away any pending events, and deallocates all "
7689 #: ../fish/guestfish-actions.pod:1652
7690 msgid "inotify-files"
7694 #: ../fish/guestfish-actions.pod:1654
7702 #: ../fish/guestfish-actions.pod:1656
7704 "This function is a helpful wrapper around L</inotify-read> which just "
7705 "returns a list of pathnames of objects that were touched. The returned "
7706 "pathnames are sorted and deduplicated."
7710 #: ../fish/guestfish-actions.pod:1660
7711 msgid "inotify-init"
7715 #: ../fish/guestfish-actions.pod:1662
7718 " inotify-init maxevents\n"
7723 #: ../fish/guestfish-actions.pod:1664 ../src/guestfs-actions.pod:2515
7725 "This command creates a new inotify handle. The inotify subsystem can be "
7726 "used to notify events which happen to objects in the guest filesystem."
7730 #: ../fish/guestfish-actions.pod:1668
7732 "C<maxevents> is the maximum number of events which will be queued up between "
7733 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
7734 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
7735 "default was 16384 events. Beyond this limit, the kernel throws away events, "
7736 "but records the fact that it threw them away by setting a flag "
7737 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
7741 #: ../fish/guestfish-actions.pod:1678
7743 "Before any events are generated, you have to add some watches to the "
7744 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
7745 "L</inotify-watch-all>."
7749 #: ../fish/guestfish-actions.pod:1684
7751 "Queued up events should be read periodically by calling L</inotify-read> (or "
7752 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
7753 "If you don't read the events out often enough then you risk the internal "
7754 "queue overflowing."
7758 #: ../fish/guestfish-actions.pod:1691
7760 "The handle should be closed after use by calling L</inotify-close>. This "
7761 "also removes any watches automatically."
7765 #: ../fish/guestfish-actions.pod:1695 ../src/guestfs-actions.pod:2546
7767 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7768 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7769 "that there is one global inotify handle per libguestfs instance."
7773 #: ../fish/guestfish-actions.pod:1700
7774 msgid "inotify-read"
7778 #: ../fish/guestfish-actions.pod:1702
7786 #: ../fish/guestfish-actions.pod:1704 ../src/guestfs-actions.pod:2560
7788 "Return the complete queue of events that have happened since the previous "
7793 #: ../fish/guestfish-actions.pod:1707 ../src/guestfs-actions.pod:2563
7794 msgid "If no events have happened, this returns an empty list."
7798 #: ../fish/guestfish-actions.pod:1709 ../src/guestfs-actions.pod:2565
7800 "I<Note>: In order to make sure that all events have been read, you must call "
7801 "this function repeatedly until it returns an empty list. The reason is that "
7802 "the call will read events up to the maximum appliance-to-host message size "
7803 "and leave remaining events in the queue."
7807 #: ../fish/guestfish-actions.pod:1715
7808 msgid "inotify-rm-watch"
7812 #: ../fish/guestfish-actions.pod:1717
7815 " inotify-rm-watch wd\n"
7820 #: ../fish/guestfish-actions.pod:1719
7821 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
7825 #: ../fish/guestfish-actions.pod:1722
7826 msgid "inspect-get-arch"
7830 #: ../fish/guestfish-actions.pod:1724
7833 " inspect-get-arch root\n"
7838 #: ../fish/guestfish-actions.pod:1726
7840 "This returns the architecture of the inspected operating system. The "
7841 "possible return values are listed under L</file-architecture>."
7845 #: ../fish/guestfish-actions.pod:1730 ../src/guestfs-actions.pod:2600
7847 "If the architecture could not be determined, then the string C<unknown> is "
7852 #: ../fish/guestfish-actions.pod:1733 ../fish/guestfish-actions.pod:1816
7853 #: ../fish/guestfish-actions.pod:1895 ../fish/guestfish-actions.pod:1907
7854 #: ../fish/guestfish-actions.pod:1991 ../fish/guestfish-actions.pod:2052
7855 #: ../fish/guestfish-actions.pod:2073 ../fish/guestfish-actions.pod:2087
7856 #: ../fish/guestfish-actions.pod:2127 ../fish/guestfish-actions.pod:2159
7857 #: ../fish/guestfish-actions.pod:2172 ../fish/guestfish-actions.pod:2185
7858 #: ../fish/guestfish-actions.pod:2195 ../fish/guestfish-actions.pod:2205
7859 #: ../fish/guestfish-actions.pod:2217 ../fish/guestfish-actions.pod:2313
7860 #: ../fish/guestfish-actions.pod:2347 ../src/guestfs-actions.pod:2603
7861 #: ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2797
7862 #: ../src/guestfs-actions.pod:2816 ../src/guestfs-actions.pod:2947
7863 #: ../src/guestfs-actions.pod:3030 ../src/guestfs-actions.pod:3058
7864 #: ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3132
7865 #: ../src/guestfs-actions.pod:3172 ../src/guestfs-actions.pod:3192
7866 #: ../src/guestfs-actions.pod:3212 ../src/guestfs-actions.pod:3229
7867 #: ../src/guestfs-actions.pod:3245 ../src/guestfs-actions.pod:3263
7868 #: ../src/guestfs-actions.pod:3365 ../src/guestfs-actions.pod:3406
7869 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7873 #: ../fish/guestfish-actions.pod:1735
7874 msgid "inspect-get-distro"
7878 #: ../fish/guestfish-actions.pod:1737
7881 " inspect-get-distro root\n"
7886 #: ../fish/guestfish-actions.pod:1739 ../src/guestfs-actions.pod:2616
7888 "This returns the distro (distribution) of the inspected operating system."
7892 #: ../fish/guestfish-actions.pod:1742 ../src/guestfs-actions.pod:2619
7893 msgid "Currently defined distros are:"
7897 #: ../fish/guestfish-actions.pod:1746 ../src/guestfs-actions.pod:2623
7898 msgid "\"archlinux\""
7902 #: ../fish/guestfish-actions.pod:1748 ../src/guestfs-actions.pod:2625
7907 #: ../fish/guestfish-actions.pod:1750 ../src/guestfs-actions.pod:2627
7912 #: ../fish/guestfish-actions.pod:1752 ../src/guestfs-actions.pod:2629
7917 #: ../fish/guestfish-actions.pod:1754 ../src/guestfs-actions.pod:2631
7922 #: ../fish/guestfish-actions.pod:1756 ../src/guestfs-actions.pod:2633
7927 #: ../fish/guestfish-actions.pod:1758 ../src/guestfs-actions.pod:2635
7932 #: ../fish/guestfish-actions.pod:1760 ../src/guestfs-actions.pod:2637
7937 #: ../fish/guestfish-actions.pod:1762 ../src/guestfs-actions.pod:2639
7942 #: ../fish/guestfish-actions.pod:1764 ../src/guestfs-actions.pod:2641
7947 #: ../fish/guestfish-actions.pod:1766 ../src/guestfs-actions.pod:2643
7948 msgid "\"linuxmint\""
7952 #: ../fish/guestfish-actions.pod:1768 ../src/guestfs-actions.pod:2645
7957 #: ../fish/guestfish-actions.pod:1770 ../src/guestfs-actions.pod:2647
7958 msgid "\"mandriva\""
7962 #: ../fish/guestfish-actions.pod:1772 ../src/guestfs-actions.pod:2649
7967 #: ../fish/guestfish-actions.pod:1774 ../src/guestfs-actions.pod:2651
7972 #: ../fish/guestfish-actions.pod:1776 ../src/guestfs-actions.pod:2653
7977 #: ../fish/guestfish-actions.pod:1778 ../src/guestfs-actions.pod:2655
7982 #: ../fish/guestfish-actions.pod:1780 ../src/guestfs-actions.pod:2657
7987 #: ../fish/guestfish-actions.pod:1782 ../src/guestfs-actions.pod:2659
7988 msgid "\"redhat-based\""
7992 #: ../fish/guestfish-actions.pod:1784 ../src/guestfs-actions.pod:2661
7993 msgid "Some Red Hat-derived distro."
7997 #: ../fish/guestfish-actions.pod:1786 ../src/guestfs-actions.pod:2663
8002 #: ../fish/guestfish-actions.pod:1788 ../src/guestfs-actions.pod:2665
8003 msgid "Red Hat Enterprise Linux."
8007 #: ../fish/guestfish-actions.pod:1790 ../src/guestfs-actions.pod:2667
8008 msgid "\"scientificlinux\""
8012 #: ../fish/guestfish-actions.pod:1792 ../src/guestfs-actions.pod:2669
8013 msgid "Scientific Linux."
8017 #: ../fish/guestfish-actions.pod:1794 ../src/guestfs-actions.pod:2671
8018 msgid "\"slackware\""
8022 #: ../fish/guestfish-actions.pod:1796 ../src/guestfs-actions.pod:2673
8027 #: ../fish/guestfish-actions.pod:1798 ../src/guestfs-actions.pod:2675
8032 #: ../fish/guestfish-actions.pod:1800 ../src/guestfs-actions.pod:2677
8037 #: ../fish/guestfish-actions.pod:1802 ../fish/guestfish-actions.pod:1886
8038 #: ../fish/guestfish-actions.pod:2150 ../src/guestfs-actions.pod:2679
8039 #: ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:3163
8044 #: ../fish/guestfish-actions.pod:1804 ../src/guestfs-actions.pod:2681
8045 msgid "The distro could not be determined."
8049 #: ../fish/guestfish-actions.pod:1806 ../fish/guestfish-actions.pod:2142
8050 #: ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:3155
8055 #: ../fish/guestfish-actions.pod:1808 ../src/guestfs-actions.pod:2685
8057 "Windows does not have distributions. This string is returned if the OS type "
8062 #: ../fish/guestfish-actions.pod:1813 ../fish/guestfish-actions.pod:1892
8063 #: ../fish/guestfish-actions.pod:2156 ../src/guestfs-actions.pod:2690
8064 #: ../src/guestfs-actions.pod:2794 ../src/guestfs-actions.pod:3169
8066 "Future versions of libguestfs may return other strings here. The caller "
8067 "should be prepared to handle any string."
8071 #: ../fish/guestfish-actions.pod:1818
8072 msgid "inspect-get-drive-mappings"
8076 #: ../fish/guestfish-actions.pod:1820
8079 " inspect-get-drive-mappings root\n"
8084 #: ../fish/guestfish-actions.pod:1822 ../src/guestfs-actions.pod:2706
8086 "This call is useful for Windows which uses a primitive system of assigning "
8087 "drive letters (like \"C:\") to partitions. This inspection API examines the "
8088 "Windows Registry to find out how disks/partitions are mapped to drive "
8089 "letters, and returns a hash table as in the example below:"
8093 #: ../fish/guestfish-actions.pod:1828 ../src/guestfs-actions.pod:2712
8103 #: ../fish/guestfish-actions.pod:1832 ../src/guestfs-actions.pod:2716
8105 "Note that keys are drive letters. For Windows, the key is case insensitive "
8106 "and just contains the drive letter, without the customary colon separator "
8111 #: ../fish/guestfish-actions.pod:1836 ../src/guestfs-actions.pod:2720
8113 "In future we may support other operating systems that also used drive "
8114 "letters, but the keys for those might not be case insensitive and might be "
8115 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
8120 #: ../fish/guestfish-actions.pod:1841 ../src/guestfs-actions.pod:2725
8122 "For Windows guests, currently only hard drive mappings are returned. "
8123 "Removable disks (eg. DVD-ROMs) are ignored."
8127 #: ../fish/guestfish-actions.pod:1844 ../src/guestfs-actions.pod:2728
8129 "For guests that do not use drive mappings, or if the drive mappings could "
8130 "not be determined, this returns an empty hash table."
8134 #: ../fish/guestfish-actions.pod:1847
8136 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8137 "get-mountpoints>, L</inspect-get-filesystems>."
8141 #: ../fish/guestfish-actions.pod:1851
8142 msgid "inspect-get-filesystems"
8146 #: ../fish/guestfish-actions.pod:1853
8149 " inspect-get-filesystems root\n"
8154 #: ../fish/guestfish-actions.pod:1855 ../src/guestfs-actions.pod:2749
8156 "This returns a list of all the filesystems that we think are associated with "
8157 "this operating system. This includes the root filesystem, other ordinary "
8158 "filesystems, and non-mounted devices like swap partitions."
8162 #: ../fish/guestfish-actions.pod:1860 ../src/guestfs-actions.pod:2754
8164 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8165 "to be shared between operating systems."
8169 #: ../fish/guestfish-actions.pod:1863
8171 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8176 #: ../fish/guestfish-actions.pod:1866
8177 msgid "inspect-get-format"
8181 #: ../fish/guestfish-actions.pod:1868
8184 " inspect-get-format root\n"
8189 #: ../fish/guestfish-actions.pod:1870 ../src/guestfs-actions.pod:2772
8191 "This returns the format of the inspected operating system. You can use it "
8192 "to detect install images, live CDs and similar."
8196 #: ../fish/guestfish-actions.pod:1873 ../src/guestfs-actions.pod:2775
8197 msgid "Currently defined formats are:"
8201 #: ../fish/guestfish-actions.pod:1877 ../src/guestfs-actions.pod:2779
8202 msgid "\"installed\""
8206 #: ../fish/guestfish-actions.pod:1879 ../src/guestfs-actions.pod:2781
8207 msgid "This is an installed operating system."
8211 #: ../fish/guestfish-actions.pod:1881 ../src/guestfs-actions.pod:2783
8212 msgid "\"installer\""
8216 #: ../fish/guestfish-actions.pod:1883 ../src/guestfs-actions.pod:2785
8218 "The disk image being inspected is not an installed operating system, but a "
8219 "I<bootable> install disk, live CD, or similar."
8223 #: ../fish/guestfish-actions.pod:1888 ../src/guestfs-actions.pod:2790
8224 msgid "The format of this disk image is not known."
8228 #: ../fish/guestfish-actions.pod:1897
8229 msgid "inspect-get-hostname"
8233 #: ../fish/guestfish-actions.pod:1899
8236 " inspect-get-hostname root\n"
8241 #: ../fish/guestfish-actions.pod:1901 ../src/guestfs-actions.pod:2810
8243 "This function returns the hostname of the operating system as found by "
8244 "inspection of the guest's configuration files."
8248 #: ../fish/guestfish-actions.pod:1904 ../src/guestfs-actions.pod:2813
8250 "If the hostname could not be determined, then the string C<unknown> is "
8255 #: ../fish/guestfish-actions.pod:1909
8256 msgid "inspect-get-icon"
8260 #: ../fish/guestfish-actions.pod:1911
8263 " inspect-get-icon root [favicon:..] [highquality:..]\n"
8268 #: ../fish/guestfish-actions.pod:1913 ../src/guestfs-actions.pod:2839
8270 "This function returns an icon corresponding to the inspected operating "
8271 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
8272 "to PNG if necessary)."
8276 #: ../fish/guestfish-actions.pod:1917 ../src/guestfs-actions.pod:2843
8278 "If it was not possible to get an icon this function returns a zero-length "
8279 "(non-NULL) buffer. I<Callers must check for this case>."
8283 #: ../fish/guestfish-actions.pod:1920 ../src/guestfs-actions.pod:2846
8285 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
8286 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
8287 "this file will be returned. You can disable favicons by passing the "
8288 "optional C<favicon> boolean as false (default is true)."
8292 #: ../fish/guestfish-actions.pod:1926 ../src/guestfs-actions.pod:2852
8294 "If finding the favicon fails, then we look in other places in the guest for "
8299 #: ../fish/guestfish-actions.pod:1929 ../src/guestfs-actions.pod:2855
8301 "If the optional C<highquality> boolean is true then only high quality icons "
8302 "are returned, which means only icons of high resolution with an alpha "
8303 "channel. The default (false) is to return any icon we can, even if it is of "
8304 "substandard quality."
8308 #: ../fish/guestfish-actions.pod:1940 ../src/guestfs-actions.pod:2866
8310 "Unlike most other inspection API calls, the guest's disks must be mounted up "
8311 "before you call this, since it needs to read information from the guest "
8312 "filesystem during the call."
8316 #: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:2872
8318 "B<Security:> The icon data comes from the untrusted guest, and should be "
8319 "treated with caution. PNG files have been known to contain exploits. "
8320 "Ensure that libpng (or other relevant libraries) are fully up to date before "
8321 "trying to process or display the icon."
8325 #: ../fish/guestfish-actions.pod:1954 ../src/guestfs-actions.pod:2880
8327 "The PNG image returned can be any size. It might not be square. Libguestfs "
8328 "tries to return the largest, highest quality icon available. The "
8329 "application must scale the icon to the required size."
8333 #: ../fish/guestfish-actions.pod:1961 ../src/guestfs-actions.pod:2887
8335 "Extracting icons from Windows guests requires the external C<wrestool> "
8336 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
8337 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
8338 "installed separately."
8342 #: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:2894
8344 "Operating system icons are usually trademarks. Seek legal advice before "
8345 "using trademarks in applications."
8349 #: ../fish/guestfish-actions.pod:1975
8350 msgid "inspect-get-major-version"
8354 #: ../fish/guestfish-actions.pod:1977
8357 " inspect-get-major-version root\n"
8362 #: ../fish/guestfish-actions.pod:1979 ../src/guestfs-actions.pod:2935
8364 "This returns the major version number of the inspected operating system."
8368 #: ../fish/guestfish-actions.pod:1982 ../src/guestfs-actions.pod:2938
8370 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8371 "popular public names used by the operating system. Notably the operating "
8372 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8373 "1). You can find out the real versions corresponding to releases of Windows "
8374 "by consulting Wikipedia or MSDN."
8378 #: ../fish/guestfish-actions.pod:1989 ../fish/guestfish-actions.pod:2000
8379 #: ../src/guestfs-actions.pod:2945 ../src/guestfs-actions.pod:2962
8380 msgid "If the version could not be determined, then C<0> is returned."
8384 #: ../fish/guestfish-actions.pod:1993
8385 msgid "inspect-get-minor-version"
8389 #: ../fish/guestfish-actions.pod:1995
8392 " inspect-get-minor-version root\n"
8397 #: ../fish/guestfish-actions.pod:1997 ../src/guestfs-actions.pod:2959
8399 "This returns the minor version number of the inspected operating system."
8403 #: ../fish/guestfish-actions.pod:2002
8405 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8406 "get-major-version>."
8410 #: ../fish/guestfish-actions.pod:2005
8411 msgid "inspect-get-mountpoints"
8415 #: ../fish/guestfish-actions.pod:2007
8418 " inspect-get-mountpoints root\n"
8423 #: ../fish/guestfish-actions.pod:2009 ../src/guestfs-actions.pod:2977
8425 "This returns a hash of where we think the filesystems associated with this "
8426 "operating system should be mounted. Callers should note that this is at "
8427 "best an educated guess made by reading configuration files such as C</etc/"
8428 "fstab>. I<In particular note> that this may return filesystems which are "
8429 "non-existent or not mountable and callers should be prepared to handle or "
8430 "ignore failures if they try to mount them."
8434 #: ../fish/guestfish-actions.pod:2018 ../src/guestfs-actions.pod:2986
8436 "Each element in the returned hashtable has a key which is the path of the "
8437 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8438 "mounted there (eg. C</dev/sda1>)."
8442 #: ../fish/guestfish-actions.pod:2023 ../src/guestfs-actions.pod:2991
8444 "Non-mounted devices such as swap devices are I<not> returned in this list."
8448 #: ../fish/guestfish-actions.pod:2026
8450 "For operating systems like Windows which still use drive letters, this call "
8451 "will only return an entry for the first drive \"mounted on\" C</>. For "
8452 "information about the mapping of drive letters to partitions, see L</inspect-"
8453 "get-drive-mappings>."
8457 #: ../fish/guestfish-actions.pod:2032
8459 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8464 #: ../fish/guestfish-actions.pod:2035
8465 msgid "inspect-get-package-format"
8469 #: ../fish/guestfish-actions.pod:2037
8472 " inspect-get-package-format root\n"
8477 #: ../fish/guestfish-actions.pod:2039
8479 "This function and L</inspect-get-package-management> return the package "
8480 "format and package management tool used by the inspected operating system. "
8481 "For example for Fedora these functions would return C<rpm> (package format) "
8482 "and C<yum> (package management)."
8486 #: ../fish/guestfish-actions.pod:2045 ../src/guestfs-actions.pod:3023
8488 "This returns the string C<unknown> if we could not determine the package "
8489 "format I<or> if the operating system does not have a real packaging system "
8494 #: ../fish/guestfish-actions.pod:2049 ../src/guestfs-actions.pod:3027
8496 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
8497 "Future versions of libguestfs may return other strings."
8501 #: ../fish/guestfish-actions.pod:2054
8502 msgid "inspect-get-package-management"
8506 #: ../fish/guestfish-actions.pod:2056
8509 " inspect-get-package-management root\n"
8514 #: ../fish/guestfish-actions.pod:2058
8516 "L</inspect-get-package-format> and this function return the package format "
8517 "and package management tool used by the inspected operating system. For "
8518 "example for Fedora these functions would return C<rpm> (package format) and "
8519 "C<yum> (package management)."
8523 #: ../fish/guestfish-actions.pod:2064 ../src/guestfs-actions.pod:3049
8525 "This returns the string C<unknown> if we could not determine the package "
8526 "management tool I<or> if the operating system does not have a real packaging "
8527 "system (eg. Windows)."
8531 #: ../fish/guestfish-actions.pod:2068 ../src/guestfs-actions.pod:3053
8533 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8534 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
8535 "libguestfs may return other strings."
8539 #: ../fish/guestfish-actions.pod:2075
8540 msgid "inspect-get-product-name"
8544 #: ../fish/guestfish-actions.pod:2077
8547 " inspect-get-product-name root\n"
8552 #: ../fish/guestfish-actions.pod:2079 ../src/guestfs-actions.pod:3071
8554 "This returns the product name of the inspected operating system. The "
8555 "product name is generally some freeform string which can be displayed to the "
8556 "user, but should not be parsed by programs."
8560 #: ../fish/guestfish-actions.pod:2084 ../src/guestfs-actions.pod:3076
8562 "If the product name could not be determined, then the string C<unknown> is "
8567 #: ../fish/guestfish-actions.pod:2089
8568 msgid "inspect-get-product-variant"
8572 #: ../fish/guestfish-actions.pod:2091
8575 " inspect-get-product-variant root\n"
8580 #: ../fish/guestfish-actions.pod:2093 ../src/guestfs-actions.pod:3092
8581 msgid "This returns the product variant of the inspected operating system."
8585 #: ../fish/guestfish-actions.pod:2096 ../src/guestfs-actions.pod:3095
8587 "For Windows guests, this returns the contents of the Registry key C<HKLM"
8588 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
8589 "is usually a string such as C<Client> or C<Server> (other values are "
8590 "possible). This can be used to distinguish consumer and enterprise versions "
8591 "of Windows that have the same version number (for example, Windows 7 and "
8592 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
8593 "the latter is C<Server>)."
8597 #: ../fish/guestfish-actions.pod:2105 ../src/guestfs-actions.pod:3104
8599 "For enterprise Linux guests, in future we intend this to return the product "
8600 "variant such as C<Desktop>, C<Server> and so on. But this is not "
8601 "implemented at present."
8605 #: ../fish/guestfish-actions.pod:2109 ../src/guestfs-actions.pod:3108
8607 "If the product variant could not be determined, then the string C<unknown> "
8612 #: ../fish/guestfish-actions.pod:2112
8614 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8615 "get-product-name>, L</inspect-get-major-version>."
8619 #: ../fish/guestfish-actions.pod:2116
8620 msgid "inspect-get-roots"
8624 #: ../fish/guestfish-actions.pod:2118
8627 " inspect-get-roots\n"
8632 #: ../fish/guestfish-actions.pod:2120
8634 "This function is a convenient way to get the list of root devices, as "
8635 "returned from a previous call to L</inspect-os>, but without redoing the "
8636 "whole inspection process."
8640 #: ../fish/guestfish-actions.pod:2124
8642 "This returns an empty list if either no root devices were found or the "
8643 "caller has not called L</inspect-os>."
8647 #: ../fish/guestfish-actions.pod:2129
8648 msgid "inspect-get-type"
8652 #: ../fish/guestfish-actions.pod:2131
8655 " inspect-get-type root\n"
8660 #: ../fish/guestfish-actions.pod:2133 ../src/guestfs-actions.pod:3146
8662 "This returns the type of the inspected operating system. Currently defined "
8667 #: ../fish/guestfish-actions.pod:2138 ../src/guestfs-actions.pod:3151
8672 #: ../fish/guestfish-actions.pod:2140 ../src/guestfs-actions.pod:3153
8673 msgid "Any Linux-based operating system."
8677 #: ../fish/guestfish-actions.pod:2144 ../src/guestfs-actions.pod:3157
8678 msgid "Any Microsoft Windows operating system."
8682 #: ../fish/guestfish-actions.pod:2146 ../src/guestfs-actions.pod:3159
8687 #: ../fish/guestfish-actions.pod:2148 ../src/guestfs-actions.pod:3161
8692 #: ../fish/guestfish-actions.pod:2152 ../src/guestfs-actions.pod:3165
8693 msgid "The operating system type could not be determined."
8697 #: ../fish/guestfish-actions.pod:2161
8698 msgid "inspect-get-windows-current-control-set"
8702 #: ../fish/guestfish-actions.pod:2163
8705 " inspect-get-windows-current-control-set root\n"
8710 #: ../fish/guestfish-actions.pod:2165 ../src/guestfs-actions.pod:3185
8712 "This returns the Windows CurrentControlSet of the inspected guest. The "
8713 "CurrentControlSet is a registry key name such as C<ControlSet001>."
8717 #: ../fish/guestfish-actions.pod:2168 ../src/guestfs-actions.pod:3188
8719 "This call assumes that the guest is Windows and that the Registry could be "
8720 "examined by inspection. If this is not the case then an error is returned."
8724 #: ../fish/guestfish-actions.pod:2174
8725 msgid "inspect-get-windows-systemroot"
8729 #: ../fish/guestfish-actions.pod:2176
8732 " inspect-get-windows-systemroot root\n"
8737 #: ../fish/guestfish-actions.pod:2178 ../src/guestfs-actions.pod:3205
8739 "This returns the Windows systemroot of the inspected guest. The systemroot "
8740 "is a directory path such as C</WINDOWS>."
8744 #: ../fish/guestfish-actions.pod:2181 ../src/guestfs-actions.pod:3208
8746 "This call assumes that the guest is Windows and that the systemroot could be "
8747 "determined by inspection. If this is not the case then an error is returned."
8751 #: ../fish/guestfish-actions.pod:2187
8752 msgid "inspect-is-live"
8756 #: ../fish/guestfish-actions.pod:2189
8759 " inspect-is-live root\n"
8764 #: ../fish/guestfish-actions.pod:2191
8766 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8767 "then this returns true if a live image was detected on the disk."
8771 #: ../fish/guestfish-actions.pod:2197
8772 msgid "inspect-is-multipart"
8776 #: ../fish/guestfish-actions.pod:2199
8779 " inspect-is-multipart root\n"
8784 #: ../fish/guestfish-actions.pod:2201
8786 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8787 "then this returns true if the disk is part of a set."
8791 #: ../fish/guestfish-actions.pod:2207
8792 msgid "inspect-is-netinst"
8796 #: ../fish/guestfish-actions.pod:2209
8799 " inspect-is-netinst root\n"
8804 #: ../fish/guestfish-actions.pod:2211
8806 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8807 "then this returns true if the disk is a network installer, ie. not a self-"
8808 "contained install CD but one which is likely to require network access to "
8809 "complete the install."
8813 #: ../fish/guestfish-actions.pod:2219
8814 msgid "inspect-list-applications"
8818 #: ../fish/guestfish-actions.pod:2221
8821 " inspect-list-applications root\n"
8826 #: ../fish/guestfish-actions.pod:2223 ../src/guestfs-actions.pod:3275
8827 msgid "Return the list of applications installed in the operating system."
8831 #: ../fish/guestfish-actions.pod:2225
8833 "I<Note:> This call works differently from other parts of the inspection "
8834 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
8835 "then mount up the disks, before calling this. Listing applications is a "
8836 "significantly more difficult operation which requires access to the full "
8837 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
8838 "are just returning data cached in the libguestfs handle, this call actually "
8839 "reads parts of the mounted filesystems during the call."
8843 #: ../fish/guestfish-actions.pod:2235 ../src/guestfs-actions.pod:3287
8845 "This returns an empty list if the inspection code was not able to determine "
8846 "the list of applications."
8850 #: ../fish/guestfish-actions.pod:2238 ../src/guestfs-actions.pod:3290
8851 msgid "The application structure contains the following fields:"
8855 #: ../fish/guestfish-actions.pod:2242 ../src/guestfs-actions.pod:3294
8860 #: ../fish/guestfish-actions.pod:2244 ../src/guestfs-actions.pod:3296
8862 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8863 "guests, this is the package name."
8867 #: ../fish/guestfish-actions.pod:2247 ../src/guestfs-actions.pod:3299
8868 msgid "C<app_display_name>"
8872 #: ../fish/guestfish-actions.pod:2249 ../src/guestfs-actions.pod:3301
8874 "The display name of the application, sometimes localized to the install "
8875 "language of the guest operating system."
8879 #: ../fish/guestfish-actions.pod:2252 ../src/guestfs-actions.pod:3304
8881 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8882 "to display something can use C<app_name> instead."
8886 #: ../fish/guestfish-actions.pod:2255 ../src/guestfs-actions.pod:3307
8887 msgid "C<app_epoch>"
8891 #: ../fish/guestfish-actions.pod:2257 ../src/guestfs-actions.pod:3309
8893 "For package managers which use epochs, this contains the epoch of the "
8894 "package (an integer). If unavailable, this is returned as C<0>."
8898 #: ../fish/guestfish-actions.pod:2260 ../src/guestfs-actions.pod:3312
8899 msgid "C<app_version>"
8903 #: ../fish/guestfish-actions.pod:2262 ../src/guestfs-actions.pod:3314
8905 "The version string of the application or package. If unavailable this is "
8906 "returned as an empty string C<\"\">."
8910 #: ../fish/guestfish-actions.pod:2265 ../src/guestfs-actions.pod:3317
8911 msgid "C<app_release>"
8915 #: ../fish/guestfish-actions.pod:2267 ../src/guestfs-actions.pod:3319
8917 "The release string of the application or package, for package managers that "
8918 "use this. If unavailable this is returned as an empty string C<\"\">."
8922 #: ../fish/guestfish-actions.pod:2271 ../src/guestfs-actions.pod:3323
8923 msgid "C<app_install_path>"
8927 #: ../fish/guestfish-actions.pod:2273 ../src/guestfs-actions.pod:3325
8929 "The installation path of the application (on operating systems such as "
8930 "Windows which use installation paths). This path is in the format used by "
8931 "the guest operating system, it is not a libguestfs path."
8935 #: ../fish/guestfish-actions.pod:2278 ../src/guestfs-actions.pod:3330
8936 msgid "If unavailable this is returned as an empty string C<\"\">."
8940 #: ../fish/guestfish-actions.pod:2280 ../src/guestfs-actions.pod:3332
8941 msgid "C<app_trans_path>"
8945 #: ../fish/guestfish-actions.pod:2282 ../src/guestfs-actions.pod:3334
8947 "The install path translated into a libguestfs path. If unavailable this is "
8948 "returned as an empty string C<\"\">."
8952 #: ../fish/guestfish-actions.pod:2285 ../src/guestfs-actions.pod:3337
8953 msgid "C<app_publisher>"
8957 #: ../fish/guestfish-actions.pod:2287 ../src/guestfs-actions.pod:3339
8959 "The name of the publisher of the application, for package managers that use "
8960 "this. If unavailable this is returned as an empty string C<\"\">."
8964 #: ../fish/guestfish-actions.pod:2291 ../src/guestfs-actions.pod:3343
8969 #: ../fish/guestfish-actions.pod:2293 ../src/guestfs-actions.pod:3345
8971 "The URL (eg. upstream URL) of the application. If unavailable this is "
8972 "returned as an empty string C<\"\">."
8976 #: ../fish/guestfish-actions.pod:2296 ../src/guestfs-actions.pod:3348
8977 msgid "C<app_source_package>"
8981 #: ../fish/guestfish-actions.pod:2298 ../src/guestfs-actions.pod:3350
8983 "For packaging systems which support this, the name of the source package. "
8984 "If unavailable this is returned as an empty string C<\"\">."
8988 #: ../fish/guestfish-actions.pod:2301 ../src/guestfs-actions.pod:3353
8989 msgid "C<app_summary>"
8993 #: ../fish/guestfish-actions.pod:2303 ../src/guestfs-actions.pod:3355
8995 "A short (usually one line) description of the application or package. If "
8996 "unavailable this is returned as an empty string C<\"\">."
9000 #: ../fish/guestfish-actions.pod:2306 ../src/guestfs-actions.pod:3358
9001 msgid "C<app_description>"
9005 #: ../fish/guestfish-actions.pod:2308 ../src/guestfs-actions.pod:3360
9007 "A longer description of the application or package. If unavailable this is "
9008 "returned as an empty string C<\"\">."
9012 #: ../fish/guestfish-actions.pod:2315
9017 #: ../fish/guestfish-actions.pod:2317
9025 #: ../fish/guestfish-actions.pod:2319 ../src/guestfs-actions.pod:3378
9027 "This function uses other libguestfs functions and certain heuristics to "
9028 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9029 "for operating systems."
9033 #: ../fish/guestfish-actions.pod:2323 ../src/guestfs-actions.pod:3382
9034 msgid "The list returned is empty if no operating systems were found."
9038 #: ../fish/guestfish-actions.pod:2325 ../src/guestfs-actions.pod:3384
9040 "If one operating system was found, then this returns a list with a single "
9041 "element, which is the name of the root filesystem of this operating system. "
9042 "It is also possible for this function to return a list containing more than "
9043 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9044 "element being the root filesystem of one of the operating systems."
9048 #: ../fish/guestfish-actions.pod:2332
9050 "You can pass the root string(s) returned to other L</inspect-get-*> "
9051 "functions in order to query further information about each operating system, "
9052 "such as the name and version."
9056 #: ../fish/guestfish-actions.pod:2337
9058 "This function uses other libguestfs features such as L</mount-ro> and L</"
9059 "umount-all> in order to mount and unmount filesystems and look at the "
9060 "contents. This should be called with no disks currently mounted. The "
9061 "function may also use Augeas, so any existing Augeas handle will be closed."
9065 #: ../fish/guestfish-actions.pod:2343 ../src/guestfs-actions.pod:3402
9067 "This function cannot decrypt encrypted disks. The caller must do that first "
9068 "(supplying the necessary keys) if the disk is encrypted."
9072 #: ../fish/guestfish-actions.pod:2349 ../fish/guestfish-actions.pod:2547
9073 #: ../fish/guestfish-actions.pod:2606
9074 msgid "See also L</list-filesystems>."
9078 #: ../fish/guestfish-actions.pod:2351
9083 #: ../fish/guestfish-actions.pod:2353
9086 " is-blockdev path\n"
9091 #: ../fish/guestfish-actions.pod:2355 ../src/guestfs-actions.pod:3422
9093 "This returns C<true> if and only if there is a block device with the given "
9098 #: ../fish/guestfish-actions.pod:2358 ../fish/guestfish-actions.pod:2376
9099 #: ../fish/guestfish-actions.pod:2395 ../fish/guestfish-actions.pod:2404
9100 #: ../fish/guestfish-actions.pod:2414 ../fish/guestfish-actions.pod:2448
9101 #: ../fish/guestfish-actions.pod:2457
9102 msgid "See also L</stat>."
9106 #: ../fish/guestfish-actions.pod:2360
9111 #: ../fish/guestfish-actions.pod:2362
9119 #: ../fish/guestfish-actions.pod:2364 ../src/guestfs-actions.pod:3436
9121 "This returns true iff this handle is busy processing a command (in the "
9126 #: ../fish/guestfish-actions.pod:2369
9131 #: ../fish/guestfish-actions.pod:2371
9134 " is-chardev path\n"
9139 #: ../fish/guestfish-actions.pod:2373 ../src/guestfs-actions.pod:3451
9141 "This returns C<true> if and only if there is a character device with the "
9142 "given C<path> name."
9146 #: ../fish/guestfish-actions.pod:2378
9151 #: ../fish/guestfish-actions.pod:2380
9159 #: ../fish/guestfish-actions.pod:2382 ../src/guestfs-actions.pod:3465
9161 "This returns true iff this handle is being configured (in the C<CONFIG> "
9166 #: ../fish/guestfish-actions.pod:2387
9171 #: ../fish/guestfish-actions.pod:2389
9179 #: ../fish/guestfish-actions.pod:2391 ../src/guestfs-actions.pod:3480
9181 "This returns C<true> if and only if there is a directory with the given "
9182 "C<path> name. Note that it returns false for other objects like files."
9186 #: ../fish/guestfish-actions.pod:2397
9191 #: ../fish/guestfish-actions.pod:2399
9199 #: ../fish/guestfish-actions.pod:2401 ../src/guestfs-actions.pod:3496
9201 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9202 "given C<path> name."
9206 #: ../fish/guestfish-actions.pod:2406
9211 #: ../fish/guestfish-actions.pod:2408
9219 #: ../fish/guestfish-actions.pod:2410 ../src/guestfs-actions.pod:3511
9221 "This returns C<true> if and only if there is a regular file with the given "
9222 "C<path> name. Note that it returns false for other objects like directories."
9226 #: ../fish/guestfish-actions.pod:2416
9227 msgid "is-launching"
9231 #: ../fish/guestfish-actions.pod:2418
9239 #: ../fish/guestfish-actions.pod:2420 ../src/guestfs-actions.pod:3526
9241 "This returns true iff this handle is launching the subprocess (in the "
9242 "C<LAUNCHING> state)."
9246 #: ../fish/guestfish-actions.pod:2425
9251 #: ../fish/guestfish-actions.pod:2427
9259 #: ../fish/guestfish-actions.pod:2429 ../src/guestfs-actions.pod:3541
9261 "This command tests whether C<device> is a logical volume, and returns true "
9262 "iff this is the case."
9266 #: ../fish/guestfish-actions.pod:2432
9271 #: ../fish/guestfish-actions.pod:2434
9279 #: ../fish/guestfish-actions.pod:2436 ../src/guestfs-actions.pod:3553
9281 "This returns true iff this handle is ready to accept commands (in the "
9286 #: ../fish/guestfish-actions.pod:2441
9291 #: ../fish/guestfish-actions.pod:2443
9299 #: ../fish/guestfish-actions.pod:2445 ../src/guestfs-actions.pod:3568
9301 "This returns C<true> if and only if there is a Unix domain socket with the "
9302 "given C<path> name."
9306 #: ../fish/guestfish-actions.pod:2450
9311 #: ../fish/guestfish-actions.pod:2452
9314 " is-symlink path\n"
9319 #: ../fish/guestfish-actions.pod:2454 ../src/guestfs-actions.pod:3583
9321 "This returns C<true> if and only if there is a symbolic link with the given "
9326 #: ../fish/guestfish-actions.pod:2459
9331 #: ../fish/guestfish-actions.pod:2461
9339 #: ../fish/guestfish-actions.pod:2463 ../src/guestfs-actions.pod:3598
9341 "This returns true iff the file exists and the file is empty or it contains "
9346 #: ../fish/guestfish-actions.pod:2466
9347 msgid "is-zero-device"
9351 #: ../fish/guestfish-actions.pod:2468
9354 " is-zero-device device\n"
9359 #: ../fish/guestfish-actions.pod:2470 ../src/guestfs-actions.pod:3611
9360 msgid "This returns true iff the device exists and contains all zero bytes."
9364 #: ../fish/guestfish-actions.pod:2472 ../src/guestfs-actions.pod:3613
9365 msgid "Note that for large devices this can take a long time to run."
9369 #: ../fish/guestfish-actions.pod:2474
9370 msgid "kill-subprocess"
9374 #: ../fish/guestfish-actions.pod:2476
9377 " kill-subprocess\n"
9382 #: ../fish/guestfish-actions.pod:2478 ../src/guestfs-actions.pod:3624
9383 msgid "This kills the qemu subprocess. You should never need to call this."
9387 #: ../fish/guestfish-actions.pod:2480
9392 #: ../fish/guestfish-actions.pod:2482
9397 #: ../fish/guestfish-actions.pod:2484
9405 #: ../fish/guestfish-actions.pod:2486 ../src/guestfs-actions.pod:3635
9407 "Internally libguestfs is implemented by running a virtual machine using "
9412 #: ../fish/guestfish-actions.pod:2489 ../src/guestfs-actions.pod:3638
9414 "You should call this after configuring the handle (eg. adding drives) but "
9415 "before performing any actions."
9419 #: ../fish/guestfish-actions.pod:2492
9424 #: ../fish/guestfish-actions.pod:2494
9427 " lchown owner group path\n"
9432 #: ../fish/guestfish-actions.pod:2496
9434 "Change the file owner to C<owner> and group to C<group>. This is like L</"
9435 "chown> but if C<path> is a symlink then the link itself is changed, not the "
9440 #: ../fish/guestfish-actions.pod:2504
9445 #: ../fish/guestfish-actions.pod:2506
9448 " lgetxattr path name\n"
9453 #: ../fish/guestfish-actions.pod:2508 ../src/guestfs-actions.pod:3678
9455 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
9456 "is a symlink, then this call returns an extended attribute from the symlink."
9460 #: ../fish/guestfish-actions.pod:2522
9461 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
9465 #: ../fish/guestfish-actions.pod:2524
9470 #: ../fish/guestfish-actions.pod:2526
9473 " lgetxattrs path\n"
9478 #: ../fish/guestfish-actions.pod:2528
9480 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
9481 "it returns the extended attributes of the link itself."
9485 #: ../fish/guestfish-actions.pod:2532
9490 #: ../fish/guestfish-actions.pod:2534
9498 #: ../fish/guestfish-actions.pod:2536 ../src/guestfs-actions.pod:3721
9500 "List all 9p filesystems attached to the guest. A list of mount tags is "
9505 #: ../fish/guestfish-actions.pod:2539
9506 msgid "list-devices"
9510 #: ../fish/guestfish-actions.pod:2541
9518 #: ../fish/guestfish-actions.pod:2543 ../src/guestfs-actions.pod:3735
9519 msgid "List all the block devices."
9523 #: ../fish/guestfish-actions.pod:2545 ../src/guestfs-actions.pod:3737
9524 msgid "The full block device names are returned, eg. C</dev/sda>."
9528 #: ../fish/guestfish-actions.pod:2549
9529 msgid "list-dm-devices"
9533 #: ../fish/guestfish-actions.pod:2551
9536 " list-dm-devices\n"
9541 #: ../fish/guestfish-actions.pod:2553 ../src/guestfs-actions.pod:3752
9542 msgid "List all device mapper devices."
9546 #: ../fish/guestfish-actions.pod:2555
9548 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
9549 "previous call to L</luks-open>."
9553 #: ../fish/guestfish-actions.pod:2558
9555 "Device mapper devices which correspond to logical volumes are I<not> "
9556 "returned in this list. Call L</lvs> if you want to list logical volumes."
9560 #: ../fish/guestfish-actions.pod:2562
9561 msgid "list-filesystems"
9565 #: ../fish/guestfish-actions.pod:2564
9568 " list-filesystems\n"
9573 #: ../fish/guestfish-actions.pod:2566 ../src/guestfs-actions.pod:3772
9575 "This inspection command looks for filesystems on partitions, block devices "
9576 "and logical volumes, returning a list of devices containing filesystems and "
9581 #: ../fish/guestfish-actions.pod:2570 ../src/guestfs-actions.pod:3776
9583 "The return value is a hash, where the keys are the devices containing "
9584 "filesystems, and the values are the filesystem types. For example:"
9588 #: ../fish/guestfish-actions.pod:2574 ../src/guestfs-actions.pod:3780
9591 " \"/dev/sda1\" => \"ntfs\"\n"
9592 " \"/dev/sda2\" => \"ext2\"\n"
9593 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9594 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9599 #: ../fish/guestfish-actions.pod:2579 ../src/guestfs-actions.pod:3785
9601 "The value can have the special value \"unknown\", meaning the content of the "
9602 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9606 #: ../fish/guestfish-actions.pod:2583
9608 "This command runs other libguestfs commands, which might include L</mount> "
9609 "and L</umount>, and therefore you should use this soon after launch and only "
9610 "when nothing is mounted."
9614 #: ../fish/guestfish-actions.pod:2587
9616 "Not all of the filesystems returned will be mountable. In particular, swap "
9617 "partitions are returned in the list. Also this command does not check that "
9618 "each filesystem found is valid and mountable, and some filesystems might be "
9619 "mountable but require special options. Filesystems may not all belong to a "
9620 "single logical operating system (use L</inspect-os> to look for OSes)."
9624 #: ../fish/guestfish-actions.pod:2595
9625 msgid "list-partitions"
9629 #: ../fish/guestfish-actions.pod:2597
9632 " list-partitions\n"
9637 #: ../fish/guestfish-actions.pod:2599 ../src/guestfs-actions.pod:3814
9638 msgid "List all the partitions detected on all block devices."
9642 #: ../fish/guestfish-actions.pod:2601 ../src/guestfs-actions.pod:3816
9643 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9647 #: ../fish/guestfish-actions.pod:2603
9649 "This does not return logical volumes. For that you will need to call L</"
9654 #: ../fish/guestfish-actions.pod:2608
9659 #: ../fish/guestfish-actions.pod:2610
9667 #: ../fish/guestfish-actions.pod:2612 ../src/guestfs-actions.pod:3835
9669 "List the files in C<directory> (relative to the root directory, there is no "
9670 "cwd) in the format of 'ls -la'."
9674 #: ../fish/guestfish-actions.pod:2615 ../src/guestfs-actions.pod:3838
9676 "This command is mostly useful for interactive sessions. It is I<not> "
9677 "intended that you try to parse the output string."
9681 #: ../fish/guestfish-actions.pod:2618
9686 #: ../fish/guestfish-actions.pod:2620
9689 " ln target linkname\n"
9694 #: ../fish/guestfish-actions.pod:2622 ../src/guestfs-actions.pod:3853
9695 msgid "This command creates a hard link using the C<ln> command."
9699 #: ../fish/guestfish-actions.pod:2624
9704 #: ../fish/guestfish-actions.pod:2626
9707 " ln-f target linkname\n"
9712 #: ../fish/guestfish-actions.pod:2628 ../src/guestfs-actions.pod:3866
9714 "This command creates a hard link using the C<ln -f> command. The I<-f> "
9715 "option removes the link (C<linkname>) if it exists already."
9719 #: ../fish/guestfish-actions.pod:2631
9724 #: ../fish/guestfish-actions.pod:2633
9727 " ln-s target linkname\n"
9732 #: ../fish/guestfish-actions.pod:2635 ../src/guestfs-actions.pod:3880
9733 msgid "This command creates a symbolic link using the C<ln -s> command."
9737 #: ../fish/guestfish-actions.pod:2637
9742 #: ../fish/guestfish-actions.pod:2639
9745 " ln-sf target linkname\n"
9750 #: ../fish/guestfish-actions.pod:2641 ../src/guestfs-actions.pod:3893
9752 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
9753 "option removes the link (C<linkname>) if it exists already."
9757 #: ../fish/guestfish-actions.pod:2644
9758 msgid "lremovexattr"
9762 #: ../fish/guestfish-actions.pod:2646
9765 " lremovexattr xattr path\n"
9770 #: ../fish/guestfish-actions.pod:2648
9772 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
9773 "it removes an extended attribute of the link itself."
9777 #: ../fish/guestfish-actions.pod:2652
9782 #: ../fish/guestfish-actions.pod:2654
9790 #: ../fish/guestfish-actions.pod:2656 ../src/guestfs-actions.pod:3921
9792 "List the files in C<directory> (relative to the root directory, there is no "
9793 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
9797 #: ../fish/guestfish-actions.pod:2660
9799 "This command is mostly useful for interactive sessions. Programs should "
9800 "probably use L</readdir> instead."
9804 #: ../fish/guestfish-actions.pod:2663
9809 #: ../fish/guestfish-actions.pod:2665
9812 " lsetxattr xattr val vallen path\n"
9817 #: ../fish/guestfish-actions.pod:2667
9819 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
9820 "sets an extended attribute of the link itself."
9824 #: ../fish/guestfish-actions.pod:2671
9829 #: ../fish/guestfish-actions.pod:2673
9837 #: ../fish/guestfish-actions.pod:2675 ../fish/guestfish-actions.pod:4483
9838 #: ../src/guestfs-actions.pod:3957 ../src/guestfs-actions.pod:6736
9839 msgid "Returns file information for the given C<path>."
9843 #: ../fish/guestfish-actions.pod:2677
9845 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
9846 "the link is stat-ed, not the file it refers to."
9850 #: ../fish/guestfish-actions.pod:2681 ../src/guestfs-actions.pod:3963
9851 msgid "This is the same as the C<lstat(2)> system call."
9855 #: ../fish/guestfish-actions.pod:2683
9860 #: ../fish/guestfish-actions.pod:2685
9863 " lstatlist path 'names ...'\n"
9868 #: ../fish/guestfish-actions.pod:2687
9870 "This call allows you to perform the L</lstat> operation on multiple files, "
9871 "where all files are in the directory C<path>. C<names> is the list of files "
9872 "from this directory."
9876 #: ../fish/guestfish-actions.pod:2691 ../src/guestfs-actions.pod:3982
9878 "On return you get a list of stat structs, with a one-to-one correspondence "
9879 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9880 "then the C<ino> field of that structure is set to C<-1>."
9884 #: ../fish/guestfish-actions.pod:2696
9886 "This call is intended for programs that want to efficiently list a directory "
9887 "contents without making many round-trips. See also L</lxattrlist> for a "
9888 "similarly efficient call for getting extended attributes. Very long "
9889 "directory listings might cause the protocol message size to be exceeded, "
9890 "causing this call to fail. The caller must split up such requests into "
9891 "smaller groups of names."
9895 #: ../fish/guestfish-actions.pod:2704
9896 msgid "luks-add-key"
9900 #: ../fish/guestfish-actions.pod:2706
9903 " luks-add-key device keyslot\n"
9908 #: ../fish/guestfish-actions.pod:2708 ../src/guestfs-actions.pod:4010
9910 "This command adds a new key on LUKS device C<device>. C<key> is any "
9911 "existing key, and is used to access the device. C<newkey> is the new key to "
9912 "add. C<keyslot> is the key slot that will be replaced."
9916 #: ../fish/guestfish-actions.pod:2713
9918 "Note that if C<keyslot> already contains a key, then this command will "
9919 "fail. You have to use L</luks-kill-slot> first to remove that key."
9923 #: ../fish/guestfish-actions.pod:2717 ../fish/guestfish-actions.pod:2739
9924 #: ../fish/guestfish-actions.pod:2752 ../fish/guestfish-actions.pod:2766
9925 #: ../fish/guestfish-actions.pod:2792 ../fish/guestfish-actions.pod:2802
9927 "This command has one or more key or passphrase parameters. Guestfish will "
9928 "prompt for these separately."
9932 #: ../fish/guestfish-actions.pod:2720
9937 #: ../fish/guestfish-actions.pod:2722
9940 " luks-close device\n"
9945 #: ../fish/guestfish-actions.pod:2724
9947 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
9948 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
9949 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
9954 #: ../fish/guestfish-actions.pod:2730
9959 #: ../fish/guestfish-actions.pod:2732
9962 " luks-format device keyslot\n"
9967 #: ../fish/guestfish-actions.pod:2734 ../src/guestfs-actions.pod:4051
9969 "This command erases existing data on C<device> and formats the device as a "
9970 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9971 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9975 #: ../fish/guestfish-actions.pod:2742 ../fish/guestfish-actions.pod:2755
9976 #: ../fish/guestfish-actions.pod:2842 ../fish/guestfish-actions.pod:3503
9977 #: ../fish/guestfish-actions.pod:4029 ../fish/guestfish-actions.pod:4354
9978 #: ../fish/guestfish-actions.pod:4377 ../fish/guestfish-actions.pod:4399
9979 #: ../fish/guestfish-actions.pod:5145 ../src/guestfs-actions.pod:4058
9980 #: ../src/guestfs-actions.pod:4081 ../src/guestfs-actions.pod:4224
9981 #: ../src/guestfs-actions.pod:5327 ../src/guestfs-actions.pod:6115
9982 #: ../src/guestfs-actions.pod:6550 ../src/guestfs-actions.pod:6580
9983 #: ../src/guestfs-actions.pod:6613 ../src/guestfs-actions.pod:7812
9985 "B<This command is dangerous. Without careful use you can easily destroy all "
9990 #: ../fish/guestfish-actions.pod:2745
9991 msgid "luks-format-cipher"
9995 #: ../fish/guestfish-actions.pod:2747
9998 " luks-format-cipher device keyslot cipher\n"
10003 #: ../fish/guestfish-actions.pod:2749
10005 "This command is the same as L</luks-format> but it also allows you to set "
10006 "the C<cipher> used."
10010 #: ../fish/guestfish-actions.pod:2758
10011 msgid "luks-kill-slot"
10015 #: ../fish/guestfish-actions.pod:2760
10018 " luks-kill-slot device keyslot\n"
10023 #: ../fish/guestfish-actions.pod:2762 ../src/guestfs-actions.pod:4098
10025 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10026 "device C<device>. C<key> must be one of the I<other> keys."
10030 #: ../fish/guestfish-actions.pod:2769
10035 #: ../fish/guestfish-actions.pod:2771
10038 " luks-open device mapname\n"
10043 #: ../fish/guestfish-actions.pod:2773 ../src/guestfs-actions.pod:4118
10045 "This command opens a block device which has been encrypted according to the "
10046 "Linux Unified Key Setup (LUKS) standard."
10050 #: ../fish/guestfish-actions.pod:2776 ../src/guestfs-actions.pod:4121
10051 msgid "C<device> is the encrypted block device or partition."
10055 #: ../fish/guestfish-actions.pod:2778 ../src/guestfs-actions.pod:4123
10057 "The caller must supply one of the keys associated with the LUKS block "
10058 "device, in the C<key> parameter."
10062 #: ../fish/guestfish-actions.pod:2781 ../src/guestfs-actions.pod:4126
10064 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10065 "writes to this block device are decrypted from and encrypted to the "
10066 "underlying C<device> respectively."
10070 #: ../fish/guestfish-actions.pod:2785
10072 "If this block device contains LVM volume groups, then calling L</vgscan> "
10073 "followed by L</vg-activate-all> will make them visible."
10077 #: ../fish/guestfish-actions.pod:2789
10078 msgid "Use L</list-dm-devices> to list all device mapper devices."
10082 #: ../fish/guestfish-actions.pod:2795
10083 msgid "luks-open-ro"
10087 #: ../fish/guestfish-actions.pod:2797
10090 " luks-open-ro device mapname\n"
10095 #: ../fish/guestfish-actions.pod:2799
10097 "This is the same as L</luks-open> except that a read-only mapping is created."
10101 #: ../fish/guestfish-actions.pod:2805
10106 #: ../fish/guestfish-actions.pod:2807
10109 " lvcreate logvol volgroup mbytes\n"
10114 #: ../fish/guestfish-actions.pod:2809 ../src/guestfs-actions.pod:4172
10116 "This creates an LVM logical volume called C<logvol> on the volume group "
10117 "C<volgroup>, with C<size> megabytes."
10121 #: ../fish/guestfish-actions.pod:2812
10122 msgid "lvm-canonical-lv-name"
10126 #: ../fish/guestfish-actions.pod:2814
10129 " lvm-canonical-lv-name lvname\n"
10134 #: ../fish/guestfish-actions.pod:2816 ../src/guestfs-actions.pod:4185
10136 "This converts alternative naming schemes for LVs that you might find to the "
10137 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10142 #: ../fish/guestfish-actions.pod:2820 ../src/guestfs-actions.pod:4189
10144 "This command returns an error if the C<lvname> parameter does not refer to a "
10149 #: ../fish/guestfish-actions.pod:2823
10150 msgid "See also L</is-lv>."
10154 #: ../fish/guestfish-actions.pod:2825
10155 msgid "lvm-clear-filter"
10159 #: ../fish/guestfish-actions.pod:2827
10162 " lvm-clear-filter\n"
10167 #: ../fish/guestfish-actions.pod:2829
10169 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
10174 #: ../fish/guestfish-actions.pod:2832 ../fish/guestfish-actions.pod:2863
10175 #: ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4249
10177 "This command also clears the LVM cache and performs a volume group scan."
10181 #: ../fish/guestfish-actions.pod:2835
10182 msgid "lvm-remove-all"
10186 #: ../fish/guestfish-actions.pod:2837
10189 " lvm-remove-all\n"
10194 #: ../fish/guestfish-actions.pod:2839 ../src/guestfs-actions.pod:4219
10196 "This command removes all LVM logical volumes, volume groups and physical "
10201 #: ../fish/guestfish-actions.pod:2845
10202 msgid "lvm-set-filter"
10206 #: ../fish/guestfish-actions.pod:2847
10209 " lvm-set-filter 'devices ...'\n"
10214 #: ../fish/guestfish-actions.pod:2849 ../src/guestfs-actions.pod:4235
10216 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10217 "block devices in the list C<devices>, and will ignore all other attached "
10222 #: ../fish/guestfish-actions.pod:2853 ../src/guestfs-actions.pod:4239
10224 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10225 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10226 "there are two types of duplication possible: either cloned PVs/VGs which "
10227 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10228 "same name. In normal operation you cannot create this situation, but you "
10229 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10230 "inside the LVM metadata."
10234 #: ../fish/guestfish-actions.pod:2866 ../src/guestfs-actions.pod:4252
10235 msgid "You can filter whole block devices or individual partitions."
10239 #: ../fish/guestfish-actions.pod:2868 ../src/guestfs-actions.pod:4254
10241 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10242 "filesystem), even if you are not filtering out that VG."
10246 #: ../fish/guestfish-actions.pod:2872
10251 #: ../fish/guestfish-actions.pod:2874
10254 " lvremove device\n"
10259 #: ../fish/guestfish-actions.pod:2876 ../src/guestfs-actions.pod:4268
10261 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10262 "LV, such as C</dev/VG/LV>."
10266 #: ../fish/guestfish-actions.pod:2879 ../src/guestfs-actions.pod:4271
10268 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10273 #: ../fish/guestfish-actions.pod:2882
10278 #: ../fish/guestfish-actions.pod:2884
10281 " lvrename logvol newlogvol\n"
10286 #: ../fish/guestfish-actions.pod:2886 ../src/guestfs-actions.pod:4285
10287 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10291 #: ../fish/guestfish-actions.pod:2888
10296 #: ../fish/guestfish-actions.pod:2890
10299 " lvresize device mbytes\n"
10304 #: ../fish/guestfish-actions.pod:2892 ../src/guestfs-actions.pod:4298
10306 "This resizes (expands or shrinks) an existing LVM logical volume to "
10307 "C<mbytes>. When reducing, data in the reduced part is lost."
10311 #: ../fish/guestfish-actions.pod:2896
10312 msgid "lvresize-free"
10316 #: ../fish/guestfish-actions.pod:2898
10319 " lvresize-free lv percent\n"
10324 #: ../fish/guestfish-actions.pod:2900 ../src/guestfs-actions.pod:4313
10326 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10327 "remaining free space in the volume group. Commonly you would call this with "
10328 "pc = 100 which expands the logical volume as much as possible, using all "
10329 "remaining free space in the volume group."
10333 #: ../fish/guestfish-actions.pod:2906
10338 #: ../fish/guestfish-actions.pod:2908
10346 #: ../fish/guestfish-actions.pod:2910 ../src/guestfs-actions.pod:4328
10348 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10353 #: ../fish/guestfish-actions.pod:2913 ../src/guestfs-actions.pod:4331
10355 "This returns a list of the logical volume device names (eg. C</dev/"
10356 "VolGroup00/LogVol00>)."
10360 #: ../fish/guestfish-actions.pod:2916
10361 msgid "See also L</lvs-full>, L</list-filesystems>."
10365 #: ../fish/guestfish-actions.pod:2918
10370 #: ../fish/guestfish-actions.pod:2920
10378 #: ../fish/guestfish-actions.pod:2922 ../src/guestfs-actions.pod:4347
10380 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10381 "(8)> command. The \"full\" version includes all fields."
10385 #: ../fish/guestfish-actions.pod:2925
10390 #: ../fish/guestfish-actions.pod:2927
10398 #: ../fish/guestfish-actions.pod:2929 ../src/guestfs-actions.pod:4362
10399 msgid "This command returns the UUID of the LVM LV C<device>."
10403 #: ../fish/guestfish-actions.pod:2931
10408 #: ../fish/guestfish-actions.pod:2933
10411 " lxattrlist path 'names ...'\n"
10416 #: ../fish/guestfish-actions.pod:2935 ../src/guestfs-actions.pod:4376
10418 "This call allows you to get the extended attributes of multiple files, where "
10419 "all files are in the directory C<path>. C<names> is the list of files from "
10424 #: ../fish/guestfish-actions.pod:2939 ../src/guestfs-actions.pod:4380
10426 "On return you get a flat list of xattr structs which must be interpreted "
10427 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10428 "C<attrval> in this struct is zero-length to indicate there was an error "
10429 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10430 "number (the number of following attributes for this file, which could be C<"
10431 "\"0\">). Then after the first xattr struct are the zero or more attributes "
10432 "for the first named file. This repeats for the second and subsequent files."
10436 #: ../fish/guestfish-actions.pod:2949
10438 "This call is intended for programs that want to efficiently list a directory "
10439 "contents without making many round-trips. See also L</lstatlist> for a "
10440 "similarly efficient call for getting standard stats. Very long directory "
10441 "listings might cause the protocol message size to be exceeded, causing this "
10442 "call to fail. The caller must split up such requests into smaller groups of "
10447 #: ../fish/guestfish-actions.pod:2957
10452 #: ../fish/guestfish-actions.pod:2959
10460 #: ../fish/guestfish-actions.pod:2961 ../src/guestfs-actions.pod:4410
10461 msgid "Create a directory named C<path>."
10465 #: ../fish/guestfish-actions.pod:2963
10470 #: ../fish/guestfish-actions.pod:2965
10473 " mkdir-mode path mode\n"
10478 #: ../fish/guestfish-actions.pod:2967 ../src/guestfs-actions.pod:4423
10480 "This command creates a directory, setting the initial permissions of the "
10481 "directory to C<mode>."
10485 #: ../fish/guestfish-actions.pod:2970 ../src/guestfs-actions.pod:4426
10487 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10488 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10493 #: ../fish/guestfish-actions.pod:2974
10494 msgid "See also L</mkdir>, L</umask>"
10498 #: ../fish/guestfish-actions.pod:2976
10503 #: ../fish/guestfish-actions.pod:2978
10511 #: ../fish/guestfish-actions.pod:2980 ../src/guestfs-actions.pod:4442
10513 "Create a directory named C<path>, creating any parent directories as "
10514 "necessary. This is like the C<mkdir -p> shell command."
10518 #: ../fish/guestfish-actions.pod:2983
10523 #: ../fish/guestfish-actions.pod:2985
10526 " mkdtemp template\n"
10531 #: ../fish/guestfish-actions.pod:2987 ../src/guestfs-actions.pod:4455
10533 "This command creates a temporary directory. The C<template> parameter "
10534 "should be a full pathname for the temporary directory name with the final "
10535 "six characters being \"XXXXXX\"."
10539 #: ../fish/guestfish-actions.pod:2992 ../src/guestfs-actions.pod:4460
10541 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10542 "being suitable for Windows filesystems."
10546 #: ../fish/guestfish-actions.pod:2995 ../src/guestfs-actions.pod:4463
10547 msgid "The name of the temporary directory that was created is returned."
10551 #: ../fish/guestfish-actions.pod:2998 ../src/guestfs-actions.pod:4466
10552 msgid "The temporary directory is created with mode 0700 and is owned by root."
10556 #: ../fish/guestfish-actions.pod:3001 ../src/guestfs-actions.pod:4469
10558 "The caller is responsible for deleting the temporary directory and its "
10559 "contents after use."
10563 #: ../fish/guestfish-actions.pod:3004 ../src/guestfs-actions.pod:4472
10564 msgid "See also: L<mkdtemp(3)>"
10568 #: ../fish/guestfish-actions.pod:3006
10573 #: ../fish/guestfish-actions.pod:3008
10576 " mke2fs-J fstype blocksize device journal\n"
10581 #: ../fish/guestfish-actions.pod:3010 ../src/guestfs-actions.pod:4488
10583 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10584 "C<journal>. It is equivalent to the command:"
10588 #: ../fish/guestfish-actions.pod:3014 ../src/guestfs-actions.pod:4492
10591 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10596 #: ../fish/guestfish-actions.pod:3016
10597 msgid "See also L</mke2journal>."
10601 #: ../fish/guestfish-actions.pod:3018
10606 #: ../fish/guestfish-actions.pod:3020
10609 " mke2fs-JL fstype blocksize device label\n"
10614 #: ../fish/guestfish-actions.pod:3022 ../src/guestfs-actions.pod:4509
10616 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10617 "the journal labeled C<label>."
10621 #: ../fish/guestfish-actions.pod:3025
10622 msgid "See also L</mke2journal-L>."
10626 #: ../fish/guestfish-actions.pod:3027
10631 #: ../fish/guestfish-actions.pod:3029
10634 " mke2fs-JU fstype blocksize device uuid\n"
10639 #: ../fish/guestfish-actions.pod:3031 ../src/guestfs-actions.pod:4527
10641 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10642 "the journal with UUID C<uuid>."
10646 #: ../fish/guestfish-actions.pod:3034
10647 msgid "See also L</mke2journal-U>."
10651 #: ../fish/guestfish-actions.pod:3036
10652 msgid "mke2journal"
10656 #: ../fish/guestfish-actions.pod:3038
10659 " mke2journal blocksize device\n"
10664 #: ../fish/guestfish-actions.pod:3040 ../src/guestfs-actions.pod:4543
10666 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10671 #: ../fish/guestfish-actions.pod:3043 ../src/guestfs-actions.pod:4546
10674 " mke2fs -O journal_dev -b blocksize device\n"
10679 #: ../fish/guestfish-actions.pod:3045
10680 msgid "mke2journal-L"
10684 #: ../fish/guestfish-actions.pod:3047
10687 " mke2journal-L blocksize label device\n"
10692 #: ../fish/guestfish-actions.pod:3049 ../src/guestfs-actions.pod:4560
10693 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10697 #: ../fish/guestfish-actions.pod:3051
10698 msgid "mke2journal-U"
10702 #: ../fish/guestfish-actions.pod:3053
10705 " mke2journal-U blocksize uuid device\n"
10710 #: ../fish/guestfish-actions.pod:3055 ../src/guestfs-actions.pod:4574
10711 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10715 #: ../fish/guestfish-actions.pod:3057
10720 #: ../fish/guestfish-actions.pod:3059
10723 " mkfifo mode path\n"
10728 #: ../fish/guestfish-actions.pod:3061
10730 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10731 "is just a convenient wrapper around L</mknod>."
10735 #: ../fish/guestfish-actions.pod:3067
10740 #: ../fish/guestfish-actions.pod:3069
10743 " mkfs fstype device\n"
10748 #: ../fish/guestfish-actions.pod:3071 ../src/guestfs-actions.pod:4604
10750 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10751 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10755 #: ../fish/guestfish-actions.pod:3075
10760 #: ../fish/guestfish-actions.pod:3077
10763 " mkfs-b fstype blocksize device\n"
10768 #: ../fish/guestfish-actions.pod:3079
10770 "This call is similar to L</mkfs>, but it allows you to control the block "
10771 "size of the resulting filesystem. Supported block sizes depend on the "
10772 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10776 #: ../fish/guestfish-actions.pod:3084 ../fish/guestfish-actions.pod:3111
10777 #: ../src/guestfs-actions.pod:4632 ../src/guestfs-actions.pod:4670
10779 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10784 #: ../fish/guestfish-actions.pod:3087
10786 "I<This function is deprecated.> In new code, use the L</mkfs_opts> call "
10791 #: ../fish/guestfish-actions.pod:3094
10796 #: ../fish/guestfish-actions.pod:3096
10799 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
10804 #: ../fish/guestfish-actions.pod:3098 ../src/guestfs-actions.pod:4657
10806 "This function creates a filesystem on C<device>. The filesystem type is "
10807 "C<fstype>, for example C<ext3>."
10811 #: ../fish/guestfish-actions.pod:3105 ../src/guestfs-actions.pod:4664
10812 msgid "C<blocksize>"
10816 #: ../fish/guestfish-actions.pod:3107 ../src/guestfs-actions.pod:4666
10818 "The filesystem block size. Supported block sizes depend on the filesystem "
10819 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
10824 #: ../fish/guestfish-actions.pod:3114 ../src/guestfs-actions.pod:4673
10825 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
10829 #: ../fish/guestfish-actions.pod:3116 ../src/guestfs-actions.pod:4675
10830 msgid "C<features>"
10834 #: ../fish/guestfish-actions.pod:3118 ../src/guestfs-actions.pod:4677
10835 msgid "This passes the I<-O> parameter to the external mkfs program."
10839 #: ../fish/guestfish-actions.pod:3120 ../src/guestfs-actions.pod:4679
10841 "For certain filesystem types, this allows extra filesystem features to be "
10842 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
10846 #: ../fish/guestfish-actions.pod:3124 ../src/guestfs-actions.pod:4683
10848 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
10853 #: ../fish/guestfish-actions.pod:3127 ../src/guestfs-actions.pod:4686
10858 #: ../fish/guestfish-actions.pod:3129 ../src/guestfs-actions.pod:4688
10860 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
10861 "sets the inode size (only for ext2/3/4 filesystems at present)."
10865 #: ../fish/guestfish-actions.pod:3132 ../src/guestfs-actions.pod:4691
10866 msgid "C<sectorsize>"
10870 #: ../fish/guestfish-actions.pod:3134 ../src/guestfs-actions.pod:4693
10872 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
10873 "sets sector size for ufs filesystem."
10877 #: ../fish/guestfish-actions.pod:3141
10878 msgid "mkmountpoint"
10882 #: ../fish/guestfish-actions.pod:3143
10885 " mkmountpoint exemptpath\n"
10890 #: ../fish/guestfish-actions.pod:3145
10892 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
10893 "to create extra mountpoints before mounting the first filesystem."
10897 #: ../fish/guestfish-actions.pod:3149 ../src/guestfs-actions.pod:4736
10899 "These calls are I<only> necessary in some very limited circumstances, mainly "
10900 "the case where you want to mount a mix of unrelated and/or read-only "
10901 "filesystems together."
10905 #: ../fish/guestfish-actions.pod:3153 ../src/guestfs-actions.pod:4740
10907 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10908 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10909 "inside that. You can unpack this as follows in guestfish:"
10913 #: ../fish/guestfish-actions.pod:3158 ../src/guestfs-actions.pod:4745
10916 " add-ro Fedora-11-i686-Live.iso\n"
10918 " mkmountpoint /cd\n"
10919 " mkmountpoint /sqsh\n"
10920 " mkmountpoint /ext3fs\n"
10921 " mount /dev/sda /cd\n"
10922 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10923 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10928 #: ../fish/guestfish-actions.pod:3167 ../src/guestfs-actions.pod:4754
10929 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10933 #: ../fish/guestfish-actions.pod:3169
10935 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
10936 "unexpected errors if you try to mix these calls. It is safest to manually "
10937 "unmount filesystems and remove mountpoints after use."
10941 #: ../fish/guestfish-actions.pod:3173
10943 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
10944 "for this to work for manual mountpoints, you must ensure that the innermost "
10945 "mountpoints have the longest pathnames, as in the example code above."
10949 #: ../fish/guestfish-actions.pod:3178 ../src/guestfs-actions.pod:4765
10951 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10955 #: ../fish/guestfish-actions.pod:3180
10957 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
10958 "L</umount-all> to be called when the handle is closed which can also trigger "
10963 #: ../fish/guestfish-actions.pod:3184
10968 #: ../fish/guestfish-actions.pod:3186
10971 " mknod mode devmajor devminor path\n"
10976 #: ../fish/guestfish-actions.pod:3188 ../src/guestfs-actions.pod:4784
10978 "This call creates block or character special devices, or named pipes (FIFOs)."
10982 #: ../fish/guestfish-actions.pod:3191 ../src/guestfs-actions.pod:4787
10984 "The C<mode> parameter should be the mode, using the standard constants. "
10985 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10986 "used when creating block and character special devices."
10990 #: ../fish/guestfish-actions.pod:3196
10992 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10993 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10994 "regular file). These constants are available in the standard Linux header "
10995 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
10996 "wrappers around this command which bitwise OR in the appropriate constant "
11001 #: ../fish/guestfish-actions.pod:3206
11006 #: ../fish/guestfish-actions.pod:3208
11009 " mknod-b mode devmajor devminor path\n"
11014 #: ../fish/guestfish-actions.pod:3210
11016 "This call creates a block device node called C<path> with mode C<mode> and "
11017 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11018 "wrapper around L</mknod>."
11022 #: ../fish/guestfish-actions.pod:3216
11027 #: ../fish/guestfish-actions.pod:3218
11030 " mknod-c mode devmajor devminor path\n"
11035 #: ../fish/guestfish-actions.pod:3220
11037 "This call creates a char device node called C<path> with mode C<mode> and "
11038 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11039 "wrapper around L</mknod>."
11043 #: ../fish/guestfish-actions.pod:3226
11048 #: ../fish/guestfish-actions.pod:3228
11056 #: ../fish/guestfish-actions.pod:3230 ../src/guestfs-actions.pod:4850
11057 msgid "Create a swap partition on C<device>."
11061 #: ../fish/guestfish-actions.pod:3232
11066 #: ../fish/guestfish-actions.pod:3234
11069 " mkswap-L label device\n"
11074 #: ../fish/guestfish-actions.pod:3236 ../src/guestfs-actions.pod:4863
11075 msgid "Create a swap partition on C<device> with label C<label>."
11079 #: ../fish/guestfish-actions.pod:3238 ../src/guestfs-actions.pod:4865
11081 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
11082 "sda>), just to a partition. This appears to be a limitation of the kernel "
11087 #: ../fish/guestfish-actions.pod:3242
11092 #: ../fish/guestfish-actions.pod:3244
11095 " mkswap-U uuid device\n"
11100 #: ../fish/guestfish-actions.pod:3246 ../src/guestfs-actions.pod:4880
11101 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11105 #: ../fish/guestfish-actions.pod:3248
11106 msgid "mkswap-file"
11110 #: ../fish/guestfish-actions.pod:3250
11113 " mkswap-file path\n"
11118 #: ../fish/guestfish-actions.pod:3252 ../src/guestfs-actions.pod:4892
11119 msgid "Create a swap file."
11123 #: ../fish/guestfish-actions.pod:3254
11125 "This command just writes a swap file signature to an existing file. To "
11126 "create the file itself, use something like L</fallocate>."
11130 #: ../fish/guestfish-actions.pod:3257
11135 #: ../fish/guestfish-actions.pod:3259
11138 " modprobe modulename\n"
11143 #: ../fish/guestfish-actions.pod:3261 ../src/guestfs-actions.pod:4907
11144 msgid "This loads a kernel module in the appliance."
11148 #: ../fish/guestfish-actions.pod:3263 ../src/guestfs-actions.pod:4909
11150 "The kernel module must have been whitelisted when libguestfs was built (see "
11151 "C<appliance/kmod.whitelist.in> in the source)."
11155 #: ../fish/guestfish-actions.pod:3266
11160 #: ../fish/guestfish-actions.pod:3268
11163 " mount device mountpoint\n"
11168 #: ../fish/guestfish-actions.pod:3270 ../src/guestfs-actions.pod:4930
11170 "Mount a guest disk at a position in the filesystem. Block devices are named "
11171 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11172 "those block devices contain partitions, they will have the usual names (eg. "
11173 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11177 #: ../fish/guestfish-actions.pod:3276 ../src/guestfs-actions.pod:4936
11179 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11180 "mounted on C</> before others can be mounted. Other filesystems can only be "
11181 "mounted on directories which already exist."
11185 #: ../fish/guestfish-actions.pod:3281 ../src/guestfs-actions.pod:4941
11187 "The mounted filesystem is writable, if we have sufficient permissions on the "
11188 "underlying device."
11192 #: ../fish/guestfish-actions.pod:3284
11194 "B<Important note:> When you use this call, the filesystem options C<sync> "
11195 "and C<noatime> are set implicitly. This was originally done because we "
11196 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11197 "very large negative performance impact and negligible effect on "
11198 "reliability. Therefore we recommend that you avoid using L</mount> in any "
11199 "code that needs performance, and instead use L</mount-options> (use an empty "
11200 "string for the first parameter if you don't want any options)."
11204 #: ../fish/guestfish-actions.pod:3294
11206 "I<This function is deprecated.> In new code, use the L</mount_options> call "
11211 #: ../fish/guestfish-actions.pod:3301
11216 #: ../fish/guestfish-actions.pod:3303
11219 " mount-9p mounttag mountpoint [options:..]\n"
11224 #: ../fish/guestfish-actions.pod:3305 ../src/guestfs-actions.pod:4973
11226 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
11231 #: ../fish/guestfish-actions.pod:3308 ../src/guestfs-actions.pod:4976
11233 "If required, C<trans=virtio> will be automatically added to the options. "
11234 "Any other options required can be passed in the optional C<options> "
11239 #: ../fish/guestfish-actions.pod:3314
11244 #: ../fish/guestfish-actions.pod:3316
11247 " mount-loop file mountpoint\n"
11252 #: ../fish/guestfish-actions.pod:3318 ../src/guestfs-actions.pod:5015
11254 "This command lets you mount C<file> (a filesystem image in a file) on a "
11255 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11260 #: ../fish/guestfish-actions.pod:3322
11261 msgid "mount-options"
11265 #: ../fish/guestfish-actions.pod:3324
11268 " mount-options options device mountpoint\n"
11273 #: ../fish/guestfish-actions.pod:3326
11275 "This is the same as the L</mount> command, but it allows you to set the "
11276 "mount options as for the L<mount(8)> I<-o> flag."
11280 #: ../fish/guestfish-actions.pod:3330 ../src/guestfs-actions.pod:5035
11282 "If the C<options> parameter is an empty string, then no options are passed "
11283 "(all options default to whatever the filesystem uses)."
11287 #: ../fish/guestfish-actions.pod:3334
11292 #: ../fish/guestfish-actions.pod:3336
11295 " mount-ro device mountpoint\n"
11300 #: ../fish/guestfish-actions.pod:3338
11302 "This is the same as the L</mount> command, but it mounts the filesystem with "
11303 "the read-only (I<-o ro>) flag."
11307 #: ../fish/guestfish-actions.pod:3341
11312 #: ../fish/guestfish-actions.pod:3343
11315 " mount-vfs options vfstype device mountpoint\n"
11320 #: ../fish/guestfish-actions.pod:3345
11322 "This is the same as the L</mount> command, but it allows you to set both the "
11323 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
11327 #: ../fish/guestfish-actions.pod:3349
11328 msgid "mountpoints"
11332 #: ../fish/guestfish-actions.pod:3351
11340 #: ../fish/guestfish-actions.pod:3353
11342 "This call is similar to L</mounts>. That call returns a list of devices. "
11343 "This one returns a hash table (map) of device name to directory where the "
11344 "device is mounted."
11348 #: ../fish/guestfish-actions.pod:3357
11353 #: ../fish/guestfish-actions.pod:3359
11361 #: ../fish/guestfish-actions.pod:3361 ../src/guestfs-actions.pod:5096
11363 "This returns the list of currently mounted filesystems. It returns the list "
11364 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11368 #: ../fish/guestfish-actions.pod:3364 ../src/guestfs-actions.pod:5099
11369 msgid "Some internal mounts are not shown."
11373 #: ../fish/guestfish-actions.pod:3366
11374 msgid "See also: L</mountpoints>"
11378 #: ../fish/guestfish-actions.pod:3368
11383 #: ../fish/guestfish-actions.pod:3370
11391 #: ../fish/guestfish-actions.pod:3372 ../src/guestfs-actions.pod:5116
11393 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11394 "destination filename or destination directory."
11398 #: ../fish/guestfish-actions.pod:3375
11399 msgid "ntfs-3g-probe"
11403 #: ../fish/guestfish-actions.pod:3377
11406 " ntfs-3g-probe true|false device\n"
11411 #: ../fish/guestfish-actions.pod:3379 ../src/guestfs-actions.pod:5130
11413 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11414 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
11415 "write, and some cannot be mounted at all)."
11419 #: ../fish/guestfish-actions.pod:3383 ../src/guestfs-actions.pod:5134
11421 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11422 "can be mounted read-write. Set it to false if you want to test if the "
11423 "volume can be mounted read-only."
11427 #: ../fish/guestfish-actions.pod:3387 ../src/guestfs-actions.pod:5138
11429 "The return value is an integer which C<0> if the operation would succeed, or "
11430 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11434 #: ../fish/guestfish-actions.pod:3391
11439 #: ../fish/guestfish-actions.pod:3393
11442 " ntfsresize device\n"
11447 #: ../fish/guestfish-actions.pod:3395 ../fish/guestfish-actions.pod:3419
11448 #: ../src/guestfs-actions.pod:5159 ../src/guestfs-actions.pod:5191
11450 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11451 "size of the underlying device."
11455 #: ../fish/guestfish-actions.pod:3398 ../src/guestfs-actions.pod:5162
11457 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
11458 "consistency check (for safety). You have to boot into Windows to perform "
11459 "this check and clear this condition. Furthermore, ntfsresize refuses to "
11460 "resize filesystems which have been marked in this way. So in effect it is "
11461 "not possible to call ntfsresize multiple times on a single filesystem "
11462 "without booting into Windows between each resize."
11466 #: ../fish/guestfish-actions.pod:3406 ../fish/guestfish-actions.pod:3445
11467 #: ../src/guestfs-actions.pod:5170 ../src/guestfs-actions.pod:5217
11468 msgid "See also L<ntfsresize(8)>."
11472 #: ../fish/guestfish-actions.pod:3408 ../fish/guestfish-actions.pod:3456
11474 "I<This function is deprecated.> In new code, use the L</ntfsresize_opts> "
11479 #: ../fish/guestfish-actions.pod:3415
11480 msgid "ntfsresize-opts"
11484 #: ../fish/guestfish-actions.pod:3417
11487 " ntfsresize-opts device [size:..] [force:..]\n"
11492 #: ../fish/guestfish-actions.pod:3428 ../src/guestfs-actions.pod:5200
11494 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
11495 "resized to fit the container (eg. partition)."
11499 #: ../fish/guestfish-actions.pod:3431 ../src/guestfs-actions.pod:5203
11504 #: ../fish/guestfish-actions.pod:3433 ../src/guestfs-actions.pod:5205
11506 "If this option is true, then force the resize of the filesystem even if the "
11507 "filesystem is marked as requiring a consistency check."
11511 #: ../fish/guestfish-actions.pod:3436
11513 "After the resize operation, the filesystem is always marked as requiring a "
11514 "consistency check (for safety). You have to boot into Windows to perform "
11515 "this check and clear this condition. If you I<don't> set the C<force> "
11516 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
11517 "a single filesystem without booting into Windows between each resize."
11521 #: ../fish/guestfish-actions.pod:3449
11522 msgid "ntfsresize-size"
11526 #: ../fish/guestfish-actions.pod:3451
11529 " ntfsresize-size device size\n"
11534 #: ../fish/guestfish-actions.pod:3453
11536 "This command is the same as L</ntfsresize> except that it allows you to "
11537 "specify the new size (in bytes) explicitly."
11541 #: ../fish/guestfish-actions.pod:3463
11546 #: ../fish/guestfish-actions.pod:3465
11549 " part-add device prlogex startsect endsect\n"
11554 #: ../fish/guestfish-actions.pod:3467
11556 "This command adds a partition to C<device>. If there is no partition table "
11557 "on the device, call L</part-init> first."
11561 #: ../fish/guestfish-actions.pod:3470 ../src/guestfs-actions.pod:5278
11563 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11564 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11565 "C<logical>) and C<e> (or C<extended>) partition types."
11569 #: ../fish/guestfish-actions.pod:3475 ../src/guestfs-actions.pod:5283
11571 "C<startsect> and C<endsect> are the start and end of the partition in "
11572 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11573 "from the end of the disk (C<-1> is the last sector)."
11577 #: ../fish/guestfish-actions.pod:3479
11579 "Creating a partition which covers the whole disk is not so easy. Use L</"
11580 "part-disk> to do that."
11584 #: ../fish/guestfish-actions.pod:3482
11589 #: ../fish/guestfish-actions.pod:3484
11592 " part-del device partnum\n"
11597 #: ../fish/guestfish-actions.pod:3486 ../src/guestfs-actions.pod:5301
11598 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11602 #: ../fish/guestfish-actions.pod:3488 ../src/guestfs-actions.pod:5303
11604 "Note that in the case of MBR partitioning, deleting an extended partition "
11605 "also deletes any logical partitions it contains."
11609 #: ../fish/guestfish-actions.pod:3492
11614 #: ../fish/guestfish-actions.pod:3494
11617 " part-disk device parttype\n"
11622 #: ../fish/guestfish-actions.pod:3496
11624 "This command is simply a combination of L</part-init> followed by L</part-"
11625 "add> to create a single primary partition covering the whole disk."
11629 #: ../fish/guestfish-actions.pod:3500
11631 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11632 "possible values are described in L</part-init>."
11636 #: ../fish/guestfish-actions.pod:3506
11637 msgid "part-get-bootable"
11641 #: ../fish/guestfish-actions.pod:3508
11644 " part-get-bootable device partnum\n"
11649 #: ../fish/guestfish-actions.pod:3510 ../src/guestfs-actions.pod:5339
11651 "This command returns true if the partition C<partnum> on C<device> has the "
11652 "bootable flag set."
11656 #: ../fish/guestfish-actions.pod:3513
11657 msgid "See also L</part-set-bootable>."
11661 #: ../fish/guestfish-actions.pod:3515
11662 msgid "part-get-mbr-id"
11666 #: ../fish/guestfish-actions.pod:3517
11669 " part-get-mbr-id device partnum\n"
11674 #: ../fish/guestfish-actions.pod:3519 ../src/guestfs-actions.pod:5355
11676 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11677 "partition C<partnum>."
11681 #: ../fish/guestfish-actions.pod:3522 ../fish/guestfish-actions.pod:3666
11683 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11684 "undefined results for other partition table types (see L</part-get-"
11689 #: ../fish/guestfish-actions.pod:3526
11690 msgid "part-get-parttype"
11694 #: ../fish/guestfish-actions.pod:3528
11697 " part-get-parttype device\n"
11702 #: ../fish/guestfish-actions.pod:3530 ../src/guestfs-actions.pod:5372
11704 "This command examines the partition table on C<device> and returns the "
11705 "partition table type (format) being used."
11709 #: ../fish/guestfish-actions.pod:3533
11711 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11712 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11713 "possible, although unusual. See L</part-init> for a full list."
11717 #: ../fish/guestfish-actions.pod:3538
11722 #: ../fish/guestfish-actions.pod:3540
11725 " part-init device parttype\n"
11730 #: ../fish/guestfish-actions.pod:3542 ../src/guestfs-actions.pod:5392
11732 "This creates an empty partition table on C<device> of one of the partition "
11733 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11734 "(for large disks)."
11738 #: ../fish/guestfish-actions.pod:3546
11740 "Initially there are no partitions. Following this, you should call L</part-"
11741 "add> for each partition required."
11745 #: ../fish/guestfish-actions.pod:3549 ../src/guestfs-actions.pod:5399
11746 msgid "Possible values for C<parttype> are:"
11750 #: ../fish/guestfish-actions.pod:3553 ../src/guestfs-actions.pod:5403
11755 #: ../fish/guestfish-actions.pod:3555 ../src/guestfs-actions.pod:5405
11760 #: ../fish/guestfish-actions.pod:3557 ../src/guestfs-actions.pod:5407
11761 msgid "Intel EFI / GPT partition table."
11765 #: ../fish/guestfish-actions.pod:3559 ../src/guestfs-actions.pod:5409
11767 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11768 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11769 "the C<mbr> format."
11773 #: ../fish/guestfish-actions.pod:3563 ../src/guestfs-actions.pod:5413
11778 #: ../fish/guestfish-actions.pod:3565 ../src/guestfs-actions.pod:5415
11783 #: ../fish/guestfish-actions.pod:3567 ../src/guestfs-actions.pod:5417
11785 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11786 "Windows. This partition type will B<only> work for device sizes up to 2 "
11787 "TB. For large disks we recommend using C<gpt>."
11791 #: ../fish/guestfish-actions.pod:3574 ../src/guestfs-actions.pod:5424
11793 "Other partition table types that may work but are not supported include:"
11797 #: ../fish/guestfish-actions.pod:3579 ../src/guestfs-actions.pod:5429
11802 #: ../fish/guestfish-actions.pod:3581 ../src/guestfs-actions.pod:5431
11803 msgid "AIX disk labels."
11807 #: ../fish/guestfish-actions.pod:3583 ../src/guestfs-actions.pod:5433
11812 #: ../fish/guestfish-actions.pod:3585 ../src/guestfs-actions.pod:5435
11817 #: ../fish/guestfish-actions.pod:3587 ../src/guestfs-actions.pod:5437
11818 msgid "Amiga \"Rigid Disk Block\" format."
11822 #: ../fish/guestfish-actions.pod:3589 ../src/guestfs-actions.pod:5439
11827 #: ../fish/guestfish-actions.pod:3591 ../src/guestfs-actions.pod:5441
11828 msgid "BSD disk labels."
11832 #: ../fish/guestfish-actions.pod:3593 ../src/guestfs-actions.pod:5443
11837 #: ../fish/guestfish-actions.pod:3595 ../src/guestfs-actions.pod:5445
11838 msgid "DASD, used on IBM mainframes."
11842 #: ../fish/guestfish-actions.pod:3597 ../src/guestfs-actions.pod:5447
11847 #: ../fish/guestfish-actions.pod:3599 ../src/guestfs-actions.pod:5449
11848 msgid "MIPS/SGI volumes."
11852 #: ../fish/guestfish-actions.pod:3601 ../src/guestfs-actions.pod:5451
11857 #: ../fish/guestfish-actions.pod:3603 ../src/guestfs-actions.pod:5453
11858 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11862 #: ../fish/guestfish-actions.pod:3605 ../src/guestfs-actions.pod:5455
11867 #: ../fish/guestfish-actions.pod:3607 ../src/guestfs-actions.pod:5457
11868 msgid "NEC PC-98 format, common in Japan apparently."
11872 #: ../fish/guestfish-actions.pod:3609 ../src/guestfs-actions.pod:5459
11877 #: ../fish/guestfish-actions.pod:3611 ../src/guestfs-actions.pod:5461
11878 msgid "Sun disk labels."
11882 #: ../fish/guestfish-actions.pod:3615
11887 #: ../fish/guestfish-actions.pod:3617
11890 " part-list device\n"
11895 #: ../fish/guestfish-actions.pod:3619 ../src/guestfs-actions.pod:5475
11897 "This command parses the partition table on C<device> and returns the list of "
11898 "partitions found."
11902 #: ../fish/guestfish-actions.pod:3622 ../src/guestfs-actions.pod:5478
11903 msgid "The fields in the returned structure are:"
11907 #: ../fish/guestfish-actions.pod:3626 ../src/guestfs-actions.pod:5482
11908 msgid "B<part_num>"
11912 #: ../fish/guestfish-actions.pod:3628 ../src/guestfs-actions.pod:5484
11913 msgid "Partition number, counting from 1."
11917 #: ../fish/guestfish-actions.pod:3630 ../src/guestfs-actions.pod:5486
11918 msgid "B<part_start>"
11922 #: ../fish/guestfish-actions.pod:3632
11924 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11925 "the device's sector size, see L</blockdev-getss>."
11929 #: ../fish/guestfish-actions.pod:3635 ../src/guestfs-actions.pod:5491
11930 msgid "B<part_end>"
11934 #: ../fish/guestfish-actions.pod:3637 ../src/guestfs-actions.pod:5493
11935 msgid "End of the partition in bytes."
11939 #: ../fish/guestfish-actions.pod:3639 ../src/guestfs-actions.pod:5495
11940 msgid "B<part_size>"
11944 #: ../fish/guestfish-actions.pod:3641 ../src/guestfs-actions.pod:5497
11945 msgid "Size of the partition in bytes."
11949 #: ../fish/guestfish-actions.pod:3645
11950 msgid "part-set-bootable"
11954 #: ../fish/guestfish-actions.pod:3647
11957 " part-set-bootable device partnum true|false\n"
11962 #: ../fish/guestfish-actions.pod:3649 ../src/guestfs-actions.pod:5515
11964 "This sets the bootable flag on partition numbered C<partnum> on device "
11965 "C<device>. Note that partitions are numbered from 1."
11969 #: ../fish/guestfish-actions.pod:3652 ../src/guestfs-actions.pod:5518
11971 "The bootable flag is used by some operating systems (notably Windows) to "
11972 "determine which partition to boot from. It is by no means universally "
11977 #: ../fish/guestfish-actions.pod:3656
11978 msgid "part-set-mbr-id"
11982 #: ../fish/guestfish-actions.pod:3658
11985 " part-set-mbr-id device partnum idbyte\n"
11990 #: ../fish/guestfish-actions.pod:3660 ../src/guestfs-actions.pod:5534
11992 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11993 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11994 "documentation are in fact hexadecimal numbers, but usually documented "
11995 "without any leading \"0x\" which might be confusing."
11999 #: ../fish/guestfish-actions.pod:3670
12000 msgid "part-set-name"
12004 #: ../fish/guestfish-actions.pod:3672
12007 " part-set-name device partnum name\n"
12012 #: ../fish/guestfish-actions.pod:3674 ../src/guestfs-actions.pod:5556
12014 "This sets the partition name on partition numbered C<partnum> on device "
12015 "C<device>. Note that partitions are numbered from 1."
12019 #: ../fish/guestfish-actions.pod:3677 ../src/guestfs-actions.pod:5559
12021 "The partition name can only be set on certain types of partition table. "
12022 "This works on C<gpt> but not on C<mbr> partitions."
12026 #: ../fish/guestfish-actions.pod:3680
12027 msgid "part-to-dev"
12031 #: ../fish/guestfish-actions.pod:3682
12034 " part-to-dev partition\n"
12039 #: ../fish/guestfish-actions.pod:3684 ../src/guestfs-actions.pod:5572
12041 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12042 "partition number, returning the device name (eg. \"/dev/sdb\")."
12046 #: ../fish/guestfish-actions.pod:3688
12048 "The named partition must exist, for example as a string returned from L</"
12049 "list-partitions>."
12053 #: ../fish/guestfish-actions.pod:3691
12054 msgid "ping-daemon"
12058 #: ../fish/guestfish-actions.pod:3693
12066 #: ../fish/guestfish-actions.pod:3695 ../src/guestfs-actions.pod:5589
12068 "This is a test probe into the guestfs daemon running inside the qemu "
12069 "subprocess. Calling this function checks that the daemon responds to the "
12070 "ping message, without affecting the daemon or attached block device(s) in "
12075 #: ../fish/guestfish-actions.pod:3700
12080 #: ../fish/guestfish-actions.pod:3702
12083 " pread path count offset\n"
12088 #: ../fish/guestfish-actions.pod:3704 ../src/guestfs-actions.pod:5607
12090 "This command lets you read part of a file. It reads C<count> bytes of the "
12091 "file, starting at C<offset>, from file C<path>."
12095 #: ../fish/guestfish-actions.pod:3707 ../fish/guestfish-actions.pod:3722
12096 #: ../src/guestfs-actions.pod:5610 ../src/guestfs-actions.pod:5636
12098 "This may read fewer bytes than requested. For further details see the "
12099 "L<pread(2)> system call."
12103 #: ../fish/guestfish-actions.pod:3710
12104 msgid "See also L</pwrite>, L</pread-device>."
12108 #: ../fish/guestfish-actions.pod:3715
12109 msgid "pread-device"
12113 #: ../fish/guestfish-actions.pod:3717
12116 " pread-device device count offset\n"
12121 #: ../fish/guestfish-actions.pod:3719 ../src/guestfs-actions.pod:5633
12123 "This command lets you read part of a file. It reads C<count> bytes of "
12124 "C<device>, starting at C<offset>."
12128 #: ../fish/guestfish-actions.pod:3725
12129 msgid "See also L</pread>."
12133 #: ../fish/guestfish-actions.pod:3730
12138 #: ../fish/guestfish-actions.pod:3732
12141 " pvcreate device\n"
12146 #: ../fish/guestfish-actions.pod:3734 ../src/guestfs-actions.pod:5656
12148 "This creates an LVM physical volume on the named C<device>, where C<device> "
12149 "should usually be a partition name such as C</dev/sda1>."
12153 #: ../fish/guestfish-actions.pod:3738
12158 #: ../fish/guestfish-actions.pod:3740
12161 " pvremove device\n"
12166 #: ../fish/guestfish-actions.pod:3742 ../src/guestfs-actions.pod:5670
12168 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12173 #: ../fish/guestfish-actions.pod:3745 ../src/guestfs-actions.pod:5673
12175 "The implementation uses the C<pvremove> command which refuses to wipe "
12176 "physical volumes that contain any volume groups, so you have to remove those "
12181 #: ../fish/guestfish-actions.pod:3749
12186 #: ../fish/guestfish-actions.pod:3751
12189 " pvresize device\n"
12194 #: ../fish/guestfish-actions.pod:3753 ../src/guestfs-actions.pod:5687
12196 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12197 "the new size of the underlying device."
12201 #: ../fish/guestfish-actions.pod:3756
12202 msgid "pvresize-size"
12206 #: ../fish/guestfish-actions.pod:3758
12209 " pvresize-size device size\n"
12214 #: ../fish/guestfish-actions.pod:3760
12216 "This command is the same as L</pvresize> except that it allows you to "
12217 "specify the new size (in bytes) explicitly."
12221 #: ../fish/guestfish-actions.pod:3763
12226 #: ../fish/guestfish-actions.pod:3765
12234 #: ../fish/guestfish-actions.pod:3767 ../src/guestfs-actions.pod:5713
12236 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12241 #: ../fish/guestfish-actions.pod:3770 ../src/guestfs-actions.pod:5716
12243 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12248 #: ../fish/guestfish-actions.pod:3773
12249 msgid "See also L</pvs-full>."
12253 #: ../fish/guestfish-actions.pod:3775
12258 #: ../fish/guestfish-actions.pod:3777
12266 #: ../fish/guestfish-actions.pod:3779 ../src/guestfs-actions.pod:5732
12268 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12269 "(8)> command. The \"full\" version includes all fields."
12273 #: ../fish/guestfish-actions.pod:3782
12278 #: ../fish/guestfish-actions.pod:3784
12286 #: ../fish/guestfish-actions.pod:3786 ../src/guestfs-actions.pod:5747
12287 msgid "This command returns the UUID of the LVM PV C<device>."
12291 #: ../fish/guestfish-actions.pod:3788
12296 #: ../fish/guestfish-actions.pod:3790
12299 " pwrite path content offset\n"
12304 #: ../fish/guestfish-actions.pod:3792 ../src/guestfs-actions.pod:5763
12306 "This command writes to part of a file. It writes the data buffer C<content> "
12307 "to the file C<path> starting at offset C<offset>."
12311 #: ../fish/guestfish-actions.pod:3795 ../src/guestfs-actions.pod:5766
12313 "This command implements the L<pwrite(2)> system call, and like that system "
12314 "call it may not write the full data requested. The return value is the "
12315 "number of bytes that were actually written to the file. This could even be "
12316 "0, although short writes are unlikely for regular files in ordinary "
12321 #: ../fish/guestfish-actions.pod:3801
12322 msgid "See also L</pread>, L</pwrite-device>."
12326 #: ../fish/guestfish-actions.pod:3806
12327 msgid "pwrite-device"
12331 #: ../fish/guestfish-actions.pod:3808
12334 " pwrite-device device content offset\n"
12339 #: ../fish/guestfish-actions.pod:3810 ../src/guestfs-actions.pod:5790
12341 "This command writes to part of a device. It writes the data buffer "
12342 "C<content> to C<device> starting at offset C<offset>."
12346 #: ../fish/guestfish-actions.pod:3813 ../src/guestfs-actions.pod:5793
12348 "This command implements the L<pwrite(2)> system call, and like that system "
12349 "call it may not write the full data requested (although short writes to disk "
12350 "devices and partitions are probably impossible with standard Linux kernels)."
12354 #: ../fish/guestfish-actions.pod:3818
12355 msgid "See also L</pwrite>."
12359 #: ../fish/guestfish-actions.pod:3823
12364 #: ../fish/guestfish-actions.pod:3825
12367 " read-file path\n"
12372 #: ../fish/guestfish-actions.pod:3827 ../src/guestfs-actions.pod:5814
12373 msgid "This calls returns the contents of the file C<path> as a buffer."
12377 #: ../fish/guestfish-actions.pod:3830
12379 "Unlike L</cat>, this function can correctly handle files that contain "
12380 "embedded ASCII NUL characters. However unlike L</download>, this function "
12381 "is limited in the total size of file that can be handled."
12385 #: ../fish/guestfish-actions.pod:3838
12390 #: ../fish/guestfish-actions.pod:3840
12393 " read-lines path\n"
12398 #: ../fish/guestfish-actions.pod:3844 ../src/guestfs-actions.pod:5839
12400 "The file contents are returned as a list of lines. Trailing C<LF> and "
12401 "C<CRLF> character sequences are I<not> returned."
12405 #: ../fish/guestfish-actions.pod:3847
12407 "Note that this function cannot correctly handle binary files (specifically, "
12408 "files containing C<\\0> character which is treated as end of line). For "
12409 "those you need to use the L</read-file> function which has a more complex "
12414 #: ../fish/guestfish-actions.pod:3852
12419 #: ../fish/guestfish-actions.pod:3854
12427 #: ../fish/guestfish-actions.pod:3856 ../src/guestfs-actions.pod:5859
12428 msgid "This returns the list of directory entries in directory C<dir>."
12432 #: ../fish/guestfish-actions.pod:3858 ../src/guestfs-actions.pod:5861
12434 "All entries in the directory are returned, including C<.> and C<..>. The "
12435 "entries are I<not> sorted, but returned in the same order as the underlying "
12440 #: ../fish/guestfish-actions.pod:3862 ../src/guestfs-actions.pod:5865
12442 "Also this call returns basic file type information about each file. The "
12443 "C<ftyp> field will contain one of the following characters:"
12447 #: ../fish/guestfish-actions.pod:3867 ../src/guestfs-actions.pod:5870
12452 #: ../fish/guestfish-actions.pod:3869 ../src/guestfs-actions.pod:5872
12453 msgid "Block special"
12457 #: ../fish/guestfish-actions.pod:3871 ../src/guestfs-actions.pod:5874
12462 #: ../fish/guestfish-actions.pod:3873 ../src/guestfs-actions.pod:5876
12463 msgid "Char special"
12467 #: ../fish/guestfish-actions.pod:3875 ../src/guestfs-actions.pod:5878
12472 #: ../fish/guestfish-actions.pod:3877 ../src/guestfs-actions.pod:5880
12477 #: ../fish/guestfish-actions.pod:3879 ../src/guestfs-actions.pod:5882
12482 #: ../fish/guestfish-actions.pod:3881 ../src/guestfs-actions.pod:5884
12483 msgid "FIFO (named pipe)"
12487 #: ../fish/guestfish-actions.pod:3883 ../src/guestfs-actions.pod:5886
12492 #: ../fish/guestfish-actions.pod:3885 ../src/guestfs-actions.pod:5888
12493 msgid "Symbolic link"
12497 #: ../fish/guestfish-actions.pod:3887 ../src/guestfs-actions.pod:5890
12502 #: ../fish/guestfish-actions.pod:3889 ../src/guestfs-actions.pod:5892
12503 msgid "Regular file"
12507 #: ../fish/guestfish-actions.pod:3891 ../src/guestfs-actions.pod:5894
12512 #: ../fish/guestfish-actions.pod:3893 ../src/guestfs-actions.pod:5896
12517 #: ../fish/guestfish-actions.pod:3895 ../src/guestfs-actions.pod:5898
12522 #: ../fish/guestfish-actions.pod:3897 ../src/guestfs-actions.pod:5900
12523 msgid "Unknown file type"
12527 #: ../fish/guestfish-actions.pod:3899 ../src/guestfs-actions.pod:5902
12532 #: ../fish/guestfish-actions.pod:3901 ../src/guestfs-actions.pod:5904
12534 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12538 #: ../fish/guestfish-actions.pod:3906
12540 "This function is primarily intended for use by programs. To get a simple "
12541 "list of names, use L</ls>. To get a printable directory for human "
12542 "consumption, use L</ll>."
12546 #: ../fish/guestfish-actions.pod:3910
12551 #: ../fish/guestfish-actions.pod:3912
12559 #: ../fish/guestfish-actions.pod:3914 ../src/guestfs-actions.pod:5925
12560 msgid "This command reads the target of a symbolic link."
12564 #: ../fish/guestfish-actions.pod:3916
12565 msgid "readlinklist"
12569 #: ../fish/guestfish-actions.pod:3918
12572 " readlinklist path 'names ...'\n"
12577 #: ../fish/guestfish-actions.pod:3920 ../src/guestfs-actions.pod:5939
12579 "This call allows you to do a C<readlink> operation on multiple files, where "
12580 "all files are in the directory C<path>. C<names> is the list of files from "
12585 #: ../fish/guestfish-actions.pod:3924 ../src/guestfs-actions.pod:5943
12587 "On return you get a list of strings, with a one-to-one correspondence to the "
12588 "C<names> list. Each string is the value of the symbolic link."
12592 #: ../fish/guestfish-actions.pod:3928 ../src/guestfs-actions.pod:5947
12594 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12595 "result string is the empty string C<\"\">. However the whole operation is "
12596 "completed even if there were C<readlink(2)> errors, and so you can call this "
12597 "function with names where you don't know if they are symbolic links already "
12598 "(albeit slightly less efficient)."
12602 #: ../fish/guestfish-actions.pod:3935 ../src/guestfs-actions.pod:5954
12604 "This call is intended for programs that want to efficiently list a directory "
12605 "contents without making many round-trips. Very long directory listings "
12606 "might cause the protocol message size to be exceeded, causing this call to "
12607 "fail. The caller must split up such requests into smaller groups of names."
12611 #: ../fish/guestfish-actions.pod:3942
12616 #: ../fish/guestfish-actions.pod:3944
12624 #: ../fish/guestfish-actions.pod:3946 ../src/guestfs-actions.pod:5973
12626 "Return the canonicalized absolute pathname of C<path>. The returned path "
12627 "has no C<.>, C<..> or symbolic link path elements."
12631 #: ../fish/guestfish-actions.pod:3949
12632 msgid "removexattr"
12636 #: ../fish/guestfish-actions.pod:3951
12639 " removexattr xattr path\n"
12644 #: ../fish/guestfish-actions.pod:3953 ../src/guestfs-actions.pod:5988
12646 "This call removes the extended attribute named C<xattr> of the file C<path>."
12650 #: ../fish/guestfish-actions.pod:3956
12651 msgid "See also: L</lremovexattr>, L<attr(5)>."
12655 #: ../fish/guestfish-actions.pod:3958
12660 #: ../fish/guestfish-actions.pod:3960
12663 " resize2fs device\n"
12668 #: ../fish/guestfish-actions.pod:3962 ../src/guestfs-actions.pod:6003
12670 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12671 "underlying device."
12675 #: ../fish/guestfish-actions.pod:3965
12677 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
12678 "before calling this command. For unknown reasons C<resize2fs> sometimes "
12679 "gives an error about this and sometimes not. In any case, it is always safe "
12680 "to call L</e2fsck-f> before calling this function."
12684 #: ../fish/guestfish-actions.pod:3971
12685 msgid "resize2fs-M"
12689 #: ../fish/guestfish-actions.pod:3973
12692 " resize2fs-M device\n"
12697 #: ../fish/guestfish-actions.pod:3975
12699 "This command is the same as L</resize2fs>, but the filesystem is resized to "
12700 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
12705 #: ../fish/guestfish-actions.pod:3979
12707 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
12708 "and read the C<Block size> and C<Block count> values. These two numbers, "
12709 "multiplied together, give the resulting size of the minimal filesystem in "
12714 #: ../fish/guestfish-actions.pod:3984
12715 msgid "resize2fs-size"
12719 #: ../fish/guestfish-actions.pod:3986
12722 " resize2fs-size device size\n"
12727 #: ../fish/guestfish-actions.pod:3988
12729 "This command is the same as L</resize2fs> except that it allows you to "
12730 "specify the new size (in bytes) explicitly."
12734 #: ../fish/guestfish-actions.pod:3991
12739 #: ../fish/guestfish-actions.pod:3993
12747 #: ../fish/guestfish-actions.pod:3995 ../src/guestfs-actions.pod:6055
12748 msgid "Remove the single file C<path>."
12752 #: ../fish/guestfish-actions.pod:3997
12757 #: ../fish/guestfish-actions.pod:3999
12765 #: ../fish/guestfish-actions.pod:4001 ../src/guestfs-actions.pod:6067
12767 "Remove the file or directory C<path>, recursively removing the contents if "
12768 "its a directory. This is like the C<rm -rf> shell command."
12772 #: ../fish/guestfish-actions.pod:4005
12777 #: ../fish/guestfish-actions.pod:4007
12785 #: ../fish/guestfish-actions.pod:4009 ../src/guestfs-actions.pod:6081
12786 msgid "Remove the single directory C<path>."
12790 #: ../fish/guestfish-actions.pod:4011
12791 msgid "rmmountpoint"
12795 #: ../fish/guestfish-actions.pod:4013
12798 " rmmountpoint exemptpath\n"
12803 #: ../fish/guestfish-actions.pod:4015
12805 "This calls removes a mountpoint that was previously created with L</"
12806 "mkmountpoint>. See L</mkmountpoint> for full details."
12810 #: ../fish/guestfish-actions.pod:4019
12811 msgid "scrub-device"
12815 #: ../fish/guestfish-actions.pod:4021
12818 " scrub-device device\n"
12823 #: ../fish/guestfish-actions.pod:4023 ../src/guestfs-actions.pod:6107
12825 "This command writes patterns over C<device> to make data retrieval more "
12830 #: ../fish/guestfish-actions.pod:4026 ../fish/guestfish-actions.pod:4041
12831 #: ../fish/guestfish-actions.pod:4054 ../src/guestfs-actions.pod:6110
12832 #: ../src/guestfs-actions.pod:6131 ../src/guestfs-actions.pod:6150
12834 "It is an interface to the L<scrub(1)> program. See that manual page for "
12839 #: ../fish/guestfish-actions.pod:4032
12844 #: ../fish/guestfish-actions.pod:4034
12847 " scrub-file file\n"
12852 #: ../fish/guestfish-actions.pod:4036 ../src/guestfs-actions.pod:6126
12854 "This command writes patterns over a file to make data retrieval more "
12859 #: ../fish/guestfish-actions.pod:4039 ../src/guestfs-actions.pod:6129
12860 msgid "The file is I<removed> after scrubbing."
12864 #: ../fish/guestfish-actions.pod:4044
12865 msgid "scrub-freespace"
12869 #: ../fish/guestfish-actions.pod:4046
12872 " scrub-freespace dir\n"
12877 #: ../fish/guestfish-actions.pod:4048
12879 "This command creates the directory C<dir> and then fills it with files until "
12880 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
12881 "deletes them. The intention is to scrub any free space on the partition "
12882 "containing C<dir>."
12886 #: ../fish/guestfish-actions.pod:4057
12891 #: ../fish/guestfish-actions.pod:4059
12896 #: ../fish/guestfish-actions.pod:4061
12899 " set-append append\n"
12904 #: ../fish/guestfish-actions.pod:4063 ../src/guestfs-actions.pod:6163
12906 "This function is used to add additional options to the guest kernel command "
12911 #: ../fish/guestfish-actions.pod:4066 ../src/guestfs-actions.pod:6166
12913 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12914 "environment variable."
12918 #: ../fish/guestfish-actions.pod:4069 ../src/guestfs-actions.pod:6169
12920 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12921 "(libguestfs always adds a few of its own)."
12925 #: ../fish/guestfish-actions.pod:4072
12926 msgid "set-attach-method"
12930 #: ../fish/guestfish-actions.pod:4074
12931 msgid "attach-method"
12935 #: ../fish/guestfish-actions.pod:4076
12938 " set-attach-method attachmethod\n"
12943 #: ../fish/guestfish-actions.pod:4078 ../src/guestfs-actions.pod:6182
12945 "Set the method that libguestfs uses to connect to the back end guestfsd "
12946 "daemon. Possible methods are:"
12950 #: ../fish/guestfish-actions.pod:4083 ../src/guestfs-actions.pod:6187
12951 #: ../src/guestfs.pod:2703
12952 msgid "C<appliance>"
12956 #: ../fish/guestfish-actions.pod:4085 ../src/guestfs-actions.pod:6189
12958 "Launch an appliance and connect to it. This is the ordinary method and the "
12963 #: ../fish/guestfish-actions.pod:4088 ../src/guestfs-actions.pod:6192
12964 msgid "C<unix:I<path>>"
12968 #: ../fish/guestfish-actions.pod:4090 ../src/guestfs-actions.pod:6194
12969 msgid "Connect to the Unix domain socket I<path>."
12973 #: ../fish/guestfish-actions.pod:4092 ../src/guestfs-actions.pod:6196
12975 "This method lets you connect to an existing daemon or (using virtio-serial) "
12976 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
12977 "RUNNING DAEMONS>."
12981 #: ../fish/guestfish-actions.pod:4098
12982 msgid "set-autosync"
12986 #: ../fish/guestfish-actions.pod:4100
12991 #: ../fish/guestfish-actions.pod:4102
12994 " set-autosync true|false\n"
12999 #: ../fish/guestfish-actions.pod:4104 ../src/guestfs-actions.pod:6212
13001 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13002 "effort attempt to make filesystems consistent and synchronized when the "
13003 "handle is closed (also if the program exits without closing handles)."
13007 #: ../fish/guestfish-actions.pod:4109 ../src/guestfs-actions.pod:6217
13009 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13010 "disabled by default)."
13014 #: ../fish/guestfish-actions.pod:4112
13019 #: ../fish/guestfish-actions.pod:4114
13024 #: ../fish/guestfish-actions.pod:4116
13027 " set-direct true|false\n"
13032 #: ../fish/guestfish-actions.pod:4118 ../src/guestfs-actions.pod:6230
13034 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13035 "passed directly through to the appliance once it is launched."
13039 #: ../fish/guestfish-actions.pod:4122
13041 "One consequence of this is that log messages aren't caught by the library "
13042 "and handled by L</set-log-message-callback>, but go straight to stdout."
13046 #: ../fish/guestfish-actions.pod:4126 ../src/guestfs-actions.pod:6238
13047 msgid "You probably don't want to use this unless you know what you are doing."
13051 #: ../fish/guestfish-actions.pod:4129 ../src/guestfs-actions.pod:6241
13052 msgid "The default is disabled."
13056 #: ../fish/guestfish-actions.pod:4131
13057 msgid "set-e2label"
13061 #: ../fish/guestfish-actions.pod:4133
13064 " set-e2label device label\n"
13069 #: ../fish/guestfish-actions.pod:4135 ../src/guestfs-actions.pod:6254
13071 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13072 "C<label>. Filesystem labels are limited to 16 characters."
13076 #: ../fish/guestfish-actions.pod:4139
13078 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
13079 "label on a filesystem."
13083 #: ../fish/guestfish-actions.pod:4142
13088 #: ../fish/guestfish-actions.pod:4144
13091 " set-e2uuid device uuid\n"
13096 #: ../fish/guestfish-actions.pod:4146 ../src/guestfs-actions.pod:6272
13098 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13099 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13100 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13104 #: ../fish/guestfish-actions.pod:4151
13106 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
13107 "UUID of a filesystem."
13111 #: ../fish/guestfish-actions.pod:4154
13112 msgid "set-memsize"
13116 #: ../fish/guestfish-actions.pod:4156
13121 #: ../fish/guestfish-actions.pod:4158
13124 " set-memsize memsize\n"
13129 #: ../fish/guestfish-actions.pod:4160
13131 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13132 "This only has any effect if called before L</launch>."
13136 #: ../fish/guestfish-actions.pod:4164 ../src/guestfs-actions.pod:6294
13138 "You can also change this by setting the environment variable "
13139 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13143 #: ../fish/guestfish-actions.pod:4171
13144 msgid "set-network"
13148 #: ../fish/guestfish-actions.pod:4173
13153 #: ../fish/guestfish-actions.pod:4175
13156 " set-network true|false\n"
13161 #: ../fish/guestfish-actions.pod:4177 ../src/guestfs-actions.pod:6311
13163 "If C<network> is true, then the network is enabled in the libguestfs "
13164 "appliance. The default is false."
13168 #: ../fish/guestfish-actions.pod:4180 ../src/guestfs-actions.pod:6314
13170 "This affects whether commands are able to access the network (see L<guestfs"
13171 "(3)/RUNNING COMMANDS>)."
13175 #: ../fish/guestfish-actions.pod:4183
13177 "You must call this before calling L</launch>, otherwise it has no effect."
13181 #: ../fish/guestfish-actions.pod:4186
13186 #: ../fish/guestfish-actions.pod:4190
13189 " set-path searchpath\n"
13194 #: ../fish/guestfish-actions.pod:4192 ../src/guestfs-actions.pod:6330
13195 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13199 #: ../fish/guestfish-actions.pod:4194 ../src/guestfs-actions.pod:6332
13201 "The default is C<$libdir/guestfs> unless overridden by setting "
13202 "C<LIBGUESTFS_PATH> environment variable."
13206 #: ../fish/guestfish-actions.pod:4197 ../src/guestfs-actions.pod:6335
13207 msgid "Setting C<path> to C<NULL> restores the default path."
13211 #: ../fish/guestfish-actions.pod:4199
13216 #: ../fish/guestfish-actions.pod:4201
13221 #: ../fish/guestfish-actions.pod:4203
13224 " set-pgroup true|false\n"
13229 #: ../fish/guestfish-actions.pod:4205 ../src/guestfs-actions.pod:6347
13231 "If C<pgroup> is true, child processes are placed into their own process "
13236 #: ../fish/guestfish-actions.pod:4208 ../src/guestfs-actions.pod:6350
13238 "The practical upshot of this is that signals like C<SIGINT> (from users "
13239 "pressing C<^C>) won't be received by the child process."
13243 #: ../fish/guestfish-actions.pod:4211 ../src/guestfs-actions.pod:6353
13245 "The default for this flag is false, because usually you want C<^C> to kill "
13250 #: ../fish/guestfish-actions.pod:4214
13255 #: ../fish/guestfish-actions.pod:4216
13260 #: ../fish/guestfish-actions.pod:4218
13268 #: ../fish/guestfish-actions.pod:4220 ../src/guestfs-actions.pod:6366
13269 msgid "Set the qemu binary that we will use."
13273 #: ../fish/guestfish-actions.pod:4222 ../src/guestfs-actions.pod:6368
13275 "The default is chosen when the library was compiled by the configure script."
13279 #: ../fish/guestfish-actions.pod:4225 ../src/guestfs-actions.pod:6371
13281 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13286 #: ../fish/guestfish-actions.pod:4228 ../src/guestfs-actions.pod:6374
13287 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13291 #: ../fish/guestfish-actions.pod:4230 ../src/guestfs-actions.pod:6376
13293 "Note that you should call this function as early as possible after creating "
13294 "the handle. This is because some pre-launch operations depend on testing "
13295 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13296 "don't retest features, and so you might see inconsistent results. Using the "
13297 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13298 "the qemu binary at the same time as the handle is created."
13302 #: ../fish/guestfish-actions.pod:4238
13303 msgid "set-recovery-proc"
13307 #: ../fish/guestfish-actions.pod:4240
13308 msgid "recovery-proc"
13312 #: ../fish/guestfish-actions.pod:4242
13315 " set-recovery-proc true|false\n"
13320 #: ../fish/guestfish-actions.pod:4244
13322 "If this is called with the parameter C<false> then L</launch> does not "
13323 "create a recovery process. The purpose of the recovery process is to stop "
13324 "runaway qemu processes in the case where the main program aborts abruptly."
13328 #: ../fish/guestfish-actions.pod:4249
13330 "This only has any effect if called before L</launch>, and the default is "
13335 #: ../fish/guestfish-actions.pod:4252 ../src/guestfs-actions.pod:6402
13337 "About the only time when you would want to disable this is if the main "
13338 "process will fork itself into the background (\"daemonize\" itself). In "
13339 "this case the recovery process thinks that the main program has disappeared "
13340 "and so kills qemu, which is not very helpful."
13344 #: ../fish/guestfish-actions.pod:4258
13345 msgid "set-selinux"
13349 #: ../fish/guestfish-actions.pod:4260
13354 #: ../fish/guestfish-actions.pod:4262
13357 " set-selinux true|false\n"
13362 #: ../fish/guestfish-actions.pod:4264 ../src/guestfs-actions.pod:6418
13364 "This sets the selinux flag that is passed to the appliance at boot time. "
13365 "The default is C<selinux=0> (disabled)."
13369 #: ../fish/guestfish-actions.pod:4267 ../src/guestfs-actions.pod:6421
13371 "Note that if SELinux is enabled, it is always in Permissive mode "
13372 "(C<enforcing=0>)."
13376 #: ../fish/guestfish-actions.pod:4273
13381 #: ../fish/guestfish-actions.pod:4275
13386 #: ../fish/guestfish-actions.pod:4277
13389 " set-trace true|false\n"
13394 #: ../fish/guestfish-actions.pod:4279 ../src/guestfs-actions.pod:6437
13396 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
13397 "return values are traced."
13401 #: ../fish/guestfish-actions.pod:4282 ../src/guestfs-actions.pod:6440
13403 "If you want to trace C API calls into libguestfs (and other libraries) then "
13404 "possibly a better way is to use the external ltrace(1) command."
13408 #: ../fish/guestfish-actions.pod:4286 ../src/guestfs-actions.pod:6444
13410 "Command traces are disabled unless the environment variable "
13411 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13415 #: ../fish/guestfish-actions.pod:4289
13417 "Trace messages are normally sent to C<stderr>, unless you register a "
13418 "callback to send them somewhere else (see L</set-event-callback>)."
13422 #: ../fish/guestfish-actions.pod:4293
13423 msgid "set-verbose"
13427 #: ../fish/guestfish-actions.pod:4295
13432 #: ../fish/guestfish-actions.pod:4297
13435 " set-verbose true|false\n"
13440 #: ../fish/guestfish-actions.pod:4299 ../src/guestfs-actions.pod:6461
13441 msgid "If C<verbose> is true, this turns on verbose messages."
13445 #: ../fish/guestfish-actions.pod:4301 ../src/guestfs-actions.pod:6463
13447 "Verbose messages are disabled unless the environment variable "
13448 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13452 #: ../fish/guestfish-actions.pod:4304
13454 "Verbose messages are normally sent to C<stderr>, unless you register a "
13455 "callback to send them somewhere else (see L</set-event-callback>)."
13459 #: ../fish/guestfish-actions.pod:4308
13464 #: ../fish/guestfish-actions.pod:4310
13467 " setcon context\n"
13472 #: ../fish/guestfish-actions.pod:4312 ../src/guestfs-actions.pod:6480
13474 "This sets the SELinux security context of the daemon to the string "
13479 #: ../fish/guestfish-actions.pod:4315 ../src/guestfs-actions.pod:6483
13480 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13484 #: ../fish/guestfish-actions.pod:4317
13489 #: ../fish/guestfish-actions.pod:4319
13492 " setxattr xattr val vallen path\n"
13497 #: ../fish/guestfish-actions.pod:4321 ../src/guestfs-actions.pod:6498
13499 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13500 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13504 #: ../fish/guestfish-actions.pod:4325
13505 msgid "See also: L</lsetxattr>, L<attr(5)>."
13509 #: ../fish/guestfish-actions.pod:4327
13514 #: ../fish/guestfish-actions.pod:4329
13517 " sfdisk device cyls heads sectors 'lines ...'\n"
13522 #: ../fish/guestfish-actions.pod:4331 ../src/guestfs-actions.pod:6525
13524 "This is a direct interface to the L<sfdisk(8)> program for creating "
13525 "partitions on block devices."
13529 #: ../fish/guestfish-actions.pod:4334 ../src/guestfs-actions.pod:6528
13530 msgid "C<device> should be a block device, for example C</dev/sda>."
13534 #: ../fish/guestfish-actions.pod:4336 ../src/guestfs-actions.pod:6530
13536 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13537 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
13538 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13539 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13540 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13541 "the kernel) cannot work out the right geometry and you will need to tell it."
13545 #: ../fish/guestfish-actions.pod:4344 ../src/guestfs-actions.pod:6538
13547 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13548 "refer to the L<sfdisk(8)> manpage."
13552 #: ../fish/guestfish-actions.pod:4347 ../src/guestfs-actions.pod:6541
13554 "To create a single partition occupying the whole disk, you would pass "
13555 "C<lines> as a single element list, when the single element being the string "
13560 #: ../fish/guestfish-actions.pod:4351
13561 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
13565 #: ../fish/guestfish-actions.pod:4357 ../fish/guestfish-actions.pod:4380
13566 #: ../fish/guestfish-actions.pod:4402
13568 "I<This function is deprecated.> In new code, use the L</part_add> call "
13573 #: ../fish/guestfish-actions.pod:4364
13578 #: ../fish/guestfish-actions.pod:4366
13581 " sfdiskM device 'lines ...'\n"
13586 #: ../fish/guestfish-actions.pod:4368
13588 "This is a simplified interface to the L</sfdisk> command, where partition "
13589 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
13590 "you don't need to specify the cyls, heads and sectors parameters which were "
13591 "rarely if ever used anyway."
13595 #: ../fish/guestfish-actions.pod:4374
13596 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
13600 #: ../fish/guestfish-actions.pod:4387
13605 #: ../fish/guestfish-actions.pod:4389
13608 " sfdisk-N device partnum cyls heads sectors line\n"
13613 #: ../fish/guestfish-actions.pod:4391 ../src/guestfs-actions.pod:6603
13615 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13616 "(note: C<n> counts from 1)."
13620 #: ../fish/guestfish-actions.pod:4394
13622 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
13623 "cyls/heads/sectors parameters."
13627 #: ../fish/guestfish-actions.pod:4397
13628 msgid "See also: L</part-add>"
13632 #: ../fish/guestfish-actions.pod:4409
13633 msgid "sfdisk-disk-geometry"
13637 #: ../fish/guestfish-actions.pod:4411
13640 " sfdisk-disk-geometry device\n"
13645 #: ../fish/guestfish-actions.pod:4413
13647 "This displays the disk geometry of C<device> read from the partition table. "
13648 "Especially in the case where the underlying block device has been resized, "
13649 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
13650 "kernel-geometry>)."
13654 #: ../fish/guestfish-actions.pod:4418 ../fish/guestfish-actions.pod:4427
13655 #: ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6645
13656 msgid "The result is in human-readable format, and not designed to be parsed."
13660 #: ../fish/guestfish-actions.pod:4421
13661 msgid "sfdisk-kernel-geometry"
13665 #: ../fish/guestfish-actions.pod:4423
13668 " sfdisk-kernel-geometry device\n"
13673 #: ../fish/guestfish-actions.pod:4425 ../src/guestfs-actions.pod:6643
13674 msgid "This displays the kernel's idea of the geometry of C<device>."
13678 #: ../fish/guestfish-actions.pod:4430
13683 #: ../fish/guestfish-actions.pod:4432
13686 " sfdisk-l device\n"
13691 #: ../fish/guestfish-actions.pod:4434 ../src/guestfs-actions.pod:6666
13693 "This displays the partition table on C<device>, in the human-readable output "
13694 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13698 #: ../fish/guestfish-actions.pod:4438
13699 msgid "See also: L</part-list>"
13703 #: ../fish/guestfish-actions.pod:4440
13705 "I<This function is deprecated.> In new code, use the L</part_list> call "
13710 #: ../fish/guestfish-actions.pod:4447
13715 #: ../fish/guestfish-actions.pod:4449
13723 #: ../fish/guestfish-actions.pod:4451 ../src/guestfs-actions.pod:6683
13725 "This call runs a command from the guest filesystem via the guest's C</bin/"
13730 #: ../fish/guestfish-actions.pod:4454
13731 msgid "This is like L</command>, but passes the command to:"
13735 #: ../fish/guestfish-actions.pod:4456 ../src/guestfs-actions.pod:6688
13738 " /bin/sh -c \"command\"\n"
13743 #: ../fish/guestfish-actions.pod:4458 ../src/guestfs-actions.pod:6690
13745 "Depending on the guest's shell, this usually results in wildcards being "
13746 "expanded, shell expressions being interpolated and so on."
13750 #: ../fish/guestfish-actions.pod:4462
13751 msgid "All the provisos about L</command> apply to this call."
13755 #: ../fish/guestfish-actions.pod:4464
13760 #: ../fish/guestfish-actions.pod:4466
13763 " sh-lines command\n"
13768 #: ../fish/guestfish-actions.pod:4468
13769 msgid "This is the same as L</sh>, but splits the result into a list of lines."
13773 #: ../fish/guestfish-actions.pod:4471
13774 msgid "See also: L</command-lines>"
13778 #: ../fish/guestfish-actions.pod:4473
13783 #: ../fish/guestfish-actions.pod:4475
13791 #: ../fish/guestfish-actions.pod:4477 ../src/guestfs-actions.pod:6724
13792 msgid "Sleep for C<secs> seconds."
13796 #: ../fish/guestfish-actions.pod:4479
13801 #: ../fish/guestfish-actions.pod:4481
13809 #: ../fish/guestfish-actions.pod:4485 ../src/guestfs-actions.pod:6738
13810 msgid "This is the same as the C<stat(2)> system call."
13814 #: ../fish/guestfish-actions.pod:4487
13819 #: ../fish/guestfish-actions.pod:4489
13827 #: ../fish/guestfish-actions.pod:4491 ../src/guestfs-actions.pod:6752
13829 "Returns file system statistics for any mounted file system. C<path> should "
13830 "be a file or directory in the mounted file system (typically it is the mount "
13831 "point itself, but it doesn't need to be)."
13835 #: ../fish/guestfish-actions.pod:4495 ../src/guestfs-actions.pod:6756
13836 msgid "This is the same as the C<statvfs(2)> system call."
13840 #: ../fish/guestfish-actions.pod:4497
13845 #: ../fish/guestfish-actions.pod:4499
13853 #: ../fish/guestfish-actions.pod:4501 ../src/guestfs-actions.pod:6770
13855 "This runs the L<strings(1)> command on a file and returns the list of "
13856 "printable strings found."
13860 #: ../fish/guestfish-actions.pod:4507
13865 #: ../fish/guestfish-actions.pod:4509
13868 " strings-e encoding path\n"
13873 #: ../fish/guestfish-actions.pod:4511
13875 "This is like the L</strings> command, but allows you to specify the encoding "
13876 "of strings that are looked for in the source file C<path>."
13880 #: ../fish/guestfish-actions.pod:4515 ../src/guestfs-actions.pod:6793
13881 msgid "Allowed encodings are:"
13885 #: ../fish/guestfish-actions.pod:4519 ../src/guestfs-actions.pod:6797
13890 #: ../fish/guestfish-actions.pod:4521
13892 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13893 "ISO-8859-X (this is what L</strings> uses)."
13897 #: ../fish/guestfish-actions.pod:4524 ../src/guestfs-actions.pod:6802
13902 #: ../fish/guestfish-actions.pod:4526 ../src/guestfs-actions.pod:6804
13903 msgid "Single 8-bit-byte characters."
13907 #: ../fish/guestfish-actions.pod:4528 ../src/guestfs-actions.pod:6806
13912 #: ../fish/guestfish-actions.pod:4530 ../src/guestfs-actions.pod:6808
13913 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13917 #: ../fish/guestfish-actions.pod:4533 ../src/guestfs-actions.pod:6811
13918 msgid "l (lower case letter L)"
13922 #: ../fish/guestfish-actions.pod:4535 ../src/guestfs-actions.pod:6813
13924 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13925 "examining binaries in Windows guests."
13929 #: ../fish/guestfish-actions.pod:4538 ../src/guestfs-actions.pod:6816
13934 #: ../fish/guestfish-actions.pod:4540 ../src/guestfs-actions.pod:6818
13935 msgid "32-bit big endian such as UCS-4BE."
13939 #: ../fish/guestfish-actions.pod:4542 ../src/guestfs-actions.pod:6820
13944 #: ../fish/guestfish-actions.pod:4544 ../src/guestfs-actions.pod:6822
13945 msgid "32-bit little endian such as UCS-4LE."
13949 #: ../fish/guestfish-actions.pod:4548 ../src/guestfs-actions.pod:6826
13950 msgid "The returned strings are transcoded to UTF-8."
13954 #: ../fish/guestfish-actions.pod:4553
13955 msgid "swapoff-device"
13959 #: ../fish/guestfish-actions.pod:4555
13962 " swapoff-device device\n"
13967 #: ../fish/guestfish-actions.pod:4557
13969 "This command disables the libguestfs appliance swap device or partition "
13970 "named C<device>. See L</swapon-device>."
13974 #: ../fish/guestfish-actions.pod:4561
13975 msgid "swapoff-file"
13979 #: ../fish/guestfish-actions.pod:4563
13982 " swapoff-file file\n"
13987 #: ../fish/guestfish-actions.pod:4565 ../src/guestfs-actions.pod:6857
13988 msgid "This command disables the libguestfs appliance swap on file."
13992 #: ../fish/guestfish-actions.pod:4567
13993 msgid "swapoff-label"
13997 #: ../fish/guestfish-actions.pod:4569
14000 " swapoff-label label\n"
14005 #: ../fish/guestfish-actions.pod:4571 ../src/guestfs-actions.pod:6869
14007 "This command disables the libguestfs appliance swap on labeled swap "
14012 #: ../fish/guestfish-actions.pod:4574
14013 msgid "swapoff-uuid"
14017 #: ../fish/guestfish-actions.pod:4576
14020 " swapoff-uuid uuid\n"
14025 #: ../fish/guestfish-actions.pod:4578 ../src/guestfs-actions.pod:6882
14027 "This command disables the libguestfs appliance swap partition with the given "
14032 #: ../fish/guestfish-actions.pod:4581
14033 msgid "swapon-device"
14037 #: ../fish/guestfish-actions.pod:4583
14040 " swapon-device device\n"
14045 #: ../fish/guestfish-actions.pod:4585
14047 "This command enables the libguestfs appliance to use the swap device or "
14048 "partition named C<device>. The increased memory is made available for all "
14049 "commands, for example those run using L</command> or L</sh>."
14053 #: ../fish/guestfish-actions.pod:4590 ../src/guestfs-actions.pod:6900
14055 "Note that you should not swap to existing guest swap partitions unless you "
14056 "know what you are doing. They may contain hibernation information, or other "
14057 "information that the guest doesn't want you to trash. You also risk leaking "
14058 "information about the host to the guest this way. Instead, attach a new "
14059 "host device to the guest and swap on that."
14063 #: ../fish/guestfish-actions.pod:4597
14064 msgid "swapon-file"
14068 #: ../fish/guestfish-actions.pod:4599
14071 " swapon-file file\n"
14076 #: ../fish/guestfish-actions.pod:4601
14078 "This command enables swap to a file. See L</swapon-device> for other notes."
14082 #: ../fish/guestfish-actions.pod:4604
14083 msgid "swapon-label"
14087 #: ../fish/guestfish-actions.pod:4606
14090 " swapon-label label\n"
14095 #: ../fish/guestfish-actions.pod:4608
14097 "This command enables swap to a labeled swap partition. See L</swapon-"
14098 "device> for other notes."
14102 #: ../fish/guestfish-actions.pod:4611
14103 msgid "swapon-uuid"
14107 #: ../fish/guestfish-actions.pod:4613
14110 " swapon-uuid uuid\n"
14115 #: ../fish/guestfish-actions.pod:4615
14117 "This command enables swap to a swap partition with the given UUID. See L</"
14118 "swapon-device> for other notes."
14122 #: ../fish/guestfish-actions.pod:4618
14127 #: ../fish/guestfish-actions.pod:4620
14135 #: ../fish/guestfish-actions.pod:4622 ../src/guestfs-actions.pod:6955
14137 "This syncs the disk, so that any writes are flushed through to the "
14138 "underlying disk image."
14142 #: ../fish/guestfish-actions.pod:4625 ../src/guestfs-actions.pod:6958
14144 "You should always call this if you have modified a disk image, before "
14145 "closing the handle."
14149 #: ../fish/guestfish-actions.pod:4628
14154 #: ../fish/guestfish-actions.pod:4630
14162 #: ../fish/guestfish-actions.pod:4632 ../src/guestfs-actions.pod:6971
14164 "This command returns up to the last 10 lines of a file as a list of strings."
14168 #: ../fish/guestfish-actions.pod:4638
14173 #: ../fish/guestfish-actions.pod:4640
14176 " tail-n nrlines path\n"
14181 #: ../fish/guestfish-actions.pod:4642 ../src/guestfs-actions.pod:6990
14183 "If the parameter C<nrlines> is a positive number, this returns the last "
14184 "C<nrlines> lines of the file C<path>."
14188 #: ../fish/guestfish-actions.pod:4645 ../src/guestfs-actions.pod:6993
14190 "If the parameter C<nrlines> is a negative number, this returns lines from "
14191 "the file C<path>, starting with the C<-nrlines>th line."
14195 #: ../fish/guestfish-actions.pod:4653
14200 #: ../fish/guestfish-actions.pod:4655
14203 " tar-in (tarfile|-) directory\n"
14208 #: ../fish/guestfish-actions.pod:4657 ../src/guestfs-actions.pod:7014
14210 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14211 "tar file) into C<directory>."
14215 #: ../fish/guestfish-actions.pod:4660
14216 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
14220 #: ../fish/guestfish-actions.pod:4665
14225 #: ../fish/guestfish-actions.pod:4667
14228 " tar-out directory (tarfile|-)\n"
14233 #: ../fish/guestfish-actions.pod:4669 ../src/guestfs-actions.pod:7031
14235 "This command packs the contents of C<directory> and downloads it to local "
14240 #: ../fish/guestfish-actions.pod:4672
14241 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
14245 #: ../fish/guestfish-actions.pod:4677
14250 #: ../fish/guestfish-actions.pod:4679
14253 " tgz-in (tarball|-) directory\n"
14258 #: ../fish/guestfish-actions.pod:4681 ../src/guestfs-actions.pod:7048
14260 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14261 "tar file) into C<directory>."
14265 #: ../fish/guestfish-actions.pod:4684
14266 msgid "To upload an uncompressed tarball, use L</tar-in>."
14270 #: ../fish/guestfish-actions.pod:4688
14275 #: ../fish/guestfish-actions.pod:4690
14278 " tgz-out directory (tarball|-)\n"
14283 #: ../fish/guestfish-actions.pod:4692 ../src/guestfs-actions.pod:7064
14285 "This command packs the contents of C<directory> and downloads it to local "
14290 #: ../fish/guestfish-actions.pod:4695
14291 msgid "To download an uncompressed tarball, use L</tar-out>."
14295 #: ../fish/guestfish-actions.pod:4699
14300 #: ../fish/guestfish-actions.pod:4701
14308 #: ../fish/guestfish-actions.pod:4703 ../src/guestfs-actions.pod:7079
14310 "Touch acts like the L<touch(1)> command. It can be used to update the "
14311 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14316 #: ../fish/guestfish-actions.pod:4707 ../src/guestfs-actions.pod:7083
14318 "This command only works on regular files, and will fail on other file types "
14319 "such as directories, symbolic links, block special etc."
14323 #: ../fish/guestfish-actions.pod:4710
14328 #: ../fish/guestfish-actions.pod:4712
14336 #: ../fish/guestfish-actions.pod:4714 ../src/guestfs-actions.pod:7096
14338 "This command truncates C<path> to a zero-length file. The file must exist "
14343 #: ../fish/guestfish-actions.pod:4717
14344 msgid "truncate-size"
14348 #: ../fish/guestfish-actions.pod:4719
14351 " truncate-size path size\n"
14356 #: ../fish/guestfish-actions.pod:4721 ../src/guestfs-actions.pod:7110
14358 "This command truncates C<path> to size C<size> bytes. The file must exist "
14363 #: ../fish/guestfish-actions.pod:4724
14365 "If the current file size is less than C<size> then the file is extended to "
14366 "the required size with zero bytes. This creates a sparse file (ie. disk "
14367 "blocks are not allocated for the file until you write to it). To create a "
14368 "non-sparse file of zeroes, use L</fallocate64> instead."
14372 #: ../fish/guestfish-actions.pod:4730
14377 #: ../fish/guestfish-actions.pod:4732
14380 " tune2fs-l device\n"
14385 #: ../fish/guestfish-actions.pod:4734 ../src/guestfs-actions.pod:7129
14387 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14392 #: ../fish/guestfish-actions.pod:4737 ../src/guestfs-actions.pod:7132
14394 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14395 "for more details. The list of fields returned isn't clearly defined, and "
14396 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14397 "and the filesystem itself."
14401 #: ../fish/guestfish-actions.pod:4742
14406 #: ../fish/guestfish-actions.pod:4744
14409 " txz-in (tarball|-) directory\n"
14414 #: ../fish/guestfish-actions.pod:4746 ../src/guestfs-actions.pod:7152
14416 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14417 "tar file) into C<directory>."
14421 #: ../fish/guestfish-actions.pod:4751
14426 #: ../fish/guestfish-actions.pod:4753
14429 " txz-out directory (tarball|-)\n"
14434 #: ../fish/guestfish-actions.pod:4755 ../src/guestfs-actions.pod:7166
14436 "This command packs the contents of C<directory> and downloads it to local "
14437 "file C<tarball> (as an xz compressed tar archive)."
14441 #: ../fish/guestfish-actions.pod:4760
14446 #: ../fish/guestfish-actions.pod:4762
14454 #: ../fish/guestfish-actions.pod:4764 ../src/guestfs-actions.pod:7179
14456 "This function sets the mask used for creating new files and device nodes to "
14461 #: ../fish/guestfish-actions.pod:4767 ../src/guestfs-actions.pod:7182
14463 "Typical umask values would be C<022> which creates new files with "
14464 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14465 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14469 #: ../fish/guestfish-actions.pod:4772 ../src/guestfs-actions.pod:7187
14471 "The default umask is C<022>. This is important because it means that "
14472 "directories and device nodes will be created with C<0644> or C<0755> mode "
14473 "even if you specify C<0777>."
14477 #: ../fish/guestfish-actions.pod:4776
14478 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
14482 #: ../fish/guestfish-actions.pod:4779 ../src/guestfs-actions.pod:7194
14483 msgid "This call returns the previous umask."
14487 #: ../fish/guestfish-actions.pod:4781
14492 #: ../fish/guestfish-actions.pod:4783
14497 #: ../fish/guestfish-actions.pod:4785
14500 " umount pathordevice\n"
14505 #: ../fish/guestfish-actions.pod:4787 ../src/guestfs-actions.pod:7206
14507 "This unmounts the given filesystem. The filesystem may be specified either "
14508 "by its mountpoint (path) or the device which contains the filesystem."
14512 #: ../fish/guestfish-actions.pod:4791
14517 #: ../fish/guestfish-actions.pod:4793
14518 msgid "unmount-all"
14522 #: ../fish/guestfish-actions.pod:4795
14530 #: ../fish/guestfish-actions.pod:4797 ../src/guestfs-actions.pod:7219
14531 msgid "This unmounts all mounted filesystems."
14535 #: ../fish/guestfish-actions.pod:4799 ../src/guestfs-actions.pod:7221
14536 msgid "Some internal mounts are not unmounted by this call."
14540 #: ../fish/guestfish-actions.pod:4801
14545 #: ../fish/guestfish-actions.pod:4803
14548 " upload (filename|-) remotefilename\n"
14553 #: ../fish/guestfish-actions.pod:4805 ../fish/guestfish-actions.pod:4818
14554 #: ../src/guestfs-actions.pod:7234 ../src/guestfs-actions.pod:7258
14555 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14559 #: ../fish/guestfish-actions.pod:4810
14560 msgid "See also L</download>."
14564 #: ../fish/guestfish-actions.pod:4814
14565 msgid "upload-offset"
14569 #: ../fish/guestfish-actions.pod:4816
14572 " upload-offset (filename|-) remotefilename offset\n"
14577 #: ../fish/guestfish-actions.pod:4821 ../src/guestfs-actions.pod:7261
14579 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14580 "The intention is to overwrite parts of existing files or devices, although "
14581 "if a non-existant file is specified then it is created with a \"hole\" "
14582 "before C<offset>. The size of the data written is implicit in the size of "
14583 "the source C<filename>."
14587 #: ../fish/guestfish-actions.pod:4828
14589 "Note that there is no limit on the amount of data that can be uploaded with "
14590 "this call, unlike with L</pwrite>, and this call always writes the full "
14591 "amount unless an error occurs."
14595 #: ../fish/guestfish-actions.pod:4833
14596 msgid "See also L</upload>, L</pwrite>."
14600 #: ../fish/guestfish-actions.pod:4837
14605 #: ../fish/guestfish-actions.pod:4839
14608 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
14613 #: ../fish/guestfish-actions.pod:4841 ../src/guestfs-actions.pod:7294
14614 msgid "This command sets the timestamps of a file with nanosecond precision."
14618 #: ../fish/guestfish-actions.pod:4844 ../src/guestfs-actions.pod:7297
14620 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14625 #: ../fish/guestfish-actions.pod:4847 ../src/guestfs-actions.pod:7300
14627 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14628 "nanoseconds from the epoch."
14632 #: ../fish/guestfish-actions.pod:4850 ../src/guestfs-actions.pod:7303
14634 "If the C<*nsecs> field contains the special value C<-1> then the "
14635 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14636 "ignored in this case)."
14640 #: ../fish/guestfish-actions.pod:4854 ../src/guestfs-actions.pod:7307
14642 "If the C<*nsecs> field contains the special value C<-2> then the "
14643 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14648 #: ../fish/guestfish-actions.pod:4858
14653 #: ../fish/guestfish-actions.pod:4860
14661 #: ../fish/guestfish-actions.pod:4862 ../src/guestfs-actions.pod:7320
14663 "Return the libguestfs version number that the program is linked against."
14667 #: ../fish/guestfish-actions.pod:4865 ../src/guestfs-actions.pod:7323
14669 "Note that because of dynamic linking this is not necessarily the version of "
14670 "libguestfs that you compiled against. You can compile the program, and then "
14671 "at runtime dynamically link against a completely different C<libguestfs.so> "
14676 #: ../fish/guestfish-actions.pod:4870 ../src/guestfs-actions.pod:7328
14678 "This call was added in version C<1.0.58>. In previous versions of "
14679 "libguestfs there was no way to get the version number. From C code you can "
14680 "use dynamic linker functions to find out if this symbol exists (if it "
14681 "doesn't, then it's an earlier version)."
14685 #: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7334
14687 "The call returns a structure with four elements. The first three (C<major>, "
14688 "C<minor> and C<release>) are numbers and correspond to the usual version "
14689 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14690 "but may be used for distro-specific information."
14694 #: ../fish/guestfish-actions.pod:4882 ../src/guestfs-actions.pod:7340
14696 "To construct the original version string: C<$major.$minor.$release$extra>"
14700 #: ../fish/guestfish-actions.pod:4885 ../src/guestfs-actions.pod:7343
14701 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14705 #: ../fish/guestfish-actions.pod:4887
14707 "I<Note:> Don't use this call to test for availability of features. In "
14708 "enterprise distributions we backport features from later versions into "
14709 "earlier versions, making this an unreliable way to test for features. Use "
14710 "L</available> instead."
14714 #: ../fish/guestfish-actions.pod:4893
14719 #: ../fish/guestfish-actions.pod:4895
14722 " vfs-label device\n"
14727 #: ../fish/guestfish-actions.pod:4897 ../src/guestfs-actions.pod:7363
14728 msgid "This returns the filesystem label of the filesystem on C<device>."
14732 #: ../fish/guestfish-actions.pod:4900 ../src/guestfs-actions.pod:7366
14733 msgid "If the filesystem is unlabeled, this returns the empty string."
14737 #: ../fish/guestfish-actions.pod:4902
14738 msgid "To find a filesystem from the label, use L</findfs-label>."
14742 #: ../fish/guestfish-actions.pod:4904
14747 #: ../fish/guestfish-actions.pod:4906
14750 " vfs-type device\n"
14755 #: ../fish/guestfish-actions.pod:4908 ../src/guestfs-actions.pod:7381
14757 "This command gets the filesystem type corresponding to the filesystem on "
14762 #: ../fish/guestfish-actions.pod:4911 ../src/guestfs-actions.pod:7384
14764 "For most filesystems, the result is the name of the Linux VFS module which "
14765 "would be used to mount this filesystem if you mounted it without specifying "
14766 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14770 #: ../fish/guestfish-actions.pod:4916
14775 #: ../fish/guestfish-actions.pod:4918
14778 " vfs-uuid device\n"
14783 #: ../fish/guestfish-actions.pod:4920 ../src/guestfs-actions.pod:7400
14784 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14788 #: ../fish/guestfish-actions.pod:4923 ../src/guestfs-actions.pod:7403
14789 msgid "If the filesystem does not have a UUID, this returns the empty string."
14793 #: ../fish/guestfish-actions.pod:4925
14794 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
14798 #: ../fish/guestfish-actions.pod:4927
14799 msgid "vg-activate"
14803 #: ../fish/guestfish-actions.pod:4929
14806 " vg-activate true|false 'volgroups ...'\n"
14811 #: ../fish/guestfish-actions.pod:4931 ../src/guestfs-actions.pod:7419
14813 "This command activates or (if C<activate> is false) deactivates all logical "
14814 "volumes in the listed volume groups C<volgroups>."
14818 #: ../fish/guestfish-actions.pod:4934 ../src/guestfs-actions.pod:7422
14819 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14823 #: ../fish/guestfish-actions.pod:4936 ../src/guestfs-actions.pod:7424
14825 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14826 "activated or deactivated."
14830 #: ../fish/guestfish-actions.pod:4939
14831 msgid "vg-activate-all"
14835 #: ../fish/guestfish-actions.pod:4941
14838 " vg-activate-all true|false\n"
14843 #: ../fish/guestfish-actions.pod:4943 ../src/guestfs-actions.pod:7437
14845 "This command activates or (if C<activate> is false) deactivates all logical "
14846 "volumes in all volume groups."
14850 #: ../fish/guestfish-actions.pod:4946 ../src/guestfs-actions.pod:7440
14851 msgid "This command is the same as running C<vgchange -a y|n>"
14855 #: ../fish/guestfish-actions.pod:4948
14860 #: ../fish/guestfish-actions.pod:4950
14863 " vgcreate volgroup 'physvols ...'\n"
14868 #: ../fish/guestfish-actions.pod:4952 ../src/guestfs-actions.pod:7453
14870 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14871 "of physical volumes C<physvols>."
14875 #: ../fish/guestfish-actions.pod:4955
14880 #: ../fish/guestfish-actions.pod:4957
14883 " vglvuuids vgname\n"
14888 #: ../fish/guestfish-actions.pod:4959 ../src/guestfs-actions.pod:7466
14890 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14891 "volumes created in this volume group."
14895 #: ../fish/guestfish-actions.pod:4962
14897 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
14898 "logical volumes and volume groups."
14902 #: ../fish/guestfish-actions.pod:4965
14903 msgid "See also L</vgpvuuids>."
14907 #: ../fish/guestfish-actions.pod:4967
14912 #: ../fish/guestfish-actions.pod:4969
14915 " vgpvuuids vgname\n"
14920 #: ../fish/guestfish-actions.pod:4971 ../src/guestfs-actions.pod:7486
14922 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14923 "volumes that this volume group resides on."
14927 #: ../fish/guestfish-actions.pod:4974
14929 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
14930 "physical volumes and volume groups."
14934 #: ../fish/guestfish-actions.pod:4977
14935 msgid "See also L</vglvuuids>."
14939 #: ../fish/guestfish-actions.pod:4979
14944 #: ../fish/guestfish-actions.pod:4981
14947 " vgremove vgname\n"
14952 #: ../fish/guestfish-actions.pod:4983 ../src/guestfs-actions.pod:7506
14953 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14957 #: ../fish/guestfish-actions.pod:4985 ../src/guestfs-actions.pod:7508
14959 "This also forcibly removes all logical volumes in the volume group (if any)."
14963 #: ../fish/guestfish-actions.pod:4988
14968 #: ../fish/guestfish-actions.pod:4990
14971 " vgrename volgroup newvolgroup\n"
14976 #: ../fish/guestfish-actions.pod:4992 ../src/guestfs-actions.pod:7522
14977 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14981 #: ../fish/guestfish-actions.pod:4994
14986 #: ../fish/guestfish-actions.pod:4996
14994 #: ../fish/guestfish-actions.pod:4998 ../src/guestfs-actions.pod:7533
14996 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15001 #: ../fish/guestfish-actions.pod:5001 ../src/guestfs-actions.pod:7536
15003 "This returns a list of just the volume group names that were detected (eg. "
15008 #: ../fish/guestfish-actions.pod:5004
15009 msgid "See also L</vgs-full>."
15013 #: ../fish/guestfish-actions.pod:5006
15018 #: ../fish/guestfish-actions.pod:5008
15026 #: ../fish/guestfish-actions.pod:5010 ../src/guestfs-actions.pod:7552
15028 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15029 "> command. The \"full\" version includes all fields."
15033 #: ../fish/guestfish-actions.pod:5013
15038 #: ../fish/guestfish-actions.pod:5015
15046 #: ../fish/guestfish-actions.pod:5017 ../src/guestfs-actions.pod:7566
15048 "This rescans all block devices and rebuilds the list of LVM physical "
15049 "volumes, volume groups and logical volumes."
15053 #: ../fish/guestfish-actions.pod:5020
15058 #: ../fish/guestfish-actions.pod:5022
15066 #: ../fish/guestfish-actions.pod:5024 ../src/guestfs-actions.pod:7579
15067 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15071 #: ../fish/guestfish-actions.pod:5026
15076 #: ../fish/guestfish-actions.pod:5028
15084 #: ../fish/guestfish-actions.pod:5030 ../src/guestfs-actions.pod:7619
15086 "This command counts the characters in a file, using the C<wc -c> external "
15091 #: ../fish/guestfish-actions.pod:5033
15096 #: ../fish/guestfish-actions.pod:5035
15104 #: ../fish/guestfish-actions.pod:5037 ../src/guestfs-actions.pod:7632
15106 "This command counts the lines in a file, using the C<wc -l> external command."
15110 #: ../fish/guestfish-actions.pod:5040
15115 #: ../fish/guestfish-actions.pod:5042
15123 #: ../fish/guestfish-actions.pod:5044 ../src/guestfs-actions.pod:7645
15125 "This command counts the words in a file, using the C<wc -w> external command."
15129 #: ../fish/guestfish-actions.pod:5047
15134 #: ../fish/guestfish-actions.pod:5049
15137 " write path content\n"
15142 #: ../fish/guestfish-actions.pod:5051 ../src/guestfs-actions.pod:7660
15144 "This call creates a file called C<path>. The content of the file is the "
15145 "string C<content> (which can contain any 8 bit data)."
15149 #: ../fish/guestfish-actions.pod:5054
15150 msgid "See also L</write-append>."
15154 #: ../fish/guestfish-actions.pod:5059
15155 msgid "write-append"
15159 #: ../fish/guestfish-actions.pod:5061
15162 " write-append path content\n"
15167 #: ../fish/guestfish-actions.pod:5063 ../src/guestfs-actions.pod:7680
15169 "This call appends C<content> to the end of file C<path>. If C<path> does "
15170 "not exist, then a new file is created."
15174 #: ../fish/guestfish-actions.pod:5066
15175 msgid "See also L</write>."
15179 #: ../fish/guestfish-actions.pod:5071
15184 #: ../fish/guestfish-actions.pod:5073
15187 " write-file path content size\n"
15192 #: ../fish/guestfish-actions.pod:5075 ../src/guestfs-actions.pod:7707
15194 "This call creates a file called C<path>. The contents of the file is the "
15195 "string C<content> (which can contain any 8 bit data), with length C<size>."
15199 #: ../fish/guestfish-actions.pod:5079 ../src/guestfs-actions.pod:7711
15201 "As a special case, if C<size> is C<0> then the length is calculated using "
15202 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15206 #: ../fish/guestfish-actions.pod:5083 ../src/guestfs-actions.pod:7715
15208 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15209 "I<not> work, even if the length is specified."
15213 #: ../fish/guestfish-actions.pod:5089
15215 "I<This function is deprecated.> In new code, use the L</write> call instead."
15219 #: ../fish/guestfish-actions.pod:5096
15224 #: ../fish/guestfish-actions.pod:5098
15227 " zegrep regex path\n"
15232 #: ../fish/guestfish-actions.pod:5100 ../src/guestfs-actions.pod:7732
15234 "This calls the external C<zegrep> program and returns the matching lines."
15238 #: ../fish/guestfish-actions.pod:5106
15243 #: ../fish/guestfish-actions.pod:5108
15246 " zegrepi regex path\n"
15251 #: ../fish/guestfish-actions.pod:5110 ../src/guestfs-actions.pod:7751
15253 "This calls the external C<zegrep -i> program and returns the matching lines."
15257 #: ../fish/guestfish-actions.pod:5116
15262 #: ../fish/guestfish-actions.pod:5118
15270 #: ../fish/guestfish-actions.pod:5120 ../src/guestfs-actions.pod:7769
15271 msgid "This command writes zeroes over the first few blocks of C<device>."
15275 #: ../fish/guestfish-actions.pod:5122 ../src/guestfs-actions.pod:7771
15277 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15278 "securely wipe the device). It should be sufficient to remove any partition "
15279 "tables, filesystem superblocks and so on."
15283 #: ../fish/guestfish-actions.pod:5126 ../fish/guestfish-actions.pod:5141
15284 #: ../src/guestfs-actions.pod:7775 ../src/guestfs-actions.pod:7801
15286 "If blocks are already zero, then this command avoids writing zeroes. This "
15287 "prevents the underlying device from becoming non-sparse or growing "
15292 #: ../fish/guestfish-actions.pod:5130
15293 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
15297 #: ../fish/guestfish-actions.pod:5133
15298 msgid "zero-device"
15302 #: ../fish/guestfish-actions.pod:5135
15305 " zero-device device\n"
15310 #: ../fish/guestfish-actions.pod:5137
15312 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
15313 "which just zeroes the first few blocks of a device."
15317 #: ../fish/guestfish-actions.pod:5148
15322 #: ../fish/guestfish-actions.pod:5150
15325 " zerofree device\n"
15330 #: ../fish/guestfish-actions.pod:5152 ../src/guestfs-actions.pod:7823
15332 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15333 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15334 "possible to compress the filesystem more effectively."
15338 #: ../fish/guestfish-actions.pod:5157 ../src/guestfs-actions.pod:7828
15339 msgid "You should B<not> run this program if the filesystem is mounted."
15343 #: ../fish/guestfish-actions.pod:5160 ../src/guestfs-actions.pod:7831
15345 "It is possible that using this program can damage the filesystem or data on "
15350 #: ../fish/guestfish-actions.pod:5163
15355 #: ../fish/guestfish-actions.pod:5165
15358 " zfgrep pattern path\n"
15363 #: ../fish/guestfish-actions.pod:5167 ../src/guestfs-actions.pod:7845
15365 "This calls the external C<zfgrep> program and returns the matching lines."
15369 #: ../fish/guestfish-actions.pod:5173
15374 #: ../fish/guestfish-actions.pod:5175
15377 " zfgrepi pattern path\n"
15382 #: ../fish/guestfish-actions.pod:5177 ../src/guestfs-actions.pod:7864
15384 "This calls the external C<zfgrep -i> program and returns the matching lines."
15388 #: ../fish/guestfish-actions.pod:5183
15393 #: ../fish/guestfish-actions.pod:5185
15396 " zfile meth path\n"
15401 #: ../fish/guestfish-actions.pod:5187 ../src/guestfs-actions.pod:7890
15403 "This command runs C<file> after first decompressing C<path> using C<method>."
15407 #: ../fish/guestfish-actions.pod:5190 ../src/guestfs-actions.pod:7893
15408 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15412 #: ../fish/guestfish-actions.pod:5192
15414 "Since 1.0.63, use L</file> instead which can now process compressed files."
15418 #: ../fish/guestfish-actions.pod:5195
15420 "I<This function is deprecated.> In new code, use the L</file> call instead."
15424 #: ../fish/guestfish-actions.pod:5202
15429 #: ../fish/guestfish-actions.pod:5204
15432 " zgrep regex path\n"
15437 #: ../fish/guestfish-actions.pod:5206 ../src/guestfs-actions.pod:7910
15439 "This calls the external C<zgrep> program and returns the matching lines."
15443 #: ../fish/guestfish-actions.pod:5212
15448 #: ../fish/guestfish-actions.pod:5214
15451 " zgrepi regex path\n"
15456 #: ../fish/guestfish-actions.pod:5216 ../src/guestfs-actions.pod:7929
15458 "This calls the external C<zgrep -i> program and returns the matching lines."
15462 #: ../fish/guestfish-commands.pod:1
15467 #: ../fish/guestfish-commands.pod:3
15472 #: ../fish/guestfish-commands.pod:5
15475 " alloc filename size\n"
15480 #: ../fish/guestfish-commands.pod:7
15482 "This creates an empty (zeroed) file of the given size, and then adds so it "
15483 "can be further examined."
15487 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:193
15488 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
15492 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:195
15493 msgid "Size can be specified using standard suffixes, eg. C<1M>."
15497 #: ../fish/guestfish-commands.pod:14
15499 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
15500 "image, see L</PREPARED DISK IMAGES>."
15504 #: ../fish/guestfish-commands.pod:17
15509 #: ../fish/guestfish-commands.pod:19
15512 " copy-in local [local ...] /remotedir\n"
15517 #: ../fish/guestfish-commands.pod:21
15519 "C<copy-in> copies local files or directories recursively into the disk "
15520 "image, placing them in the directory called C</remotedir> (which must "
15521 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
15522 "other commands as necessary."
15526 #: ../fish/guestfish-commands.pod:26
15528 "Multiple local files and directories can be specified, but the last "
15529 "parameter must always be a remote directory. Wildcards cannot be used."
15533 #: ../fish/guestfish-commands.pod:30
15538 #: ../fish/guestfish-commands.pod:32
15541 " copy-out remote [remote ...] localdir\n"
15546 #: ../fish/guestfish-commands.pod:34
15548 "C<copy-out> copies remote files or directories recursively out of the disk "
15549 "image, placing them on the host disk in a local directory called C<localdir> "
15550 "(which must exist). This guestfish meta-command turns into a sequence of L</"
15551 "download>, L</tar-out> and other commands as necessary."
15555 #: ../fish/guestfish-commands.pod:40
15557 "Multiple remote files and directories can be specified, but the last "
15558 "parameter must always be a local directory. To download to the current "
15559 "directory, use C<.> as in:"
15563 #: ../fish/guestfish-commands.pod:44
15566 " copy-out /home .\n"
15571 #: ../fish/guestfish-commands.pod:46
15573 "Wildcards cannot be used in the ordinary command, but you can use them with "
15574 "the help of L</glob> like this:"
15578 #: ../fish/guestfish-commands.pod:49
15581 " glob copy-out /home/* .\n"
15586 #: ../fish/guestfish-commands.pod:51
15591 #: ../fish/guestfish-commands.pod:53
15594 " display filename\n"
15599 #: ../fish/guestfish-commands.pod:55
15601 "Use C<display> (a graphical display program) to display an image file. It "
15602 "downloads the file, and runs C<display> on it."
15606 #: ../fish/guestfish-commands.pod:58
15608 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
15609 "environment variable. For example to use the GNOME display program:"
15613 #: ../fish/guestfish-commands.pod:61
15616 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
15621 #: ../fish/guestfish-commands.pod:63
15622 msgid "See also L<display(1)>."
15626 #: ../fish/guestfish-commands.pod:65
15631 #: ../fish/guestfish-commands.pod:67
15634 " echo [params ...]\n"
15639 #: ../fish/guestfish-commands.pod:69
15640 msgid "This echos the parameters to the terminal."
15644 #: ../fish/guestfish-commands.pod:71
15649 #: ../fish/guestfish-commands.pod:73
15654 #: ../fish/guestfish-commands.pod:75
15659 #: ../fish/guestfish-commands.pod:77
15667 #: ../fish/guestfish-commands.pod:79
15669 "This is used to edit a file. It downloads the file, edits it locally using "
15670 "your editor, then uploads the result."
15674 #: ../fish/guestfish-commands.pod:82
15676 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
15677 "or C<emacs> you will get those corresponding editors."
15681 #: ../fish/guestfish-commands.pod:86
15686 #: ../fish/guestfish-commands.pod:88
15689 " glob command args...\n"
15694 #: ../fish/guestfish-commands.pod:90
15696 "Expand wildcards in any paths in the args list, and run C<command> "
15697 "repeatedly on each matching path."
15701 #: ../fish/guestfish-commands.pod:93
15702 msgid "See L</WILDCARDS AND GLOBBING>."
15706 #: ../fish/guestfish-commands.pod:95
15711 #: ../fish/guestfish-commands.pod:97
15714 " hexedit <filename|device>\n"
15715 " hexedit <filename|device> <max>\n"
15716 " hexedit <filename|device> <start> <max>\n"
15721 #: ../fish/guestfish-commands.pod:101
15723 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
15728 #: ../fish/guestfish-commands.pod:104
15730 "This command works by downloading potentially the whole file or device, "
15731 "editing it locally, then uploading it. If the file or device is large, you "
15732 "have to specify which part you wish to edit by using C<max> and/or C<start> "
15733 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
15734 "usual modifiers allowed such as C<1M> (1 megabyte)."
15738 #: ../fish/guestfish-commands.pod:111
15739 msgid "For example to edit the first few sectors of a disk you might do:"
15743 #: ../fish/guestfish-commands.pod:114
15746 " hexedit /dev/sda 1M\n"
15751 #: ../fish/guestfish-commands.pod:116
15753 "which would allow you to edit anywhere within the first megabyte of the disk."
15757 #: ../fish/guestfish-commands.pod:119
15758 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
15762 #: ../fish/guestfish-commands.pod:121
15765 " hexedit /dev/sda1 0x400 0x400\n"
15770 #: ../fish/guestfish-commands.pod:123
15771 msgid "(assuming the superblock is in the standard location)."
15775 #: ../fish/guestfish-commands.pod:125
15777 "This command requires the external L<hexedit(1)> program. You can specify "
15778 "another program to use by setting the C<HEXEDITOR> environment variable."
15782 #: ../fish/guestfish-commands.pod:129
15783 msgid "See also L</hexdump>."
15787 #: ../fish/guestfish-commands.pod:131
15792 #: ../fish/guestfish-commands.pod:133
15800 #: ../fish/guestfish-commands.pod:135
15802 "Change the local directory, ie. the current directory of guestfish itself."
15806 #: ../fish/guestfish-commands.pod:138
15807 msgid "Note that C<!cd> won't do what you might expect."
15811 #: ../fish/guestfish-commands.pod:140
15816 #: ../fish/guestfish-commands.pod:142
15821 #: ../fish/guestfish-commands.pod:144
15829 #: ../fish/guestfish-commands.pod:146
15830 msgid "Opens the manual page for guestfish."
15834 #: ../fish/guestfish-commands.pod:148
15839 #: ../fish/guestfish-commands.pod:150
15844 #: ../fish/guestfish-commands.pod:152
15852 #: ../fish/guestfish-commands.pod:154
15860 #: ../fish/guestfish-commands.pod:156
15861 msgid "This is used to view a file."
15865 #: ../fish/guestfish-commands.pod:158
15867 "The default viewer is C<$PAGER>. However if you use the alternate command "
15868 "C<less> you will get the C<less> command specifically."
15872 #: ../fish/guestfish-commands.pod:161
15877 #: ../fish/guestfish-commands.pod:163
15885 #: ../fish/guestfish-commands.pod:165
15887 "Close and reopen the libguestfs handle. It is not necessary to use this "
15888 "normally, because the handle is closed properly when guestfish exits. "
15889 "However this is occasionally useful for testing."
15893 #: ../fish/guestfish-commands.pod:169
15898 #: ../fish/guestfish-commands.pod:171
15901 " setenv VAR value\n"
15906 #: ../fish/guestfish-commands.pod:173
15907 msgid "Set the environment variable C<VAR> to the string C<value>."
15911 #: ../fish/guestfish-commands.pod:175
15913 "To print the value of an environment variable use a shell command such as:"
15917 #: ../fish/guestfish-commands.pod:178
15925 #: ../fish/guestfish-commands.pod:180
15930 #: ../fish/guestfish-commands.pod:182
15933 " sparse filename size\n"
15938 #: ../fish/guestfish-commands.pod:184
15940 "This creates an empty sparse file of the given size, and then adds so it can "
15941 "be further examined."
15945 #: ../fish/guestfish-commands.pod:187
15947 "In all respects it works the same as the L</alloc> command, except that the "
15948 "image file is allocated sparsely, which means that disk blocks are not "
15949 "assigned to the file until they are needed. Sparse disk files only use "
15950 "space when written to, but they are slower and there is a danger you could "
15951 "run out of real disk space during a write operation."
15955 #: ../fish/guestfish-commands.pod:197
15960 #: ../fish/guestfish-commands.pod:199
15968 #: ../fish/guestfish-commands.pod:201
15970 "This command returns a list of the optional groups known to the daemon, and "
15971 "indicates which ones are supported by this build of the libguestfs appliance."
15975 #: ../fish/guestfish-commands.pod:205
15976 msgid "See also L<guestfs(3)/AVAILABILITY>."
15980 #: ../fish/guestfish-commands.pod:207
15985 #: ../fish/guestfish-commands.pod:209
15988 " time command args...\n"
15993 #: ../fish/guestfish-commands.pod:211
15995 "Run the command as usual, but print the elapsed time afterwards. This can "
15996 "be useful for benchmarking operations."
16000 #: ../fish/guestfish-commands.pod:214
16005 #: ../fish/guestfish-commands.pod:216
16013 #: ../fish/guestfish-commands.pod:218
16014 msgid "Remove C<VAR> from the environment."
16018 #: ../fish/guestfish.pod:5
16019 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16023 #: ../fish/guestfish.pod:9
16026 " guestfish [--options] [commands]\n"
16031 #: ../fish/guestfish.pod:11
16039 #: ../fish/guestfish.pod:13
16042 " guestfish [--ro|--rw] -a disk.img\n"
16047 #: ../fish/guestfish.pod:15
16050 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16055 #: ../fish/guestfish.pod:17
16058 " guestfish -d libvirt-domain\n"
16063 #: ../fish/guestfish.pod:19
16066 " guestfish [--ro|--rw] -a disk.img -i\n"
16071 #: ../fish/guestfish.pod:21
16074 " guestfish -d libvirt-domain -i\n"
16079 #: ../fish/guestfish.pod:25
16081 "Using guestfish in read/write mode on live virtual machines can be "
16082 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16083 "option to use guestfish safely if the disk image or virtual machine might be "
16088 #: ../fish/guestfish.pod:32
16090 "Guestfish is a shell and command-line tool for examining and modifying "
16091 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16092 "functionality of the guestfs API, see L<guestfs(3)>."
16096 #: ../fish/guestfish.pod:36
16098 "Guestfish gives you structured access to the libguestfs API, from shell "
16099 "scripts or the command line or interactively. If you want to rescue a "
16100 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16105 #: ../fish/guestfish.pod:43
16106 msgid "As an interactive shell"
16110 #: ../fish/guestfish.pod:45
16118 #: ../fish/guestfish.pod:47
16121 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16122 " editing virtual machine filesystems.\n"
16127 #: ../fish/guestfish.pod:50
16130 " Type: 'help' for a list of commands\n"
16131 " 'man' to read the manual\n"
16132 " 'quit' to quit the shell\n"
16137 #: ../fish/guestfish.pod:54
16140 " ><fs> add-ro disk.img\n"
16142 " ><fs> list-filesystems\n"
16143 " /dev/sda1: ext4\n"
16144 " /dev/vg_guest/lv_root: ext4\n"
16145 " /dev/vg_guest/lv_swap: swap\n"
16146 " ><fs> mount /dev/vg_guest/lv_root /\n"
16147 " ><fs> cat /etc/fstab\n"
16149 " # Created by anaconda\n"
16156 #: ../fish/guestfish.pod:67
16157 msgid "From shell scripts"
16161 #: ../fish/guestfish.pod:69
16162 msgid "Create a new C</etc/motd> file in a guest or disk image:"
16166 #: ../fish/guestfish.pod:71
16169 " guestfish <<_EOF_\n"
16172 " mount /dev/vg_guest/lv_root /\n"
16173 " write /etc/motd \"Welcome, new users\"\n"
16179 #: ../fish/guestfish.pod:78
16180 msgid "List the LVM logical volumes in a disk image:"
16184 #: ../fish/guestfish.pod:80
16187 " guestfish -a disk.img --ro <<_EOF_\n"
16195 #: ../fish/guestfish.pod:85
16196 msgid "List all the filesystems in a disk image:"
16200 #: ../fish/guestfish.pod:87
16203 " guestfish -a disk.img --ro <<_EOF_\n"
16205 " list-filesystems\n"
16211 #: ../fish/guestfish.pod:92
16212 msgid "On one command line"
16216 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
16217 msgid "Update C</etc/resolv.conf> in a guest:"
16221 #: ../fish/guestfish.pod:96
16225 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16226 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16231 #: ../fish/guestfish.pod:100
16232 msgid "Edit C</boot/grub/grub.conf> interactively:"
16236 #: ../fish/guestfish.pod:102
16239 " guestfish --rw --add disk.img \\\n"
16240 " --mount /dev/vg_guest/lv_root \\\n"
16241 " --mount /dev/sda1:/boot \\\n"
16242 " edit /boot/grub/grub.conf\n"
16247 #: ../fish/guestfish.pod:107
16248 msgid "Mount disks automatically"
16252 #: ../fish/guestfish.pod:109
16254 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
16258 #: ../fish/guestfish.pod:112
16261 " guestfish --ro -a disk.img -i cat /etc/group\n"
16266 #: ../fish/guestfish.pod:114
16269 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16274 #: ../fish/guestfish.pod:116
16275 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16279 #: ../fish/guestfish.pod:118
16282 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16287 #: ../fish/guestfish.pod:120
16288 msgid "As a script interpreter"
16292 #: ../fish/guestfish.pod:122
16293 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16297 #: ../fish/guestfish.pod:124
16300 " #!/usr/bin/guestfish -f\n"
16301 " sparse test1.img 100M\n"
16303 " part-disk /dev/sda mbr\n"
16304 " mkfs ext2 /dev/sda1\n"
16309 #: ../fish/guestfish.pod:130
16310 msgid "Start with a prepared disk"
16314 #: ../fish/guestfish.pod:132
16316 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16317 "single ext2-formatted partition:"
16321 #: ../fish/guestfish.pod:135
16324 " guestfish -N fs\n"
16329 #: ../fish/guestfish.pod:137
16330 msgid "To list what is available do:"
16334 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1009
16337 " guestfish -N help | less\n"
16342 #: ../fish/guestfish.pod:141
16343 msgid "Remote control"
16347 #: ../fish/guestfish.pod:143
16350 " eval \"`guestfish --listen`\"\n"
16351 " guestfish --remote add-ro disk.img\n"
16352 " guestfish --remote run\n"
16353 " guestfish --remote lvs\n"
16358 #: ../fish/guestfish.pod:154
16359 msgid "Displays general help on options."
16363 #: ../fish/guestfish.pod:158
16364 msgid "B<--cmd-help>"
16368 #: ../fish/guestfish.pod:160
16369 msgid "Lists all available guestfish commands."
16373 #: ../fish/guestfish.pod:162
16378 #: ../fish/guestfish.pod:164
16379 msgid "B<--cmd-help cmd>"
16383 #: ../fish/guestfish.pod:166
16384 msgid "Displays detailed help on a single command C<cmd>."
16388 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:87
16389 msgid "B<-a image>"
16393 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:89
16394 msgid "B<--add image>"
16398 #: ../fish/guestfish.pod:172
16399 msgid "Add a block device or virtual machine image to the shell."
16403 #: ../fish/guestfish.pod:177
16405 "Using this flag is mostly equivalent to using the C<add> command, with "
16406 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
16407 "the I<--format=...> flag was given."
16411 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:100
16413 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16414 "URI to use. The default is to use the default libvirt connection."
16418 #: ../fish/guestfish.pod:189
16423 #: ../fish/guestfish.pod:191
16425 "If using the I<--listen> option and a csh-like shell, use this option. See "
16426 "section L</REMOTE CONTROL AND CSH> below."
16430 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:104
16431 msgid "B<-d libvirt-domain>"
16435 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:106
16436 msgid "B<--domain libvirt-domain>"
16440 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:108
16442 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16443 "used, then any libvirt domain can be used. However in write mode, only "
16444 "libvirt domains which are shut down can be named here."
16448 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:112
16449 msgid "Domain UUIDs can be used instead of names."
16453 #: ../fish/guestfish.pod:204
16455 "Using this flag is mostly equivalent to using the C<add-domain> command, "
16456 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
16457 "if the I<--format:...> flag was given."
16461 #: ../fish/guestfish.pod:208
16466 #: ../fish/guestfish.pod:210
16467 msgid "B<--no-dest-paths>"
16471 #: ../fish/guestfish.pod:212
16473 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16474 "to hit the tab key to complete paths on the guest filesystem, but this "
16475 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16476 "allow this feature to be disabled."
16480 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:128
16482 "When prompting for keys and passphrases, guestfish normally turns echoing "
16483 "off so you cannot see what you are typing. If you are not worried about "
16484 "Tempest attacks and there is no one else in the room you can specify this "
16485 "flag to see what you are typing."
16489 #: ../fish/guestfish.pod:224
16494 #: ../fish/guestfish.pod:226
16495 msgid "B<--file file>"
16499 #: ../fish/guestfish.pod:228
16500 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16504 #: ../fish/guestfish.pod:231
16507 " #!/usr/bin/guestfish -f\n"
16512 #: ../fish/guestfish.pod:244
16515 " guestfish --format=raw -a disk.img\n"
16520 #: ../fish/guestfish.pod:248
16523 " guestfish --format=raw -a disk.img --format -a another.img\n"
16528 #: ../fish/guestfish.pod:253
16530 "If you have untrusted raw-format guest disk images, you should use this "
16531 "option to specify the disk format. This avoids a possible security problem "
16532 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16536 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:157
16537 msgid "B<--inspector>"
16541 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:159
16543 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16544 "system and mount filesystems as they would be mounted on the real virtual "
16549 #: ../fish/guestfish.pod:266
16550 msgid "Typical usage is either:"
16554 #: ../fish/guestfish.pod:268
16557 " guestfish -d myguest -i\n"
16562 #: ../fish/guestfish.pod:270
16563 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16567 #: ../fish/guestfish.pod:272
16570 " guestfish --ro -d myguest -i\n"
16575 #: ../fish/guestfish.pod:274
16576 msgid "(for active domains, readonly), or specify the block device directly:"
16580 #: ../fish/guestfish.pod:276
16583 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16588 #: ../fish/guestfish.pod:278
16590 "Note that the command line syntax changed slightly over older versions of "
16591 "guestfish. You can still use the old syntax:"
16595 #: ../fish/guestfish.pod:281
16598 " guestfish [--ro] -i disk.img\n"
16603 #: ../fish/guestfish.pod:283
16606 " guestfish [--ro] -i libvirt-domain\n"
16611 #: ../fish/guestfish.pod:285
16613 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
16614 "then using other commands to mount the filesystems that were found."
16618 #: ../fish/guestfish.pod:294
16619 msgid "B<--listen>"
16623 #: ../fish/guestfish.pod:296
16625 "Fork into the background and listen for remote commands. See section L</"
16626 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16630 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:168
16635 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:170
16637 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
16638 "ATTACHING TO RUNNING DAEMONS>)."
16642 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:173
16643 msgid "B<-m dev[:mountpoint[:options]]>"
16647 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:175
16648 msgid "B<--mount dev[:mountpoint[:options]]>"
16652 #: ../fish/guestfish.pod:308
16653 msgid "Mount the named partition or logical volume on the given mountpoint."
16657 #: ../fish/guestfish.pod:310
16658 msgid "If the mountpoint is omitted, it defaults to C</>."
16662 #: ../fish/guestfish.pod:312
16663 msgid "You have to mount something on C</> before most commands will work."
16667 #: ../fish/guestfish.pod:314
16669 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16674 #: ../fish/guestfish.pod:317
16676 "If you don't know what filesystems a disk image contains, you can either run "
16677 "guestfish without this option, then list the partitions, filesystems and LVs "
16678 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
16679 "commands), or you can use the L<virt-filesystems(1)> program."
16683 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:183
16685 "The third (and rarely used) part of the mount parameter is the list of mount "
16686 "options used to mount the underlying filesystem. If this is not given, then "
16687 "the mount options are either the empty string or C<ro> (the latter if the "
16688 "I<--ro> flag is used). By specifying the mount options, you override this "
16689 "default choice. Probably the only time you would use this is to enable ACLs "
16690 "and/or extended attributes if the filesystem can support them:"
16694 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:191
16697 " -m /dev/sda1:/:acl,user_xattr\n"
16702 #: ../fish/guestfish.pod:333
16703 msgid "Using this flag is equivalent to using the C<mount-options> command."
16707 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:193
16708 #: ../resize/virt-resize.pod:358
16713 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:195
16714 msgid "B<--no-sync>"
16718 #: ../fish/guestfish.pod:339
16720 "Disable autosync. This is enabled by default. See the discussion of "
16721 "autosync in the L<guestfs(3)> manpage."
16725 #: ../fish/guestfish.pod:342
16730 #: ../fish/guestfish.pod:344
16731 msgid "B<--new type>"
16735 #: ../fish/guestfish.pod:346
16740 #: ../fish/guestfish.pod:348
16742 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16743 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16744 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16749 #: ../fish/guestfish.pod:353
16750 msgid "B<--progress-bars>"
16754 #: ../fish/guestfish.pod:355
16755 msgid "Enable progress bars, even when guestfish is used non-interactively."
16759 #: ../fish/guestfish.pod:357
16761 "Progress bars are enabled by default when guestfish is used as an "
16762 "interactive shell."
16766 #: ../fish/guestfish.pod:360
16767 msgid "B<--no-progress-bars>"
16771 #: ../fish/guestfish.pod:362
16772 msgid "Disable progress bars."
16776 #: ../fish/guestfish.pod:364
16777 msgid "B<--remote[=pid]>"
16781 #: ../fish/guestfish.pod:366
16783 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16784 "CONTROL GUESTFISH OVER A SOCKET> below."
16788 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:239
16789 #: ../rescue/virt-rescue.pod:161
16794 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:241
16795 #: ../rescue/virt-rescue.pod:163
16800 #: ../fish/guestfish.pod:373
16802 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16803 "mounts are done read-only."
16807 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
16809 "The option must always be used if the disk image or virtual machine might be "
16810 "running, and is generally recommended in cases where you don't need write "
16811 "access to the disk."
16815 #: ../fish/guestfish.pod:380
16817 "Note that prepared disk images created with I<-N> are not affected by this "
16818 "option. Also commands like C<add> are not affected - you have to specify "
16819 "the C<readonly:true> option explicitly if you need it."
16823 #: ../fish/guestfish.pod:384
16824 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
16828 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:253
16829 #: ../rescue/virt-rescue.pod:173
16830 msgid "B<--selinux>"
16834 #: ../fish/guestfish.pod:388
16835 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16839 #: ../fish/guestfish.pod:394
16841 "Enable very verbose messages. This is particularly useful if you find a bug."
16845 #: ../fish/guestfish.pod:401
16846 msgid "Display the guestfish / libguestfs version number and exit."
16850 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:269
16851 #: ../rescue/virt-rescue.pod:190
16856 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:271
16857 #: ../rescue/virt-rescue.pod:192
16862 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:273
16864 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16865 "mounts are done read-write."
16869 #: ../fish/guestfish.pod:410
16870 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
16874 #: ../fish/guestfish.pod:414
16875 msgid "Echo each command before executing it."
16879 #: ../fish/guestfish.pod:418
16880 msgid "COMMANDS ON COMMAND LINE"
16884 #: ../fish/guestfish.pod:420
16886 "Any additional (non-option) arguments are treated as commands to execute."
16890 #: ../fish/guestfish.pod:423
16892 "Commands to execute should be separated by a colon (C<:>), where the colon "
16893 "is a separate parameter. Thus:"
16897 #: ../fish/guestfish.pod:426
16900 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16905 #: ../fish/guestfish.pod:428
16907 "If there are no additional arguments, then we enter a shell, either an "
16908 "interactive shell with a prompt (if the input is a terminal) or a non-"
16909 "interactive shell."
16913 #: ../fish/guestfish.pod:432
16915 "In either command line mode or non-interactive shell, the first command that "
16916 "gives an error causes the whole shell to exit. In interactive mode (with a "
16917 "prompt) if a command fails, you can continue to enter commands."
16921 #: ../fish/guestfish.pod:437
16922 msgid "USING launch (OR run)"
16926 #: ../fish/guestfish.pod:439
16928 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16929 "then launch it, then mount any disks you need, and finally issue actions/"
16930 "commands. So the general order of the day is:"
16934 #: ../fish/guestfish.pod:447
16935 msgid "add or -a/--add"
16939 #: ../fish/guestfish.pod:451
16940 msgid "launch (aka run)"
16944 #: ../fish/guestfish.pod:455
16945 msgid "mount or -m/--mount"
16949 #: ../fish/guestfish.pod:459
16950 msgid "any other commands"
16954 #: ../fish/guestfish.pod:463
16956 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16957 "guest before mounting or performing any other commands."
16961 #: ../fish/guestfish.pod:466
16963 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16964 "I<--new> options were given then C<run> is done automatically, simply "
16965 "because guestfish can't perform the action you asked for without doing this."
16969 #: ../fish/guestfish.pod:471
16970 msgid "OPENING DISKS FOR READ AND WRITE"
16974 #: ../fish/guestfish.pod:473
16976 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
16977 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
16978 "I<-i> and I<-m> open disk images read-only or for writing."
16982 #: ../fish/guestfish.pod:478
16984 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
16985 "opening disk images supplied on the command line for write. To open a disk "
16986 "image read-only you have to do I<-a image --ro>."
16990 #: ../fish/guestfish.pod:482
16992 "This matters: If you accidentally open a live VM disk image writable then "
16993 "you will cause irreversible disk corruption."
16997 #: ../fish/guestfish.pod:485
16999 "In a future libguestfs we intend to change the default the other way. Disk "
17000 "images will be opened read-only. You will have to either specify "
17001 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
17002 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
17003 "access for disk images specified by those other command line options."
17007 #: ../fish/guestfish.pod:492
17009 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
17010 "which does nothing (it is already the default). However it is highly "
17011 "recommended that you use this option to indicate that you need write access, "
17012 "and prepare your scripts for the day when this option will be required for "
17017 #: ../fish/guestfish.pod:498
17019 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17020 "other libguestfs program apart from guestfish and guestmount."
17024 #: ../fish/guestfish.pod:501
17029 #: ../fish/guestfish.pod:503
17031 "You can quote ordinary parameters using either single or double quotes. For "
17036 #: ../fish/guestfish.pod:506
17039 " add \"file with a space.img\"\n"
17044 #: ../fish/guestfish.pod:508
17047 " rm '/file name'\n"
17052 #: ../fish/guestfish.pod:510
17060 #: ../fish/guestfish.pod:512
17062 "A few commands require a list of strings to be passed. For these, use a "
17063 "whitespace-separated list, enclosed in quotes. Strings containing "
17064 "whitespace to be passed through must be enclosed in single quotes. A "
17065 "literal single quote must be escaped with a backslash."
17069 #: ../fish/guestfish.pod:517
17072 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17073 " command \"/bin/echo 'foo bar'\"\n"
17074 " command \"/bin/echo \\'foo\\'\"\n"
17079 #: ../fish/guestfish.pod:521
17080 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
17084 #: ../fish/guestfish.pod:523
17086 "In double-quoted arguments (only) use backslash to insert special characters:"
17090 #: ../fish/guestfish.pod:528
17095 #: ../fish/guestfish.pod:530
17096 msgid "Alert (bell) character."
17100 #: ../fish/guestfish.pod:532
17105 #: ../fish/guestfish.pod:534
17106 msgid "Backspace character."
17110 #: ../fish/guestfish.pod:536
17115 #: ../fish/guestfish.pod:538
17116 msgid "Form feed character."
17120 #: ../fish/guestfish.pod:540
17125 #: ../fish/guestfish.pod:542
17126 msgid "Newline character."
17130 #: ../fish/guestfish.pod:544
17135 #: ../fish/guestfish.pod:546
17136 msgid "Carriage return character."
17140 #: ../fish/guestfish.pod:548
17145 #: ../fish/guestfish.pod:550
17146 msgid "Horizontal tab character."
17150 #: ../fish/guestfish.pod:552
17155 #: ../fish/guestfish.pod:554
17156 msgid "Vertical tab character."
17160 #: ../fish/guestfish.pod:556
17165 #: ../fish/guestfish.pod:558
17166 msgid "A literal double quote character."
17170 #: ../fish/guestfish.pod:560
17175 #: ../fish/guestfish.pod:562
17177 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
17182 #: ../fish/guestfish.pod:565
17187 #: ../fish/guestfish.pod:567
17189 "A character with hex value I<hh>. There must be precisely 2 hex digits."
17193 #: ../fish/guestfish.pod:570
17195 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
17200 #: ../fish/guestfish.pod:573
17205 #: ../fish/guestfish.pod:575
17206 msgid "A literal backslash character."
17210 #: ../fish/guestfish.pod:579
17211 msgid "OPTIONAL ARGUMENTS"
17215 #: ../fish/guestfish.pod:581
17217 "Some commands take optional arguments. These arguments appear in this "
17218 "documentation as C<[argname:..]>. You can use them as in these examples:"
17222 #: ../fish/guestfish.pod:585
17225 " add-drive-opts filename\n"
17230 #: ../fish/guestfish.pod:587
17233 " add-drive-opts filename readonly:true\n"
17238 #: ../fish/guestfish.pod:589
17241 " add-drive-opts filename format:qcow2 readonly:false\n"
17246 #: ../fish/guestfish.pod:591
17248 "Each optional argument can appear at most once. All optional arguments must "
17249 "appear after the required ones."
17253 #: ../fish/guestfish.pod:594
17258 #: ../fish/guestfish.pod:596
17260 "This section applies to all commands which can take integers as parameters."
17264 #: ../fish/guestfish.pod:599
17265 msgid "SIZE SUFFIX"
17269 #: ../fish/guestfish.pod:601
17271 "When the command takes a parameter measured in bytes, you can use one of the "
17272 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17276 #: ../fish/guestfish.pod:607
17277 msgid "B<k> or B<K> or B<KiB>"
17281 #: ../fish/guestfish.pod:609
17282 msgid "The size in kilobytes (multiplied by 1024)."
17286 #: ../fish/guestfish.pod:611
17291 #: ../fish/guestfish.pod:613
17292 msgid "The size in SI 1000 byte units."
17296 #: ../fish/guestfish.pod:615
17297 msgid "B<M> or B<MiB>"
17301 #: ../fish/guestfish.pod:617
17302 msgid "The size in megabytes (multiplied by 1048576)."
17306 #: ../fish/guestfish.pod:619
17311 #: ../fish/guestfish.pod:621
17312 msgid "The size in SI 1000000 byte units."
17316 #: ../fish/guestfish.pod:623
17317 msgid "B<G> or B<GiB>"
17321 #: ../fish/guestfish.pod:625
17322 msgid "The size in gigabytes (multiplied by 2**30)."
17326 #: ../fish/guestfish.pod:627
17331 #: ../fish/guestfish.pod:629
17332 msgid "The size in SI 10**9 byte units."
17336 #: ../fish/guestfish.pod:631
17337 msgid "B<T> or B<TiB>"
17341 #: ../fish/guestfish.pod:633
17342 msgid "The size in terabytes (multiplied by 2**40)."
17346 #: ../fish/guestfish.pod:635
17351 #: ../fish/guestfish.pod:637
17352 msgid "The size in SI 10**12 byte units."
17356 #: ../fish/guestfish.pod:639
17357 msgid "B<P> or B<PiB>"
17361 #: ../fish/guestfish.pod:641
17362 msgid "The size in petabytes (multiplied by 2**50)."
17366 #: ../fish/guestfish.pod:643
17371 #: ../fish/guestfish.pod:645
17372 msgid "The size in SI 10**15 byte units."
17376 #: ../fish/guestfish.pod:647
17377 msgid "B<E> or B<EiB>"
17381 #: ../fish/guestfish.pod:649
17382 msgid "The size in exabytes (multiplied by 2**60)."
17386 #: ../fish/guestfish.pod:651
17391 #: ../fish/guestfish.pod:653
17392 msgid "The size in SI 10**18 byte units."
17396 #: ../fish/guestfish.pod:655
17397 msgid "B<Z> or B<ZiB>"
17401 #: ../fish/guestfish.pod:657
17402 msgid "The size in zettabytes (multiplied by 2**70)."
17406 #: ../fish/guestfish.pod:659
17411 #: ../fish/guestfish.pod:661
17412 msgid "The size in SI 10**21 byte units."
17416 #: ../fish/guestfish.pod:663
17417 msgid "B<Y> or B<YiB>"
17421 #: ../fish/guestfish.pod:665
17422 msgid "The size in yottabytes (multiplied by 2**80)."
17426 #: ../fish/guestfish.pod:667
17431 #: ../fish/guestfish.pod:669
17432 msgid "The size in SI 10**24 byte units."
17436 #: ../fish/guestfish.pod:675
17439 " truncate-size /file 1G\n"
17444 #: ../fish/guestfish.pod:677
17445 msgid "would truncate the file to 1 gigabyte."
17449 #: ../fish/guestfish.pod:679
17451 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
17452 "the parameter to L</memsize> is specified in megabytes already). Adding a "
17453 "suffix will probably not do what you expect."
17457 #: ../fish/guestfish.pod:683
17458 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17462 #: ../fish/guestfish.pod:685
17464 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17465 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17469 #: ../fish/guestfish.pod:688
17472 " 1234 decimal number 1234\n"
17473 " 02322 octal number, equivalent to decimal 1234\n"
17474 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17479 #: ../fish/guestfish.pod:692
17481 "When using the C<chmod> command, you almost always want to specify an octal "
17482 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17483 "L<chmod(1)> program):"
17487 #: ../fish/guestfish.pod:696
17490 " chmod 0777 /public # OK\n"
17491 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17496 #: ../fish/guestfish.pod:699
17498 "Commands that return numbers usually print them in decimal, but some "
17499 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17500 "octal, preceeded by C<0>)."
17504 #: ../fish/guestfish.pod:703
17505 msgid "WILDCARDS AND GLOBBING"
17509 #: ../fish/guestfish.pod:705
17511 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17512 "(globbing) by default. So for example the following will not do what you "
17517 #: ../fish/guestfish.pod:709
17525 #: ../fish/guestfish.pod:711
17527 "Assuming you don't have a directory called literally C</home/*> then the "
17528 "above command will return an error."
17532 #: ../fish/guestfish.pod:714
17533 msgid "To perform wildcard expansion, use the C<glob> command."
17537 #: ../fish/guestfish.pod:716
17540 " glob rm-rf /home/*\n"
17545 #: ../fish/guestfish.pod:718
17547 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17548 "many times), equivalent to:"
17552 #: ../fish/guestfish.pod:721
17555 " rm-rf /home/jim\n"
17556 " rm-rf /home/joe\n"
17557 " rm-rf /home/mary\n"
17562 #: ../fish/guestfish.pod:725
17563 msgid "C<glob> only works on simple guest paths and not on device names."
17567 #: ../fish/guestfish.pod:727
17569 "If you have several parameters, each containing a wildcard, then glob will "
17570 "perform a Cartesian product."
17574 #: ../fish/guestfish.pod:730
17579 #: ../fish/guestfish.pod:732
17581 "Any line which starts with a I<#> character is treated as a comment and "
17582 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17583 "a command. For example:"
17587 #: ../fish/guestfish.pod:736
17590 " # this is a comment\n"
17591 " # this is a comment\n"
17592 " foo # NOT a comment\n"
17597 #: ../fish/guestfish.pod:740
17598 msgid "Blank lines are also ignored."
17602 #: ../fish/guestfish.pod:742
17603 msgid "RUNNING COMMANDS LOCALLY"
17607 #: ../fish/guestfish.pod:744
17609 "Any line which starts with a I<!> character is treated as a command sent to "
17610 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17614 #: ../fish/guestfish.pod:748
17618 " tgz-out /remote local/remote-data.tar.gz\n"
17623 #: ../fish/guestfish.pod:751
17625 "will create a directory C<local> on the host, and then export the contents "
17626 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17627 "(See C<tgz-out>)."
17631 #: ../fish/guestfish.pod:755
17633 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17634 "effect, due to the way that subprocesses work in Unix."
17638 #: ../fish/guestfish.pod:758
17639 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
17643 #: ../fish/guestfish.pod:760
17645 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
17646 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
17647 "and executed as guestfish commands."
17651 #: ../fish/guestfish.pod:764
17653 "Thus you can use shell script to construct arbitrary guestfish commands "
17654 "which are then parsed by guestfish."
17658 #: ../fish/guestfish.pod:767
17660 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
17661 "through C</foo.100>) using guestfish commands alone. However this is simple "
17662 "if we use a shell script to create the guestfish commands for us:"
17666 #: ../fish/guestfish.pod:772
17669 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
17674 #: ../fish/guestfish.pod:774
17675 msgid "or with names like C</foo.001>:"
17679 #: ../fish/guestfish.pod:776
17682 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
17687 #: ../fish/guestfish.pod:778
17689 "When using guestfish interactively it can be helpful to just run the shell "
17690 "script first (ie. remove the initial C<E<lt>> character so it is just an "
17691 "ordinary I<!> local command), see what guestfish commands it would run, and "
17692 "when you are happy with those prepend the C<E<lt>> character to run the "
17693 "guestfish commands for real."
17697 #: ../fish/guestfish.pod:784
17702 #: ../fish/guestfish.pod:786
17704 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17705 "command (a guestfish command) to the second command (any host command). For "
17710 #: ../fish/guestfish.pod:790
17713 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17718 #: ../fish/guestfish.pod:792
17720 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17721 "program). The above command would list all accounts in the guest filesystem "
17722 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17726 #: ../fish/guestfish.pod:797
17729 " hexdump /bin/ls | head\n"
17730 " list-devices | tail -1\n"
17731 " tgz-out / - | tar ztf -\n"
17736 #: ../fish/guestfish.pod:801
17738 "The space before the pipe symbol is required, any space after the pipe "
17739 "symbol is optional. Everything after the pipe symbol is just passed "
17740 "straight to the host shell, so it can contain redirections, globs and "
17741 "anything else that makes sense on the host side."
17745 #: ../fish/guestfish.pod:806
17747 "To use a literal argument which begins with a pipe symbol, you have to quote "
17752 #: ../fish/guestfish.pod:809
17760 #: ../fish/guestfish.pod:811
17761 msgid "HOME DIRECTORIES"
17765 #: ../fish/guestfish.pod:813
17767 "If a parameter starts with the character C<~> then the tilde may be expanded "
17768 "as a home directory path (either C<~> for the current user's home directory, "
17769 "or C<~user> for another user)."
17773 #: ../fish/guestfish.pod:817
17775 "Note that home directory expansion happens for users known I<on the host>, "
17776 "not in the guest filesystem."
17780 #: ../fish/guestfish.pod:820
17782 "To use a literal argument which begins with a tilde, you have to quote it, "
17787 #: ../fish/guestfish.pod:823
17795 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:519
17796 msgid "ENCRYPTED DISKS"
17800 #: ../fish/guestfish.pod:827
17802 "Libguestfs has some support for Linux guests encrypted according to the "
17803 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17804 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
17805 "LUKS is supported."
17809 #: ../fish/guestfish.pod:832
17810 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17814 #: ../fish/guestfish.pod:834
17817 " ><fs> vfs-type /dev/sda2\n"
17823 #: ../fish/guestfish.pod:837
17825 "Then open those devices using L</luks-open>. This creates a device-mapper "
17826 "device called C</dev/mapper/luksdev>."
17830 #: ../fish/guestfish.pod:840
17833 " ><fs> luks-open /dev/sda2 luksdev\n"
17834 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17839 #: ../fish/guestfish.pod:843
17841 "Finally you have to tell LVM to scan for volume groups on the newly created "
17846 #: ../fish/guestfish.pod:846
17850 " vg-activate-all true\n"
17855 #: ../fish/guestfish.pod:849
17856 msgid "The logical volume(s) can now be mounted in the usual way."
17860 #: ../fish/guestfish.pod:851
17862 "Before closing a LUKS device you must unmount any logical volumes on it and "
17863 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17864 "one. Then you can close the mapper device:"
17868 #: ../fish/guestfish.pod:855
17871 " vg-activate false /dev/VG\n"
17872 " luks-close /dev/mapper/luksdev\n"
17877 #: ../fish/guestfish.pod:860
17879 "If a path is prefixed with C<win:> then you can use Windows-style drive "
17880 "letters and paths (with some limitations). The following commands are "
17885 #: ../fish/guestfish.pod:864
17888 " file /WINDOWS/system32/config/system.LOG\n"
17893 #: ../fish/guestfish.pod:866
17896 " file win:\\windows\\system32\\config\\system.log\n"
17901 #: ../fish/guestfish.pod:868
17904 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
17909 #: ../fish/guestfish.pod:870
17911 "The parameter is rewritten \"behind the scenes\" by looking up the position "
17912 "where the drive is mounted, prepending that to the path, changing all "
17913 "backslash characters to forward slash, then resolving the result using L</"
17914 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
17915 "the parameter might be rewritten like this:"
17919 #: ../fish/guestfish.pod:876
17922 " win:e:\\foo\\bar => /e/FOO/bar\n"
17927 #: ../fish/guestfish.pod:878
17928 msgid "This only works in argument positions that expect a path."
17932 #: ../fish/guestfish.pod:880
17933 msgid "UPLOADING AND DOWNLOADING FILES"
17937 #: ../fish/guestfish.pod:882
17939 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17940 "others which upload from or download to a local file, you can use the "
17941 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17945 #: ../fish/guestfish.pod:886
17953 #: ../fish/guestfish.pod:888
17955 "reads stdin and creates from that a file C</foo> in the disk image, and:"
17959 #: ../fish/guestfish.pod:891
17962 " tar-out /etc - | tar tf -\n"
17967 #: ../fish/guestfish.pod:893
17969 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17970 "command (see L</PIPES>)."
17974 #: ../fish/guestfish.pod:896
17976 "When using C<-> to read from stdin, the input is read up to the end of "
17977 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17978 "some arbitrary end marker:"
17982 #: ../fish/guestfish.pod:900
17985 " upload -<<END /foo\n"
17994 #: ../fish/guestfish.pod:906
17996 "Any string of characters can be used instead of C<END>. The end marker must "
17997 "appear on a line of its own, without any preceeding or following characters "
17998 "(not even spaces)."
18002 #: ../fish/guestfish.pod:910
18004 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18005 "upload local files (so-called \"FileIn\" parameters in the generator)."
18009 #: ../fish/guestfish.pod:913
18010 msgid "EXIT ON ERROR BEHAVIOUR"
18014 #: ../fish/guestfish.pod:915
18016 "By default, guestfish will ignore any errors when in interactive mode (ie. "
18017 "taking commands from a human over a tty), and will exit on the first error "
18018 "in non-interactive mode (scripts, commands given on the command line)."
18022 #: ../fish/guestfish.pod:920
18024 "If you prefix a command with a I<-> character, then that command will not "
18025 "cause guestfish to exit, even if that (one) command returns an error."
18029 #: ../fish/guestfish.pod:924
18030 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18034 #: ../fish/guestfish.pod:926
18036 "Guestfish can be remote-controlled over a socket. This is useful "
18037 "particularly in shell scripts where you want to make several different "
18038 "changes to a filesystem, but you don't want the overhead of starting up a "
18039 "guestfish process each time."
18043 #: ../fish/guestfish.pod:931
18044 msgid "Start a guestfish server process using:"
18048 #: ../fish/guestfish.pod:933
18051 " eval \"`guestfish --listen`\"\n"
18056 #: ../fish/guestfish.pod:935
18057 msgid "and then send it commands by doing:"
18061 #: ../fish/guestfish.pod:937
18064 " guestfish --remote cmd [...]\n"
18069 #: ../fish/guestfish.pod:939
18070 msgid "To cause the server to exit, send it the exit command:"
18074 #: ../fish/guestfish.pod:943
18076 "Note that the server will normally exit if there is an error in a command. "
18077 "You can change this in the usual way. See section L</EXIT ON ERROR "
18082 #: ../fish/guestfish.pod:947
18083 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18087 #: ../fish/guestfish.pod:949
18089 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18090 "is how the I<--remote> option knows where to send the commands. You can "
18091 "have several guestfish listener processes running using:"
18095 #: ../fish/guestfish.pod:953
18098 " eval \"`guestfish --listen`\"\n"
18099 " pid1=$GUESTFISH_PID\n"
18100 " eval \"`guestfish --listen`\"\n"
18101 " pid2=$GUESTFISH_PID\n"
18103 " guestfish --remote=$pid1 cmd\n"
18104 " guestfish --remote=$pid2 cmd\n"
18109 #: ../fish/guestfish.pod:961
18110 msgid "REMOTE CONTROL AND CSH"
18114 #: ../fish/guestfish.pod:963
18116 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18121 #: ../fish/guestfish.pod:966
18124 " eval \"`guestfish --listen --csh`\"\n"
18129 #: ../fish/guestfish.pod:968
18130 msgid "REMOTE CONTROL DETAILS"
18134 #: ../fish/guestfish.pod:970
18136 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18137 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18138 "and C<$PID> is the process ID of the server."
18142 #: ../fish/guestfish.pod:974
18143 msgid "Guestfish client and server versions must match exactly."
18147 #: ../fish/guestfish.pod:976
18148 msgid "REMOTE CONTROL RUN COMMAND HANGING"
18152 #: ../fish/guestfish.pod:978
18154 "Using the C<run> (or C<launch>) command remotely in a command substitution "
18155 "context hangs, ie. don't do (note the backquotes):"
18159 #: ../fish/guestfish.pod:981
18162 " a=`guestfish --remote run`\n"
18167 #: ../fish/guestfish.pod:983
18169 "Since the C<run> command produces no output on stdout, this is not useful "
18170 "anyway. For further information see L<https://bugzilla.redhat.com/show_bug."
18175 #: ../fish/guestfish.pod:987
18176 msgid "PREPARED DISK IMAGES"
18180 #: ../fish/guestfish.pod:989
18182 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18183 "preformatted disk images that guestfish can make for you to save typing. "
18184 "This is particularly useful for testing purposes. This option is used "
18185 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18186 "can be mixed with I<-a>)."
18190 #: ../fish/guestfish.pod:995
18192 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18193 "the second and so on. Existing files in the current directory are "
18198 #: ../fish/guestfish.pod:999
18200 "The type briefly describes how the disk should be sized, partitioned, how "
18201 "filesystem(s) should be created, and how content should be added. "
18202 "Optionally the type can be followed by extra parameters, separated by C<:> "
18203 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18204 "allocated disk, containing a single partition, with the partition formatted "
18205 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18210 #: ../fish/guestfish.pod:1007
18211 msgid "To list the available types and any extra parameters they take, run:"
18215 #: ../fish/guestfish.pod:1011
18217 "Note that the prepared filesystem is not mounted. You would usually have to "
18218 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18222 #: ../fish/guestfish.pod:1015
18224 "If any I<-N> or I<--new> options are given, the guest is automatically "
18229 #: ../fish/guestfish.pod:1020
18230 msgid "Create a 100MB disk with an ext4-formatted partition:"
18234 #: ../fish/guestfish.pod:1022
18237 " guestfish -N fs:ext4\n"
18242 #: ../fish/guestfish.pod:1024
18243 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18247 #: ../fish/guestfish.pod:1026
18250 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18255 #: ../fish/guestfish.pod:1028
18256 msgid "Create a blank 200MB disk:"
18260 #: ../fish/guestfish.pod:1030
18263 " guestfish -N disk:200M\n"
18268 #: ../fish/guestfish.pod:1032
18269 msgid "PROGRESS BARS"
18273 #: ../fish/guestfish.pod:1034
18275 "Some (not all) long-running commands send progress notification messages as "
18276 "they are running. Guestfish turns these messages into progress bars."
18280 #: ../fish/guestfish.pod:1038
18282 "When a command that supports progress bars takes longer than two seconds to "
18283 "run, and if progress bars are enabled, then you will see one appearing below "
18288 #: ../fish/guestfish.pod:1042
18291 " ><fs> copy-size /large-file /another-file 2048M\n"
18292 " / 10% [#####-----------------------------------------] 00:30\n"
18297 #: ../fish/guestfish.pod:1045
18299 "The spinner on the left hand side moves round once for every progress "
18300 "notification received from the backend. This is a (reasonably) golden "
18301 "assurance that the command is \"doing something\" even if the progress bar "
18302 "is not moving, because the command is able to send the progress "
18303 "notifications. When the bar reaches 100% and the command finishes, the "
18304 "spinner disappears."
18308 #: ../fish/guestfish.pod:1052
18310 "Progress bars are enabled by default when guestfish is used interactively. "
18311 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18312 "and you can disable them completely using I<--no-progress-bars>."
18316 #: ../fish/guestfish.pod:1057
18317 msgid "GUESTFISH COMMANDS"
18321 #: ../fish/guestfish.pod:1059
18323 "The commands in this section are guestfish convenience commands, in other "
18324 "words, they are not part of the L<guestfs(3)> API."
18328 #: ../fish/guestfish.pod:1062
18333 #: ../fish/guestfish.pod:1064
18342 #: ../fish/guestfish.pod:1067
18343 msgid "Without any parameter, this provides general help."
18347 #: ../fish/guestfish.pod:1069
18348 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18352 #: ../fish/guestfish.pod:1071
18353 msgid "quit | exit"
18357 #: ../fish/guestfish.pod:1073
18358 msgid "This exits guestfish. You can also use C<^D> key."
18362 #: ../fish/guestfish.pod:1075
18363 msgid "@FISH_COMMANDS@"
18367 #: ../fish/guestfish.pod:1077
18372 #: ../fish/guestfish.pod:1079 ../src/guestfs.pod:1475
18377 #: ../fish/guestfish.pod:1083
18379 "guestfish returns 0 if the commands completed without error, or 1 if there "
18384 #: ../fish/guestfish.pod:1090
18389 #: ../fish/guestfish.pod:1092
18391 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18396 #: ../fish/guestfish.pod:1095 ../src/guestfs.pod:2985
18397 msgid "FEBOOTSTRAP_KERNEL"
18401 #: ../fish/guestfish.pod:1097 ../src/guestfs.pod:2987
18402 msgid "FEBOOTSTRAP_MODULES"
18406 #: ../fish/guestfish.pod:1099 ../src/guestfs.pod:2989
18408 "These two environment variables allow the kernel that libguestfs uses in the "
18409 "appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
18410 "most recent host kernel is chosen. For more information about kernel "
18411 "selection, see L<febootstrap-supermin-helper(8)>. This feature is only "
18412 "available in febootstrap E<ge> 3.8."
18416 #: ../fish/guestfish.pod:1105
18417 msgid "GUESTFISH_DISPLAY_IMAGE"
18421 #: ../fish/guestfish.pod:1107
18423 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
18424 "If not set, it uses L<display(1)>."
18428 #: ../fish/guestfish.pod:1110
18429 msgid "GUESTFISH_PID"
18433 #: ../fish/guestfish.pod:1112
18435 "Used with the I<--remote> option to specify the remote guestfish process to "
18436 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18440 #: ../fish/guestfish.pod:1116
18445 #: ../fish/guestfish.pod:1118
18447 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18448 "not specified, the external L<hexedit(1)> program is used."
18452 #: ../fish/guestfish.pod:1122
18457 #: ../fish/guestfish.pod:1124
18459 "If compiled with GNU readline support, various files in the home directory "
18460 "can be used. See L</FILES>."
18464 #: ../fish/guestfish.pod:1127 ../src/guestfs.pod:2995
18465 msgid "LIBGUESTFS_APPEND"
18469 #: ../fish/guestfish.pod:1129 ../src/guestfs.pod:2997
18470 msgid "Pass additional options to the guest kernel."
18474 #: ../fish/guestfish.pod:1131 ../src/guestfs.pod:2999
18475 msgid "LIBGUESTFS_DEBUG"
18479 #: ../fish/guestfish.pod:1133
18481 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18482 "effect as using the B<-v> option."
18486 #: ../fish/guestfish.pod:1136 ../src/guestfs.pod:3004
18487 msgid "LIBGUESTFS_MEMSIZE"
18491 #: ../fish/guestfish.pod:1138 ../src/guestfs.pod:3006
18493 "Set the memory allocated to the qemu process, in megabytes. For example:"
18497 #: ../fish/guestfish.pod:1141 ../src/guestfs.pod:3009
18500 " LIBGUESTFS_MEMSIZE=700\n"
18505 #: ../fish/guestfish.pod:1143 ../src/guestfs.pod:3011
18506 msgid "LIBGUESTFS_PATH"
18510 #: ../fish/guestfish.pod:1145
18512 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18513 "the discussion of paths in L<guestfs(3)>."
18517 #: ../fish/guestfish.pod:1148 ../src/guestfs.pod:3016
18518 msgid "LIBGUESTFS_QEMU"
18522 #: ../fish/guestfish.pod:1150 ../src/guestfs.pod:3018
18524 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
18525 "which was found at compile time by the configure script is used."
18529 #: ../fish/guestfish.pod:1154 ../src/guestfs.pod:3024
18530 msgid "LIBGUESTFS_TRACE"
18534 #: ../fish/guestfish.pod:1156
18535 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18539 #: ../fish/guestfish.pod:1158
18544 #: ../fish/guestfish.pod:1160
18546 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18551 #: ../fish/guestfish.pod:1163 ../src/guestfs.pod:3029
18556 #: ../fish/guestfish.pod:1165 ../src/guestfs.pod:3031
18558 "Location of temporary directory, defaults to C</tmp> except for the cached "
18559 "supermin appliance which defaults to C</var/tmp>."
18563 #: ../fish/guestfish.pod:1168 ../src/guestfs.pod:3034
18565 "If libguestfs was compiled to use the supermin appliance then the real "
18566 "appliance is cached in this directory, shared between all handles belonging "
18567 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
18568 "use in case C</var/tmp> is not large enough."
18572 #: ../fish/guestfish.pod:1176 ../fuse/guestmount.pod:288
18573 #: ../rescue/virt-rescue.pod:269
18578 #: ../fish/guestfish.pod:1180 ../fuse/guestmount.pod:292
18579 #: ../rescue/virt-rescue.pod:273
18580 msgid "$HOME/.libguestfs-tools.rc"
18584 #: ../fish/guestfish.pod:1182 ../fuse/guestmount.pod:294
18585 #: ../rescue/virt-rescue.pod:275
18586 msgid "/etc/libguestfs-tools.conf"
18590 #: ../fish/guestfish.pod:1184 ../fuse/guestmount.pod:296
18591 #: ../rescue/virt-rescue.pod:277
18593 "This configuration file controls the default read-only or read-write mode "
18594 "(I<--ro> or I<--rw>)."
18598 #: ../fish/guestfish.pod:1187
18599 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
18603 #: ../fish/guestfish.pod:1189
18604 msgid "$HOME/.guestfish"
18608 #: ../fish/guestfish.pod:1191
18610 "If compiled with GNU readline support, then the command history is saved in "
18615 #: ../fish/guestfish.pod:1194
18616 msgid "$HOME/.inputrc"
18620 #: ../fish/guestfish.pod:1196
18621 msgid "/etc/inputrc"
18625 #: ../fish/guestfish.pod:1198
18627 "If compiled with GNU readline support, then these files can be used to "
18628 "configure readline. For further information, please see L<readline(3)/"
18629 "INITIALIZATION FILE>."
18633 #: ../fish/guestfish.pod:1202
18634 msgid "To write rules which only apply to guestfish, use:"
18638 #: ../fish/guestfish.pod:1204
18648 #: ../fish/guestfish.pod:1208
18650 "Variables that you can set in inputrc that change the behaviour of guestfish "
18651 "in useful ways include:"
18655 #: ../fish/guestfish.pod:1213
18656 msgid "completion-ignore-case (default: on)"
18660 #: ../fish/guestfish.pod:1215
18662 "By default, guestfish will ignore case when tab-completing paths on the "
18667 #: ../fish/guestfish.pod:1218
18670 " set completion-ignore-case off\n"
18675 #: ../fish/guestfish.pod:1220
18676 msgid "to make guestfish case sensitive."
18680 #: ../fish/guestfish.pod:1224
18685 #: ../fish/guestfish.pod:1226
18686 msgid "test2.img (etc)"
18690 #: ../fish/guestfish.pod:1228
18692 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
18693 "will be created in the file C<test1.img> in the current directory. The "
18694 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
18695 "the same name will be overwritten."
18699 #: ../fish/guestfish.pod:1237
18701 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
18702 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
18703 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
18704 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
18705 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
18706 ">, L<display(1)>, L<hexedit(1)>, L<febootstrap-supermin-helper(8)>."
18710 #: ../fish/guestfish.pod:1266 ../src/guestfs.pod:3120
18711 #: ../test-tool/libguestfs-test-tool.pod:99
18712 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
18716 #: ../fish/virt-copy-in.pod:5
18718 "virt-copy-in - Copy files and directories into a virtual machine disk image."
18722 #: ../fish/virt-copy-in.pod:9
18725 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
18730 #: ../fish/virt-copy-in.pod:11
18733 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
18738 #: ../fish/virt-copy-in.pod:15
18740 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
18741 "causing disk corruption. The virtual machine must be shut down before you "
18742 "use this command."
18746 #: ../fish/virt-copy-in.pod:21
18748 "C<virt-copy-in> copies files and directories from the local disk into a "
18749 "virtual machine disk image or named libvirt domain."
18753 #: ../fish/virt-copy-in.pod:24
18755 "You can give one of more filenames and directories on the command line. "
18756 "Directories are copied in recursively. The final parameter must be the "
18757 "destination directory in the disk image which must be an absolute path "
18758 "starting with a C</> character."
18762 #: ../fish/virt-copy-in.pod:33
18765 " virt-copy-in -d MyGuest resolv.conf /etc\n"
18770 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
18771 msgid "Upload a home directory to a guest:"
18775 #: ../fish/virt-copy-in.pod:37
18778 " virt-copy-in -d MyGuest skel /home\n"
18783 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28
18784 #: ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
18785 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
18789 #: ../fish/virt-copy-in.pod:41
18791 "This command is just a simple shell script wrapper around the L<guestfish(1)"
18792 "> C<copy-in> command. For anything more complex than a trivial copy, you "
18793 "are probably better off using guestfish directly."
18797 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36
18798 #: ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
18800 "Since the shell script just passes options straight to guestfish, read "
18801 "L<guestfish(1)> to see the full list of options."
18805 #: ../fish/virt-copy-in.pod:52
18807 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
18808 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18812 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55
18813 #: ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
18814 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
18818 #: ../fish/virt-copy-out.pod:5
18820 "virt-copy-out - Copy files and directories out of a virtual machine disk "
18825 #: ../fish/virt-copy-out.pod:9
18828 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
18833 #: ../fish/virt-copy-out.pod:11
18836 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
18841 #: ../fish/virt-copy-out.pod:15
18843 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
18844 "image or named libvirt domain."
18848 #: ../fish/virt-copy-out.pod:18
18850 "You can give one of more filenames and directories on the command line. "
18851 "Directories are copied out recursively."
18855 #: ../fish/virt-copy-out.pod:23
18856 msgid "Download the home directories from a virtual machine:"
18860 #: ../fish/virt-copy-out.pod:25
18864 " virt-copy-out -d MyGuest /home homes\n"
18869 #: ../fish/virt-copy-out.pod:30
18871 "This command is just a simple shell script wrapper around the L<guestfish(1)"
18872 "> C<copy-out> command. For anything more complex than a trivial copy, you "
18873 "are probably better off using guestfish directly."
18877 #: ../fish/virt-copy-out.pod:41
18879 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, L<virt-"
18880 "tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18884 #: ../fish/virt-tar-in.pod:5
18885 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
18889 #: ../fish/virt-tar-in.pod:9
18892 " virt-tar-in -a disk.img data.tar /destination\n"
18897 #: ../fish/virt-tar-in.pod:11
18900 " virt-tar-in -d domain data.tar /destination\n"
18905 #: ../fish/virt-tar-in.pod:13
18908 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
18913 #: ../fish/virt-tar-in.pod:17
18915 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
18916 "causing disk corruption. The virtual machine must be shut down before you "
18917 "use this command."
18921 #: ../fish/virt-tar-in.pod:23
18923 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
18924 "image or named libvirt domain."
18928 #: ../fish/virt-tar-in.pod:26
18930 "The first parameter is the tar file. Use C<-> to read the tar file from "
18931 "standard input. The second parameter is the absolute target directory to "
18936 #: ../fish/virt-tar-in.pod:34
18939 " virt-tar-in -d MyGuest homes.tar /home\n"
18944 #: ../fish/virt-tar-in.pod:38
18946 "This command is just a simple shell script wrapper around the L<guestfish(1)"
18947 "> C<tar-in> command. For anything more complex than a trivial copy, you are "
18948 "probably better off using guestfish directly."
18952 #: ../fish/virt-tar-in.pod:49
18954 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18955 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, L<http://libguestfs."
18960 #: ../fish/virt-tar-out.pod:5
18962 "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
18966 #: ../fish/virt-tar-out.pod:9
18969 " virt-tar-out -a disk.img /dir files.tar\n"
18974 #: ../fish/virt-tar-out.pod:11
18977 " virt-tar-out -d domain /dir files.tar\n"
18982 #: ../fish/virt-tar-out.pod:13
18985 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
18990 #: ../fish/virt-tar-out.pod:17
18992 "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
18996 #: ../fish/virt-tar-out.pod:20
18998 "The first parameter is the absolute path of the virtual machine directory. "
18999 "The second parameter is the tar file to write. Use C<-> to write to "
19004 #: ../fish/virt-tar-out.pod:26
19005 msgid "Download the home directories from a guest:"
19009 #: ../fish/virt-tar-out.pod:28
19012 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
19017 #: ../fish/virt-tar-out.pod:32
19019 "This command is just a simple shell script wrapper around the L<guestfish(1)"
19020 "> C<tar-out> command. For anything more complex than a trivial copy, you "
19021 "are probably better off using guestfish directly."
19025 #: ../fish/virt-tar-out.pod:43
19027 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
19028 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
19032 #: ../fuse/guestmount.pod:5
19034 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
19038 #: ../fuse/guestmount.pod:9
19041 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
19046 #: ../fuse/guestmount.pod:11
19049 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
19054 #: ../fuse/guestmount.pod:13
19057 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
19062 #: ../fuse/guestmount.pod:17
19064 "You must I<not> use C<guestmount> in read-write mode on live virtual "
19065 "machines. If you do this, you risk disk corruption in the VM."
19069 #: ../fuse/guestmount.pod:22
19071 "The guestmount program can be used to mount virtual machine filesystems and "
19072 "other disk images on the host. It uses libguestfs for access to the guest "
19073 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
19074 "a mountable device."
19078 #: ../fuse/guestmount.pod:27
19080 "Along with other options, you have to give at least one device (I<-a> "
19081 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
19082 "option) or use the I<-i> inspection option. How this works is better "
19083 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
19088 #: ../fuse/guestmount.pod:33
19090 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
19091 "by you, and the filesystem will not be visible to any other users unless you "
19092 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
19093 "the filesystem, use the C<fusermount -u> command."
19097 #: ../fuse/guestmount.pod:41
19099 "For a typical Windows guest which has its main filesystem on the first "
19104 #: ../fuse/guestmount.pod:44
19107 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
19112 #: ../fuse/guestmount.pod:46
19114 "For a typical Linux guest which has a /boot filesystem on the first "
19115 "partition, and the root filesystem on a logical volume:"
19119 #: ../fuse/guestmount.pod:49
19122 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
19127 #: ../fuse/guestmount.pod:51
19128 msgid "To get libguestfs to detect guest mountpoints for you:"
19132 #: ../fuse/guestmount.pod:53
19135 " guestmount -a guest.img -i --ro /mnt\n"
19140 #: ../fuse/guestmount.pod:55
19141 msgid "For a libvirt guest called \"Guest\" you could do:"
19145 #: ../fuse/guestmount.pod:57
19148 " guestmount -d Guest -i --ro /mnt\n"
19153 #: ../fuse/guestmount.pod:59
19155 "If you don't know what filesystems are contained in a guest or disk image, "
19156 "use L<virt-filesystems(1)> first:"
19160 #: ../fuse/guestmount.pod:62
19163 " virt-filesystems MyGuest\n"
19168 #: ../fuse/guestmount.pod:64
19170 "If you want to trace the libguestfs calls but without excessive debugging "
19171 "information, we recommend:"
19175 #: ../fuse/guestmount.pod:67
19178 " guestmount [...] --trace /mnt\n"
19183 #: ../fuse/guestmount.pod:69
19184 msgid "If you want to debug the program, we recommend:"
19188 #: ../fuse/guestmount.pod:71
19191 " guestmount [...] --trace --verbose /mnt\n"
19196 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68
19197 #: ../resize/virt-resize.pod:544
19202 #: ../fuse/guestmount.pod:75
19203 msgid "Other users cannot see the filesystem by default"
19207 #: ../fuse/guestmount.pod:77
19209 "If you mount a filesystem as one user (eg. root), then other users will not "
19210 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
19211 "option when mounting:"
19215 #: ../fuse/guestmount.pod:81
19218 " sudo guestmount [...] -o allow_other /mnt\n"
19223 #: ../fuse/guestmount.pod:91
19224 msgid "Add a block device or virtual machine image."
19228 #: ../fuse/guestmount.pod:114
19229 msgid "B<--dir-cache-timeout N>"
19233 #: ../fuse/guestmount.pod:116
19235 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
19236 "seconds. The readdir cache [actually, there are several semi-independent "
19237 "caches] is populated after a readdir(2) call with the stat and extended "
19238 "attributes of the files in the directory, in anticipation that they will be "
19239 "requested soon after."
19243 #: ../fuse/guestmount.pod:122
19245 "There is also a different attribute cache implemented by FUSE (see the FUSE "
19246 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
19247 "requests, only cache existing ones."
19251 #: ../fuse/guestmount.pod:142
19253 "If you have untrusted raw-format guest disk images, you should use this "
19254 "option to specify the disk format. This avoids a possible security problem "
19255 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
19256 "guestfs_add_drive_opts>."
19260 #: ../fuse/guestmount.pod:147
19261 msgid "B<--fuse-help>"
19265 #: ../fuse/guestmount.pod:149
19266 msgid "Display help on special FUSE options (see I<-o> below)."
19270 #: ../fuse/guestmount.pod:153
19271 msgid "Display brief help and exit."
19275 #: ../fuse/guestmount.pod:177
19277 "Mount the named partition or logical volume on the given mountpoint B<in the "
19278 "guest> (this has nothing to do with mountpoints in the host)."
19282 #: ../fuse/guestmount.pod:180
19284 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
19285 "something on C</>."
19289 #: ../fuse/guestmount.pod:197
19291 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
19292 "unmounted. If you specify this option, then we don't attempt to sync the "
19293 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
19297 #: ../fuse/guestmount.pod:202
19298 msgid "B<-o option>"
19302 #: ../fuse/guestmount.pod:204
19303 msgid "B<--option option>"
19307 #: ../fuse/guestmount.pod:206
19308 msgid "Pass extra options to FUSE."
19312 #: ../fuse/guestmount.pod:208
19314 "To get a list of all the extra options supported by FUSE, use the command "
19315 "below. Note that only the FUSE I<-o> options can be passed, and only some "
19316 "of them are a good idea."
19320 #: ../fuse/guestmount.pod:212
19323 " guestmount --fuse-help\n"
19328 #: ../fuse/guestmount.pod:214
19329 msgid "Some potentially useful FUSE options:"
19333 #: ../fuse/guestmount.pod:218
19334 msgid "B<-o allow_other>"
19338 #: ../fuse/guestmount.pod:220
19339 msgid "Allow other users to see the filesystem."
19343 #: ../fuse/guestmount.pod:222
19344 msgid "B<-o attr_timeout=N>"
19348 #: ../fuse/guestmount.pod:224
19349 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
19353 #: ../fuse/guestmount.pod:226
19354 msgid "B<-o kernel_cache>"
19358 #: ../fuse/guestmount.pod:228
19360 "Allow the kernel to cache files (reduces the number of reads that have to go "
19361 "through the L<guestfs(3)> API). This is generally a good idea if you can "
19362 "afford the extra memory usage."
19366 #: ../fuse/guestmount.pod:232
19367 msgid "B<-o uid=N> B<-o gid=N>"
19371 #: ../fuse/guestmount.pod:234
19373 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
19374 "the chosen values."
19378 #: ../fuse/guestmount.pod:243
19380 "Add devices and mount everything read-only. Also disallow writes and make "
19381 "the disk appear read-only to FUSE."
19385 #: ../fuse/guestmount.pod:246
19387 "This is highly recommended if you are not going to edit the guest disk. If "
19388 "the guest is running and this option is I<not> supplied, then there is a "
19389 "strong risk of disk corruption in the guest. We try to prevent this from "
19390 "happening, but it is not always possible."
19394 #: ../fuse/guestmount.pod:251 ../rescue/virt-rescue.pod:171
19395 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19399 #: ../fuse/guestmount.pod:255
19400 msgid "Enable SELinux support for the guest."
19404 #: ../fuse/guestmount.pod:261
19405 msgid "Enable verbose messages from underlying libguestfs."
19409 #: ../fuse/guestmount.pod:267
19410 msgid "Display the program version and exit."
19414 #: ../fuse/guestmount.pod:276 ../fuse/guestmount.pod:299
19415 #: ../rescue/virt-rescue.pod:197 ../rescue/virt-rescue.pod:280
19416 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19420 #: ../fuse/guestmount.pod:280
19425 #: ../fuse/guestmount.pod:282
19426 msgid "Trace libguestfs calls and entry into each FUSE function."
19430 #: ../fuse/guestmount.pod:284
19431 msgid "This also stops the daemon from forking into the background."
19435 #: ../fuse/guestmount.pod:310
19437 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
19438 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
19443 #: ../fuse/guestmount.pod:325
19444 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
19448 #: ../inspector/virt-inspector.pod:5
19450 "virt-inspector - Display operating system version and other information "
19451 "about a virtual machine"
19455 #: ../inspector/virt-inspector.pod:9
19458 " virt-inspector [--options] -d domname\n"
19463 #: ../inspector/virt-inspector.pod:11
19466 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
19471 #: ../inspector/virt-inspector.pod:15
19474 " virt-inspector domname\n"
19479 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
19482 " virt-inspector disk.img [disk.img ...]\n"
19487 #: ../inspector/virt-inspector.pod:21
19489 "B<virt-inspector> examines a virtual machine or disk image and tries to "
19490 "determine the version of the operating system and other information about "
19491 "the virtual machine."
19495 #: ../inspector/virt-inspector.pod:25
19496 msgid "Virt-inspector produces XML output for feeding into other programs."
19500 #: ../inspector/virt-inspector.pod:27
19502 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
19503 "the libvirt domain (see: C<virsh list --all>)."
19507 #: ../inspector/virt-inspector.pod:30
19509 "You can also run virt-inspector directly on disk images from a single "
19510 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
19511 "has several block devices, in which case you should list several I<-a> "
19512 "options one after another, with the first corresponding to the guest's C</"
19513 "dev/sda>, the second to the guest's C</dev/sdb> and so on."
19517 #: ../inspector/virt-inspector.pod:37
19519 "You can also run virt-inspector on install disks, live CDs, bootable USB "
19520 "keys and similar."
19524 #: ../inspector/virt-inspector.pod:40
19526 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
19527 "inspect several virtual machines, you have to run virt-inspector several "
19528 "times (for example, from a shell script for-loop)."
19532 #: ../inspector/virt-inspector.pod:45
19534 "Because virt-inspector needs direct access to guest images, it won't "
19535 "normally work over remote libvirt connections."
19539 #: ../inspector/virt-inspector.pod:48
19541 "All of the information available from virt-inspector is also available "
19542 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
19543 "The same information can also be fetched using guestfish or via libguestfs "
19544 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
19545 "WITH OTHER PROGRAMMING LANGUAGES>)."
19549 #: ../inspector/virt-inspector.pod:81
19551 "Libvirt is only used if you specify a C<domname> on the command line. If "
19552 "you specify guest block devices directly (I<-a>), then libvirt is not used "
19557 #: ../inspector/virt-inspector.pod:94
19559 "When prompting for keys and passphrases, virt-inspector normally turns "
19560 "echoing off so you cannot see what you are typing. If you are not worried "
19561 "about Tempest attacks and there is no one else in the room you can specify "
19562 "this flag to see what you are typing."
19566 #: ../inspector/virt-inspector.pod:103 ../tools/virt-list-filesystems.pl:93
19567 #: ../tools/virt-list-partitions.pl:94 ../tools/virt-tar.pl:143
19568 #: ../tools/virt-win-reg.pl:144
19570 "Specify the format of disk images given on the command line. If this is "
19571 "omitted then the format is autodetected from the content of the disk image."
19575 #: ../inspector/virt-inspector.pod:107 ../tools/virt-list-filesystems.pl:97
19576 #: ../tools/virt-list-partitions.pl:98 ../tools/virt-tar.pl:147
19577 #: ../tools/virt-win-reg.pl:148
19579 "If disk images are requested from libvirt, then this program asks libvirt "
19580 "for this information. In this case, the value of the format parameter is "
19585 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:314
19586 #: ../resize/virt-resize.pod:406 ../tools/virt-list-filesystems.pl:101
19587 #: ../tools/virt-list-partitions.pl:102 ../tools/virt-tar.pl:151
19588 #: ../tools/virt-win-reg.pl:152
19590 "If working with untrusted raw-format guest disk images, you should ensure "
19591 "the format is always specified."
19595 #: ../inspector/virt-inspector.pod:139
19596 msgid "Previous versions of virt-inspector allowed you to write either:"
19600 #: ../inspector/virt-inspector.pod:145
19603 " virt-inspector guestname\n"
19608 #: ../inspector/virt-inspector.pod:153
19613 #: ../inspector/virt-inspector.pod:155
19615 "The virt-inspector XML is described precisely in a RELAX NG schema file "
19616 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
19617 "just an overview."
19621 #: ../inspector/virt-inspector.pod:159
19623 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
19624 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
19625 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
19626 "which is vanishingly rare in real world VMs."
19630 #: ../inspector/virt-inspector.pod:164
19631 msgid "E<lt>operatingsystemE<gt>"
19635 #: ../inspector/virt-inspector.pod:166
19637 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
19638 "describe the operating system, its architecture, the descriptive \"product "
19639 "name\" string, the type of OS and so on, as in this example:"
19643 #: ../inspector/virt-inspector.pod:170
19646 " <operatingsystems>\n"
19647 " <operatingsystem>\n"
19648 " <root>/dev/sda2</root>\n"
19649 " <name>windows</name>\n"
19650 " <arch>i386</arch>\n"
19651 " <distro>windows</distro>\n"
19652 " <product_name>Windows 7 Enterprise</product_name>\n"
19653 " <product_variant>Client</product_variant>\n"
19654 " <major_version>6</major_version>\n"
19655 " <minor_version>1</minor_version>\n"
19656 " <windows_systemroot>/Windows</windows_systemroot>\n"
19657 " <format>installed</format>\n"
19662 #: ../inspector/virt-inspector.pod:183
19664 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
19665 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
19666 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
19667 "architecture. The other fields are fairly self-explanatory, but because "
19668 "these fields are taken directly from the libguestfs inspection API you can "
19669 "find precise information from L<guestfs(3)/INSPECTION>."
19673 #: ../inspector/virt-inspector.pod:191
19675 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
19676 "of view of libguestfs (block devices may have completely different names "
19677 "inside the VM itself)."
19681 #: ../inspector/virt-inspector.pod:195
19682 msgid "E<lt>mountpointsE<gt>"
19686 #: ../inspector/virt-inspector.pod:197
19688 "Un*x-like guests typically have multiple filesystems which are mounted at "
19689 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
19690 "element which looks like this:"
19694 #: ../inspector/virt-inspector.pod:201
19697 " <operatingsystems>\n"
19698 " <operatingsystem>\n"
19701 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
19702 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
19703 " </mountpoints>\n"
19708 #: ../inspector/virt-inspector.pod:209
19710 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
19711 "and may have completely different names inside the guest. Only mountable "
19712 "filesystems appear in this list, not things like swap devices."
19716 #: ../inspector/virt-inspector.pod:214
19717 msgid "E<lt>filesystemsE<gt>"
19721 #: ../inspector/virt-inspector.pod:216
19723 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
19724 "filesystems belonging to the guest, including swap and empty partitions. "
19725 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
19726 "this OS or shared with this OS and other OSes)."
19730 #: ../inspector/virt-inspector.pod:222
19731 msgid "You might see something like this:"
19735 #: ../inspector/virt-inspector.pod:224
19738 " <operatingsystems>\n"
19739 " <operatingsystem>\n"
19742 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19743 " <type>ext4</type>\n"
19744 " <label>Fedora-13-x86_64</label>\n"
19745 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
19751 #: ../inspector/virt-inspector.pod:234
19753 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
19754 "the label, and the UUID."
19758 #: ../inspector/virt-inspector.pod:237
19759 msgid "E<lt>applicationsE<gt>"
19763 #: ../inspector/virt-inspector.pod:239
19765 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
19766 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
19771 #: ../inspector/virt-inspector.pod:243
19773 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
19774 "Typical values would be C<rpm> and C<deb>."
19778 #: ../inspector/virt-inspector.pod:246
19780 "E<lt>package_managementE<gt>, if present, describes the package manager. "
19781 "Typical values include C<yum>, C<up2date> and C<apt>"
19785 #: ../inspector/virt-inspector.pod:249
19786 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
19790 #: ../inspector/virt-inspector.pod:252
19793 " <operatingsystems>\n"
19794 " <operatingsystem>\n"
19796 " <applications>\n"
19798 " <name>coreutils</name>\n"
19799 " <version>8.5</version>\n"
19800 " <release>1</release>\n"
19801 " </application>\n"
19806 #: ../inspector/virt-inspector.pod:262
19808 "The version and release fields may not be available for some types guests. "
19809 "Other fields are possible, see L<guestfs(3)/"
19810 "guestfs_inspect_list_applications>."
19814 #: ../inspector/virt-inspector.pod:266
19815 msgid "E<lt>drive_mappingsE<gt>"
19819 #: ../inspector/virt-inspector.pod:268
19821 "For operating systems like Windows which use drive letters, virt-inspector "
19822 "is able to find out how drive letters map to filesystems."
19826 #: ../inspector/virt-inspector.pod:272
19829 " <operatingsystems>\n"
19830 " <operatingsystem>\n"
19832 " <drive_mappings>\n"
19833 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
19834 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
19835 " </drive_mappings>\n"
19840 #: ../inspector/virt-inspector.pod:280
19842 "In the example above, drive C maps to the filesystem on the second partition "
19843 "on the first disk, and drive E maps to the filesystem on the first partition "
19844 "on the second disk."
19848 #: ../inspector/virt-inspector.pod:284
19850 "Note that this only covers permanent local filesystem mappings, not things "
19851 "like network shares. Furthermore NTFS volume mount points may not be listed "
19856 #: ../inspector/virt-inspector.pod:288
19857 msgid "E<lt>iconE<gt>"
19861 #: ../inspector/virt-inspector.pod:290
19863 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
19864 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
19865 "very large and high quality."
19869 #: ../inspector/virt-inspector.pod:294
19872 " <operatingsystems>\n"
19873 " <operatingsystem>\n"
19876 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
19877 " [... many lines of base64 data ...]\n"
19883 #: ../inspector/virt-inspector.pod:302
19885 "To display the icon, you have to extract it and convert the base64 data back "
19886 "to a binary file. Use an XPath query or simply an editor to extract the "
19887 "data, then use the coreutils L<base64(1)> program to do the conversion back "
19892 #: ../inspector/virt-inspector.pod:307
19895 " base64 -i -d < icon.data > icon.png\n"
19900 #: ../inspector/virt-inspector.pod:309
19901 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
19905 #: ../inspector/virt-inspector.pod:311
19907 "Virt-inspector can detect some operating system installers on install disks, "
19908 "live CDs, bootable USB keys and more."
19912 #: ../inspector/virt-inspector.pod:314
19914 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
19915 "fields may be present to indicate a live CD, network installer, or one part "
19916 "of a multipart CD. For example:"
19920 #: ../inspector/virt-inspector.pod:318
19923 " <operatingsystems>\n"
19924 " <operatingsystem>\n"
19925 " <root>/dev/sda</root>\n"
19926 " <name>linux</name>\n"
19927 " <arch>i386</arch>\n"
19928 " <distro>ubuntu</distro>\n"
19929 " <product_name>Ubuntu 10.10 "Maverick Meerkat"</product_name>\n"
19930 " <major_version>10</major_version>\n"
19931 " <minor_version>10</minor_version>\n"
19932 " <format>installer</format>\n"
19938 #: ../inspector/virt-inspector.pod:330
19939 msgid "USING XPATH"
19943 #: ../inspector/virt-inspector.pod:332
19945 "You can use the XPath query language to select parts of the XML. We "
19946 "recommend using C<xmlstarlet> to perform XPath queries from the command line."
19950 #: ../inspector/virt-inspector.pod:338
19953 " $ virt-inspector -d Guest | xmlstarlet sel -t -c '//filesystems'\n"
19955 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19956 " <type>ext4</type>\n"
19962 #: ../inspector/virt-inspector.pod:344
19965 " $ virt-inspector -d Guest | \\\n"
19966 " xmlstarlet sel -t -c \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
19972 #: ../inspector/virt-inspector.pod:348
19975 " $ virt-inspector -d Guest | \\\n"
19976 " xmlstarlet sel -t -v '//icon' | base64 -i -d | display -\n"
19977 " [displays the guest icon, if there is one]\n"
19982 #: ../inspector/virt-inspector.pod:359
19983 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
19987 #: ../inspector/virt-inspector.pod:361
19989 "Early versions of libguestfs shipped with a different virt-inspector program "
19990 "written in Perl (the current version is written in C). The XML output of "
19991 "the Perl virt-inspector was different and it could also output in other "
19992 "formats like text."
19996 #: ../inspector/virt-inspector.pod:366
19998 "The old virt-inspector is no longer supported or shipped with libguestfs."
20002 #: ../inspector/virt-inspector.pod:369
20004 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
20005 "versions of virt-inspector with different names:"
20009 #: ../inspector/virt-inspector.pod:372
20012 " virt-inspector Old Perl version.\n"
20013 " virt-inspector2 New C version.\n"
20018 #: ../inspector/virt-inspector.pod:382
20020 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, L<base64(1)"
20021 ">, L<xmlstarlet(1)>, L<http://libguestfs.org/>."
20025 #: ../inspector/virt-inspector.pod:399
20026 msgid "Matthew Booth L<mbooth@redhat.com>"
20030 #: ../java/examples/guestfs-java.pod:5
20031 msgid "guestfs-java - How to use libguestfs from Java"
20035 #: ../java/examples/guestfs-java.pod:9
20038 " import com.redhat.et.libguestfs.*;\n"
20043 #: ../java/examples/guestfs-java.pod:11
20046 " GuestFS g = new GuestFS ();\n"
20047 " g.add_drive_opts (\"disk.img\", null);\n"
20053 #: ../java/examples/guestfs-java.pod:17
20055 "This manual page documents how to call libguestfs from the Java programming "
20056 "language. This page just documents the differences from the C API and gives "
20057 "some examples. If you are not familiar with using libguestfs, you also need "
20058 "to read L<guestfs(3)>."
20062 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
20063 msgid "CLOSING THE HANDLE"
20067 #: ../java/examples/guestfs-java.pod:24
20069 "The handle is closed when it is reaped by the garbage collector. Because "
20070 "libguestfs handles include a lot of state, it is also possible to close (and "
20071 "hence free) them explicitly by calling the C<close> method."
20075 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60
20076 #: ../python/examples/guestfs-python.pod:21
20077 #: ../ruby/examples/guestfs-ruby.pod:22
20082 #: ../java/examples/guestfs-java.pod:31
20084 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
20085 "exception. This has a single parameter which is the error message (a "
20090 #: ../java/examples/guestfs-java.pod:35
20091 msgid "Calling any method on a closed handle raises the same exception."
20095 #: ../java/examples/guestfs-java.pod:47
20097 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)"
20098 ">, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
20099 "libguestfs.org/>, L<http://caml.inria.fr/>."
20103 #: ../java/examples/guestfs-java.pod:63 ../perl/examples/guestfs-perl.pod:57
20104 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
20108 #: ../ocaml/examples/guestfs-ocaml.pod:5
20109 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
20113 #: ../ocaml/examples/guestfs-ocaml.pod:9
20114 msgid "Module style:"
20118 #: ../ocaml/examples/guestfs-ocaml.pod:11
20121 " let g = Guestfs.create () in\n"
20122 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
20123 " Guestfs.launch g;\n"
20128 #: ../ocaml/examples/guestfs-ocaml.pod:15
20129 msgid "Object-oriented style:"
20133 #: ../ocaml/examples/guestfs-ocaml.pod:17
20136 " let g = new Guestfs.guestfs () in\n"
20137 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
20143 #: ../ocaml/examples/guestfs-ocaml.pod:21
20146 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
20148 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
20153 #: ../ocaml/examples/guestfs-ocaml.pod:27
20155 "This manual page documents how to call libguestfs from the OCaml programming "
20156 "language. This page just documents the differences from the C API and gives "
20157 "some examples. If you are not familiar with using libguestfs, you also need "
20158 "to read L<guestfs(3)>."
20162 #: ../ocaml/examples/guestfs-ocaml.pod:32
20163 msgid "PROGRAMMING STYLES"
20167 #: ../ocaml/examples/guestfs-ocaml.pod:34
20169 "There are two different programming styles supported by the OCaml bindings. "
20170 "You can use a module style, with each C function mapped to an OCaml function:"
20174 #: ../ocaml/examples/guestfs-ocaml.pod:38
20177 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
20182 #: ../ocaml/examples/guestfs-ocaml.pod:40
20187 #: ../ocaml/examples/guestfs-ocaml.pod:42
20190 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
20195 #: ../ocaml/examples/guestfs-ocaml.pod:44
20197 "Alternately you can use an object-oriented style, calling methods on the "
20198 "class C<Guestfs.guestfs>:"
20202 #: ../ocaml/examples/guestfs-ocaml.pod:47
20205 " method set_verbose : bool -> unit\n"
20210 #: ../ocaml/examples/guestfs-ocaml.pod:49
20212 "The object-oriented style is usually briefer, and the minor performance "
20213 "penalty isn't noticable in the general overhead of performing libguestfs "
20218 #: ../ocaml/examples/guestfs-ocaml.pod:55
20220 "The handle is closed when it is reaped by the garbage collector. Because "
20221 "libguestfs handles include a lot of state, it is also possible to close (and "
20222 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
20227 #: ../ocaml/examples/guestfs-ocaml.pod:62
20229 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
20230 "exception. This has a single parameter which is the error message (a "
20235 #: ../ocaml/examples/guestfs-ocaml.pod:66
20237 "Calling any function/method on a closed handle raises C<Guestfs."
20238 "Handle_closed>. The single parameter is the name of the function that you "
20243 #: ../ocaml/examples/guestfs-ocaml.pod:80
20245 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-perl(3)"
20246 ">, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
20247 "libguestfs.org/>, L<http://caml.inria.fr/>."
20251 #: ../perl/examples/guestfs-perl.pod:5
20252 msgid "guestfs-perl - How to use libguestfs from Perl"
20256 #: ../perl/examples/guestfs-perl.pod:9
20259 " use Sys::Guestfs;\n"
20264 #: ../perl/examples/guestfs-perl.pod:11
20267 " my $h = Sys::Guestfs->new ();\n"
20268 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
20269 " $h->launch ();\n"
20270 " $h->mount_options ('', '/dev/sda1', '/');\n"
20271 " $h->touch ('/hello');\n"
20277 #: ../perl/examples/guestfs-perl.pod:20
20279 "This manual page documents how to call libguestfs from the Perl programming "
20280 "language. This page just documents the differences from the C API and gives "
20281 "some examples. If you are not familiar with using libguestfs, you also need "
20282 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
20286 #: ../perl/examples/guestfs-perl.pod:26
20291 #: ../perl/examples/guestfs-perl.pod:28
20293 "Errors from libguestfs functions turn into calls to C<croak> (see L<Carp(3)"
20298 #: ../perl/examples/guestfs-perl.pod:41
20300 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)"
20301 ">, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
20302 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
20306 #: ../python/examples/guestfs-python.pod:5
20307 msgid "guestfs-python - How to use libguestfs from Python"
20311 #: ../python/examples/guestfs-python.pod:9
20314 " import guestfs\n"
20315 " g = guestfs.GuestFS ()\n"
20316 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
20322 #: ../python/examples/guestfs-python.pod:16
20324 "This manual page documents how to call libguestfs from the Python "
20325 "programming language. This page just documents the differences from the C "
20326 "API and gives some examples. If you are not familiar with using libguestfs, "
20327 "you also need to read L<guestfs(3)>."
20331 #: ../python/examples/guestfs-python.pod:23
20333 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
20334 "single string argument which is the error message."
20338 #: ../python/examples/guestfs-python.pod:26
20339 msgid "MORE DOCUMENTATION"
20343 #: ../python/examples/guestfs-python.pod:28
20348 #: ../python/examples/guestfs-python.pod:30
20352 " >>> import guestfs\n"
20353 " >>> help (guestfs)\n"
20358 #: ../python/examples/guestfs-python.pod:44
20360 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
20361 ">, L<guestfs-perl(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
20362 "libguestfs.org/>."
20366 #: ../rescue/virt-rescue.pod:5
20367 msgid "virt-rescue - Run a rescue shell on a virtual machine"
20371 #: ../rescue/virt-rescue.pod:9
20374 " virt-rescue [--options] -d domname\n"
20379 #: ../rescue/virt-rescue.pod:11
20382 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
20387 #: ../rescue/virt-rescue.pod:15
20390 " virt-rescue [--options] domname\n"
20395 #: ../rescue/virt-rescue.pod:17
20398 " virt-rescue [--options] disk.img [disk.img ...]\n"
20403 #: ../rescue/virt-rescue.pod:21
20405 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
20406 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
20407 "you from doing this, but doesn't catch all cases."
20411 #: ../rescue/virt-rescue.pod:25
20413 "However if you use the I<--ro> (read only) option, then you can attach a "
20414 "shell to a live virtual machine. The results might be strange or "
20415 "inconsistent at times but you won't get disk corruption."
20419 #: ../rescue/virt-rescue.pod:31
20421 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
20422 "need for a CD. virt-rescue gives you a rescue shell and some simple "
20423 "recovery tools which you can use to examine or rescue a virtual machine or "
20428 #: ../rescue/virt-rescue.pod:36
20430 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
20431 "on disk image(s):"
20435 #: ../rescue/virt-rescue.pod:39
20438 " virt-rescue -d GuestName\n"
20443 #: ../rescue/virt-rescue.pod:41
20446 " virt-rescue --ro -a /path/to/disk.img\n"
20451 #: ../rescue/virt-rescue.pod:43
20454 " virt-rescue -a /dev/sdc\n"
20459 #: ../rescue/virt-rescue.pod:45
20460 msgid "For live VMs you I<must> use the --ro option."
20464 #: ../rescue/virt-rescue.pod:47
20466 "When you run virt-rescue on a virtual machine or disk image, you are placed "
20467 "in an interactive bash shell where you can use many ordinary Linux "
20468 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
20469 "appliance. You must mount the virtual machine's filesystems by hand. There "
20470 "is an empty directory called C</sysroot> where you can mount filesystems."
20474 #: ../rescue/virt-rescue.pod:54
20476 "In the example below, we list logical volumes, then choose one to mount "
20477 "under C</sysroot>:"
20481 #: ../rescue/virt-rescue.pod:57
20485 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
20486 " lv_root vg_f11x64 -wi-a- 8.83G\n"
20487 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
20488 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
20489 " ><rescue> ls /sysroot\n"
20494 #: ../rescue/virt-rescue.pod:64
20496 "If you don't know what filesystems are available on the virtual machine then "
20497 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
20501 #: ../rescue/virt-rescue.pod:70
20503 "Virt-rescue can be used on I<any> disk image file or device, not just a "
20504 "virtual machine. For example you can use it on a blank file if you want to "
20505 "partition that file (although we would recommend using L<guestfish(1)> "
20506 "instead as it is more suitable for this purpose). You can even use virt-"
20507 "rescue on things like SD cards."
20511 #: ../rescue/virt-rescue.pod:76
20513 "Virt-rescue does not require root. You only need to run it as root if you "
20514 "need root to open the disk image."
20518 #: ../rescue/virt-rescue.pod:79
20520 "This tool is just designed for quick interactive hacking on a virtual "
20521 "machine. For more structured access to a virtual machine disk image, you "
20522 "should use L<guestfs(3)>. To get a structured shell that you can use to "
20523 "make scripted changes to guests, use L<guestfish(1)>."
20527 #: ../rescue/virt-rescue.pod:103
20528 msgid "B<--append kernelopts>"
20532 #: ../rescue/virt-rescue.pod:105
20533 msgid "Pass additional options to the rescue kernel."
20537 #: ../rescue/virt-rescue.pod:135
20540 " virt-rescue --format=raw -a disk.img\n"
20545 #: ../rescue/virt-rescue.pod:139
20548 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
20553 #: ../rescue/virt-rescue.pod:148
20558 #: ../rescue/virt-rescue.pod:150
20559 msgid "B<--memsize MB>"
20563 #: ../rescue/virt-rescue.pod:152
20565 "Change the amount of memory allocated to the rescue system. The default is "
20566 "set by libguestfs and is small but adequate for running system tools. The "
20567 "occasional program might need more memory. The parameter is specified in "
20572 #: ../rescue/virt-rescue.pod:157
20573 msgid "B<--network>"
20577 #: ../rescue/virt-rescue.pod:159
20578 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
20582 #: ../rescue/virt-rescue.pod:165
20583 msgid "Open the image read-only."
20587 #: ../rescue/virt-rescue.pod:175
20589 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
20590 "SELINUX> before using this option."
20594 #: ../rescue/virt-rescue.pod:194
20596 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
20597 "are done read-write."
20601 #: ../rescue/virt-rescue.pod:207
20602 msgid "Previous versions of virt-rescue allowed you to write either:"
20606 #: ../rescue/virt-rescue.pod:209
20609 " virt-rescue disk.img [disk.img ...]\n"
20614 #: ../rescue/virt-rescue.pod:213
20617 " virt-rescue guestname\n"
20622 #: ../rescue/virt-rescue.pod:221
20627 #: ../rescue/virt-rescue.pod:223
20629 "Adding the I<--network> option enables QEMU user networking in the rescue "
20630 "appliance. There are some differences between user networking and ordinary "
20635 #: ../rescue/virt-rescue.pod:229
20636 msgid "ping does not work"
20640 #: ../rescue/virt-rescue.pod:231
20642 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
20643 "send the ping packets, and because virt-rescue must be able to run as non-"
20644 "root, QEMU user networking is not able to emulate the L<ping(8)> command. "
20645 "The ping command will appear to resolve addresses but will not be able to "
20646 "send or receive any packets. This does not mean that the network is not "
20651 #: ../rescue/virt-rescue.pod:238
20652 msgid "cannot receive connections"
20656 #: ../rescue/virt-rescue.pod:240
20657 msgid "QEMU user networking cannot receive incoming connections."
20661 #: ../rescue/virt-rescue.pod:242
20662 msgid "making TCP connections"
20666 #: ../rescue/virt-rescue.pod:244
20668 "The virt-rescue appliance needs to be small and so does not include many "
20669 "network tools. In particular there is no L<telnet(1)> command. You can "
20670 "make TCP connections from the shell using the magical C</dev/tcp/"
20671 "E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
20675 #: ../rescue/virt-rescue.pod:249
20678 " exec 3<>/dev/tcp/redhat.com/80\n"
20679 " echo \"GET /\" >&3\n"
20685 #: ../rescue/virt-rescue.pod:253
20686 msgid "See L<bash(1)> for more details."
20690 #: ../rescue/virt-rescue.pod:259
20692 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
20693 "ENVIRONMENT VARIABLES> for the complete list."
20697 #: ../rescue/virt-rescue.pod:286
20699 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<http://"
20700 "libguestfs.org/>."
20704 #: ../resize/virt-resize.pod:5
20705 msgid "virt-resize - Resize a virtual machine disk"
20709 #: ../resize/virt-resize.pod:9
20712 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
20713 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
20714 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
20719 #: ../resize/virt-resize.pod:15
20721 "Virt-resize is a tool which can resize a virtual machine disk, making it "
20722 "larger or smaller overall, and resizing or deleting any partitions contained "
20727 #: ../resize/virt-resize.pod:19
20729 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
20730 "not> be used on live virtual machines - for consistent results, shut the "
20731 "virtual machine down before resizing it."
20735 #: ../resize/virt-resize.pod:23
20737 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
20738 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
20742 #: ../resize/virt-resize.pod:31 ../resize/virt-resize.pod:520
20743 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1396
20744 #: ../src/guestfs.pod:2481
20749 #: ../resize/virt-resize.pod:33
20751 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
20752 "fill the extra 5GB of space."
20756 #: ../resize/virt-resize.pod:36
20759 " virt-filesystems --long -h --all -a olddisk\n"
20764 #: ../resize/virt-resize.pod:38
20767 " truncate -r olddisk newdisk\n"
20768 " truncate -s +5G newdisk\n"
20773 #: ../resize/virt-resize.pod:41
20776 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
20777 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
20782 #: ../resize/virt-resize.pod:44 ../resize/virt-resize.pod:527
20783 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1400
20784 #: ../src/guestfs.pod:2506
20789 #: ../resize/virt-resize.pod:46
20791 "As above, but make the /boot partition 200MB bigger, while giving the "
20792 "remaining space to /dev/sda2:"
20796 #: ../resize/virt-resize.pod:49
20799 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20800 " olddisk newdisk\n"
20805 #: ../resize/virt-resize.pod:52 ../resize/virt-resize.pod:533
20806 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1406
20811 #: ../resize/virt-resize.pod:54
20813 "As in the first example, but expand a logical volume as the final step. "
20814 "This is what you would typically use for Linux guests that use LVM:"
20818 #: ../resize/virt-resize.pod:58
20821 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
20822 " olddisk newdisk\n"
20827 #: ../resize/virt-resize.pod:61
20832 #: ../resize/virt-resize.pod:63
20834 "As in the first example, but the output format will be qcow2 instead of a "
20839 #: ../resize/virt-resize.pod:66
20842 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
20843 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
20848 #: ../resize/virt-resize.pod:71
20849 msgid "DETAILED USAGE"
20853 #: ../resize/virt-resize.pod:73
20854 msgid "EXPANDING A VIRTUAL MACHINE DISK"
20858 #: ../resize/virt-resize.pod:77
20859 msgid "1. Shut down the virtual machine"
20863 #: ../resize/virt-resize.pod:79
20864 msgid "2. Locate input disk image"
20868 #: ../resize/virt-resize.pod:81
20870 "Locate the input disk image (ie. the file or device on the host containing "
20871 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
20872 "dumpxml> like this to find the disk image name:"
20876 #: ../resize/virt-resize.pod:85
20879 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
20880 " Found 1 nodes:\n"
20882 " <source dev=\"/dev/vg/lv_guest\" />\n"
20887 #: ../resize/virt-resize.pod:90
20888 msgid "3. Look at current sizing"
20892 #: ../resize/virt-resize.pod:92
20893 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
20897 #: ../resize/virt-resize.pod:95
20900 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
20901 " Name Type Size Parent\n"
20902 " /dev/sda1 partition 101M /dev/sda\n"
20903 " /dev/sda2 partition 7.9G /dev/sda\n"
20904 " /dev/sda device 8.0G -\n"
20909 #: ../resize/virt-resize.pod:101
20911 "(This example is a virtual machine with an 8 GB disk which we would like to "
20912 "expand up to 10 GB)."
20916 #: ../resize/virt-resize.pod:104
20917 msgid "4. Create output disk"
20921 #: ../resize/virt-resize.pod:106
20923 "Virt-resize cannot do in-place disk modifications. You have to have space "
20924 "to store the resized output disk."
20928 #: ../resize/virt-resize.pod:109
20930 "To store the resized disk image in a file, create a file of a suitable size:"
20934 #: ../resize/virt-resize.pod:112
20937 " # rm -f outdisk\n"
20938 " # truncate -s 10G outdisk\n"
20943 #: ../resize/virt-resize.pod:115
20944 msgid "Or use L<lvcreate(1)> to create a logical volume:"
20948 #: ../resize/virt-resize.pod:117
20951 " # lvcreate -L 10G -n lv_name vg_name\n"
20956 #: ../resize/virt-resize.pod:119
20957 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
20961 #: ../resize/virt-resize.pod:121
20964 " # virsh pool-list\n"
20965 " # virsh vol-create-as poolname newvol 10G\n"
20970 #: ../resize/virt-resize.pod:124
20975 #: ../resize/virt-resize.pod:126
20977 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
20978 "file) and the output disk. The output disk is the one created in the "
20983 #: ../resize/virt-resize.pod:130
20986 " # virt-resize indisk outdisk\n"
20991 #: ../resize/virt-resize.pod:132
20993 "This command just copies disk image C<indisk> to disk image C<outdisk> "
20994 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
20995 "larger, then an extra, empty partition is created at the end of the disk "
20996 "covering the extra space. If C<outdisk> is smaller, then it will give an "
21001 #: ../resize/virt-resize.pod:138
21003 "More realistically you'd want to expand existing partitions in the disk "
21004 "image by passing extra options (for the full list see the L</OPTIONS> "
21009 #: ../resize/virt-resize.pod:142
21011 "L</--expand> is the most useful option. It expands the named partition "
21012 "within the disk to fill any extra space:"
21016 #: ../resize/virt-resize.pod:145
21019 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
21024 #: ../resize/virt-resize.pod:147
21026 "(In this case, an extra partition is I<not> created at the end of the disk, "
21027 "because there will be no unused space)."
21031 #: ../resize/virt-resize.pod:150
21033 "L</--resize> is the other commonly used option. The following would "
21034 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
21035 "rest of the available space:"
21039 #: ../resize/virt-resize.pod:154
21042 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
21043 " indisk outdisk\n"
21048 #: ../resize/virt-resize.pod:157
21050 "If the expanded partition in the image contains a filesystem or LVM PV, then "
21051 "if virt-resize knows how, it will resize the contents, the equivalent of "
21052 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
21053 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
21054 "filesystems, so you would have to online resize them after booting the guest."
21058 #: ../resize/virt-resize.pod:164
21059 msgid "Other options are covered below."
21063 #: ../resize/virt-resize.pod:166
21068 #: ../resize/virt-resize.pod:168
21069 msgid "Thoroughly test the new disk image I<before> discarding the old one."
21073 #: ../resize/virt-resize.pod:170
21074 msgid "If you are using libvirt, edit the XML to point at the new disk:"
21078 #: ../resize/virt-resize.pod:172
21081 " # virsh edit guestname\n"
21086 #: ../resize/virt-resize.pod:174
21088 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
21089 "html#elementsDisks>"
21093 #: ../resize/virt-resize.pod:177
21094 msgid "Then start up the domain with the new, resized disk:"
21098 #: ../resize/virt-resize.pod:179
21101 " # virsh start guestname\n"
21106 #: ../resize/virt-resize.pod:181
21108 "and check that it still works. See also the L</NOTES> section below for "
21109 "additional information."
21113 #: ../resize/virt-resize.pod:184
21114 msgid "7. Resize LVs etc inside the guest"
21118 #: ../resize/virt-resize.pod:186
21119 msgid "(This can also be done offline using L<guestfish(1)>)"
21123 #: ../resize/virt-resize.pod:188
21125 "Once the guest has booted you should see the new space available, at least "
21126 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
21127 "may need to resize LVs inside PVs, and also resize filesystem types that "
21128 "virt-resize does not know how to expand."
21132 #: ../resize/virt-resize.pod:195
21133 msgid "SHRINKING A VIRTUAL MACHINE DISK"
21137 #: ../resize/virt-resize.pod:197
21139 "Shrinking is somewhat more complex than expanding, and only an overview is "
21144 #: ../resize/virt-resize.pod:200
21146 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
21147 "filesystems). The user has to shrink content before passing the disk image "
21148 "to virt-resize, and virt-resize will check that the content has been shrunk "
21153 #: ../resize/virt-resize.pod:205
21154 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
21158 #: ../resize/virt-resize.pod:207
21160 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
21161 "steps 3 and 4 above to allocate a new disk image."
21165 #: ../resize/virt-resize.pod:210
21167 "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
21171 #: ../resize/virt-resize.pod:213
21172 msgid "IGNORING OR DELETING PARTITIONS"
21176 #: ../resize/virt-resize.pod:215
21178 "virt-resize also gives a convenient way to ignore or delete partitions when "
21179 "copying from the input disk to the output disk. Ignoring a partition speeds "
21180 "up the copy where you don't care about the existing contents of a "
21181 "partition. Deleting a partition removes it completely, but note that it "
21182 "also renumbers any partitions after the one which is deleted, which can "
21183 "leave some guests unbootable."
21187 #: ../resize/virt-resize.pod:222
21188 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
21192 #: ../resize/virt-resize.pod:224
21194 "If the input disk is in qcow2 format, then you may prefer that the output is "
21195 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
21196 "the fly. The output format is simply determined by the format of the empty "
21197 "output container that you provide. Thus to create qcow2 output, use:"
21201 #: ../resize/virt-resize.pod:230
21204 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
21209 #: ../resize/virt-resize.pod:232
21210 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
21214 #: ../resize/virt-resize.pod:234
21215 msgid "Similarly, to get non-sparse raw output use:"
21219 #: ../resize/virt-resize.pod:236
21222 " fallocate -l size outdisk\n"
21227 #: ../resize/virt-resize.pod:238
21229 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
21230 "dev/zero of=outdisk bs=1M count=..>)"
21234 #: ../resize/virt-resize.pod:247
21235 msgid "Display help."
21239 #: ../resize/virt-resize.pod:249
21244 #: ../resize/virt-resize.pod:251 ../tools/virt-make-fs.pl:177
21245 #: ../tools/virt-win-reg.pl:120
21250 #: ../resize/virt-resize.pod:253 ../tools/virt-win-reg.pl:122
21251 msgid "Enable debugging messages."
21255 #: ../resize/virt-resize.pod:255
21256 msgid "B<--delete part>"
21260 #: ../resize/virt-resize.pod:257
21262 "Delete the named partition. It would be more accurate to describe this as "
21263 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
21264 "the original disk image is left intact."
21268 #: ../resize/virt-resize.pod:261
21270 "Note that when you delete a partition, then anything contained in the "
21271 "partition is also deleted. Furthermore, this causes any partitions that "
21272 "come after to be I<renumbered>, which can easily make your guest unbootable."
21276 #: ../resize/virt-resize.pod:266 ../resize/virt-resize.pod:327
21277 #: ../resize/virt-resize.pod:454
21278 msgid "You can give this option multiple times."
21282 #: ../resize/virt-resize.pod:268
21283 msgid "B<--expand part>"
21287 #: ../resize/virt-resize.pod:270
21289 "Expand the named partition so it uses up all extra space (space left over "
21290 "after any other resize changes that you request have been done)."
21294 #: ../resize/virt-resize.pod:273
21296 "If virt-resize knows how, it will expand the direct content of the "
21297 "partition. For example, if the partition is an LVM PV, it will expand the "
21298 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
21299 "content it doesn't know about alone."
21303 #: ../resize/virt-resize.pod:278
21304 msgid "Currently virt-resize can resize:"
21308 #: ../resize/virt-resize.pod:284
21309 msgid "ext2, ext3 and ext4 filesystems."
21313 #: ../resize/virt-resize.pod:288
21314 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
21318 #: ../resize/virt-resize.pod:290
21320 "The filesystem must have been shut down consistently last time it was used. "
21321 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
21322 "consistency check, so at the first boot after resizing Windows will check "
21327 #: ../resize/virt-resize.pod:297
21329 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
21330 "inside the PV, but see the I<--LV-expand> option. The user could also "
21331 "resize LVs as desired after boot."
21335 #: ../resize/virt-resize.pod:303
21336 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
21340 #: ../resize/virt-resize.pod:307 ../resize/virt-resize.pod:482
21341 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
21345 #: ../resize/virt-resize.pod:309 ../tools/virt-list-filesystems.pl:91
21346 #: ../tools/virt-list-partitions.pl:92 ../tools/virt-tar.pl:141
21347 #: ../tools/virt-win-reg.pl:142
21348 msgid "B<--format> raw"
21352 #: ../resize/virt-resize.pod:311
21354 "Specify the format of the input disk image. If this flag is not given then "
21355 "it is auto-detected from the image itself."
21359 #: ../resize/virt-resize.pod:317
21361 "Note that this option I<does not> affect the output format. See L</QCOW2 "
21362 "AND NON-SPARSE RAW FORMATS>."
21366 #: ../resize/virt-resize.pod:320
21367 msgid "B<--ignore part>"
21371 #: ../resize/virt-resize.pod:322
21373 "Ignore the named partition. Effectively this means the partition is "
21374 "allocated on the destination disk, but the content is not copied across from "
21375 "the source disk. The content of the partition will be blank (all zero "
21380 #: ../resize/virt-resize.pod:329
21381 msgid "B<--LV-expand logvol>"
21385 #: ../resize/virt-resize.pod:331
21387 "This takes the logical volume and, as a final step, expands it to fill all "
21388 "the space available in its volume group. A typical usage, assuming a Linux "
21389 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
21390 "lv_root> would be:"
21394 #: ../resize/virt-resize.pod:336
21397 " virt-resize indisk outdisk \\\n"
21398 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
21403 #: ../resize/virt-resize.pod:339
21405 "This would first expand the partition (and PV), and then expand the root "
21406 "device to fill the extra space in the PV."
21410 #: ../resize/virt-resize.pod:342
21412 "The contents of the LV are also resized if virt-resize knows how to do "
21413 "that. You can stop virt-resize from trying to expand the content by using "
21414 "the option I<--no-expand-content>."
21418 #: ../resize/virt-resize.pod:346
21419 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
21423 #: ../resize/virt-resize.pod:348
21425 "You can give this option multiple times, I<but> it doesn't make sense to do "
21426 "this unless the logical volumes you specify are all in different volume "
21431 #: ../resize/virt-resize.pod:352
21432 msgid "B<--machine-readable>"
21436 #: ../resize/virt-resize.pod:354
21438 "This option is used to make the output more machine friendly when being "
21439 "parsed by other programs. See L</MACHINE READABLE OUTPUT> below."
21443 #: ../resize/virt-resize.pod:360
21444 msgid "B<--dryrun>"
21448 #: ../resize/virt-resize.pod:362
21449 msgid "Print a summary of what would be done, but don't do anything."
21453 #: ../resize/virt-resize.pod:364
21454 msgid "B<--no-copy-boot-loader>"
21458 #: ../resize/virt-resize.pod:366
21460 "By default, virt-resize copies over some sectors at the start of the disk "
21461 "(up to the beginning of the first partition). Commonly these sectors "
21462 "contain the Master Boot Record (MBR) and the boot loader, and are required "
21463 "in order for the guest to boot correctly."
21467 #: ../resize/virt-resize.pod:371
21469 "If you specify this flag, then this initial copy is not done. You may need "
21470 "to reinstall the boot loader in this case."
21474 #: ../resize/virt-resize.pod:374
21475 msgid "B<--no-extra-partition>"
21479 #: ../resize/virt-resize.pod:376
21481 "By default, virt-resize creates an extra partition if there is any extra, "
21482 "unused space after all resizing has happened. Use this option to prevent "
21483 "the extra partition from being created. If you do this then the extra space "
21484 "will be inaccessible until you run fdisk, parted, or some other partitioning "
21485 "tool in the guest."
21489 #: ../resize/virt-resize.pod:382
21491 "Note that if the surplus space is smaller than 10 MB, no extra partition "
21496 #: ../resize/virt-resize.pod:385
21497 msgid "B<--no-expand-content>"
21501 #: ../resize/virt-resize.pod:387
21503 "By default, virt-resize will try to expand the direct contents of "
21504 "partitions, if it knows how (see I<--expand> option above)."
21508 #: ../resize/virt-resize.pod:390
21510 "If you give the I<--no-expand-content> option then virt-resize will not "
21515 #: ../resize/virt-resize.pod:393
21516 msgid "B<--ntfsresize-force>"
21520 #: ../resize/virt-resize.pod:395
21522 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
21523 "the NTFS disk is marked as needing a consistency check. You have to use "
21524 "this option if you want to resize a Windows guest multiple times without "
21525 "booting into Windows between each resize."
21529 #: ../resize/virt-resize.pod:401
21530 msgid "B<--output-format> raw"
21534 #: ../resize/virt-resize.pod:403
21536 "Specify the format of the output disk image. If this flag is not given then "
21537 "it is auto-detected from the image itself."
21541 #: ../resize/virt-resize.pod:409
21543 "Note that this option I<does not create> the output format. This option "
21544 "just tells libguestfs what it is so it doesn't try to guess it. You still "
21545 "need to create the output disk with the right format. See L</QCOW2 AND NON-"
21546 "SPARSE RAW FORMATS>."
21550 #: ../resize/virt-resize.pod:414
21555 #: ../resize/virt-resize.pod:416
21560 #: ../resize/virt-resize.pod:418
21561 msgid "Don't print the summary."
21565 #: ../resize/virt-resize.pod:420
21566 msgid "B<--resize part=size>"
21570 #: ../resize/virt-resize.pod:422
21572 "Resize the named partition (expanding or shrinking it) so that it has the "
21577 #: ../resize/virt-resize.pod:425
21579 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
21580 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
21581 "size; or as a relative number or percentage. For example:"
21585 #: ../resize/virt-resize.pod:431
21588 " --resize /dev/sda2=10G\n"
21593 #: ../resize/virt-resize.pod:433
21596 " --resize /dev/sda4=90%\n"
21601 #: ../resize/virt-resize.pod:435
21604 " --resize /dev/sda2=+1G\n"
21609 #: ../resize/virt-resize.pod:437
21612 " --resize /dev/sda2=-200M\n"
21617 #: ../resize/virt-resize.pod:439
21620 " --resize /dev/sda1=+128K\n"
21625 #: ../resize/virt-resize.pod:441
21628 " --resize /dev/sda1=+10%\n"
21633 #: ../resize/virt-resize.pod:443
21636 " --resize /dev/sda1=-10%\n"
21641 #: ../resize/virt-resize.pod:445
21643 "You can increase the size of any partition. Virt-resize will expand the "
21644 "direct content of the partition if it knows how (see I<--expand> below)."
21648 #: ../resize/virt-resize.pod:449
21650 "You can only I<decrease> the size of partitions that contain filesystems or "
21651 "PVs which have already been shrunk. Virt-resize will check this has been "
21652 "done before proceeding, or else will print an error (see also I<--resize-"
21657 #: ../resize/virt-resize.pod:456
21658 msgid "B<--resize-force part=size>"
21662 #: ../resize/virt-resize.pod:458
21664 "This is the same as I<--resize> except that it will let you decrease the "
21665 "size of any partition. Generally this means you will lose any data which "
21666 "was at the end of the partition you shrink, but you may not care about that "
21667 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
21668 "as a swap partition)."
21672 #: ../resize/virt-resize.pod:464
21673 msgid "See also the I<--ignore> option."
21677 #: ../resize/virt-resize.pod:466
21678 msgid "B<--shrink part>"
21682 #: ../resize/virt-resize.pod:468
21684 "Shrink the named partition until the overall disk image fits in the "
21685 "destination. The named partition B<must> contain a filesystem or PV which "
21686 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
21687 "online tools). Virt-resize will check this and give an error if it has not "
21692 #: ../resize/virt-resize.pod:474
21694 "The amount by which the overall disk must be shrunk (after carrying out all "
21695 "other operations requested by the user) is called the \"deficit\". For "
21696 "example, a straight copy (assume no other operations) from a 5GB disk image "
21697 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
21698 "would give an error unless the user specified a partition to shrink and that "
21699 "partition had more than a gigabyte of free space."
21703 #: ../resize/virt-resize.pod:492
21704 msgid "MACHINE READABLE OUTPUT"
21708 #: ../resize/virt-resize.pod:494
21710 "The I<--machine-readable> option can be used to make the output more machine "
21711 "friendly, which is useful when calling virt-resize from other programs, GUIs "
21716 #: ../resize/virt-resize.pod:498
21717 msgid "There are two ways to use this option."
21721 #: ../resize/virt-resize.pod:500
21723 "Firstly use the option on its own to query the capabilities of the virt-"
21724 "resize binary. Typical output looks like this:"
21728 #: ../resize/virt-resize.pod:503
21731 " $ virt-resize --machine-readable\n"
21733 " ntfsresize-force\n"
21741 #: ../resize/virt-resize.pod:510
21743 "A list of features is printed, one per line, and the program exits with "
21748 #: ../resize/virt-resize.pod:513
21750 "Secondly use the option in conjunction with other options to make the "
21751 "regular program output more machine friendly."
21755 #: ../resize/virt-resize.pod:516
21756 msgid "At the moment this means:"
21760 #: ../resize/virt-resize.pod:522
21762 "Progress bar messages can be parsed from stdout by looking for this regular "
21767 #: ../resize/virt-resize.pod:525
21770 " ^[0-9]+/[0-9]+$\n"
21775 #: ../resize/virt-resize.pod:529
21777 "The calling program should treat messages sent to stdout (except for "
21778 "progress bar messages) as status messages. They can be logged and/or "
21779 "displayed to the user."
21783 #: ../resize/virt-resize.pod:535
21785 "The calling program should treat messages sent to stderr as error messages. "
21786 "In addition, virt-resize exits with a non-zero status code if there was a "
21791 #: ../resize/virt-resize.pod:541
21793 "Versions of the program prior to 1.13.9 did not support the I<--machine-"
21794 "readable> option and will return an error."
21798 #: ../resize/virt-resize.pod:546
21799 msgid "\"Partition 1 does not end on cylinder boundary.\""
21803 #: ../resize/virt-resize.pod:548
21805 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
21806 "means the partitions will not be aligned to the ancient CHS geometry. "
21807 "However CHS geometry is meaningless for disks manufactured since the early "
21808 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
21809 "cylinders is not required by any modern operating system."
21813 #: ../resize/virt-resize.pod:555
21814 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
21818 #: ../resize/virt-resize.pod:557
21820 "In Windows Vista and later versions, Microsoft switched to using a separate "
21821 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
21822 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
21823 "the boot partition. Doing so seems to break the guest completely. However "
21824 "expanding the second partition (ie. C: drive) should work."
21828 #: ../resize/virt-resize.pod:564
21830 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
21831 "NTFS partitions have been expanded. This is just a safety check and (unless "
21832 "it find errors) is nothing to worry about."
21836 #: ../resize/virt-resize.pod:568
21837 msgid "GUEST BOOT STUCK AT \"GRUB\""
21841 #: ../resize/virt-resize.pod:570
21843 "If a Linux guest does not boot after resizing, and the boot is stuck after "
21844 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
21845 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
21846 "although we think is to do with partition alignment."
21850 #: ../resize/virt-resize.pod:575
21853 " guestfish -i -a newdisk\n"
21854 " ><fs> cat /boot/grub/device.map\n"
21855 " # check the contents of this file are sensible or\n"
21856 " # edit the file if necessary\n"
21857 " ><fs> grub-install / /dev/vda\n"
21863 #: ../resize/virt-resize.pod:582
21865 "For more flexible guest reconfiguration, including if you need to specify "
21866 "other parameters to grub-install, use L<virt-rescue(1)>."
21870 #: ../resize/virt-resize.pod:585
21871 msgid "ALTERNATIVE TOOLS"
21875 #: ../resize/virt-resize.pod:587
21877 "There are several proprietary tools for resizing partitions. We won't "
21878 "mention any here."
21882 #: ../resize/virt-resize.pod:590
21884 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
21885 "operations on disk images. They can resize and move partitions, but I don't "
21886 "think they can do anything with the contents, and they certainly don't "
21891 #: ../resize/virt-resize.pod:595
21893 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
21894 "but at a much lower level. You will probably end up hand-calculating sector "
21895 "offsets, which is something that virt-resize was designed to avoid. If you "
21896 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
21901 #: ../resize/virt-resize.pod:615
21903 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
21904 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
21905 "L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, "
21906 "L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, L<http://libguestfs.org/>."
21910 #: ../ruby/examples/guestfs-ruby.pod:5
21911 msgid "guestfs-ruby - How to use libguestfs from Ruby"
21915 #: ../ruby/examples/guestfs-ruby.pod:9
21918 " require 'guestfs'\n"
21919 " g = Guestfs::Guestfs.new()\n"
21920 " g.add_drive_opts(\"disk.img\",\n"
21921 " :readonly => 1, :format => \"raw\")\n"
21927 #: ../ruby/examples/guestfs-ruby.pod:17
21929 "This manual page documents how to call libguestfs from the Ruby programming "
21930 "language. This page just documents the differences from the C API and gives "
21931 "some examples. If you are not familiar with using libguestfs, you also need "
21932 "to read L<guestfs(3)>."
21936 #: ../ruby/examples/guestfs-ruby.pod:24
21938 "Errors from libguestfs functions are mapped into the C<Error> exception. "
21939 "This has a single parameter which is the error message (a string)."
21943 #: ../ruby/examples/guestfs-ruby.pod:38
21945 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
21946 ">, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<http://"
21947 "libguestfs.org/>."
21951 #: ../src/guestfs-actions.pod:1
21952 msgid "guestfs_add_cdrom"
21956 #: ../src/guestfs-actions.pod:3
21960 " guestfs_add_cdrom (guestfs_h *g,\n"
21961 " const char *filename);\n"
21966 #: ../src/guestfs-actions.pod:7 ../src/guestfs-actions.pod:249
21967 #: ../src/guestfs-actions.pod:270
21969 "I<This function is deprecated.> In new code, use the L</"
21970 "guestfs_add_drive_opts> call instead."
21974 #: ../src/guestfs-actions.pod:24
21976 "This call checks for the existence of C<filename>. This stops you from "
21977 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21978 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
21983 #: ../src/guestfs-actions.pod:31
21985 "If you just want to add an ISO file (often you use this as an efficient way "
21986 "to transfer large files into the guest), then you should probably use "
21987 "C<guestfs_add_drive_ro> instead."
21991 #: ../src/guestfs-actions.pod:37 ../src/guestfs-actions.pod:140
21992 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
21993 #: ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:280
21994 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
21995 #: ../src/guestfs-actions.pod:427 ../src/guestfs-actions.pod:447
21996 #: ../src/guestfs-actions.pod:461 ../src/guestfs-actions.pod:506
21997 #: ../src/guestfs-actions.pod:534 ../src/guestfs-actions.pod:552
21998 #: ../src/guestfs-actions.pod:619 ../src/guestfs-actions.pod:652
21999 #: ../src/guestfs-actions.pod:666 ../src/guestfs-actions.pod:681
22000 #: ../src/guestfs-actions.pod:780 ../src/guestfs-actions.pod:798
22001 #: ../src/guestfs-actions.pod:812 ../src/guestfs-actions.pod:826
22002 #: ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:1046
22003 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1084
22004 #: ../src/guestfs-actions.pod:1168 ../src/guestfs-actions.pod:1186
22005 #: ../src/guestfs-actions.pod:1205 ../src/guestfs-actions.pod:1219
22006 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1309
22007 #: ../src/guestfs-actions.pod:1340 ../src/guestfs-actions.pod:1365
22008 #: ../src/guestfs-actions.pod:1407 ../src/guestfs-actions.pod:1520
22009 #: ../src/guestfs-actions.pod:1547 ../src/guestfs-actions.pod:1762
22010 #: ../src/guestfs-actions.pod:1784 ../src/guestfs-actions.pod:1871
22011 #: ../src/guestfs-actions.pod:2346 ../src/guestfs-actions.pod:2490
22012 #: ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2586
22013 #: ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3641
22014 #: ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:3855
22015 #: ../src/guestfs-actions.pod:3869 ../src/guestfs-actions.pod:3882
22016 #: ../src/guestfs-actions.pod:3896 ../src/guestfs-actions.pod:3911
22017 #: ../src/guestfs-actions.pod:3947 ../src/guestfs-actions.pod:4019
22018 #: ../src/guestfs-actions.pod:4039 ../src/guestfs-actions.pod:4056
22019 #: ../src/guestfs-actions.pod:4079 ../src/guestfs-actions.pod:4102
22020 #: ../src/guestfs-actions.pod:4137 ../src/guestfs-actions.pod:4156
22021 #: ../src/guestfs-actions.pod:4175 ../src/guestfs-actions.pod:4210
22022 #: ../src/guestfs-actions.pod:4222 ../src/guestfs-actions.pod:4258
22023 #: ../src/guestfs-actions.pod:4274 ../src/guestfs-actions.pod:4287
22024 #: ../src/guestfs-actions.pod:4302 ../src/guestfs-actions.pod:4319
22025 #: ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4432
22026 #: ../src/guestfs-actions.pod:4445 ../src/guestfs-actions.pod:4496
22027 #: ../src/guestfs-actions.pod:4514 ../src/guestfs-actions.pod:4532
22028 #: ../src/guestfs-actions.pod:4548 ../src/guestfs-actions.pod:4562
22029 #: ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4593
22030 #: ../src/guestfs-actions.pod:4608 ../src/guestfs-actions.pod:4635
22031 #: ../src/guestfs-actions.pod:4698 ../src/guestfs-actions.pod:4771
22032 #: ../src/guestfs-actions.pod:4802 ../src/guestfs-actions.pod:4821
22033 #: ../src/guestfs-actions.pod:4840 ../src/guestfs-actions.pod:4852
22034 #: ../src/guestfs-actions.pod:4869 ../src/guestfs-actions.pod:4882
22035 #: ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:4912
22036 #: ../src/guestfs-actions.pod:4954 ../src/guestfs-actions.pod:4980
22037 #: ../src/guestfs-actions.pod:5019 ../src/guestfs-actions.pod:5039
22038 #: ../src/guestfs-actions.pod:5053 ../src/guestfs-actions.pod:5070
22039 #: ../src/guestfs-actions.pod:5119 ../src/guestfs-actions.pod:5172
22040 #: ../src/guestfs-actions.pod:5219 ../src/guestfs-actions.pod:5262
22041 #: ../src/guestfs-actions.pod:5290 ../src/guestfs-actions.pod:5307
22042 #: ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5465
22043 #: ../src/guestfs-actions.pod:5522 ../src/guestfs-actions.pod:5544
22044 #: ../src/guestfs-actions.pod:5562 ../src/guestfs-actions.pod:5594
22045 #: ../src/guestfs-actions.pod:5660 ../src/guestfs-actions.pod:5677
22046 #: ../src/guestfs-actions.pod:5690 ../src/guestfs-actions.pod:5704
22047 #: ../src/guestfs-actions.pod:5993 ../src/guestfs-actions.pod:6012
22048 #: ../src/guestfs-actions.pod:6031 ../src/guestfs-actions.pod:6045
22049 #: ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6071
22050 #: ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6097
22051 #: ../src/guestfs-actions.pod:6113 ../src/guestfs-actions.pod:6134
22052 #: ../src/guestfs-actions.pod:6153 ../src/guestfs-actions.pod:6172
22053 #: ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6220
22054 #: ../src/guestfs-actions.pod:6243 ../src/guestfs-actions.pod:6261
22055 #: ../src/guestfs-actions.pod:6280 ../src/guestfs-actions.pod:6301
22056 #: ../src/guestfs-actions.pod:6320 ../src/guestfs-actions.pod:6337
22057 #: ../src/guestfs-actions.pod:6356 ../src/guestfs-actions.pod:6384
22058 #: ../src/guestfs-actions.pod:6408 ../src/guestfs-actions.pod:6427
22059 #: ../src/guestfs-actions.pod:6451 ../src/guestfs-actions.pod:6470
22060 #: ../src/guestfs-actions.pod:6485 ../src/guestfs-actions.pod:6504
22061 #: ../src/guestfs-actions.pod:6548 ../src/guestfs-actions.pod:6578
22062 #: ../src/guestfs-actions.pod:6611 ../src/guestfs-actions.pod:6726
22063 #: ../src/guestfs-actions.pod:6847 ../src/guestfs-actions.pod:6859
22064 #: ../src/guestfs-actions.pod:6872 ../src/guestfs-actions.pod:6885
22065 #: ../src/guestfs-actions.pod:6907 ../src/guestfs-actions.pod:6920
22066 #: ../src/guestfs-actions.pod:6933 ../src/guestfs-actions.pod:6946
22067 #: ../src/guestfs-actions.pod:6961 ../src/guestfs-actions.pod:7020
22068 #: ../src/guestfs-actions.pod:7037 ../src/guestfs-actions.pod:7053
22069 #: ../src/guestfs-actions.pod:7069 ../src/guestfs-actions.pod:7086
22070 #: ../src/guestfs-actions.pod:7099 ../src/guestfs-actions.pod:7119
22071 #: ../src/guestfs-actions.pod:7155 ../src/guestfs-actions.pod:7169
22072 #: ../src/guestfs-actions.pod:7210 ../src/guestfs-actions.pod:7223
22073 #: ../src/guestfs-actions.pod:7241 ../src/guestfs-actions.pod:7275
22074 #: ../src/guestfs-actions.pod:7311 ../src/guestfs-actions.pod:7427
22075 #: ../src/guestfs-actions.pod:7442 ../src/guestfs-actions.pod:7456
22076 #: ../src/guestfs-actions.pod:7511 ../src/guestfs-actions.pod:7524
22077 #: ../src/guestfs-actions.pod:7569 ../src/guestfs-actions.pod:7609
22078 #: ../src/guestfs-actions.pod:7665 ../src/guestfs-actions.pod:7685
22079 #: ../src/guestfs-actions.pod:7718 ../src/guestfs-actions.pod:7782
22080 #: ../src/guestfs-actions.pod:7805 ../src/guestfs-actions.pod:7834
22081 msgid "This function returns 0 on success or -1 on error."
22085 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
22086 #: ../src/guestfs-actions.pod:1170 ../src/guestfs-actions.pod:1985
22087 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2197
22088 #: ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3648
22089 #: ../src/guestfs-actions.pod:4956 ../src/guestfs-actions.pod:6222
22090 #: ../src/guestfs-actions.pod:6339 ../src/guestfs-actions.pod:6472
22091 #: ../src/guestfs-actions.pod:6963 ../src/guestfs-actions.pod:7088
22092 #: ../src/guestfs-actions.pod:7611
22093 msgid "(Added in 0.3)"
22097 #: ../src/guestfs-actions.pod:41
22098 msgid "guestfs_add_domain"
22102 #: ../src/guestfs-actions.pod:43
22106 " guestfs_add_domain (guestfs_h *g,\n"
22107 " const char *dom,\n"
22113 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
22114 #: ../src/guestfs-actions.pod:837 ../src/guestfs-actions.pod:2831
22115 #: ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4966
22116 #: ../src/guestfs-actions.pod:5183
22118 "You may supply a list of optional arguments to this call. Use zero or more "
22119 "of the following pairs of parameters, and terminate the list with C<-1> on "
22120 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
22124 #: ../src/guestfs-actions.pod:53
22127 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
22128 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
22129 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
22130 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
22131 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
22136 #: ../src/guestfs-actions.pod:59
22138 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
22139 "It works by connecting to libvirt, requesting the domain and domain XML from "
22140 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
22145 #: ../src/guestfs-actions.pod:94
22147 "The other optional parameters are passed directly through to "
22148 "C<guestfs_add_drive_opts>."
22152 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
22153 #: ../src/guestfs-actions.pod:520 ../src/guestfs-actions.pod:698
22154 #: ../src/guestfs-actions.pod:729 ../src/guestfs-actions.pod:747
22155 #: ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:1385
22156 #: ../src/guestfs-actions.pod:1741 ../src/guestfs-actions.pod:1944
22157 #: ../src/guestfs-actions.pod:2055 ../src/guestfs-actions.pod:2106
22158 #: ../src/guestfs-actions.pod:2161 ../src/guestfs-actions.pod:2184
22159 #: ../src/guestfs-actions.pod:2477 ../src/guestfs-actions.pod:2949
22160 #: ../src/guestfs-actions.pod:2967 ../src/guestfs-actions.pod:5142
22161 #: ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5774
22162 #: ../src/guestfs-actions.pod:5800 ../src/guestfs-actions.pod:7196
22163 #: ../src/guestfs-actions.pod:7622 ../src/guestfs-actions.pod:7635
22164 #: ../src/guestfs-actions.pod:7648
22165 msgid "On error this function returns -1."
22169 #: ../src/guestfs-actions.pod:99
22170 msgid "(Added in 1.7.4)"
22174 #: ../src/guestfs-actions.pod:101
22175 msgid "guestfs_add_domain_va"
22179 #: ../src/guestfs-actions.pod:103
22183 " guestfs_add_domain_va (guestfs_h *g,\n"
22184 " const char *dom,\n"
22185 " va_list args);\n"
22190 #: ../src/guestfs-actions.pod:108
22191 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
22195 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
22196 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
22197 #: ../src/guestfs-actions.pod:876 ../src/guestfs-actions.pod:887
22198 #: ../src/guestfs-actions.pod:2915 ../src/guestfs-actions.pod:2927
22199 #: ../src/guestfs-actions.pod:4712 ../src/guestfs-actions.pod:4724
22200 #: ../src/guestfs-actions.pod:4994 ../src/guestfs-actions.pod:5006
22201 #: ../src/guestfs-actions.pod:5232 ../src/guestfs-actions.pod:5243
22202 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
22206 #: ../src/guestfs-actions.pod:112
22207 msgid "guestfs_add_domain_argv"
22211 #: ../src/guestfs-actions.pod:114
22215 " guestfs_add_domain_argv (guestfs_h *g,\n"
22216 " const char *dom,\n"
22217 " const struct guestfs_add_domain_argv *optargs);\n"
22222 #: ../src/guestfs-actions.pod:119
22223 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
22227 #: ../src/guestfs-actions.pod:123
22228 msgid "guestfs_add_drive"
22232 #: ../src/guestfs-actions.pod:125
22236 " guestfs_add_drive (guestfs_h *g,\n"
22237 " const char *filename);\n"
22242 #: ../src/guestfs-actions.pod:129
22244 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
22245 "optional parameters, so the disk is added writable, with the format being "
22246 "detected automatically."
22250 #: ../src/guestfs-actions.pod:133
22252 "Automatic detection of the format opens you up to a potential security hole "
22253 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22254 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22255 "you should think about replacing calls to this function with calls to "
22256 "C<guestfs_add_drive_opts>, and specifying the format."
22260 #: ../src/guestfs-actions.pod:144
22261 msgid "guestfs_add_drive_opts"
22265 #: ../src/guestfs-actions.pod:146
22269 " guestfs_add_drive_opts (guestfs_h *g,\n"
22270 " const char *filename,\n"
22276 #: ../src/guestfs-actions.pod:156
22279 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
22280 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
22281 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
22286 #: ../src/guestfs-actions.pod:185
22288 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
22289 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
22290 "Possible formats include C<raw> and C<qcow2>."
22294 #: ../src/guestfs-actions.pod:196
22296 "This rarely-used option lets you emulate the behaviour of the deprecated "
22297 "C<guestfs_add_drive_with_if> call (q.v.)"
22301 #: ../src/guestfs-actions.pod:203
22302 msgid "(Added in 1.5.23)"
22306 #: ../src/guestfs-actions.pod:205
22307 msgid "guestfs_add_drive_opts_va"
22311 #: ../src/guestfs-actions.pod:207
22315 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
22316 " const char *filename,\n"
22317 " va_list args);\n"
22322 #: ../src/guestfs-actions.pod:212
22323 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
22327 #: ../src/guestfs-actions.pod:216
22328 msgid "guestfs_add_drive_opts_argv"
22332 #: ../src/guestfs-actions.pod:218
22336 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
22337 " const char *filename,\n"
22338 " const struct guestfs_add_drive_opts_argv *optargs);\n"
22343 #: ../src/guestfs-actions.pod:223
22344 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
22348 #: ../src/guestfs-actions.pod:227
22349 msgid "guestfs_add_drive_ro"
22353 #: ../src/guestfs-actions.pod:229
22357 " guestfs_add_drive_ro (guestfs_h *g,\n"
22358 " const char *filename);\n"
22363 #: ../src/guestfs-actions.pod:233
22365 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
22366 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
22367 "disk is added read-only, with the format being detected automatically."
22371 #: ../src/guestfs-actions.pod:240
22372 msgid "(Added in 1.0.38)"
22376 #: ../src/guestfs-actions.pod:242
22377 msgid "guestfs_add_drive_ro_with_if"
22381 #: ../src/guestfs-actions.pod:244
22385 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
22386 " const char *filename,\n"
22387 " const char *iface);\n"
22392 #: ../src/guestfs-actions.pod:256
22394 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
22395 "QEMU interface emulation to use at run time."
22399 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
22400 #: ../src/guestfs-actions.pod:2436
22401 msgid "(Added in 1.0.84)"
22405 #: ../src/guestfs-actions.pod:263
22406 msgid "guestfs_add_drive_with_if"
22410 #: ../src/guestfs-actions.pod:265
22414 " guestfs_add_drive_with_if (guestfs_h *g,\n"
22415 " const char *filename,\n"
22416 " const char *iface);\n"
22421 #: ../src/guestfs-actions.pod:277
22423 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
22424 "QEMU interface emulation to use at run time."
22428 #: ../src/guestfs-actions.pod:284
22429 msgid "guestfs_aug_clear"
22433 #: ../src/guestfs-actions.pod:286
22437 " guestfs_aug_clear (guestfs_h *g,\n"
22438 " const char *augpath);\n"
22443 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2186
22444 msgid "(Added in 1.3.4)"
22448 #: ../src/guestfs-actions.pod:297
22449 msgid "guestfs_aug_close"
22453 #: ../src/guestfs-actions.pod:299
22457 " guestfs_aug_close (guestfs_h *g);\n"
22462 #: ../src/guestfs-actions.pod:302
22464 "Close the current Augeas handle and free up any resources used by it. After "
22465 "calling this, you have to call C<guestfs_aug_init> again before you can use "
22466 "any other Augeas functions."
22470 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
22471 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
22472 #: ../src/guestfs-actions.pod:429 ../src/guestfs-actions.pod:449
22473 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:494
22474 #: ../src/guestfs-actions.pod:508 ../src/guestfs-actions.pod:522
22475 #: ../src/guestfs-actions.pod:536 ../src/guestfs-actions.pod:554
22476 #: ../src/guestfs-actions.pod:5851
22477 msgid "(Added in 0.7)"
22481 #: ../src/guestfs-actions.pod:311
22482 msgid "guestfs_aug_defnode"
22486 #: ../src/guestfs-actions.pod:313
22489 " struct guestfs_int_bool *\n"
22490 " guestfs_aug_defnode (guestfs_h *g,\n"
22491 " const char *name,\n"
22492 " const char *expr,\n"
22493 " const char *val);\n"
22498 #: ../src/guestfs-actions.pod:322
22500 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22501 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
22502 "containing that single node."
22506 #: ../src/guestfs-actions.pod:330
22508 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
22509 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
22513 #: ../src/guestfs-actions.pod:336
22514 msgid "guestfs_aug_defvar"
22518 #: ../src/guestfs-actions.pod:338
22522 " guestfs_aug_defvar (guestfs_h *g,\n"
22523 " const char *name,\n"
22524 " const char *expr);\n"
22529 #: ../src/guestfs-actions.pod:354
22530 msgid "guestfs_aug_get"
22534 #: ../src/guestfs-actions.pod:356
22538 " guestfs_aug_get (guestfs_h *g,\n"
22539 " const char *augpath);\n"
22544 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:927
22545 #: ../src/guestfs-actions.pod:945 ../src/guestfs-actions.pod:1005
22546 #: ../src/guestfs-actions.pod:1021 ../src/guestfs-actions.pod:1124
22547 #: ../src/guestfs-actions.pod:1254 ../src/guestfs-actions.pod:1271
22548 #: ../src/guestfs-actions.pod:1290 ../src/guestfs-actions.pod:1424
22549 #: ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1724
22550 #: ../src/guestfs-actions.pod:1887 ../src/guestfs-actions.pod:1904
22551 #: ../src/guestfs-actions.pod:1971 ../src/guestfs-actions.pod:2014
22552 #: ../src/guestfs-actions.pod:2035 ../src/guestfs-actions.pod:2209
22553 #: ../src/guestfs-actions.pod:2401 ../src/guestfs-actions.pod:2605
22554 #: ../src/guestfs-actions.pod:2695 ../src/guestfs-actions.pod:2799
22555 #: ../src/guestfs-actions.pod:2818 ../src/guestfs-actions.pod:3032
22556 #: ../src/guestfs-actions.pod:3060 ../src/guestfs-actions.pod:3081
22557 #: ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3174
22558 #: ../src/guestfs-actions.pod:3194 ../src/guestfs-actions.pod:3214
22559 #: ../src/guestfs-actions.pod:3841 ../src/guestfs-actions.pod:4194
22560 #: ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4474
22561 #: ../src/guestfs-actions.pod:5380 ../src/guestfs-actions.pod:5579
22562 #: ../src/guestfs-actions.pod:5749 ../src/guestfs-actions.pod:5927
22563 #: ../src/guestfs-actions.pod:5976 ../src/guestfs-actions.pod:6632
22564 #: ../src/guestfs-actions.pod:6648 ../src/guestfs-actions.pod:6672
22565 #: ../src/guestfs-actions.pod:6696 ../src/guestfs-actions.pod:7370
22566 #: ../src/guestfs-actions.pod:7389 ../src/guestfs-actions.pod:7407
22567 #: ../src/guestfs-actions.pod:7581 ../src/guestfs-actions.pod:7898
22569 "This function returns a string, or NULL on error. I<The caller must free "
22570 "the returned string after use>."
22574 #: ../src/guestfs-actions.pod:368
22575 msgid "guestfs_aug_init"
22579 #: ../src/guestfs-actions.pod:370
22583 " guestfs_aug_init (guestfs_h *g,\n"
22584 " const char *root,\n"
22590 #: ../src/guestfs-actions.pod:379
22591 msgid "You must call this before using any other C<guestfs_aug_*> commands."
22595 #: ../src/guestfs-actions.pod:404
22597 "This option is only useful when debugging Augeas lenses. Use of this option "
22598 "may require additional memory for the libguestfs appliance. You may need to "
22599 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
22600 "C<guestfs_set_memsize>."
22604 #: ../src/guestfs-actions.pod:419
22605 msgid "Do not load the tree in C<guestfs_aug_init>."
22609 #: ../src/guestfs-actions.pod:423
22610 msgid "To close the handle, you can call C<guestfs_aug_close>."
22614 #: ../src/guestfs-actions.pod:431
22615 msgid "guestfs_aug_insert"
22619 #: ../src/guestfs-actions.pod:433
22623 " guestfs_aug_insert (guestfs_h *g,\n"
22624 " const char *augpath,\n"
22625 " const char *label,\n"
22631 #: ../src/guestfs-actions.pod:451
22632 msgid "guestfs_aug_load"
22636 #: ../src/guestfs-actions.pod:453
22640 " guestfs_aug_load (guestfs_h *g);\n"
22645 #: ../src/guestfs-actions.pod:465
22646 msgid "guestfs_aug_ls"
22650 #: ../src/guestfs-actions.pod:467
22654 " guestfs_aug_ls (guestfs_h *g,\n"
22655 " const char *augpath);\n"
22660 #: ../src/guestfs-actions.pod:471
22662 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
22663 "sorting the resulting nodes into alphabetical order."
22667 #: ../src/guestfs-actions.pod:474 ../src/guestfs-actions.pod:490
22668 #: ../src/guestfs-actions.pod:636 ../src/guestfs-actions.pod:1143
22669 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1458
22670 #: ../src/guestfs-actions.pod:1561 ../src/guestfs-actions.pod:1580
22671 #: ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:2281
22672 #: ../src/guestfs-actions.pod:2297 ../src/guestfs-actions.pod:2316
22673 #: ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2383
22674 #: ../src/guestfs-actions.pod:2454 ../src/guestfs-actions.pod:2503
22675 #: ../src/guestfs-actions.pod:2760 ../src/guestfs-actions.pod:3134
22676 #: ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3724
22677 #: ../src/guestfs-actions.pod:3741 ../src/guestfs-actions.pod:3761
22678 #: ../src/guestfs-actions.pod:3823 ../src/guestfs-actions.pod:3928
22679 #: ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:5103
22680 #: ../src/guestfs-actions.pod:5721 ../src/guestfs-actions.pod:5847
22681 #: ../src/guestfs-actions.pod:5961 ../src/guestfs-actions.pod:6712
22682 #: ../src/guestfs-actions.pod:6773 ../src/guestfs-actions.pod:6828
22683 #: ../src/guestfs-actions.pod:6974 ../src/guestfs-actions.pod:6998
22684 #: ../src/guestfs-actions.pod:7474 ../src/guestfs-actions.pod:7494
22685 #: ../src/guestfs-actions.pod:7541 ../src/guestfs-actions.pod:7735
22686 #: ../src/guestfs-actions.pod:7754 ../src/guestfs-actions.pod:7848
22687 #: ../src/guestfs-actions.pod:7867 ../src/guestfs-actions.pod:7913
22688 #: ../src/guestfs-actions.pod:7932
22690 "This function returns a NULL-terminated array of strings (like L<environ(3)"
22691 ">), or NULL if there was an error. I<The caller must free the strings and "
22692 "the array after use>."
22696 #: ../src/guestfs-actions.pod:478 ../src/guestfs-actions.pod:1068
22697 #: ../src/guestfs-actions.pod:1086 ../src/guestfs-actions.pod:1496
22698 #: ../src/guestfs-actions.pod:3488 ../src/guestfs-actions.pod:3519
22699 #: ../src/guestfs-actions.pod:4177 ../src/guestfs-actions.pod:4227
22700 #: ../src/guestfs-actions.pod:4414 ../src/guestfs-actions.pod:4447
22701 #: ../src/guestfs-actions.pod:4610 ../src/guestfs-actions.pod:5107
22702 #: ../src/guestfs-actions.pod:5662 ../src/guestfs-actions.pod:6059
22703 #: ../src/guestfs-actions.pod:6073 ../src/guestfs-actions.pod:6085
22704 #: ../src/guestfs-actions.pod:6553 ../src/guestfs-actions.pod:7212
22705 #: ../src/guestfs-actions.pod:7225 ../src/guestfs-actions.pod:7458
22706 #: ../src/guestfs-actions.pod:7723
22707 msgid "(Added in 0.8)"
22711 #: ../src/guestfs-actions.pod:480
22712 msgid "guestfs_aug_match"
22716 #: ../src/guestfs-actions.pod:482
22720 " guestfs_aug_match (guestfs_h *g,\n"
22721 " const char *augpath);\n"
22726 #: ../src/guestfs-actions.pod:496
22727 msgid "guestfs_aug_mv"
22731 #: ../src/guestfs-actions.pod:498
22735 " guestfs_aug_mv (guestfs_h *g,\n"
22736 " const char *src,\n"
22737 " const char *dest);\n"
22742 #: ../src/guestfs-actions.pod:510
22743 msgid "guestfs_aug_rm"
22747 #: ../src/guestfs-actions.pod:512
22751 " guestfs_aug_rm (guestfs_h *g,\n"
22752 " const char *augpath);\n"
22757 #: ../src/guestfs-actions.pod:524
22758 msgid "guestfs_aug_save"
22762 #: ../src/guestfs-actions.pod:526
22766 " guestfs_aug_save (guestfs_h *g);\n"
22771 #: ../src/guestfs-actions.pod:531
22773 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
22778 #: ../src/guestfs-actions.pod:538
22779 msgid "guestfs_aug_set"
22783 #: ../src/guestfs-actions.pod:540
22787 " guestfs_aug_set (guestfs_h *g,\n"
22788 " const char *augpath,\n"
22789 " const char *val);\n"
22794 #: ../src/guestfs-actions.pod:547
22796 "In the Augeas API, it is possible to clear a node by setting the value to "
22797 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22798 "this call. Instead you must use the C<guestfs_aug_clear> call."
22802 #: ../src/guestfs-actions.pod:556
22803 msgid "guestfs_available"
22807 #: ../src/guestfs-actions.pod:558
22811 " guestfs_available (guestfs_h *g,\n"
22812 " char *const *groups);\n"
22817 #: ../src/guestfs-actions.pod:566
22819 "The libguestfs groups, and the functions that those groups correspond to, "
22820 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22821 "runtime by calling C<guestfs_available_all_groups>."
22825 #: ../src/guestfs-actions.pod:590
22826 msgid "You must call C<guestfs_launch> before calling this function."
22830 #: ../src/guestfs-actions.pod:612
22832 "This call was added in version C<1.0.80>. In previous versions of "
22833 "libguestfs all you could do would be to speculatively execute a command to "
22834 "find out if the daemon implemented it. See also C<guestfs_version>."
22838 #: ../src/guestfs-actions.pod:621 ../src/guestfs-actions.pod:1241
22839 msgid "(Added in 1.0.80)"
22843 #: ../src/guestfs-actions.pod:623
22844 msgid "guestfs_available_all_groups"
22848 #: ../src/guestfs-actions.pod:625
22852 " guestfs_available_all_groups (guestfs_h *g);\n"
22857 #: ../src/guestfs-actions.pod:628
22859 "This command returns a list of all optional groups that this daemon knows "
22860 "about. Note this returns both supported and unsupported groups. To find "
22861 "out which ones the daemon can actually support you have to call "
22862 "C<guestfs_available> on each member of the returned list."
22866 #: ../src/guestfs-actions.pod:634
22867 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
22871 #: ../src/guestfs-actions.pod:640
22872 msgid "(Added in 1.3.15)"
22876 #: ../src/guestfs-actions.pod:642
22877 msgid "guestfs_base64_in"
22881 #: ../src/guestfs-actions.pod:644
22885 " guestfs_base64_in (guestfs_h *g,\n"
22886 " const char *base64file,\n"
22887 " const char *filename);\n"
22892 #: ../src/guestfs-actions.pod:654 ../src/guestfs-actions.pod:668
22893 msgid "(Added in 1.3.5)"
22897 #: ../src/guestfs-actions.pod:656
22898 msgid "guestfs_base64_out"
22902 #: ../src/guestfs-actions.pod:658
22906 " guestfs_base64_out (guestfs_h *g,\n"
22907 " const char *filename,\n"
22908 " const char *base64file);\n"
22913 #: ../src/guestfs-actions.pod:670
22914 msgid "guestfs_blockdev_flushbufs"
22918 #: ../src/guestfs-actions.pod:672
22922 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
22923 " const char *device);\n"
22928 #: ../src/guestfs-actions.pod:683 ../src/guestfs-actions.pod:700
22929 #: ../src/guestfs-actions.pod:715 ../src/guestfs-actions.pod:731
22930 #: ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:768
22931 #: ../src/guestfs-actions.pod:782 ../src/guestfs-actions.pod:800
22932 #: ../src/guestfs-actions.pod:814 ../src/guestfs-actions.pod:828
22933 msgid "(Added in 0.9.3)"
22937 #: ../src/guestfs-actions.pod:685
22938 msgid "guestfs_blockdev_getbsz"
22942 #: ../src/guestfs-actions.pod:687
22946 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
22947 " const char *device);\n"
22952 #: ../src/guestfs-actions.pod:702
22953 msgid "guestfs_blockdev_getro"
22957 #: ../src/guestfs-actions.pod:704
22961 " guestfs_blockdev_getro (guestfs_h *g,\n"
22962 " const char *device);\n"
22967 #: ../src/guestfs-actions.pod:713 ../src/guestfs-actions.pod:1479
22968 #: ../src/guestfs-actions.pod:1494 ../src/guestfs-actions.pod:1983
22969 #: ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:2066
22970 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2132
22971 #: ../src/guestfs-actions.pod:2147 ../src/guestfs-actions.pod:2172
22972 #: ../src/guestfs-actions.pod:2195 ../src/guestfs-actions.pod:3231
22973 #: ../src/guestfs-actions.pod:3247 ../src/guestfs-actions.pod:3265
22974 #: ../src/guestfs-actions.pod:3427 ../src/guestfs-actions.pod:3441
22975 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:3470
22976 #: ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3501
22977 #: ../src/guestfs-actions.pod:3517 ../src/guestfs-actions.pod:3531
22978 #: ../src/guestfs-actions.pod:3544 ../src/guestfs-actions.pod:3558
22979 #: ../src/guestfs-actions.pod:3573 ../src/guestfs-actions.pod:3588
22980 #: ../src/guestfs-actions.pod:3601 ../src/guestfs-actions.pod:3615
22981 #: ../src/guestfs-actions.pod:5344
22982 msgid "This function returns a C truth value on success or -1 on error."
22986 #: ../src/guestfs-actions.pod:717
22987 msgid "guestfs_blockdev_getsize64"
22991 #: ../src/guestfs-actions.pod:719
22995 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
22996 " const char *device);\n"
23001 #: ../src/guestfs-actions.pod:725
23002 msgid "See also C<guestfs_blockdev_getsz>."
23006 #: ../src/guestfs-actions.pod:733
23007 msgid "guestfs_blockdev_getss"
23011 #: ../src/guestfs-actions.pod:735
23015 " guestfs_blockdev_getss (guestfs_h *g,\n"
23016 " const char *device);\n"
23021 #: ../src/guestfs-actions.pod:742
23023 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
23028 #: ../src/guestfs-actions.pod:751
23029 msgid "guestfs_blockdev_getsz"
23033 #: ../src/guestfs-actions.pod:753
23037 " guestfs_blockdev_getsz (guestfs_h *g,\n"
23038 " const char *device);\n"
23043 #: ../src/guestfs-actions.pod:760
23045 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
23046 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
23050 #: ../src/guestfs-actions.pod:770
23051 msgid "guestfs_blockdev_rereadpt"
23055 #: ../src/guestfs-actions.pod:772
23059 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
23060 " const char *device);\n"
23065 #: ../src/guestfs-actions.pod:784
23066 msgid "guestfs_blockdev_setbsz"
23070 #: ../src/guestfs-actions.pod:786
23074 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
23075 " const char *device,\n"
23076 " int blocksize);\n"
23081 #: ../src/guestfs-actions.pod:802
23082 msgid "guestfs_blockdev_setro"
23086 #: ../src/guestfs-actions.pod:804
23090 " guestfs_blockdev_setro (guestfs_h *g,\n"
23091 " const char *device);\n"
23096 #: ../src/guestfs-actions.pod:816
23097 msgid "guestfs_blockdev_setrw"
23101 #: ../src/guestfs-actions.pod:818
23105 " guestfs_blockdev_setrw (guestfs_h *g,\n"
23106 " const char *device);\n"
23111 #: ../src/guestfs-actions.pod:830
23112 msgid "guestfs_btrfs_filesystem_resize"
23116 #: ../src/guestfs-actions.pod:832
23120 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
23121 " const char *mountpoint,\n"
23127 #: ../src/guestfs-actions.pod:842
23130 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
23135 #: ../src/guestfs-actions.pod:865
23136 msgid "(Added in 1.11.17)"
23140 #: ../src/guestfs-actions.pod:867
23141 msgid "guestfs_btrfs_filesystem_resize_va"
23145 #: ../src/guestfs-actions.pod:869
23149 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
23150 " const char *mountpoint,\n"
23151 " va_list args);\n"
23156 #: ../src/guestfs-actions.pod:874
23157 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
23161 #: ../src/guestfs-actions.pod:878
23162 msgid "guestfs_btrfs_filesystem_resize_argv"
23166 #: ../src/guestfs-actions.pod:880
23170 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
23171 " const char *mountpoint,\n"
23172 " const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
23177 #: ../src/guestfs-actions.pod:885
23178 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
23182 #: ../src/guestfs-actions.pod:889
23183 msgid "guestfs_case_sensitive_path"
23187 #: ../src/guestfs-actions.pod:891
23191 " guestfs_case_sensitive_path (guestfs_h *g,\n"
23192 " const char *path);\n"
23197 #: ../src/guestfs-actions.pod:917
23199 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
23200 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
23201 "how the directories were originally created under Windows)."
23205 #: ../src/guestfs-actions.pod:925
23206 msgid "See also C<guestfs_realpath>."
23210 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:7392
23211 msgid "(Added in 1.0.75)"
23215 #: ../src/guestfs-actions.pod:932
23216 msgid "guestfs_cat"
23220 #: ../src/guestfs-actions.pod:934
23224 " guestfs_cat (guestfs_h *g,\n"
23225 " const char *path);\n"
23230 #: ../src/guestfs-actions.pod:940
23232 "Note that this function cannot correctly handle binary files (specifically, "
23233 "files containing C<\\0> character which is treated as end of string). For "
23234 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
23235 "functions which have a more complex interface."
23239 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:3745
23240 #: ../src/guestfs-actions.pod:3827 ../src/guestfs-actions.pod:3844
23241 #: ../src/guestfs-actions.pod:3932 ../src/guestfs-actions.pod:4340
23242 #: ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:5725
23243 #: ../src/guestfs-actions.pod:5739 ../src/guestfs-actions.pod:7545
23244 #: ../src/guestfs-actions.pod:7559
23245 msgid "(Added in 0.4)"
23249 #: ../src/guestfs-actions.pod:953
23250 msgid "guestfs_checksum"
23254 #: ../src/guestfs-actions.pod:955
23258 " guestfs_checksum (guestfs_h *g,\n"
23259 " const char *csumtype,\n"
23260 " const char *path);\n"
23265 #: ../src/guestfs-actions.pod:1001
23266 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
23270 #: ../src/guestfs-actions.pod:1003
23271 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
23275 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1316
23276 #: ../src/guestfs-actions.pod:2163 ../src/guestfs-actions.pod:3443
23277 #: ../src/guestfs-actions.pod:3472 ../src/guestfs-actions.pod:3533
23278 #: ../src/guestfs-actions.pod:3560 ../src/guestfs-actions.pod:7248
23279 msgid "(Added in 1.0.2)"
23283 #: ../src/guestfs-actions.pod:1010
23284 msgid "guestfs_checksum_device"
23288 #: ../src/guestfs-actions.pod:1012
23292 " guestfs_checksum_device (guestfs_h *g,\n"
23293 " const char *csumtype,\n"
23294 " const char *device);\n"
23299 #: ../src/guestfs-actions.pod:1017
23301 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23302 "device named C<device>. For the types of checksums supported see the "
23303 "C<guestfs_checksum> command."
23307 #: ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:5174
23308 #: ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:5346
23309 #: ../src/guestfs-actions.pod:5364 ../src/guestfs-actions.pod:5546
23310 #: ../src/guestfs-actions.pod:7157 ../src/guestfs-actions.pod:7171
23311 #: ../src/guestfs-actions.pod:7571
23312 msgid "(Added in 1.3.2)"
23316 #: ../src/guestfs-actions.pod:1026
23317 msgid "guestfs_checksums_out"
23321 #: ../src/guestfs-actions.pod:1028
23325 " guestfs_checksums_out (guestfs_h *g,\n"
23326 " const char *csumtype,\n"
23327 " const char *directory,\n"
23328 " const char *sumsfile);\n"
23333 #: ../src/guestfs-actions.pod:1048
23334 msgid "(Added in 1.3.7)"
23338 #: ../src/guestfs-actions.pod:1050
23339 msgid "guestfs_chmod"
23343 #: ../src/guestfs-actions.pod:1052
23347 " guestfs_chmod (guestfs_h *g,\n"
23349 " const char *path);\n"
23354 #: ../src/guestfs-actions.pod:1070
23355 msgid "guestfs_chown"
23359 #: ../src/guestfs-actions.pod:1072
23363 " guestfs_chown (guestfs_h *g,\n"
23366 " const char *path);\n"
23371 #: ../src/guestfs-actions.pod:1088
23372 msgid "guestfs_command"
23376 #: ../src/guestfs-actions.pod:1090
23380 " guestfs_command (guestfs_h *g,\n"
23381 " char *const *arguments);\n"
23386 #: ../src/guestfs-actions.pod:1099
23388 "The single parameter is an argv-style list of arguments. The first element "
23389 "is the name of the program to run. Subsequent elements are parameters. The "
23390 "list must be non-empty (ie. must contain a program name). Note that the "
23391 "command runs directly, and is I<not> invoked via the shell (see "
23396 #: ../src/guestfs-actions.pod:1130 ../src/guestfs-actions.pod:1150
23397 #: ../src/guestfs-actions.pod:1615
23398 msgid "(Added in 0.9.1)"
23402 #: ../src/guestfs-actions.pod:1132
23403 msgid "guestfs_command_lines"
23407 #: ../src/guestfs-actions.pod:1134
23411 " guestfs_command_lines (guestfs_h *g,\n"
23412 " char *const *arguments);\n"
23417 #: ../src/guestfs-actions.pod:1138
23419 "This is the same as C<guestfs_command>, but splits the result into a list of "
23424 #: ../src/guestfs-actions.pod:1141
23425 msgid "See also: C<guestfs_sh_lines>"
23429 #: ../src/guestfs-actions.pod:1152
23430 msgid "guestfs_config"
23434 #: ../src/guestfs-actions.pod:1154
23438 " guestfs_config (guestfs_h *g,\n"
23439 " const char *qemuparam,\n"
23440 " const char *qemuvalue);\n"
23445 #: ../src/guestfs-actions.pod:1172
23446 msgid "guestfs_copy_size"
23450 #: ../src/guestfs-actions.pod:1174
23454 " guestfs_copy_size (guestfs_h *g,\n"
23455 " const char *src,\n"
23456 " const char *dest,\n"
23457 " int64_t size);\n"
23462 #: ../src/guestfs-actions.pod:1188 ../src/guestfs-actions.pod:1311
23463 #: ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:1387
23464 #: ../src/guestfs-actions.pod:1764 ../src/guestfs-actions.pod:1786
23465 #: ../src/guestfs-actions.pod:3643 ../src/guestfs-actions.pod:7243
23466 #: ../src/guestfs-actions.pod:7277 ../src/guestfs-actions.pod:7784
23467 #: ../src/guestfs-actions.pod:7807
23469 "This long-running command can generate progress notification messages so "
23470 "that the caller can display a progress bar or indicator. To receive these "
23471 "messages, the caller must register a progress event callback. See L<guestfs"
23472 "(3)/GUESTFS_EVENT_PROGRESS>."
23476 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:4367
23477 #: ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:7478
23478 #: ../src/guestfs-actions.pod:7498 ../src/guestfs-actions.pod:7584
23479 msgid "(Added in 1.0.87)"
23483 #: ../src/guestfs-actions.pod:1195
23488 #: ../src/guestfs-actions.pod:1197
23492 " guestfs_cp (guestfs_h *g,\n"
23493 " const char *src,\n"
23494 " const char *dest);\n"
23499 #: ../src/guestfs-actions.pod:1207 ../src/guestfs-actions.pod:1221
23500 #: ../src/guestfs-actions.pod:1293 ../src/guestfs-actions.pod:1367
23501 #: ../src/guestfs-actions.pod:1481 ../src/guestfs-actions.pod:5121
23502 #: ../src/guestfs-actions.pod:5596
23503 msgid "(Added in 1.0.18)"
23507 #: ../src/guestfs-actions.pod:1209
23508 msgid "guestfs_cp_a"
23512 #: ../src/guestfs-actions.pod:1211
23516 " guestfs_cp_a (guestfs_h *g,\n"
23517 " const char *src,\n"
23518 " const char *dest);\n"
23523 #: ../src/guestfs-actions.pod:1223
23528 #: ../src/guestfs-actions.pod:1225
23532 " guestfs_dd (guestfs_h *g,\n"
23533 " const char *src,\n"
23534 " const char *dest);\n"
23539 #: ../src/guestfs-actions.pod:1235
23541 "If the destination is a device, it must be as large or larger than the "
23542 "source file or device, otherwise the copy will fail. This command cannot do "
23543 "partial copies (see C<guestfs_copy_size>)."
23547 #: ../src/guestfs-actions.pod:1243
23552 #: ../src/guestfs-actions.pod:1245
23556 " guestfs_df (guestfs_h *g);\n"
23561 #: ../src/guestfs-actions.pod:1250 ../src/guestfs-actions.pod:1267
23563 "This command is mostly useful for interactive sessions. It is I<not> "
23564 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
23569 #: ../src/guestfs-actions.pod:1257 ../src/guestfs-actions.pod:1274
23570 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:2366
23571 #: ../src/guestfs-actions.pod:2390 ../src/guestfs-actions.pod:2458
23572 #: ../src/guestfs-actions.pod:4477 ../src/guestfs-actions.pod:5021
23573 #: ../src/guestfs-actions.pod:6981 ../src/guestfs-actions.pod:7005
23574 #: ../src/guestfs-actions.pod:7624 ../src/guestfs-actions.pod:7637
23575 #: ../src/guestfs-actions.pod:7650
23576 msgid "(Added in 1.0.54)"
23580 #: ../src/guestfs-actions.pod:1259
23581 msgid "guestfs_df_h"
23585 #: ../src/guestfs-actions.pod:1261
23589 " guestfs_df_h (guestfs_h *g);\n"
23594 #: ../src/guestfs-actions.pod:1276
23595 msgid "guestfs_dmesg"
23599 #: ../src/guestfs-actions.pod:1278
23603 " guestfs_dmesg (guestfs_h *g);\n"
23608 #: ../src/guestfs-actions.pod:1285
23610 "Another way to get the same information is to enable verbose messages with "
23611 "C<guestfs_set_verbose> or by setting the environment variable "
23612 "C<LIBGUESTFS_DEBUG=1> before running the program."
23616 #: ../src/guestfs-actions.pod:1295
23617 msgid "guestfs_download"
23621 #: ../src/guestfs-actions.pod:1297
23625 " guestfs_download (guestfs_h *g,\n"
23626 " const char *remotefilename,\n"
23627 " const char *filename);\n"
23632 #: ../src/guestfs-actions.pod:1307
23633 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
23637 #: ../src/guestfs-actions.pod:1318
23638 msgid "guestfs_download_offset"
23642 #: ../src/guestfs-actions.pod:1320
23646 " guestfs_download_offset (guestfs_h *g,\n"
23647 " const char *remotefilename,\n"
23648 " const char *filename,\n"
23649 " int64_t offset,\n"
23650 " int64_t size);\n"
23655 #: ../src/guestfs-actions.pod:1333
23657 "Note that there is no limit on the amount of data that can be downloaded "
23658 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
23659 "full amount unless an error occurs."
23663 #: ../src/guestfs-actions.pod:1338
23664 msgid "See also C<guestfs_download>, C<guestfs_pread>."
23668 #: ../src/guestfs-actions.pod:1347 ../src/guestfs-actions.pod:7282
23669 msgid "(Added in 1.5.17)"
23673 #: ../src/guestfs-actions.pod:1349
23674 msgid "guestfs_drop_caches"
23678 #: ../src/guestfs-actions.pod:1351
23682 " guestfs_drop_caches (guestfs_h *g,\n"
23683 " int whattodrop);\n"
23688 #: ../src/guestfs-actions.pod:1369
23693 #: ../src/guestfs-actions.pod:1371
23697 " guestfs_du (guestfs_h *g,\n"
23698 " const char *path);\n"
23703 #: ../src/guestfs-actions.pod:1394
23704 msgid "guestfs_e2fsck_f"
23708 #: ../src/guestfs-actions.pod:1396
23712 " guestfs_e2fsck_f (guestfs_h *g,\n"
23713 " const char *device);\n"
23718 #: ../src/guestfs-actions.pod:1404
23720 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
23721 "Normally you should use C<guestfs_fsck>."
23725 #: ../src/guestfs-actions.pod:1409
23726 msgid "(Added in 1.0.29)"
23730 #: ../src/guestfs-actions.pod:1411
23731 msgid "guestfs_echo_daemon"
23735 #: ../src/guestfs-actions.pod:1413
23739 " guestfs_echo_daemon (guestfs_h *g,\n"
23740 " char *const *words);\n"
23745 #: ../src/guestfs-actions.pod:1422
23746 msgid "See also C<guestfs_ping_daemon>."
23750 #: ../src/guestfs-actions.pod:1427 ../src/guestfs-actions.pod:2174
23751 #: ../src/guestfs-actions.pod:6453
23752 msgid "(Added in 1.0.69)"
23756 #: ../src/guestfs-actions.pod:1429
23757 msgid "guestfs_egrep"
23761 #: ../src/guestfs-actions.pod:1431
23765 " guestfs_egrep (guestfs_h *g,\n"
23766 " const char *regex,\n"
23767 " const char *path);\n"
23772 #: ../src/guestfs-actions.pod:1446 ../src/guestfs-actions.pod:1465
23773 #: ../src/guestfs-actions.pod:1522 ../src/guestfs-actions.pod:1568
23774 #: ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:2304
23775 #: ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:2479
23776 #: ../src/guestfs-actions.pod:2492 ../src/guestfs-actions.pod:2507
23777 #: ../src/guestfs-actions.pod:2553 ../src/guestfs-actions.pod:2575
23778 #: ../src/guestfs-actions.pod:2588 ../src/guestfs-actions.pod:3857
23779 #: ../src/guestfs-actions.pod:3871 ../src/guestfs-actions.pod:3884
23780 #: ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:4899
23781 #: ../src/guestfs-actions.pod:5930 ../src/guestfs-actions.pod:5979
23782 #: ../src/guestfs-actions.pod:6849 ../src/guestfs-actions.pod:6861
23783 #: ../src/guestfs-actions.pod:6874 ../src/guestfs-actions.pod:6887
23784 #: ../src/guestfs-actions.pod:6909 ../src/guestfs-actions.pod:6922
23785 #: ../src/guestfs-actions.pod:6935 ../src/guestfs-actions.pod:6948
23786 #: ../src/guestfs-actions.pod:7742 ../src/guestfs-actions.pod:7761
23787 #: ../src/guestfs-actions.pod:7855 ../src/guestfs-actions.pod:7874
23788 #: ../src/guestfs-actions.pod:7920 ../src/guestfs-actions.pod:7939
23789 msgid "(Added in 1.0.66)"
23793 #: ../src/guestfs-actions.pod:1448
23794 msgid "guestfs_egrepi"
23798 #: ../src/guestfs-actions.pod:1450
23802 " guestfs_egrepi (guestfs_h *g,\n"
23803 " const char *regex,\n"
23804 " const char *path);\n"
23809 #: ../src/guestfs-actions.pod:1467
23810 msgid "guestfs_equal"
23814 #: ../src/guestfs-actions.pod:1469
23818 " guestfs_equal (guestfs_h *g,\n"
23819 " const char *file1,\n"
23820 " const char *file2);\n"
23825 #: ../src/guestfs-actions.pod:1483
23826 msgid "guestfs_exists"
23830 #: ../src/guestfs-actions.pod:1485
23834 " guestfs_exists (guestfs_h *g,\n"
23835 " const char *path);\n"
23840 #: ../src/guestfs-actions.pod:1492
23841 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
23845 #: ../src/guestfs-actions.pod:1498
23846 msgid "guestfs_fallocate"
23850 #: ../src/guestfs-actions.pod:1500
23854 " guestfs_fallocate (guestfs_h *g,\n"
23855 " const char *path,\n"
23861 #: ../src/guestfs-actions.pod:1505
23863 "I<This function is deprecated.> In new code, use the L</guestfs_fallocate64> "
23868 #: ../src/guestfs-actions.pod:1524
23869 msgid "guestfs_fallocate64"
23873 #: ../src/guestfs-actions.pod:1526
23877 " guestfs_fallocate64 (guestfs_h *g,\n"
23878 " const char *path,\n"
23884 #: ../src/guestfs-actions.pod:1535
23886 "Note that this call allocates disk blocks for the file. To create a sparse "
23887 "file use C<guestfs_truncate_size> instead."
23891 #: ../src/guestfs-actions.pod:1538
23893 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
23894 "oversight it only allowed 30 bit lengths to be specified, effectively "
23895 "limiting the maximum size of files created through that call to 1GB."
23899 #: ../src/guestfs-actions.pod:1549
23900 msgid "(Added in 1.3.17)"
23904 #: ../src/guestfs-actions.pod:1551
23905 msgid "guestfs_fgrep"
23909 #: ../src/guestfs-actions.pod:1553
23913 " guestfs_fgrep (guestfs_h *g,\n"
23914 " const char *pattern,\n"
23915 " const char *path);\n"
23920 #: ../src/guestfs-actions.pod:1570
23921 msgid "guestfs_fgrepi"
23925 #: ../src/guestfs-actions.pod:1572
23929 " guestfs_fgrepi (guestfs_h *g,\n"
23930 " const char *pattern,\n"
23931 " const char *path);\n"
23936 #: ../src/guestfs-actions.pod:1589
23937 msgid "guestfs_file"
23941 #: ../src/guestfs-actions.pod:1591
23945 " guestfs_file (guestfs_h *g,\n"
23946 " const char *path);\n"
23951 #: ../src/guestfs-actions.pod:1609
23953 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
23954 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
23958 #: ../src/guestfs-actions.pod:1617
23959 msgid "guestfs_file_architecture"
23963 #: ../src/guestfs-actions.pod:1619
23967 " guestfs_file_architecture (guestfs_h *g,\n"
23968 " const char *filename);\n"
23973 #: ../src/guestfs-actions.pod:1727 ../src/guestfs-actions.pod:1890
23974 #: ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:2608
23975 #: ../src/guestfs-actions.pod:2698 ../src/guestfs-actions.pod:2764
23976 #: ../src/guestfs-actions.pod:2951 ../src/guestfs-actions.pod:2969
23977 #: ../src/guestfs-actions.pod:3009 ../src/guestfs-actions.pod:3084
23978 #: ../src/guestfs-actions.pod:3177 ../src/guestfs-actions.pod:3414
23979 #: ../src/guestfs-actions.pod:3546
23980 msgid "(Added in 1.5.3)"
23984 #: ../src/guestfs-actions.pod:1729
23985 msgid "guestfs_filesize"
23989 #: ../src/guestfs-actions.pod:1731
23993 " guestfs_filesize (guestfs_h *g,\n"
23994 " const char *file);\n"
23999 #: ../src/guestfs-actions.pod:1737
24001 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
24002 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
24003 "devices, use C<guestfs_blockdev_getsize64>."
24007 #: ../src/guestfs-actions.pod:1743
24008 msgid "(Added in 1.0.82)"
24012 #: ../src/guestfs-actions.pod:1745
24013 msgid "guestfs_fill"
24017 #: ../src/guestfs-actions.pod:1747
24021 " guestfs_fill (guestfs_h *g,\n"
24024 " const char *path);\n"
24029 #: ../src/guestfs-actions.pod:1757
24031 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
24032 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
24033 "bytes use C<guestfs_fill_pattern>."
24037 #: ../src/guestfs-actions.pod:1769
24038 msgid "(Added in 1.0.79)"
24042 #: ../src/guestfs-actions.pod:1771
24043 msgid "guestfs_fill_pattern"
24047 #: ../src/guestfs-actions.pod:1773
24051 " guestfs_fill_pattern (guestfs_h *g,\n"
24052 " const char *pattern,\n"
24054 " const char *path);\n"
24059 #: ../src/guestfs-actions.pod:1779
24061 "This function is like C<guestfs_fill> except that it creates a new file of "
24062 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
24063 "pattern is truncated if necessary to ensure the length of the file is "
24064 "exactly C<len> bytes."
24068 #: ../src/guestfs-actions.pod:1791
24069 msgid "(Added in 1.3.12)"
24073 #: ../src/guestfs-actions.pod:1793
24074 msgid "guestfs_find"
24078 #: ../src/guestfs-actions.pod:1795
24082 " guestfs_find (guestfs_h *g,\n"
24083 " const char *directory);\n"
24088 #: ../src/guestfs-actions.pod:1811
24090 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
24094 #: ../src/guestfs-actions.pod:1824
24095 msgid "See also C<guestfs_find0>."
24099 #: ../src/guestfs-actions.pod:1833 ../src/guestfs-actions.pod:4304
24100 #: ../src/guestfs-actions.pod:6014
24101 msgid "(Added in 1.0.27)"
24105 #: ../src/guestfs-actions.pod:1835
24106 msgid "guestfs_find0"
24110 #: ../src/guestfs-actions.pod:1837
24114 " guestfs_find0 (guestfs_h *g,\n"
24115 " const char *directory,\n"
24116 " const char *files);\n"
24121 #: ../src/guestfs-actions.pod:1846
24123 "This command works the same way as C<guestfs_find> with the following "
24128 #: ../src/guestfs-actions.pod:1873
24129 msgid "(Added in 1.0.74)"
24133 #: ../src/guestfs-actions.pod:1875
24134 msgid "guestfs_findfs_label"
24138 #: ../src/guestfs-actions.pod:1877
24142 " guestfs_findfs_label (guestfs_h *g,\n"
24143 " const char *label);\n"
24148 #: ../src/guestfs-actions.pod:1885
24149 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
24153 #: ../src/guestfs-actions.pod:1892
24154 msgid "guestfs_findfs_uuid"
24158 #: ../src/guestfs-actions.pod:1894
24162 " guestfs_findfs_uuid (guestfs_h *g,\n"
24163 " const char *uuid);\n"
24168 #: ../src/guestfs-actions.pod:1902
24169 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
24173 #: ../src/guestfs-actions.pod:1909
24174 msgid "guestfs_fsck"
24178 #: ../src/guestfs-actions.pod:1911
24182 " guestfs_fsck (guestfs_h *g,\n"
24183 " const char *fstype,\n"
24184 " const char *device);\n"
24189 #: ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:7789
24190 msgid "(Added in 1.0.16)"
24194 #: ../src/guestfs-actions.pod:1948
24195 msgid "guestfs_get_append"
24199 #: ../src/guestfs-actions.pod:1950
24203 " guestfs_get_append (guestfs_h *g);\n"
24208 #: ../src/guestfs-actions.pod:1958
24210 "This function returns a string which may be NULL. There is no way to return "
24211 "an error from this function. The string is owned by the guest handle and "
24212 "must I<not> be freed."
24216 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:5692
24217 #: ../src/guestfs-actions.pod:6174 ../src/guestfs-actions.pod:6616
24218 #: ../src/guestfs-actions.pod:6635 ../src/guestfs-actions.pod:6651
24219 #: ../src/guestfs-actions.pod:6675 ../src/guestfs-actions.pod:7429
24220 #: ../src/guestfs-actions.pod:7444 ../src/guestfs-actions.pod:7836
24221 msgid "(Added in 1.0.26)"
24225 #: ../src/guestfs-actions.pod:1964
24226 msgid "guestfs_get_attach_method"
24230 #: ../src/guestfs-actions.pod:1966
24234 " guestfs_get_attach_method (guestfs_h *g);\n"
24239 #: ../src/guestfs-actions.pod:1969
24240 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
24244 #: ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:6204
24245 msgid "(Added in 1.9.8)"
24249 #: ../src/guestfs-actions.pod:1976
24250 msgid "guestfs_get_autosync"
24254 #: ../src/guestfs-actions.pod:1978
24258 " guestfs_get_autosync (guestfs_h *g);\n"
24263 #: ../src/guestfs-actions.pod:1987
24264 msgid "guestfs_get_direct"
24268 #: ../src/guestfs-actions.pod:1989
24272 " guestfs_get_direct (guestfs_h *g);\n"
24277 #: ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:6245
24278 msgid "(Added in 1.0.72)"
24282 #: ../src/guestfs-actions.pod:1998
24283 msgid "guestfs_get_e2label"
24287 #: ../src/guestfs-actions.pod:2000
24291 " guestfs_get_e2label (guestfs_h *g,\n"
24292 " const char *device);\n"
24297 #: ../src/guestfs-actions.pod:2004
24299 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_label> "
24304 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2038
24305 #: ../src/guestfs-actions.pod:6263 ../src/guestfs-actions.pod:6282
24306 msgid "(Added in 1.0.15)"
24310 #: ../src/guestfs-actions.pod:2019
24311 msgid "guestfs_get_e2uuid"
24315 #: ../src/guestfs-actions.pod:2021
24319 " guestfs_get_e2uuid (guestfs_h *g,\n"
24320 " const char *device);\n"
24325 #: ../src/guestfs-actions.pod:2025
24327 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_uuid> "
24332 #: ../src/guestfs-actions.pod:2040
24333 msgid "guestfs_get_memsize"
24337 #: ../src/guestfs-actions.pod:2042
24341 " guestfs_get_memsize (guestfs_h *g);\n"
24346 #: ../src/guestfs-actions.pod:2048
24348 "If C<guestfs_set_memsize> was not called on this handle, and if "
24349 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
24350 "value for memsize."
24354 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:4595
24355 #: ../src/guestfs-actions.pod:4804 ../src/guestfs-actions.pod:4823
24356 #: ../src/guestfs-actions.pod:4842 ../src/guestfs-actions.pod:4854
24357 #: ../src/guestfs-actions.pod:4871 ../src/guestfs-actions.pod:4884
24358 #: ../src/guestfs-actions.pod:5917 ../src/guestfs-actions.pod:6303
24359 #: ../src/guestfs-actions.pod:6583 ../src/guestfs-actions.pod:7198
24360 msgid "(Added in 1.0.55)"
24364 #: ../src/guestfs-actions.pod:2059
24365 msgid "guestfs_get_network"
24369 #: ../src/guestfs-actions.pod:2061
24373 " guestfs_get_network (guestfs_h *g);\n"
24378 #: ../src/guestfs-actions.pod:2068 ../src/guestfs-actions.pod:6322
24379 msgid "(Added in 1.5.4)"
24383 #: ../src/guestfs-actions.pod:2070
24384 msgid "guestfs_get_path"
24388 #: ../src/guestfs-actions.pod:2072
24392 " guestfs_get_path (guestfs_h *g);\n"
24397 #: ../src/guestfs-actions.pod:2080 ../src/guestfs-actions.pod:2120
24399 "This function returns a string, or NULL on error. The string is owned by "
24400 "the guest handle and must I<not> be freed."
24404 #: ../src/guestfs-actions.pod:2085
24405 msgid "guestfs_get_pgroup"
24409 #: ../src/guestfs-actions.pod:2087
24413 " guestfs_get_pgroup (guestfs_h *g);\n"
24418 #: ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:6358
24419 #: ../src/guestfs-actions.pod:7690
24420 msgid "(Added in 1.11.18)"
24424 #: ../src/guestfs-actions.pod:2096
24425 msgid "guestfs_get_pid"
24429 #: ../src/guestfs-actions.pod:2098
24433 " guestfs_get_pid (guestfs_h *g);\n"
24438 #: ../src/guestfs-actions.pod:2108
24439 msgid "(Added in 1.0.56)"
24443 #: ../src/guestfs-actions.pod:2110
24444 msgid "guestfs_get_qemu"
24448 #: ../src/guestfs-actions.pod:2112
24452 " guestfs_get_qemu (guestfs_h *g);\n"
24457 #: ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:6386
24458 msgid "(Added in 1.0.6)"
24462 #: ../src/guestfs-actions.pod:2125
24463 msgid "guestfs_get_recovery_proc"
24467 #: ../src/guestfs-actions.pod:2127
24471 " guestfs_get_recovery_proc (guestfs_h *g);\n"
24476 #: ../src/guestfs-actions.pod:2134 ../src/guestfs-actions.pod:3668
24477 #: ../src/guestfs-actions.pod:3999 ../src/guestfs-actions.pod:4402
24478 #: ../src/guestfs-actions.pod:4434 ../src/guestfs-actions.pod:5622
24479 #: ../src/guestfs-actions.pod:5965 ../src/guestfs-actions.pod:6410
24480 #: ../src/guestfs-actions.pod:7101 ../src/guestfs-actions.pod:7121
24481 #: ../src/guestfs-actions.pod:7313
24482 msgid "(Added in 1.0.77)"
24486 #: ../src/guestfs-actions.pod:2136
24487 msgid "guestfs_get_selinux"
24491 #: ../src/guestfs-actions.pod:2138
24495 " guestfs_get_selinux (guestfs_h *g);\n"
24500 #: ../src/guestfs-actions.pod:2141
24502 "This returns the current setting of the selinux flag which is passed to the "
24503 "appliance at boot time. See C<guestfs_set_selinux>."
24507 #: ../src/guestfs-actions.pod:2149 ../src/guestfs-actions.pod:2212
24508 #: ../src/guestfs-actions.pod:6429 ../src/guestfs-actions.pod:6487
24509 msgid "(Added in 1.0.67)"
24513 #: ../src/guestfs-actions.pod:2151
24514 msgid "guestfs_get_state"
24518 #: ../src/guestfs-actions.pod:2153
24522 " guestfs_get_state (guestfs_h *g);\n"
24527 #: ../src/guestfs-actions.pod:2165
24528 msgid "guestfs_get_trace"
24532 #: ../src/guestfs-actions.pod:2167
24536 " guestfs_get_trace (guestfs_h *g);\n"
24541 #: ../src/guestfs-actions.pod:2176
24542 msgid "guestfs_get_umask"
24546 #: ../src/guestfs-actions.pod:2178
24550 " guestfs_get_umask (guestfs_h *g);\n"
24555 #: ../src/guestfs-actions.pod:2181
24557 "Return the current umask. By default the umask is C<022> unless it has been "
24558 "set by calling C<guestfs_umask>."
24562 #: ../src/guestfs-actions.pod:2188
24563 msgid "guestfs_get_verbose"
24567 #: ../src/guestfs-actions.pod:2190
24571 " guestfs_get_verbose (guestfs_h *g);\n"
24576 #: ../src/guestfs-actions.pod:2199
24577 msgid "guestfs_getcon"
24581 #: ../src/guestfs-actions.pod:2201
24585 " guestfs_getcon (guestfs_h *g);\n"
24590 #: ../src/guestfs-actions.pod:2206
24592 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
24596 #: ../src/guestfs-actions.pod:2214
24597 msgid "guestfs_getxattr"
24601 #: ../src/guestfs-actions.pod:2216
24605 " guestfs_getxattr (guestfs_h *g,\n"
24606 " const char *path,\n"
24607 " const char *name,\n"
24608 " size_t *size_r);\n"
24613 #: ../src/guestfs-actions.pod:2222
24615 "Get a single extended attribute from file C<path> named C<name>. This call "
24616 "follows symlinks. If you want to lookup an extended attribute for the "
24617 "symlink itself, use C<guestfs_lgetxattr>."
24621 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:3682
24623 "Normally it is better to get all extended attributes from a file in one go "
24624 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
24625 "implementations are buggy and do not provide a way to list out attributes. "
24626 "For these filesystems (notably ntfs-3g) you have to know the names of the "
24627 "extended attributes you want in advance and call this function."
24631 #: ../src/guestfs-actions.pod:2236
24632 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
24636 #: ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2429
24637 #: ../src/guestfs-actions.pod:2899 ../src/guestfs-actions.pod:3694
24638 #: ../src/guestfs-actions.pod:5615 ../src/guestfs-actions.pod:5641
24639 #: ../src/guestfs-actions.pod:5822
24641 "This function returns a buffer, or NULL on error. The size of the returned "
24642 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
24647 #: ../src/guestfs-actions.pod:2242 ../src/guestfs-actions.pod:3698
24648 msgid "(Added in 1.7.24)"
24652 #: ../src/guestfs-actions.pod:2244
24653 msgid "guestfs_getxattrs"
24657 #: ../src/guestfs-actions.pod:2246
24660 " struct guestfs_xattr_list *\n"
24661 " guestfs_getxattrs (guestfs_h *g,\n"
24662 " const char *path);\n"
24667 #: ../src/guestfs-actions.pod:2256
24668 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
24672 #: ../src/guestfs-actions.pod:2258 ../src/guestfs-actions.pod:3710
24673 #: ../src/guestfs-actions.pod:4398
24675 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
24676 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
24680 #: ../src/guestfs-actions.pod:2262 ../src/guestfs-actions.pod:3714
24681 #: ../src/guestfs-actions.pod:3913 ../src/guestfs-actions.pod:3949
24682 #: ../src/guestfs-actions.pod:5995 ../src/guestfs-actions.pod:6506
24683 #: ../src/guestfs-actions.pod:7901
24684 msgid "(Added in 1.0.59)"
24688 #: ../src/guestfs-actions.pod:2264
24689 msgid "guestfs_glob_expand"
24693 #: ../src/guestfs-actions.pod:2266
24697 " guestfs_glob_expand (guestfs_h *g,\n"
24698 " const char *pattern);\n"
24703 #: ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:6699
24704 #: ../src/guestfs-actions.pod:6716
24705 msgid "(Added in 1.0.50)"
24709 #: ../src/guestfs-actions.pod:2287
24710 msgid "guestfs_grep"
24714 #: ../src/guestfs-actions.pod:2289
24718 " guestfs_grep (guestfs_h *g,\n"
24719 " const char *regex,\n"
24720 " const char *path);\n"
24725 #: ../src/guestfs-actions.pod:2306
24726 msgid "guestfs_grepi"
24730 #: ../src/guestfs-actions.pod:2308
24734 " guestfs_grepi (guestfs_h *g,\n"
24735 " const char *regex,\n"
24736 " const char *path);\n"
24741 #: ../src/guestfs-actions.pod:2325
24742 msgid "guestfs_grub_install"
24746 #: ../src/guestfs-actions.pod:2327
24750 " guestfs_grub_install (guestfs_h *g,\n"
24751 " const char *root,\n"
24752 " const char *device);\n"
24757 #: ../src/guestfs-actions.pod:2348
24758 msgid "(Added in 1.0.17)"
24762 #: ../src/guestfs-actions.pod:2350
24763 msgid "guestfs_head"
24767 #: ../src/guestfs-actions.pod:2352
24771 " guestfs_head (guestfs_h *g,\n"
24772 " const char *path);\n"
24777 #: ../src/guestfs-actions.pod:2368
24778 msgid "guestfs_head_n"
24782 #: ../src/guestfs-actions.pod:2370
24786 " guestfs_head_n (guestfs_h *g,\n"
24788 " const char *path);\n"
24793 #: ../src/guestfs-actions.pod:2392
24794 msgid "guestfs_hexdump"
24798 #: ../src/guestfs-actions.pod:2394
24802 " guestfs_hexdump (guestfs_h *g,\n"
24803 " const char *path);\n"
24808 #: ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:6780
24809 #: ../src/guestfs-actions.pod:6835
24810 msgid "(Added in 1.0.22)"
24814 #: ../src/guestfs-actions.pod:2409
24815 msgid "guestfs_initrd_cat"
24819 #: ../src/guestfs-actions.pod:2411
24823 " guestfs_initrd_cat (guestfs_h *g,\n"
24824 " const char *initrdpath,\n"
24825 " const char *filename,\n"
24826 " size_t *size_r);\n"
24831 #: ../src/guestfs-actions.pod:2427
24832 msgid "See also C<guestfs_initrd_list>."
24836 #: ../src/guestfs-actions.pod:2438
24837 msgid "guestfs_initrd_list"
24841 #: ../src/guestfs-actions.pod:2440
24845 " guestfs_initrd_list (guestfs_h *g,\n"
24846 " const char *path);\n"
24851 #: ../src/guestfs-actions.pod:2460
24852 msgid "guestfs_inotify_add_watch"
24856 #: ../src/guestfs-actions.pod:2462
24860 " guestfs_inotify_add_watch (guestfs_h *g,\n"
24861 " const char *path,\n"
24867 #: ../src/guestfs-actions.pod:2481
24868 msgid "guestfs_inotify_close"
24872 #: ../src/guestfs-actions.pod:2483
24876 " guestfs_inotify_close (guestfs_h *g);\n"
24881 #: ../src/guestfs-actions.pod:2494
24882 msgid "guestfs_inotify_files"
24886 #: ../src/guestfs-actions.pod:2496
24890 " guestfs_inotify_files (guestfs_h *g);\n"
24895 #: ../src/guestfs-actions.pod:2499
24897 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
24898 "returns a list of pathnames of objects that were touched. The returned "
24899 "pathnames are sorted and deduplicated."
24903 #: ../src/guestfs-actions.pod:2509
24904 msgid "guestfs_inotify_init"
24908 #: ../src/guestfs-actions.pod:2511
24912 " guestfs_inotify_init (guestfs_h *g,\n"
24913 " int maxevents);\n"
24918 #: ../src/guestfs-actions.pod:2519
24920 "C<maxevents> is the maximum number of events which will be queued up between "
24921 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
24922 "passed as C<0>, then the kernel (or previously set) default is used. For "
24923 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
24924 "throws away events, but records the fact that it threw them away by setting "
24925 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
24926 "C<guestfs_inotify_read>)."
24930 #: ../src/guestfs-actions.pod:2529
24932 "Before any events are generated, you have to add some watches to the "
24933 "internal watch list. See: C<guestfs_inotify_add_watch>, "
24934 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
24938 #: ../src/guestfs-actions.pod:2535
24940 "Queued up events should be read periodically by calling "
24941 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
24942 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
24943 "often enough then you risk the internal queue overflowing."
24947 #: ../src/guestfs-actions.pod:2542
24949 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
24950 "This also removes any watches automatically."
24954 #: ../src/guestfs-actions.pod:2555
24955 msgid "guestfs_inotify_read"
24959 #: ../src/guestfs-actions.pod:2557
24962 " struct guestfs_inotify_event_list *\n"
24963 " guestfs_inotify_read (guestfs_h *g);\n"
24968 #: ../src/guestfs-actions.pod:2571
24970 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
24971 "there was an error. I<The caller must call "
24972 "C<guestfs_free_inotify_event_list> after use>."
24976 #: ../src/guestfs-actions.pod:2577
24977 msgid "guestfs_inotify_rm_watch"
24981 #: ../src/guestfs-actions.pod:2579
24985 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
24991 #: ../src/guestfs-actions.pod:2583
24993 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
24997 #: ../src/guestfs-actions.pod:2590
24998 msgid "guestfs_inspect_get_arch"
25002 #: ../src/guestfs-actions.pod:2592
25006 " guestfs_inspect_get_arch (guestfs_h *g,\n"
25007 " const char *root);\n"
25012 #: ../src/guestfs-actions.pod:2596
25014 "This returns the architecture of the inspected operating system. The "
25015 "possible return values are listed under C<guestfs_file_architecture>."
25019 #: ../src/guestfs-actions.pod:2610
25020 msgid "guestfs_inspect_get_distro"
25024 #: ../src/guestfs-actions.pod:2612
25028 " guestfs_inspect_get_distro (guestfs_h *g,\n"
25029 " const char *root);\n"
25034 #: ../src/guestfs-actions.pod:2700
25035 msgid "guestfs_inspect_get_drive_mappings"
25039 #: ../src/guestfs-actions.pod:2702
25043 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
25044 " const char *root);\n"
25049 #: ../src/guestfs-actions.pod:2731
25051 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25052 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
25056 #: ../src/guestfs-actions.pod:2735 ../src/guestfs-actions.pod:3003
25057 #: ../src/guestfs-actions.pod:3801 ../src/guestfs-actions.pod:5083
25058 #: ../src/guestfs-actions.pod:7137
25060 "This function returns a NULL-terminated array of strings, or NULL if there "
25061 "was an error. The array of strings will always have length C<2n+1>, where "
25062 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
25063 "caller must free the strings and the array after use>."
25067 #: ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:3197
25068 msgid "(Added in 1.9.17)"
25072 #: ../src/guestfs-actions.pod:2743
25073 msgid "guestfs_inspect_get_filesystems"
25077 #: ../src/guestfs-actions.pod:2745
25081 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
25082 " const char *root);\n"
25087 #: ../src/guestfs-actions.pod:2757
25089 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25090 "C<guestfs_inspect_get_mountpoints>."
25094 #: ../src/guestfs-actions.pod:2766
25095 msgid "guestfs_inspect_get_format"
25099 #: ../src/guestfs-actions.pod:2768
25103 " guestfs_inspect_get_format (guestfs_h *g,\n"
25104 " const char *root);\n"
25109 #: ../src/guestfs-actions.pod:2802 ../src/guestfs-actions.pod:3233
25110 #: ../src/guestfs-actions.pod:3249 ../src/guestfs-actions.pod:3267
25111 #: ../src/guestfs-actions.pod:6033
25112 msgid "(Added in 1.9.4)"
25116 #: ../src/guestfs-actions.pod:2804
25117 msgid "guestfs_inspect_get_hostname"
25121 #: ../src/guestfs-actions.pod:2806
25125 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
25126 " const char *root);\n"
25131 #: ../src/guestfs-actions.pod:2821
25132 msgid "(Added in 1.7.9)"
25136 #: ../src/guestfs-actions.pod:2823
25137 msgid "guestfs_inspect_get_icon"
25141 #: ../src/guestfs-actions.pod:2825
25145 " guestfs_inspect_get_icon (guestfs_h *g,\n"
25146 " const char *root,\n"
25147 " size_t *size_r,\n"
25153 #: ../src/guestfs-actions.pod:2836
25156 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
25157 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
25162 #: ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:3728
25163 #: ../src/guestfs-actions.pod:4982
25164 msgid "(Added in 1.11.12)"
25168 #: ../src/guestfs-actions.pod:2905
25169 msgid "guestfs_inspect_get_icon_va"
25173 #: ../src/guestfs-actions.pod:2907
25177 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
25178 " const char *root,\n"
25179 " size_t *size_r,\n"
25180 " va_list args);\n"
25185 #: ../src/guestfs-actions.pod:2913
25186 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
25190 #: ../src/guestfs-actions.pod:2917
25191 msgid "guestfs_inspect_get_icon_argv"
25195 #: ../src/guestfs-actions.pod:2919
25199 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
25200 " const char *root,\n"
25201 " size_t *size_r,\n"
25202 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
25207 #: ../src/guestfs-actions.pod:2925
25208 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
25212 #: ../src/guestfs-actions.pod:2929
25213 msgid "guestfs_inspect_get_major_version"
25217 #: ../src/guestfs-actions.pod:2931
25221 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
25222 " const char *root);\n"
25227 #: ../src/guestfs-actions.pod:2953
25228 msgid "guestfs_inspect_get_minor_version"
25232 #: ../src/guestfs-actions.pod:2955
25236 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
25237 " const char *root);\n"
25242 #: ../src/guestfs-actions.pod:2964
25244 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25245 "C<guestfs_inspect_get_major_version>."
25249 #: ../src/guestfs-actions.pod:2971
25250 msgid "guestfs_inspect_get_mountpoints"
25254 #: ../src/guestfs-actions.pod:2973
25258 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
25259 " const char *root);\n"
25264 #: ../src/guestfs-actions.pod:2994
25266 "For operating systems like Windows which still use drive letters, this call "
25267 "will only return an entry for the first drive \"mounted on\" C</>. For "
25268 "information about the mapping of drive letters to partitions, see "
25269 "C<guestfs_inspect_get_drive_mappings>."
25273 #: ../src/guestfs-actions.pod:3000
25275 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25276 "C<guestfs_inspect_get_filesystems>."
25280 #: ../src/guestfs-actions.pod:3011
25281 msgid "guestfs_inspect_get_package_format"
25285 #: ../src/guestfs-actions.pod:3013
25289 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
25290 " const char *root);\n"
25295 #: ../src/guestfs-actions.pod:3017
25297 "This function and C<guestfs_inspect_get_package_management> return the "
25298 "package format and package management tool used by the inspected operating "
25299 "system. For example for Fedora these functions would return C<rpm> (package "
25300 "format) and C<yum> (package management)."
25304 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3063
25305 msgid "(Added in 1.7.5)"
25309 #: ../src/guestfs-actions.pod:3037
25310 msgid "guestfs_inspect_get_package_management"
25314 #: ../src/guestfs-actions.pod:3039
25318 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
25319 " const char *root);\n"
25324 #: ../src/guestfs-actions.pod:3043
25326 "C<guestfs_inspect_get_package_format> and this function return the package "
25327 "format and package management tool used by the inspected operating system. "
25328 "For example for Fedora these functions would return C<rpm> (package format) "
25329 "and C<yum> (package management)."
25333 #: ../src/guestfs-actions.pod:3065
25334 msgid "guestfs_inspect_get_product_name"
25338 #: ../src/guestfs-actions.pod:3067
25342 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
25343 " const char *root);\n"
25348 #: ../src/guestfs-actions.pod:3086
25349 msgid "guestfs_inspect_get_product_variant"
25353 #: ../src/guestfs-actions.pod:3088
25357 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
25358 " const char *root);\n"
25363 #: ../src/guestfs-actions.pod:3111
25365 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25366 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
25370 #: ../src/guestfs-actions.pod:3118
25371 msgid "(Added in 1.9.13)"
25375 #: ../src/guestfs-actions.pod:3120
25376 msgid "guestfs_inspect_get_roots"
25380 #: ../src/guestfs-actions.pod:3122
25384 " guestfs_inspect_get_roots (guestfs_h *g);\n"
25389 #: ../src/guestfs-actions.pod:3125
25391 "This function is a convenient way to get the list of root devices, as "
25392 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
25393 "the whole inspection process."
25397 #: ../src/guestfs-actions.pod:3129
25399 "This returns an empty list if either no root devices were found or the "
25400 "caller has not called C<guestfs_inspect_os>."
25404 #: ../src/guestfs-actions.pod:3138
25405 msgid "(Added in 1.7.3)"
25409 #: ../src/guestfs-actions.pod:3140
25410 msgid "guestfs_inspect_get_type"
25414 #: ../src/guestfs-actions.pod:3142
25418 " guestfs_inspect_get_type (guestfs_h *g,\n"
25419 " const char *root);\n"
25424 #: ../src/guestfs-actions.pod:3179
25425 msgid "guestfs_inspect_get_windows_current_control_set"
25429 #: ../src/guestfs-actions.pod:3181
25433 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
25434 " const char *root);\n"
25439 #: ../src/guestfs-actions.pod:3199
25440 msgid "guestfs_inspect_get_windows_systemroot"
25444 #: ../src/guestfs-actions.pod:3201
25448 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
25449 " const char *root);\n"
25454 #: ../src/guestfs-actions.pod:3217
25455 msgid "(Added in 1.5.25)"
25459 #: ../src/guestfs-actions.pod:3219
25460 msgid "guestfs_inspect_is_live"
25464 #: ../src/guestfs-actions.pod:3221
25468 " guestfs_inspect_is_live (guestfs_h *g,\n"
25469 " const char *root);\n"
25474 #: ../src/guestfs-actions.pod:3225
25476 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25477 "disk), then this returns true if a live image was detected on the disk."
25481 #: ../src/guestfs-actions.pod:3235
25482 msgid "guestfs_inspect_is_multipart"
25486 #: ../src/guestfs-actions.pod:3237
25490 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
25491 " const char *root);\n"
25496 #: ../src/guestfs-actions.pod:3241
25498 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25499 "disk), then this returns true if the disk is part of a set."
25503 #: ../src/guestfs-actions.pod:3251
25504 msgid "guestfs_inspect_is_netinst"
25508 #: ../src/guestfs-actions.pod:3253
25512 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
25513 " const char *root);\n"
25518 #: ../src/guestfs-actions.pod:3257
25520 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25521 "disk), then this returns true if the disk is a network installer, ie. not a "
25522 "self-contained install CD but one which is likely to require network access "
25523 "to complete the install."
25527 #: ../src/guestfs-actions.pod:3269
25528 msgid "guestfs_inspect_list_applications"
25532 #: ../src/guestfs-actions.pod:3271
25535 " struct guestfs_application_list *\n"
25536 " guestfs_inspect_list_applications (guestfs_h *g,\n"
25537 " const char *root);\n"
25542 #: ../src/guestfs-actions.pod:3277
25544 "I<Note:> This call works differently from other parts of the inspection "
25545 "API. You have to call C<guestfs_inspect_os>, then "
25546 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
25547 "this. Listing applications is a significantly more difficult operation "
25548 "which requires access to the full filesystem. Also note that unlike the "
25549 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
25550 "the libguestfs handle, this call actually reads parts of the mounted "
25551 "filesystems during the call."
25555 #: ../src/guestfs-actions.pod:3367
25557 "This function returns a C<struct guestfs_application_list *>, or NULL if "
25558 "there was an error. I<The caller must call C<guestfs_free_application_list> "
25563 #: ../src/guestfs-actions.pod:3371
25564 msgid "(Added in 1.7.8)"
25568 #: ../src/guestfs-actions.pod:3373
25569 msgid "guestfs_inspect_os"
25573 #: ../src/guestfs-actions.pod:3375
25577 " guestfs_inspect_os (guestfs_h *g);\n"
25582 #: ../src/guestfs-actions.pod:3391
25584 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
25585 "functions in order to query further information about each operating system, "
25586 "such as the name and version."
25590 #: ../src/guestfs-actions.pod:3396
25592 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
25593 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
25594 "the contents. This should be called with no disks currently mounted. The "
25595 "function may also use Augeas, so any existing Augeas handle will be closed."
25599 #: ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3739
25600 #: ../src/guestfs-actions.pod:3821
25601 msgid "See also C<guestfs_list_filesystems>."
25605 #: ../src/guestfs-actions.pod:3416
25606 msgid "guestfs_is_blockdev"
25610 #: ../src/guestfs-actions.pod:3418
25614 " guestfs_is_blockdev (guestfs_h *g,\n"
25615 " const char *path);\n"
25620 #: ../src/guestfs-actions.pod:3425 ../src/guestfs-actions.pod:3454
25621 #: ../src/guestfs-actions.pod:3484 ../src/guestfs-actions.pod:3499
25622 #: ../src/guestfs-actions.pod:3515 ../src/guestfs-actions.pod:3571
25623 #: ../src/guestfs-actions.pod:3586
25624 msgid "See also C<guestfs_stat>."
25628 #: ../src/guestfs-actions.pod:3429 ../src/guestfs-actions.pod:3458
25629 #: ../src/guestfs-actions.pod:3503 ../src/guestfs-actions.pod:3575
25630 #: ../src/guestfs-actions.pod:3590
25631 msgid "(Added in 1.5.10)"
25635 #: ../src/guestfs-actions.pod:3431
25636 msgid "guestfs_is_busy"
25640 #: ../src/guestfs-actions.pod:3433
25644 " guestfs_is_busy (guestfs_h *g);\n"
25649 #: ../src/guestfs-actions.pod:3445
25650 msgid "guestfs_is_chardev"
25654 #: ../src/guestfs-actions.pod:3447
25658 " guestfs_is_chardev (guestfs_h *g,\n"
25659 " const char *path);\n"
25664 #: ../src/guestfs-actions.pod:3460
25665 msgid "guestfs_is_config"
25669 #: ../src/guestfs-actions.pod:3462
25673 " guestfs_is_config (guestfs_h *g);\n"
25678 #: ../src/guestfs-actions.pod:3474
25679 msgid "guestfs_is_dir"
25683 #: ../src/guestfs-actions.pod:3476
25687 " guestfs_is_dir (guestfs_h *g,\n"
25688 " const char *path);\n"
25693 #: ../src/guestfs-actions.pod:3490
25694 msgid "guestfs_is_fifo"
25698 #: ../src/guestfs-actions.pod:3492
25702 " guestfs_is_fifo (guestfs_h *g,\n"
25703 " const char *path);\n"
25708 #: ../src/guestfs-actions.pod:3505
25709 msgid "guestfs_is_file"
25713 #: ../src/guestfs-actions.pod:3507
25717 " guestfs_is_file (guestfs_h *g,\n"
25718 " const char *path);\n"
25723 #: ../src/guestfs-actions.pod:3521
25724 msgid "guestfs_is_launching"
25728 #: ../src/guestfs-actions.pod:3523
25732 " guestfs_is_launching (guestfs_h *g);\n"
25737 #: ../src/guestfs-actions.pod:3535
25738 msgid "guestfs_is_lv"
25742 #: ../src/guestfs-actions.pod:3537
25746 " guestfs_is_lv (guestfs_h *g,\n"
25747 " const char *device);\n"
25752 #: ../src/guestfs-actions.pod:3548
25753 msgid "guestfs_is_ready"
25757 #: ../src/guestfs-actions.pod:3550
25761 " guestfs_is_ready (guestfs_h *g);\n"
25766 #: ../src/guestfs-actions.pod:3562
25767 msgid "guestfs_is_socket"
25771 #: ../src/guestfs-actions.pod:3564
25775 " guestfs_is_socket (guestfs_h *g,\n"
25776 " const char *path);\n"
25781 #: ../src/guestfs-actions.pod:3577
25782 msgid "guestfs_is_symlink"
25786 #: ../src/guestfs-actions.pod:3579
25790 " guestfs_is_symlink (guestfs_h *g,\n"
25791 " const char *path);\n"
25796 #: ../src/guestfs-actions.pod:3592
25797 msgid "guestfs_is_zero"
25801 #: ../src/guestfs-actions.pod:3594
25805 " guestfs_is_zero (guestfs_h *g,\n"
25806 " const char *path);\n"
25811 #: ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:3617
25812 msgid "(Added in 1.11.8)"
25816 #: ../src/guestfs-actions.pod:3605
25817 msgid "guestfs_is_zero_device"
25821 #: ../src/guestfs-actions.pod:3607
25825 " guestfs_is_zero_device (guestfs_h *g,\n"
25826 " const char *device);\n"
25831 #: ../src/guestfs-actions.pod:3619
25832 msgid "guestfs_kill_subprocess"
25836 #: ../src/guestfs-actions.pod:3621
25840 " guestfs_kill_subprocess (guestfs_h *g);\n"
25845 #: ../src/guestfs-actions.pod:3630
25846 msgid "guestfs_launch"
25850 #: ../src/guestfs-actions.pod:3632
25854 " guestfs_launch (guestfs_h *g);\n"
25859 #: ../src/guestfs-actions.pod:3650
25860 msgid "guestfs_lchown"
25864 #: ../src/guestfs-actions.pod:3652
25868 " guestfs_lchown (guestfs_h *g,\n"
25871 " const char *path);\n"
25876 #: ../src/guestfs-actions.pod:3658
25878 "Change the file owner to C<owner> and group to C<group>. This is like "
25879 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
25880 "changed, not the target."
25884 #: ../src/guestfs-actions.pod:3670
25885 msgid "guestfs_lgetxattr"
25889 #: ../src/guestfs-actions.pod:3672
25893 " guestfs_lgetxattr (guestfs_h *g,\n"
25894 " const char *path,\n"
25895 " const char *name,\n"
25896 " size_t *size_r);\n"
25901 #: ../src/guestfs-actions.pod:3692
25902 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
25906 #: ../src/guestfs-actions.pod:3700
25907 msgid "guestfs_lgetxattrs"
25911 #: ../src/guestfs-actions.pod:3702
25914 " struct guestfs_xattr_list *\n"
25915 " guestfs_lgetxattrs (guestfs_h *g,\n"
25916 " const char *path);\n"
25921 #: ../src/guestfs-actions.pod:3706
25923 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
25924 "then it returns the extended attributes of the link itself."
25928 #: ../src/guestfs-actions.pod:3716
25929 msgid "guestfs_list_9p"
25933 #: ../src/guestfs-actions.pod:3718
25937 " guestfs_list_9p (guestfs_h *g);\n"
25942 #: ../src/guestfs-actions.pod:3730
25943 msgid "guestfs_list_devices"
25947 #: ../src/guestfs-actions.pod:3732
25951 " guestfs_list_devices (guestfs_h *g);\n"
25956 #: ../src/guestfs-actions.pod:3747
25957 msgid "guestfs_list_dm_devices"
25961 #: ../src/guestfs-actions.pod:3749
25965 " guestfs_list_dm_devices (guestfs_h *g);\n"
25970 #: ../src/guestfs-actions.pod:3754
25972 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
25973 "previous call to C<guestfs_luks_open>."
25977 #: ../src/guestfs-actions.pod:3757
25979 "Device mapper devices which correspond to logical volumes are I<not> "
25980 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
25985 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:5221
25986 msgid "(Added in 1.11.15)"
25990 #: ../src/guestfs-actions.pod:3767
25991 msgid "guestfs_list_filesystems"
25995 #: ../src/guestfs-actions.pod:3769
25999 " guestfs_list_filesystems (guestfs_h *g);\n"
26004 #: ../src/guestfs-actions.pod:3789
26006 "This command runs other libguestfs commands, which might include "
26007 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
26008 "soon after launch and only when nothing is mounted."
26012 #: ../src/guestfs-actions.pod:3793
26014 "Not all of the filesystems returned will be mountable. In particular, swap "
26015 "partitions are returned in the list. Also this command does not check that "
26016 "each filesystem found is valid and mountable, and some filesystems might be "
26017 "mountable but require special options. Filesystems may not all belong to a "
26018 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
26022 #: ../src/guestfs-actions.pod:3807 ../src/guestfs-actions.pod:5582
26023 msgid "(Added in 1.5.15)"
26027 #: ../src/guestfs-actions.pod:3809
26028 msgid "guestfs_list_partitions"
26032 #: ../src/guestfs-actions.pod:3811
26036 " guestfs_list_partitions (guestfs_h *g);\n"
26041 #: ../src/guestfs-actions.pod:3818
26043 "This does not return logical volumes. For that you will need to call "
26048 #: ../src/guestfs-actions.pod:3829
26053 #: ../src/guestfs-actions.pod:3831
26057 " guestfs_ll (guestfs_h *g,\n"
26058 " const char *directory);\n"
26063 #: ../src/guestfs-actions.pod:3846
26068 #: ../src/guestfs-actions.pod:3848
26072 " guestfs_ln (guestfs_h *g,\n"
26073 " const char *target,\n"
26074 " const char *linkname);\n"
26079 #: ../src/guestfs-actions.pod:3859
26080 msgid "guestfs_ln_f"
26084 #: ../src/guestfs-actions.pod:3861
26088 " guestfs_ln_f (guestfs_h *g,\n"
26089 " const char *target,\n"
26090 " const char *linkname);\n"
26095 #: ../src/guestfs-actions.pod:3873
26096 msgid "guestfs_ln_s"
26100 #: ../src/guestfs-actions.pod:3875
26104 " guestfs_ln_s (guestfs_h *g,\n"
26105 " const char *target,\n"
26106 " const char *linkname);\n"
26111 #: ../src/guestfs-actions.pod:3886
26112 msgid "guestfs_ln_sf"
26116 #: ../src/guestfs-actions.pod:3888
26120 " guestfs_ln_sf (guestfs_h *g,\n"
26121 " const char *target,\n"
26122 " const char *linkname);\n"
26127 #: ../src/guestfs-actions.pod:3900
26128 msgid "guestfs_lremovexattr"
26132 #: ../src/guestfs-actions.pod:3902
26136 " guestfs_lremovexattr (guestfs_h *g,\n"
26137 " const char *xattr,\n"
26138 " const char *path);\n"
26143 #: ../src/guestfs-actions.pod:3907
26145 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
26146 "link, then it removes an extended attribute of the link itself."
26150 #: ../src/guestfs-actions.pod:3915
26155 #: ../src/guestfs-actions.pod:3917
26159 " guestfs_ls (guestfs_h *g,\n"
26160 " const char *directory);\n"
26165 #: ../src/guestfs-actions.pod:3925
26167 "This command is mostly useful for interactive sessions. Programs should "
26168 "probably use C<guestfs_readdir> instead."
26172 #: ../src/guestfs-actions.pod:3934
26173 msgid "guestfs_lsetxattr"
26177 #: ../src/guestfs-actions.pod:3936
26181 " guestfs_lsetxattr (guestfs_h *g,\n"
26182 " const char *xattr,\n"
26183 " const char *val,\n"
26185 " const char *path);\n"
26190 #: ../src/guestfs-actions.pod:3943
26192 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
26193 "then it sets an extended attribute of the link itself."
26197 #: ../src/guestfs-actions.pod:3951
26198 msgid "guestfs_lstat"
26202 #: ../src/guestfs-actions.pod:3953
26205 " struct guestfs_stat *\n"
26206 " guestfs_lstat (guestfs_h *g,\n"
26207 " const char *path);\n"
26212 #: ../src/guestfs-actions.pod:3959
26214 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
26215 "link, then the link is stat-ed, not the file it refers to."
26219 #: ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:6740
26221 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
26222 "error. I<The caller must call C<guestfs_free_stat> after use>."
26226 #: ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:6744
26227 #: ../src/guestfs-actions.pod:6762 ../src/guestfs-actions.pod:7143
26228 msgid "(Added in 0.9.2)"
26232 #: ../src/guestfs-actions.pod:3971
26233 msgid "guestfs_lstatlist"
26237 #: ../src/guestfs-actions.pod:3973
26240 " struct guestfs_stat_list *\n"
26241 " guestfs_lstatlist (guestfs_h *g,\n"
26242 " const char *path,\n"
26243 " char *const *names);\n"
26248 #: ../src/guestfs-actions.pod:3978
26250 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
26251 "files, where all files are in the directory C<path>. C<names> is the list "
26252 "of files from this directory."
26256 #: ../src/guestfs-actions.pod:3987
26258 "This call is intended for programs that want to efficiently list a directory "
26259 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
26260 "for a similarly efficient call for getting extended attributes. Very long "
26261 "directory listings might cause the protocol message size to be exceeded, "
26262 "causing this call to fail. The caller must split up such requests into "
26263 "smaller groups of names."
26267 #: ../src/guestfs-actions.pod:3995
26269 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
26270 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
26274 #: ../src/guestfs-actions.pod:4001
26275 msgid "guestfs_luks_add_key"
26279 #: ../src/guestfs-actions.pod:4003
26283 " guestfs_luks_add_key (guestfs_h *g,\n"
26284 " const char *device,\n"
26285 " const char *key,\n"
26286 " const char *newkey,\n"
26292 #: ../src/guestfs-actions.pod:4015
26294 "Note that if C<keyslot> already contains a key, then this command will "
26295 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
26299 #: ../src/guestfs-actions.pod:4021 ../src/guestfs-actions.pod:4061
26300 #: ../src/guestfs-actions.pod:4084 ../src/guestfs-actions.pod:4104
26301 #: ../src/guestfs-actions.pod:4139 ../src/guestfs-actions.pod:4158
26303 "This function takes a key or passphrase parameter which could contain "
26304 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
26309 #: ../src/guestfs-actions.pod:4025 ../src/guestfs-actions.pod:4065
26310 #: ../src/guestfs-actions.pod:4088 ../src/guestfs-actions.pod:4108
26311 msgid "(Added in 1.5.2)"
26315 #: ../src/guestfs-actions.pod:4027
26316 msgid "guestfs_luks_close"
26320 #: ../src/guestfs-actions.pod:4029
26324 " guestfs_luks_close (guestfs_h *g,\n"
26325 " const char *device);\n"
26330 #: ../src/guestfs-actions.pod:4033
26332 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
26333 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
26334 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
26335 "underlying block device."
26339 #: ../src/guestfs-actions.pod:4041 ../src/guestfs-actions.pod:4143
26340 #: ../src/guestfs-actions.pod:4162 ../src/guestfs-actions.pod:4212
26341 #: ../src/guestfs-actions.pod:4260
26342 msgid "(Added in 1.5.1)"
26346 #: ../src/guestfs-actions.pod:4043
26347 msgid "guestfs_luks_format"
26351 #: ../src/guestfs-actions.pod:4045
26355 " guestfs_luks_format (guestfs_h *g,\n"
26356 " const char *device,\n"
26357 " const char *key,\n"
26363 #: ../src/guestfs-actions.pod:4067
26364 msgid "guestfs_luks_format_cipher"
26368 #: ../src/guestfs-actions.pod:4069
26372 " guestfs_luks_format_cipher (guestfs_h *g,\n"
26373 " const char *device,\n"
26374 " const char *key,\n"
26376 " const char *cipher);\n"
26381 #: ../src/guestfs-actions.pod:4076
26383 "This command is the same as C<guestfs_luks_format> but it also allows you to "
26384 "set the C<cipher> used."
26388 #: ../src/guestfs-actions.pod:4090
26389 msgid "guestfs_luks_kill_slot"
26393 #: ../src/guestfs-actions.pod:4092
26397 " guestfs_luks_kill_slot (guestfs_h *g,\n"
26398 " const char *device,\n"
26399 " const char *key,\n"
26405 #: ../src/guestfs-actions.pod:4110
26406 msgid "guestfs_luks_open"
26410 #: ../src/guestfs-actions.pod:4112
26414 " guestfs_luks_open (guestfs_h *g,\n"
26415 " const char *device,\n"
26416 " const char *key,\n"
26417 " const char *mapname);\n"
26422 #: ../src/guestfs-actions.pod:4130
26424 "If this block device contains LVM volume groups, then calling "
26425 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
26430 #: ../src/guestfs-actions.pod:4134
26431 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
26435 #: ../src/guestfs-actions.pod:4145
26436 msgid "guestfs_luks_open_ro"
26440 #: ../src/guestfs-actions.pod:4147
26444 " guestfs_luks_open_ro (guestfs_h *g,\n"
26445 " const char *device,\n"
26446 " const char *key,\n"
26447 " const char *mapname);\n"
26452 #: ../src/guestfs-actions.pod:4153
26454 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
26459 #: ../src/guestfs-actions.pod:4164
26460 msgid "guestfs_lvcreate"
26464 #: ../src/guestfs-actions.pod:4166
26468 " guestfs_lvcreate (guestfs_h *g,\n"
26469 " const char *logvol,\n"
26470 " const char *volgroup,\n"
26476 #: ../src/guestfs-actions.pod:4179
26477 msgid "guestfs_lvm_canonical_lv_name"
26481 #: ../src/guestfs-actions.pod:4181
26485 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
26486 " const char *lvname);\n"
26491 #: ../src/guestfs-actions.pod:4192
26492 msgid "See also C<guestfs_is_lv>."
26496 #: ../src/guestfs-actions.pod:4197
26497 msgid "(Added in 1.5.24)"
26501 #: ../src/guestfs-actions.pod:4199
26502 msgid "guestfs_lvm_clear_filter"
26506 #: ../src/guestfs-actions.pod:4201
26510 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
26515 #: ../src/guestfs-actions.pod:4204
26517 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
26518 "see every block device."
26522 #: ../src/guestfs-actions.pod:4214
26523 msgid "guestfs_lvm_remove_all"
26527 #: ../src/guestfs-actions.pod:4216
26531 " guestfs_lvm_remove_all (guestfs_h *g);\n"
26536 #: ../src/guestfs-actions.pod:4229
26537 msgid "guestfs_lvm_set_filter"
26541 #: ../src/guestfs-actions.pod:4231
26545 " guestfs_lvm_set_filter (guestfs_h *g,\n"
26546 " char *const *devices);\n"
26551 #: ../src/guestfs-actions.pod:4262
26552 msgid "guestfs_lvremove"
26556 #: ../src/guestfs-actions.pod:4264
26560 " guestfs_lvremove (guestfs_h *g,\n"
26561 " const char *device);\n"
26566 #: ../src/guestfs-actions.pod:4276 ../src/guestfs-actions.pod:5679
26567 #: ../src/guestfs-actions.pod:7513
26568 msgid "(Added in 1.0.13)"
26572 #: ../src/guestfs-actions.pod:4278
26573 msgid "guestfs_lvrename"
26577 #: ../src/guestfs-actions.pod:4280
26581 " guestfs_lvrename (guestfs_h *g,\n"
26582 " const char *logvol,\n"
26583 " const char *newlogvol);\n"
26588 #: ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:7526
26589 msgid "(Added in 1.0.83)"
26593 #: ../src/guestfs-actions.pod:4291
26594 msgid "guestfs_lvresize"
26598 #: ../src/guestfs-actions.pod:4293
26602 " guestfs_lvresize (guestfs_h *g,\n"
26603 " const char *device,\n"
26609 #: ../src/guestfs-actions.pod:4306
26610 msgid "guestfs_lvresize_free"
26614 #: ../src/guestfs-actions.pod:4308
26618 " guestfs_lvresize_free (guestfs_h *g,\n"
26619 " const char *lv,\n"
26625 #: ../src/guestfs-actions.pod:4321
26626 msgid "(Added in 1.3.3)"
26630 #: ../src/guestfs-actions.pod:4323
26631 msgid "guestfs_lvs"
26635 #: ../src/guestfs-actions.pod:4325
26639 " guestfs_lvs (guestfs_h *g);\n"
26644 #: ../src/guestfs-actions.pod:4334
26645 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
26649 #: ../src/guestfs-actions.pod:4342
26650 msgid "guestfs_lvs_full"
26654 #: ../src/guestfs-actions.pod:4344
26657 " struct guestfs_lvm_lv_list *\n"
26658 " guestfs_lvs_full (guestfs_h *g);\n"
26663 #: ../src/guestfs-actions.pod:4350
26665 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
26666 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
26670 #: ../src/guestfs-actions.pod:4356
26671 msgid "guestfs_lvuuid"
26675 #: ../src/guestfs-actions.pod:4358
26679 " guestfs_lvuuid (guestfs_h *g,\n"
26680 " const char *device);\n"
26685 #: ../src/guestfs-actions.pod:4369
26686 msgid "guestfs_lxattrlist"
26690 #: ../src/guestfs-actions.pod:4371
26693 " struct guestfs_xattr_list *\n"
26694 " guestfs_lxattrlist (guestfs_h *g,\n"
26695 " const char *path,\n"
26696 " char *const *names);\n"
26701 #: ../src/guestfs-actions.pod:4390
26703 "This call is intended for programs that want to efficiently list a directory "
26704 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
26705 "a similarly efficient call for getting standard stats. Very long directory "
26706 "listings might cause the protocol message size to be exceeded, causing this "
26707 "call to fail. The caller must split up such requests into smaller groups of "
26712 #: ../src/guestfs-actions.pod:4404
26713 msgid "guestfs_mkdir"
26717 #: ../src/guestfs-actions.pod:4406
26721 " guestfs_mkdir (guestfs_h *g,\n"
26722 " const char *path);\n"
26727 #: ../src/guestfs-actions.pod:4416
26728 msgid "guestfs_mkdir_mode"
26732 #: ../src/guestfs-actions.pod:4418
26736 " guestfs_mkdir_mode (guestfs_h *g,\n"
26737 " const char *path,\n"
26743 #: ../src/guestfs-actions.pod:4430
26744 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
26748 #: ../src/guestfs-actions.pod:4436
26749 msgid "guestfs_mkdir_p"
26753 #: ../src/guestfs-actions.pod:4438
26757 " guestfs_mkdir_p (guestfs_h *g,\n"
26758 " const char *path);\n"
26763 #: ../src/guestfs-actions.pod:4449
26764 msgid "guestfs_mkdtemp"
26768 #: ../src/guestfs-actions.pod:4451
26772 " guestfs_mkdtemp (guestfs_h *g,\n"
26773 " const char *template);\n"
26778 #: ../src/guestfs-actions.pod:4479
26779 msgid "guestfs_mke2fs_J"
26783 #: ../src/guestfs-actions.pod:4481
26787 " guestfs_mke2fs_J (guestfs_h *g,\n"
26788 " const char *fstype,\n"
26789 " int blocksize,\n"
26790 " const char *device,\n"
26791 " const char *journal);\n"
26796 #: ../src/guestfs-actions.pod:4494
26797 msgid "See also C<guestfs_mke2journal>."
26801 #: ../src/guestfs-actions.pod:4498 ../src/guestfs-actions.pod:4516
26802 #: ../src/guestfs-actions.pod:4534 ../src/guestfs-actions.pod:4550
26803 #: ../src/guestfs-actions.pod:4564 ../src/guestfs-actions.pod:4578
26804 #: ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4914
26805 msgid "(Added in 1.0.68)"
26809 #: ../src/guestfs-actions.pod:4500
26810 msgid "guestfs_mke2fs_JL"
26814 #: ../src/guestfs-actions.pod:4502
26818 " guestfs_mke2fs_JL (guestfs_h *g,\n"
26819 " const char *fstype,\n"
26820 " int blocksize,\n"
26821 " const char *device,\n"
26822 " const char *label);\n"
26827 #: ../src/guestfs-actions.pod:4512
26828 msgid "See also C<guestfs_mke2journal_L>."
26832 #: ../src/guestfs-actions.pod:4518
26833 msgid "guestfs_mke2fs_JU"
26837 #: ../src/guestfs-actions.pod:4520
26841 " guestfs_mke2fs_JU (guestfs_h *g,\n"
26842 " const char *fstype,\n"
26843 " int blocksize,\n"
26844 " const char *device,\n"
26845 " const char *uuid);\n"
26850 #: ../src/guestfs-actions.pod:4530
26851 msgid "See also C<guestfs_mke2journal_U>."
26855 #: ../src/guestfs-actions.pod:4536
26856 msgid "guestfs_mke2journal"
26860 #: ../src/guestfs-actions.pod:4538
26864 " guestfs_mke2journal (guestfs_h *g,\n"
26865 " int blocksize,\n"
26866 " const char *device);\n"
26871 #: ../src/guestfs-actions.pod:4552
26872 msgid "guestfs_mke2journal_L"
26876 #: ../src/guestfs-actions.pod:4554
26880 " guestfs_mke2journal_L (guestfs_h *g,\n"
26881 " int blocksize,\n"
26882 " const char *label,\n"
26883 " const char *device);\n"
26888 #: ../src/guestfs-actions.pod:4566
26889 msgid "guestfs_mke2journal_U"
26893 #: ../src/guestfs-actions.pod:4568
26897 " guestfs_mke2journal_U (guestfs_h *g,\n"
26898 " int blocksize,\n"
26899 " const char *uuid,\n"
26900 " const char *device);\n"
26905 #: ../src/guestfs-actions.pod:4580
26906 msgid "guestfs_mkfifo"
26910 #: ../src/guestfs-actions.pod:4582
26914 " guestfs_mkfifo (guestfs_h *g,\n"
26916 " const char *path);\n"
26921 #: ../src/guestfs-actions.pod:4587
26923 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26924 "is just a convenient wrapper around C<guestfs_mknod>."
26928 #: ../src/guestfs-actions.pod:4597
26929 msgid "guestfs_mkfs"
26933 #: ../src/guestfs-actions.pod:4599
26937 " guestfs_mkfs (guestfs_h *g,\n"
26938 " const char *fstype,\n"
26939 " const char *device);\n"
26944 #: ../src/guestfs-actions.pod:4612
26945 msgid "guestfs_mkfs_b"
26949 #: ../src/guestfs-actions.pod:4614
26953 " guestfs_mkfs_b (guestfs_h *g,\n"
26954 " const char *fstype,\n"
26955 " int blocksize,\n"
26956 " const char *device);\n"
26961 #: ../src/guestfs-actions.pod:4620
26963 "I<This function is deprecated.> In new code, use the L</guestfs_mkfs_opts> "
26968 #: ../src/guestfs-actions.pod:4627
26970 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
26971 "block size of the resulting filesystem. Supported block sizes depend on the "
26972 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26976 #: ../src/guestfs-actions.pod:4639
26977 msgid "guestfs_mkfs_opts"
26981 #: ../src/guestfs-actions.pod:4641
26985 " guestfs_mkfs_opts (guestfs_h *g,\n"
26986 " const char *fstype,\n"
26987 " const char *device,\n"
26993 #: ../src/guestfs-actions.pod:4652
26996 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
26997 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
26998 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
26999 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
27004 #: ../src/guestfs-actions.pod:4700
27005 msgid "(Added in 1.7.19)"
27009 #: ../src/guestfs-actions.pod:4702
27010 msgid "guestfs_mkfs_opts_va"
27014 #: ../src/guestfs-actions.pod:4704
27018 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
27019 " const char *fstype,\n"
27020 " const char *device,\n"
27021 " va_list args);\n"
27026 #: ../src/guestfs-actions.pod:4710
27027 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
27031 #: ../src/guestfs-actions.pod:4714
27032 msgid "guestfs_mkfs_opts_argv"
27036 #: ../src/guestfs-actions.pod:4716
27040 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
27041 " const char *fstype,\n"
27042 " const char *device,\n"
27043 " const struct guestfs_mkfs_opts_argv *optargs);\n"
27048 #: ../src/guestfs-actions.pod:4722
27049 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
27053 #: ../src/guestfs-actions.pod:4726
27054 msgid "guestfs_mkmountpoint"
27058 #: ../src/guestfs-actions.pod:4728
27062 " guestfs_mkmountpoint (guestfs_h *g,\n"
27063 " const char *exemptpath);\n"
27068 #: ../src/guestfs-actions.pod:4732
27070 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
27071 "that can be used to create extra mountpoints before mounting the first "
27076 #: ../src/guestfs-actions.pod:4756
27078 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
27079 "may get unexpected errors if you try to mix these calls. It is safest to "
27080 "manually unmount filesystems and remove mountpoints after use."
27084 #: ../src/guestfs-actions.pod:4760
27086 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
27087 "first, so for this to work for manual mountpoints, you must ensure that the "
27088 "innermost mountpoints have the longest pathnames, as in the example code "
27093 #: ../src/guestfs-actions.pod:4767
27095 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
27096 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
27097 "can also trigger these issues."
27101 #: ../src/guestfs-actions.pod:4773 ../src/guestfs-actions.pod:5089
27102 #: ../src/guestfs-actions.pod:6099
27103 msgid "(Added in 1.0.62)"
27107 #: ../src/guestfs-actions.pod:4775
27108 msgid "guestfs_mknod"
27112 #: ../src/guestfs-actions.pod:4777
27116 " guestfs_mknod (guestfs_h *g,\n"
27120 " const char *path);\n"
27125 #: ../src/guestfs-actions.pod:4792
27127 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
27128 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
27129 "regular file). These constants are available in the standard Linux header "
27130 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
27131 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
27132 "the appropriate constant for you."
27136 #: ../src/guestfs-actions.pod:4806
27137 msgid "guestfs_mknod_b"
27141 #: ../src/guestfs-actions.pod:4808
27145 " guestfs_mknod_b (guestfs_h *g,\n"
27149 " const char *path);\n"
27154 #: ../src/guestfs-actions.pod:4815
27156 "This call creates a block device node called C<path> with mode C<mode> and "
27157 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27158 "wrapper around C<guestfs_mknod>."
27162 #: ../src/guestfs-actions.pod:4825
27163 msgid "guestfs_mknod_c"
27167 #: ../src/guestfs-actions.pod:4827
27171 " guestfs_mknod_c (guestfs_h *g,\n"
27175 " const char *path);\n"
27180 #: ../src/guestfs-actions.pod:4834
27182 "This call creates a char device node called C<path> with mode C<mode> and "
27183 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27184 "wrapper around C<guestfs_mknod>."
27188 #: ../src/guestfs-actions.pod:4844
27189 msgid "guestfs_mkswap"
27193 #: ../src/guestfs-actions.pod:4846
27197 " guestfs_mkswap (guestfs_h *g,\n"
27198 " const char *device);\n"
27203 #: ../src/guestfs-actions.pod:4856
27204 msgid "guestfs_mkswap_L"
27208 #: ../src/guestfs-actions.pod:4858
27212 " guestfs_mkswap_L (guestfs_h *g,\n"
27213 " const char *label,\n"
27214 " const char *device);\n"
27219 #: ../src/guestfs-actions.pod:4873
27220 msgid "guestfs_mkswap_U"
27224 #: ../src/guestfs-actions.pod:4875
27228 " guestfs_mkswap_U (guestfs_h *g,\n"
27229 " const char *uuid,\n"
27230 " const char *device);\n"
27235 #: ../src/guestfs-actions.pod:4886
27236 msgid "guestfs_mkswap_file"
27240 #: ../src/guestfs-actions.pod:4888
27244 " guestfs_mkswap_file (guestfs_h *g,\n"
27245 " const char *path);\n"
27250 #: ../src/guestfs-actions.pod:4894
27252 "This command just writes a swap file signature to an existing file. To "
27253 "create the file itself, use something like C<guestfs_fallocate>."
27257 #: ../src/guestfs-actions.pod:4901
27258 msgid "guestfs_modprobe"
27262 #: ../src/guestfs-actions.pod:4903
27266 " guestfs_modprobe (guestfs_h *g,\n"
27267 " const char *modulename);\n"
27272 #: ../src/guestfs-actions.pod:4916
27273 msgid "guestfs_mount"
27277 #: ../src/guestfs-actions.pod:4918
27281 " guestfs_mount (guestfs_h *g,\n"
27282 " const char *device,\n"
27283 " const char *mountpoint);\n"
27288 #: ../src/guestfs-actions.pod:4923
27290 "I<This function is deprecated.> In new code, use the L</"
27291 "guestfs_mount_options> call instead."
27295 #: ../src/guestfs-actions.pod:4944
27297 "B<Important note:> When you use this call, the filesystem options C<sync> "
27298 "and C<noatime> are set implicitly. This was originally done because we "
27299 "thought it would improve reliability, but it turns out that I<-o sync> has a "
27300 "very large negative performance impact and negligible effect on "
27301 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
27302 "in any code that needs performance, and instead use C<guestfs_mount_options> "
27303 "(use an empty string for the first parameter if you don't want any options)."
27307 #: ../src/guestfs-actions.pod:4958
27308 msgid "guestfs_mount_9p"
27312 #: ../src/guestfs-actions.pod:4960
27316 " guestfs_mount_9p (guestfs_h *g,\n"
27317 " const char *mounttag,\n"
27318 " const char *mountpoint,\n"
27324 #: ../src/guestfs-actions.pod:4971
27327 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
27332 #: ../src/guestfs-actions.pod:4984
27333 msgid "guestfs_mount_9p_va"
27337 #: ../src/guestfs-actions.pod:4986
27341 " guestfs_mount_9p_va (guestfs_h *g,\n"
27342 " const char *mounttag,\n"
27343 " const char *mountpoint,\n"
27344 " va_list args);\n"
27349 #: ../src/guestfs-actions.pod:4992
27350 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
27354 #: ../src/guestfs-actions.pod:4996
27355 msgid "guestfs_mount_9p_argv"
27359 #: ../src/guestfs-actions.pod:4998
27363 " guestfs_mount_9p_argv (guestfs_h *g,\n"
27364 " const char *mounttag,\n"
27365 " const char *mountpoint,\n"
27366 " const struct guestfs_mount_9p_argv *optargs);\n"
27371 #: ../src/guestfs-actions.pod:5004
27372 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
27376 #: ../src/guestfs-actions.pod:5008
27377 msgid "guestfs_mount_loop"
27381 #: ../src/guestfs-actions.pod:5010
27385 " guestfs_mount_loop (guestfs_h *g,\n"
27386 " const char *file,\n"
27387 " const char *mountpoint);\n"
27392 #: ../src/guestfs-actions.pod:5023
27393 msgid "guestfs_mount_options"
27397 #: ../src/guestfs-actions.pod:5025
27401 " guestfs_mount_options (guestfs_h *g,\n"
27402 " const char *options,\n"
27403 " const char *device,\n"
27404 " const char *mountpoint);\n"
27409 #: ../src/guestfs-actions.pod:5031
27411 "This is the same as the C<guestfs_mount> command, but it allows you to set "
27412 "the mount options as for the L<mount(8)> I<-o> flag."
27416 #: ../src/guestfs-actions.pod:5041 ../src/guestfs-actions.pod:5055
27417 #: ../src/guestfs-actions.pod:5072
27418 msgid "(Added in 1.0.10)"
27422 #: ../src/guestfs-actions.pod:5043
27423 msgid "guestfs_mount_ro"
27427 #: ../src/guestfs-actions.pod:5045
27431 " guestfs_mount_ro (guestfs_h *g,\n"
27432 " const char *device,\n"
27433 " const char *mountpoint);\n"
27438 #: ../src/guestfs-actions.pod:5050
27440 "This is the same as the C<guestfs_mount> command, but it mounts the "
27441 "filesystem with the read-only (I<-o ro>) flag."
27445 #: ../src/guestfs-actions.pod:5057
27446 msgid "guestfs_mount_vfs"
27450 #: ../src/guestfs-actions.pod:5059
27454 " guestfs_mount_vfs (guestfs_h *g,\n"
27455 " const char *options,\n"
27456 " const char *vfstype,\n"
27457 " const char *device,\n"
27458 " const char *mountpoint);\n"
27463 #: ../src/guestfs-actions.pod:5066
27465 "This is the same as the C<guestfs_mount> command, but it allows you to set "
27466 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
27471 #: ../src/guestfs-actions.pod:5074
27472 msgid "guestfs_mountpoints"
27476 #: ../src/guestfs-actions.pod:5076
27480 " guestfs_mountpoints (guestfs_h *g);\n"
27485 #: ../src/guestfs-actions.pod:5079
27487 "This call is similar to C<guestfs_mounts>. That call returns a list of "
27488 "devices. This one returns a hash table (map) of device name to directory "
27489 "where the device is mounted."
27493 #: ../src/guestfs-actions.pod:5091
27494 msgid "guestfs_mounts"
27498 #: ../src/guestfs-actions.pod:5093
27502 " guestfs_mounts (guestfs_h *g);\n"
27507 #: ../src/guestfs-actions.pod:5101
27508 msgid "See also: C<guestfs_mountpoints>"
27512 #: ../src/guestfs-actions.pod:5109
27517 #: ../src/guestfs-actions.pod:5111
27521 " guestfs_mv (guestfs_h *g,\n"
27522 " const char *src,\n"
27523 " const char *dest);\n"
27528 #: ../src/guestfs-actions.pod:5123
27529 msgid "guestfs_ntfs_3g_probe"
27533 #: ../src/guestfs-actions.pod:5125
27537 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
27539 " const char *device);\n"
27544 #: ../src/guestfs-actions.pod:5144
27545 msgid "(Added in 1.0.43)"
27549 #: ../src/guestfs-actions.pod:5146
27550 msgid "guestfs_ntfsresize"
27554 #: ../src/guestfs-actions.pod:5148
27558 " guestfs_ntfsresize (guestfs_h *g,\n"
27559 " const char *device);\n"
27564 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5252
27566 "I<This function is deprecated.> In new code, use the L</"
27567 "guestfs_ntfsresize_opts> call instead."
27571 #: ../src/guestfs-actions.pod:5176
27572 msgid "guestfs_ntfsresize_opts"
27576 #: ../src/guestfs-actions.pod:5178
27580 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
27581 " const char *device,\n"
27587 #: ../src/guestfs-actions.pod:5188
27590 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
27591 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
27596 #: ../src/guestfs-actions.pod:5208
27598 "After the resize operation, the filesystem is always marked as requiring a "
27599 "consistency check (for safety). You have to boot into Windows to perform "
27600 "this check and clear this condition. If you I<don't> set the C<force> "
27601 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
27602 "times on a single filesystem without booting into Windows between each "
27607 #: ../src/guestfs-actions.pod:5223
27608 msgid "guestfs_ntfsresize_opts_va"
27612 #: ../src/guestfs-actions.pod:5225
27616 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
27617 " const char *device,\n"
27618 " va_list args);\n"
27623 #: ../src/guestfs-actions.pod:5230
27624 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
27628 #: ../src/guestfs-actions.pod:5234
27629 msgid "guestfs_ntfsresize_opts_argv"
27633 #: ../src/guestfs-actions.pod:5236
27637 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
27638 " const char *device,\n"
27639 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
27644 #: ../src/guestfs-actions.pod:5241
27645 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
27649 #: ../src/guestfs-actions.pod:5245
27650 msgid "guestfs_ntfsresize_size"
27654 #: ../src/guestfs-actions.pod:5247
27658 " guestfs_ntfsresize_size (guestfs_h *g,\n"
27659 " const char *device,\n"
27660 " int64_t size);\n"
27665 #: ../src/guestfs-actions.pod:5259
27667 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
27668 "to specify the new size (in bytes) explicitly."
27672 #: ../src/guestfs-actions.pod:5264 ../src/guestfs-actions.pod:5706
27673 #: ../src/guestfs-actions.pod:5779 ../src/guestfs-actions.pod:6047
27674 #: ../src/guestfs-actions.pod:7670
27675 msgid "(Added in 1.3.14)"
27679 #: ../src/guestfs-actions.pod:5266
27680 msgid "guestfs_part_add"
27684 #: ../src/guestfs-actions.pod:5268
27688 " guestfs_part_add (guestfs_h *g,\n"
27689 " const char *device,\n"
27690 " const char *prlogex,\n"
27691 " int64_t startsect,\n"
27692 " int64_t endsect);\n"
27697 #: ../src/guestfs-actions.pod:5275
27699 "This command adds a partition to C<device>. If there is no partition table "
27700 "on the device, call C<guestfs_part_init> first."
27704 #: ../src/guestfs-actions.pod:5287
27706 "Creating a partition which covers the whole disk is not so easy. Use "
27707 "C<guestfs_part_disk> to do that."
27711 #: ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:5330
27712 #: ../src/guestfs-actions.pod:5383 ../src/guestfs-actions.pod:5467
27713 #: ../src/guestfs-actions.pod:5505 ../src/guestfs-actions.pod:5524
27714 #: ../src/guestfs-actions.pod:5564
27715 msgid "(Added in 1.0.78)"
27719 #: ../src/guestfs-actions.pod:5294
27720 msgid "guestfs_part_del"
27724 #: ../src/guestfs-actions.pod:5296
27728 " guestfs_part_del (guestfs_h *g,\n"
27729 " const char *device,\n"
27735 #: ../src/guestfs-actions.pod:5311
27736 msgid "guestfs_part_disk"
27740 #: ../src/guestfs-actions.pod:5313
27744 " guestfs_part_disk (guestfs_h *g,\n"
27745 " const char *device,\n"
27746 " const char *parttype);\n"
27751 #: ../src/guestfs-actions.pod:5318
27753 "This command is simply a combination of C<guestfs_part_init> followed by "
27754 "C<guestfs_part_add> to create a single primary partition covering the whole "
27759 #: ../src/guestfs-actions.pod:5322
27761 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
27762 "possible values are described in C<guestfs_part_init>."
27766 #: ../src/guestfs-actions.pod:5332
27767 msgid "guestfs_part_get_bootable"
27771 #: ../src/guestfs-actions.pod:5334
27775 " guestfs_part_get_bootable (guestfs_h *g,\n"
27776 " const char *device,\n"
27782 #: ../src/guestfs-actions.pod:5342
27783 msgid "See also C<guestfs_part_set_bootable>."
27787 #: ../src/guestfs-actions.pod:5348
27788 msgid "guestfs_part_get_mbr_id"
27792 #: ../src/guestfs-actions.pod:5350
27796 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
27797 " const char *device,\n"
27803 #: ../src/guestfs-actions.pod:5358 ../src/guestfs-actions.pod:5540
27805 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
27806 "undefined results for other partition table types (see "
27807 "C<guestfs_part_get_parttype>)."
27811 #: ../src/guestfs-actions.pod:5366
27812 msgid "guestfs_part_get_parttype"
27816 #: ../src/guestfs-actions.pod:5368
27820 " guestfs_part_get_parttype (guestfs_h *g,\n"
27821 " const char *device);\n"
27826 #: ../src/guestfs-actions.pod:5375
27828 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
27829 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
27830 "possible, although unusual. See C<guestfs_part_init> for a full list."
27834 #: ../src/guestfs-actions.pod:5385
27835 msgid "guestfs_part_init"
27839 #: ../src/guestfs-actions.pod:5387
27843 " guestfs_part_init (guestfs_h *g,\n"
27844 " const char *device,\n"
27845 " const char *parttype);\n"
27850 #: ../src/guestfs-actions.pod:5396
27852 "Initially there are no partitions. Following this, you should call "
27853 "C<guestfs_part_add> for each partition required."
27857 #: ../src/guestfs-actions.pod:5469
27858 msgid "guestfs_part_list"
27862 #: ../src/guestfs-actions.pod:5471
27865 " struct guestfs_partition_list *\n"
27866 " guestfs_part_list (guestfs_h *g,\n"
27867 " const char *device);\n"
27872 #: ../src/guestfs-actions.pod:5488
27874 "Start of the partition I<in bytes>. To get sectors you have to divide by "
27875 "the device's sector size, see C<guestfs_blockdev_getss>."
27879 #: ../src/guestfs-actions.pod:5501
27881 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
27882 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
27887 #: ../src/guestfs-actions.pod:5507
27888 msgid "guestfs_part_set_bootable"
27892 #: ../src/guestfs-actions.pod:5509
27896 " guestfs_part_set_bootable (guestfs_h *g,\n"
27897 " const char *device,\n"
27899 " int bootable);\n"
27904 #: ../src/guestfs-actions.pod:5526
27905 msgid "guestfs_part_set_mbr_id"
27909 #: ../src/guestfs-actions.pod:5528
27913 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
27914 " const char *device,\n"
27921 #: ../src/guestfs-actions.pod:5548
27922 msgid "guestfs_part_set_name"
27926 #: ../src/guestfs-actions.pod:5550
27930 " guestfs_part_set_name (guestfs_h *g,\n"
27931 " const char *device,\n"
27933 " const char *name);\n"
27938 #: ../src/guestfs-actions.pod:5566
27939 msgid "guestfs_part_to_dev"
27943 #: ../src/guestfs-actions.pod:5568
27947 " guestfs_part_to_dev (guestfs_h *g,\n"
27948 " const char *partition);\n"
27953 #: ../src/guestfs-actions.pod:5576
27955 "The named partition must exist, for example as a string returned from "
27956 "C<guestfs_list_partitions>."
27960 #: ../src/guestfs-actions.pod:5584
27961 msgid "guestfs_ping_daemon"
27965 #: ../src/guestfs-actions.pod:5586
27969 " guestfs_ping_daemon (guestfs_h *g);\n"
27974 #: ../src/guestfs-actions.pod:5598
27975 msgid "guestfs_pread"
27979 #: ../src/guestfs-actions.pod:5600
27983 " guestfs_pread (guestfs_h *g,\n"
27984 " const char *path,\n"
27986 " int64_t offset,\n"
27987 " size_t *size_r);\n"
27992 #: ../src/guestfs-actions.pod:5613
27993 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
27997 #: ../src/guestfs-actions.pod:5624
27998 msgid "guestfs_pread_device"
28002 #: ../src/guestfs-actions.pod:5626
28006 " guestfs_pread_device (guestfs_h *g,\n"
28007 " const char *device,\n"
28009 " int64_t offset,\n"
28010 " size_t *size_r);\n"
28015 #: ../src/guestfs-actions.pod:5639
28016 msgid "See also C<guestfs_pread>."
28020 #: ../src/guestfs-actions.pod:5648
28021 msgid "(Added in 1.5.21)"
28025 #: ../src/guestfs-actions.pod:5650
28026 msgid "guestfs_pvcreate"
28030 #: ../src/guestfs-actions.pod:5652
28034 " guestfs_pvcreate (guestfs_h *g,\n"
28035 " const char *device);\n"
28040 #: ../src/guestfs-actions.pod:5664
28041 msgid "guestfs_pvremove"
28045 #: ../src/guestfs-actions.pod:5666
28049 " guestfs_pvremove (guestfs_h *g,\n"
28050 " const char *device);\n"
28055 #: ../src/guestfs-actions.pod:5681
28056 msgid "guestfs_pvresize"
28060 #: ../src/guestfs-actions.pod:5683
28064 " guestfs_pvresize (guestfs_h *g,\n"
28065 " const char *device);\n"
28070 #: ../src/guestfs-actions.pod:5694
28071 msgid "guestfs_pvresize_size"
28075 #: ../src/guestfs-actions.pod:5696
28079 " guestfs_pvresize_size (guestfs_h *g,\n"
28080 " const char *device,\n"
28081 " int64_t size);\n"
28086 #: ../src/guestfs-actions.pod:5701
28088 "This command is the same as C<guestfs_pvresize> except that it allows you to "
28089 "specify the new size (in bytes) explicitly."
28093 #: ../src/guestfs-actions.pod:5708
28094 msgid "guestfs_pvs"
28098 #: ../src/guestfs-actions.pod:5710
28102 " guestfs_pvs (guestfs_h *g);\n"
28107 #: ../src/guestfs-actions.pod:5719
28108 msgid "See also C<guestfs_pvs_full>."
28112 #: ../src/guestfs-actions.pod:5727
28113 msgid "guestfs_pvs_full"
28117 #: ../src/guestfs-actions.pod:5729
28120 " struct guestfs_lvm_pv_list *\n"
28121 " guestfs_pvs_full (guestfs_h *g);\n"
28126 #: ../src/guestfs-actions.pod:5735
28128 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
28129 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
28133 #: ../src/guestfs-actions.pod:5741
28134 msgid "guestfs_pvuuid"
28138 #: ../src/guestfs-actions.pod:5743
28142 " guestfs_pvuuid (guestfs_h *g,\n"
28143 " const char *device);\n"
28148 #: ../src/guestfs-actions.pod:5754
28149 msgid "guestfs_pwrite"
28153 #: ../src/guestfs-actions.pod:5756
28157 " guestfs_pwrite (guestfs_h *g,\n"
28158 " const char *path,\n"
28159 " const char *content,\n"
28160 " size_t content_size,\n"
28161 " int64_t offset);\n"
28166 #: ../src/guestfs-actions.pod:5772
28167 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
28171 #: ../src/guestfs-actions.pod:5781
28172 msgid "guestfs_pwrite_device"
28176 #: ../src/guestfs-actions.pod:5783
28180 " guestfs_pwrite_device (guestfs_h *g,\n"
28181 " const char *device,\n"
28182 " const char *content,\n"
28183 " size_t content_size,\n"
28184 " int64_t offset);\n"
28189 #: ../src/guestfs-actions.pod:5798
28190 msgid "See also C<guestfs_pwrite>."
28194 #: ../src/guestfs-actions.pod:5805
28195 msgid "(Added in 1.5.20)"
28199 #: ../src/guestfs-actions.pod:5807
28200 msgid "guestfs_read_file"
28204 #: ../src/guestfs-actions.pod:5809
28208 " guestfs_read_file (guestfs_h *g,\n"
28209 " const char *path,\n"
28210 " size_t *size_r);\n"
28215 #: ../src/guestfs-actions.pod:5817
28217 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
28218 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
28219 "function is limited in the total size of file that can be handled."
28223 #: ../src/guestfs-actions.pod:5829
28224 msgid "(Added in 1.0.63)"
28228 #: ../src/guestfs-actions.pod:5831
28229 msgid "guestfs_read_lines"
28233 #: ../src/guestfs-actions.pod:5833
28237 " guestfs_read_lines (guestfs_h *g,\n"
28238 " const char *path);\n"
28243 #: ../src/guestfs-actions.pod:5842
28245 "Note that this function cannot correctly handle binary files (specifically, "
28246 "files containing C<\\0> character which is treated as end of line). For "
28247 "those you need to use the C<guestfs_read_file> function which has a more "
28248 "complex interface."
28252 #: ../src/guestfs-actions.pod:5853
28253 msgid "guestfs_readdir"
28257 #: ../src/guestfs-actions.pod:5855
28260 " struct guestfs_dirent_list *\n"
28261 " guestfs_readdir (guestfs_h *g,\n"
28262 " const char *dir);\n"
28267 #: ../src/guestfs-actions.pod:5909
28269 "This function is primarily intended for use by programs. To get a simple "
28270 "list of names, use C<guestfs_ls>. To get a printable directory for human "
28271 "consumption, use C<guestfs_ll>."
28275 #: ../src/guestfs-actions.pod:5913
28277 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
28278 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
28282 #: ../src/guestfs-actions.pod:5919
28283 msgid "guestfs_readlink"
28287 #: ../src/guestfs-actions.pod:5921
28291 " guestfs_readlink (guestfs_h *g,\n"
28292 " const char *path);\n"
28297 #: ../src/guestfs-actions.pod:5932
28298 msgid "guestfs_readlinklist"
28302 #: ../src/guestfs-actions.pod:5934
28306 " guestfs_readlinklist (guestfs_h *g,\n"
28307 " const char *path,\n"
28308 " char *const *names);\n"
28313 #: ../src/guestfs-actions.pod:5967
28314 msgid "guestfs_realpath"
28318 #: ../src/guestfs-actions.pod:5969
28322 " guestfs_realpath (guestfs_h *g,\n"
28323 " const char *path);\n"
28328 #: ../src/guestfs-actions.pod:5981
28329 msgid "guestfs_removexattr"
28333 #: ../src/guestfs-actions.pod:5983
28337 " guestfs_removexattr (guestfs_h *g,\n"
28338 " const char *xattr,\n"
28339 " const char *path);\n"
28344 #: ../src/guestfs-actions.pod:5991
28345 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
28349 #: ../src/guestfs-actions.pod:5997
28350 msgid "guestfs_resize2fs"
28354 #: ../src/guestfs-actions.pod:5999
28358 " guestfs_resize2fs (guestfs_h *g,\n"
28359 " const char *device);\n"
28364 #: ../src/guestfs-actions.pod:6006
28366 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
28367 "C<device> before calling this command. For unknown reasons C<resize2fs> "
28368 "sometimes gives an error about this and sometimes not. In any case, it is "
28369 "always safe to call C<guestfs_e2fsck_f> before calling this function."
28373 #: ../src/guestfs-actions.pod:6016
28374 msgid "guestfs_resize2fs_M"
28378 #: ../src/guestfs-actions.pod:6018
28382 " guestfs_resize2fs_M (guestfs_h *g,\n"
28383 " const char *device);\n"
28388 #: ../src/guestfs-actions.pod:6022
28390 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
28391 "resized to its minimum size. This works like the I<-M> option to the "
28392 "C<resize2fs> command."
28396 #: ../src/guestfs-actions.pod:6026
28398 "To get the resulting size of the filesystem you should call "
28399 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
28400 "These two numbers, multiplied together, give the resulting size of the "
28401 "minimal filesystem in bytes."
28405 #: ../src/guestfs-actions.pod:6035
28406 msgid "guestfs_resize2fs_size"
28410 #: ../src/guestfs-actions.pod:6037
28414 " guestfs_resize2fs_size (guestfs_h *g,\n"
28415 " const char *device,\n"
28416 " int64_t size);\n"
28421 #: ../src/guestfs-actions.pod:6042
28423 "This command is the same as C<guestfs_resize2fs> except that it allows you "
28424 "to specify the new size (in bytes) explicitly."
28428 #: ../src/guestfs-actions.pod:6049
28433 #: ../src/guestfs-actions.pod:6051
28437 " guestfs_rm (guestfs_h *g,\n"
28438 " const char *path);\n"
28443 #: ../src/guestfs-actions.pod:6061
28444 msgid "guestfs_rm_rf"
28448 #: ../src/guestfs-actions.pod:6063
28452 " guestfs_rm_rf (guestfs_h *g,\n"
28453 " const char *path);\n"
28458 #: ../src/guestfs-actions.pod:6075
28459 msgid "guestfs_rmdir"
28463 #: ../src/guestfs-actions.pod:6077
28467 " guestfs_rmdir (guestfs_h *g,\n"
28468 " const char *path);\n"
28473 #: ../src/guestfs-actions.pod:6087
28474 msgid "guestfs_rmmountpoint"
28478 #: ../src/guestfs-actions.pod:6089
28482 " guestfs_rmmountpoint (guestfs_h *g,\n"
28483 " const char *exemptpath);\n"
28488 #: ../src/guestfs-actions.pod:6093
28490 "This calls removes a mountpoint that was previously created with "
28491 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
28495 #: ../src/guestfs-actions.pod:6101
28496 msgid "guestfs_scrub_device"
28500 #: ../src/guestfs-actions.pod:6103
28504 " guestfs_scrub_device (guestfs_h *g,\n"
28505 " const char *device);\n"
28510 #: ../src/guestfs-actions.pod:6118 ../src/guestfs-actions.pod:6136
28511 #: ../src/guestfs-actions.pod:6155
28512 msgid "(Added in 1.0.52)"
28516 #: ../src/guestfs-actions.pod:6120
28517 msgid "guestfs_scrub_file"
28521 #: ../src/guestfs-actions.pod:6122
28525 " guestfs_scrub_file (guestfs_h *g,\n"
28526 " const char *file);\n"
28531 #: ../src/guestfs-actions.pod:6138
28532 msgid "guestfs_scrub_freespace"
28536 #: ../src/guestfs-actions.pod:6140
28540 " guestfs_scrub_freespace (guestfs_h *g,\n"
28541 " const char *dir);\n"
28546 #: ../src/guestfs-actions.pod:6144
28548 "This command creates the directory C<dir> and then fills it with files until "
28549 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
28550 "and deletes them. The intention is to scrub any free space on the partition "
28551 "containing C<dir>."
28555 #: ../src/guestfs-actions.pod:6157
28556 msgid "guestfs_set_append"
28560 #: ../src/guestfs-actions.pod:6159
28564 " guestfs_set_append (guestfs_h *g,\n"
28565 " const char *append);\n"
28570 #: ../src/guestfs-actions.pod:6176
28571 msgid "guestfs_set_attach_method"
28575 #: ../src/guestfs-actions.pod:6178
28579 " guestfs_set_attach_method (guestfs_h *g,\n"
28580 " const char *attachmethod);\n"
28585 #: ../src/guestfs-actions.pod:6206
28586 msgid "guestfs_set_autosync"
28590 #: ../src/guestfs-actions.pod:6208
28594 " guestfs_set_autosync (guestfs_h *g,\n"
28595 " int autosync);\n"
28600 #: ../src/guestfs-actions.pod:6224
28601 msgid "guestfs_set_direct"
28605 #: ../src/guestfs-actions.pod:6226
28609 " guestfs_set_direct (guestfs_h *g,\n"
28615 #: ../src/guestfs-actions.pod:6234
28617 "One consequence of this is that log messages aren't caught by the library "
28618 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
28623 #: ../src/guestfs-actions.pod:6247
28624 msgid "guestfs_set_e2label"
28628 #: ../src/guestfs-actions.pod:6249
28632 " guestfs_set_e2label (guestfs_h *g,\n"
28633 " const char *device,\n"
28634 " const char *label);\n"
28639 #: ../src/guestfs-actions.pod:6258
28641 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
28642 "the existing label on a filesystem."
28646 #: ../src/guestfs-actions.pod:6265
28647 msgid "guestfs_set_e2uuid"
28651 #: ../src/guestfs-actions.pod:6267
28655 " guestfs_set_e2uuid (guestfs_h *g,\n"
28656 " const char *device,\n"
28657 " const char *uuid);\n"
28662 #: ../src/guestfs-actions.pod:6277
28664 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
28665 "the existing UUID of a filesystem."
28669 #: ../src/guestfs-actions.pod:6284
28670 msgid "guestfs_set_memsize"
28674 #: ../src/guestfs-actions.pod:6286
28678 " guestfs_set_memsize (guestfs_h *g,\n"
28684 #: ../src/guestfs-actions.pod:6290
28686 "This sets the memory size in megabytes allocated to the qemu subprocess. "
28687 "This only has any effect if called before C<guestfs_launch>."
28691 #: ../src/guestfs-actions.pod:6305
28692 msgid "guestfs_set_network"
28696 #: ../src/guestfs-actions.pod:6307
28700 " guestfs_set_network (guestfs_h *g,\n"
28706 #: ../src/guestfs-actions.pod:6317
28708 "You must call this before calling C<guestfs_launch>, otherwise it has no "
28713 #: ../src/guestfs-actions.pod:6324
28714 msgid "guestfs_set_path"
28718 #: ../src/guestfs-actions.pod:6326
28722 " guestfs_set_path (guestfs_h *g,\n"
28723 " const char *searchpath);\n"
28728 #: ../src/guestfs-actions.pod:6341
28729 msgid "guestfs_set_pgroup"
28733 #: ../src/guestfs-actions.pod:6343
28737 " guestfs_set_pgroup (guestfs_h *g,\n"
28743 #: ../src/guestfs-actions.pod:6360
28744 msgid "guestfs_set_qemu"
28748 #: ../src/guestfs-actions.pod:6362
28752 " guestfs_set_qemu (guestfs_h *g,\n"
28753 " const char *qemu);\n"
28758 #: ../src/guestfs-actions.pod:6388
28759 msgid "guestfs_set_recovery_proc"
28763 #: ../src/guestfs-actions.pod:6390
28767 " guestfs_set_recovery_proc (guestfs_h *g,\n"
28768 " int recoveryproc);\n"
28773 #: ../src/guestfs-actions.pod:6394
28775 "If this is called with the parameter C<false> then C<guestfs_launch> does "
28776 "not create a recovery process. The purpose of the recovery process is to "
28777 "stop runaway qemu processes in the case where the main program aborts "
28782 #: ../src/guestfs-actions.pod:6399
28784 "This only has any effect if called before C<guestfs_launch>, and the default "
28789 #: ../src/guestfs-actions.pod:6412
28790 msgid "guestfs_set_selinux"
28794 #: ../src/guestfs-actions.pod:6414
28798 " guestfs_set_selinux (guestfs_h *g,\n"
28804 #: ../src/guestfs-actions.pod:6431
28805 msgid "guestfs_set_trace"
28809 #: ../src/guestfs-actions.pod:6433
28813 " guestfs_set_trace (guestfs_h *g,\n"
28819 #: ../src/guestfs-actions.pod:6447
28821 "Trace messages are normally sent to C<stderr>, unless you register a "
28822 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
28826 #: ../src/guestfs-actions.pod:6455
28827 msgid "guestfs_set_verbose"
28831 #: ../src/guestfs-actions.pod:6457
28835 " guestfs_set_verbose (guestfs_h *g,\n"
28841 #: ../src/guestfs-actions.pod:6466
28843 "Verbose messages are normally sent to C<stderr>, unless you register a "
28844 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
28848 #: ../src/guestfs-actions.pod:6474
28849 msgid "guestfs_setcon"
28853 #: ../src/guestfs-actions.pod:6476
28857 " guestfs_setcon (guestfs_h *g,\n"
28858 " const char *context);\n"
28863 #: ../src/guestfs-actions.pod:6489
28864 msgid "guestfs_setxattr"
28868 #: ../src/guestfs-actions.pod:6491
28872 " guestfs_setxattr (guestfs_h *g,\n"
28873 " const char *xattr,\n"
28874 " const char *val,\n"
28876 " const char *path);\n"
28881 #: ../src/guestfs-actions.pod:6502
28882 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
28886 #: ../src/guestfs-actions.pod:6508
28887 msgid "guestfs_sfdisk"
28891 #: ../src/guestfs-actions.pod:6510
28895 " guestfs_sfdisk (guestfs_h *g,\n"
28896 " const char *device,\n"
28900 " char *const *lines);\n"
28905 #: ../src/guestfs-actions.pod:6518 ../src/guestfs-actions.pod:6562
28906 #: ../src/guestfs-actions.pod:6596
28908 "I<This function is deprecated.> In new code, use the L</guestfs_part_add> "
28913 #: ../src/guestfs-actions.pod:6545
28915 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
28919 #: ../src/guestfs-actions.pod:6555
28920 msgid "guestfs_sfdiskM"
28924 #: ../src/guestfs-actions.pod:6557
28928 " guestfs_sfdiskM (guestfs_h *g,\n"
28929 " const char *device,\n"
28930 " char *const *lines);\n"
28935 #: ../src/guestfs-actions.pod:6569
28937 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
28938 "partition sizes are specified in megabytes only (rounded to the nearest "
28939 "cylinder) and you don't need to specify the cyls, heads and sectors "
28940 "parameters which were rarely if ever used anyway."
28944 #: ../src/guestfs-actions.pod:6575
28946 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
28947 "C<guestfs_part_disk>"
28951 #: ../src/guestfs-actions.pod:6585
28952 msgid "guestfs_sfdisk_N"
28956 #: ../src/guestfs-actions.pod:6587
28960 " guestfs_sfdisk_N (guestfs_h *g,\n"
28961 " const char *device,\n"
28966 " const char *line);\n"
28971 #: ../src/guestfs-actions.pod:6606
28973 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
28974 "for the cyls/heads/sectors parameters."
28978 #: ../src/guestfs-actions.pod:6609
28979 msgid "See also: C<guestfs_part_add>"
28983 #: ../src/guestfs-actions.pod:6618
28984 msgid "guestfs_sfdisk_disk_geometry"
28988 #: ../src/guestfs-actions.pod:6620
28992 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
28993 " const char *device);\n"
28998 #: ../src/guestfs-actions.pod:6624
29000 "This displays the disk geometry of C<device> read from the partition table. "
29001 "Especially in the case where the underlying block device has been resized, "
29002 "this can be different from the kernel's idea of the geometry (see "
29003 "C<guestfs_sfdisk_kernel_geometry>)."
29007 #: ../src/guestfs-actions.pod:6637
29008 msgid "guestfs_sfdisk_kernel_geometry"
29012 #: ../src/guestfs-actions.pod:6639
29016 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
29017 " const char *device);\n"
29022 #: ../src/guestfs-actions.pod:6653
29023 msgid "guestfs_sfdisk_l"
29027 #: ../src/guestfs-actions.pod:6655
29031 " guestfs_sfdisk_l (guestfs_h *g,\n"
29032 " const char *device);\n"
29037 #: ../src/guestfs-actions.pod:6659
29039 "I<This function is deprecated.> In new code, use the L</guestfs_part_list> "
29044 #: ../src/guestfs-actions.pod:6670
29045 msgid "See also: C<guestfs_part_list>"
29049 #: ../src/guestfs-actions.pod:6677
29054 #: ../src/guestfs-actions.pod:6679
29058 " guestfs_sh (guestfs_h *g,\n"
29059 " const char *command);\n"
29064 #: ../src/guestfs-actions.pod:6686
29065 msgid "This is like C<guestfs_command>, but passes the command to:"
29069 #: ../src/guestfs-actions.pod:6694
29070 msgid "All the provisos about C<guestfs_command> apply to this call."
29074 #: ../src/guestfs-actions.pod:6701
29075 msgid "guestfs_sh_lines"
29079 #: ../src/guestfs-actions.pod:6703
29083 " guestfs_sh_lines (guestfs_h *g,\n"
29084 " const char *command);\n"
29089 #: ../src/guestfs-actions.pod:6707
29091 "This is the same as C<guestfs_sh>, but splits the result into a list of "
29096 #: ../src/guestfs-actions.pod:6710
29097 msgid "See also: C<guestfs_command_lines>"
29101 #: ../src/guestfs-actions.pod:6718
29102 msgid "guestfs_sleep"
29106 #: ../src/guestfs-actions.pod:6720
29110 " guestfs_sleep (guestfs_h *g,\n"
29116 #: ../src/guestfs-actions.pod:6728
29117 msgid "(Added in 1.0.41)"
29121 #: ../src/guestfs-actions.pod:6730 ../src/guestfs-structs.pod:109
29122 msgid "guestfs_stat"
29126 #: ../src/guestfs-actions.pod:6732
29129 " struct guestfs_stat *\n"
29130 " guestfs_stat (guestfs_h *g,\n"
29131 " const char *path);\n"
29136 #: ../src/guestfs-actions.pod:6746 ../src/guestfs-structs.pod:135
29137 msgid "guestfs_statvfs"
29141 #: ../src/guestfs-actions.pod:6748
29144 " struct guestfs_statvfs *\n"
29145 " guestfs_statvfs (guestfs_h *g,\n"
29146 " const char *path);\n"
29151 #: ../src/guestfs-actions.pod:6758
29153 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
29154 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
29158 #: ../src/guestfs-actions.pod:6764
29159 msgid "guestfs_strings"
29163 #: ../src/guestfs-actions.pod:6766
29167 " guestfs_strings (guestfs_h *g,\n"
29168 " const char *path);\n"
29173 #: ../src/guestfs-actions.pod:6782
29174 msgid "guestfs_strings_e"
29178 #: ../src/guestfs-actions.pod:6784
29182 " guestfs_strings_e (guestfs_h *g,\n"
29183 " const char *encoding,\n"
29184 " const char *path);\n"
29189 #: ../src/guestfs-actions.pod:6789
29191 "This is like the C<guestfs_strings> command, but allows you to specify the "
29192 "encoding of strings that are looked for in the source file C<path>."
29196 #: ../src/guestfs-actions.pod:6799
29198 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
29199 "ISO-8859-X (this is what C<guestfs_strings> uses)."
29203 #: ../src/guestfs-actions.pod:6837
29204 msgid "guestfs_swapoff_device"
29208 #: ../src/guestfs-actions.pod:6839
29212 " guestfs_swapoff_device (guestfs_h *g,\n"
29213 " const char *device);\n"
29218 #: ../src/guestfs-actions.pod:6843
29220 "This command disables the libguestfs appliance swap device or partition "
29221 "named C<device>. See C<guestfs_swapon_device>."
29225 #: ../src/guestfs-actions.pod:6851
29226 msgid "guestfs_swapoff_file"
29230 #: ../src/guestfs-actions.pod:6853
29234 " guestfs_swapoff_file (guestfs_h *g,\n"
29235 " const char *file);\n"
29240 #: ../src/guestfs-actions.pod:6863
29241 msgid "guestfs_swapoff_label"
29245 #: ../src/guestfs-actions.pod:6865
29249 " guestfs_swapoff_label (guestfs_h *g,\n"
29250 " const char *label);\n"
29255 #: ../src/guestfs-actions.pod:6876
29256 msgid "guestfs_swapoff_uuid"
29260 #: ../src/guestfs-actions.pod:6878
29264 " guestfs_swapoff_uuid (guestfs_h *g,\n"
29265 " const char *uuid);\n"
29270 #: ../src/guestfs-actions.pod:6889
29271 msgid "guestfs_swapon_device"
29275 #: ../src/guestfs-actions.pod:6891
29279 " guestfs_swapon_device (guestfs_h *g,\n"
29280 " const char *device);\n"
29285 #: ../src/guestfs-actions.pod:6895
29287 "This command enables the libguestfs appliance to use the swap device or "
29288 "partition named C<device>. The increased memory is made available for all "
29289 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
29293 #: ../src/guestfs-actions.pod:6911
29294 msgid "guestfs_swapon_file"
29298 #: ../src/guestfs-actions.pod:6913
29302 " guestfs_swapon_file (guestfs_h *g,\n"
29303 " const char *file);\n"
29308 #: ../src/guestfs-actions.pod:6917
29310 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
29315 #: ../src/guestfs-actions.pod:6924
29316 msgid "guestfs_swapon_label"
29320 #: ../src/guestfs-actions.pod:6926
29324 " guestfs_swapon_label (guestfs_h *g,\n"
29325 " const char *label);\n"
29330 #: ../src/guestfs-actions.pod:6930
29332 "This command enables swap to a labeled swap partition. See "
29333 "C<guestfs_swapon_device> for other notes."
29337 #: ../src/guestfs-actions.pod:6937
29338 msgid "guestfs_swapon_uuid"
29342 #: ../src/guestfs-actions.pod:6939
29346 " guestfs_swapon_uuid (guestfs_h *g,\n"
29347 " const char *uuid);\n"
29352 #: ../src/guestfs-actions.pod:6943
29354 "This command enables swap to a swap partition with the given UUID. See "
29355 "C<guestfs_swapon_device> for other notes."
29359 #: ../src/guestfs-actions.pod:6950
29360 msgid "guestfs_sync"
29364 #: ../src/guestfs-actions.pod:6952
29368 " guestfs_sync (guestfs_h *g);\n"
29373 #: ../src/guestfs-actions.pod:6965
29374 msgid "guestfs_tail"
29378 #: ../src/guestfs-actions.pod:6967
29382 " guestfs_tail (guestfs_h *g,\n"
29383 " const char *path);\n"
29388 #: ../src/guestfs-actions.pod:6983
29389 msgid "guestfs_tail_n"
29393 #: ../src/guestfs-actions.pod:6985
29397 " guestfs_tail_n (guestfs_h *g,\n"
29399 " const char *path);\n"
29404 #: ../src/guestfs-actions.pod:7007
29405 msgid "guestfs_tar_in"
29409 #: ../src/guestfs-actions.pod:7009
29413 " guestfs_tar_in (guestfs_h *g,\n"
29414 " const char *tarfile,\n"
29415 " const char *directory);\n"
29420 #: ../src/guestfs-actions.pod:7017
29422 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
29426 #: ../src/guestfs-actions.pod:7022 ../src/guestfs-actions.pod:7039
29427 #: ../src/guestfs-actions.pod:7055 ../src/guestfs-actions.pod:7071
29428 msgid "(Added in 1.0.3)"
29432 #: ../src/guestfs-actions.pod:7024
29433 msgid "guestfs_tar_out"
29437 #: ../src/guestfs-actions.pod:7026
29441 " guestfs_tar_out (guestfs_h *g,\n"
29442 " const char *directory,\n"
29443 " const char *tarfile);\n"
29448 #: ../src/guestfs-actions.pod:7034
29450 "To download a compressed tarball, use C<guestfs_tgz_out> or "
29451 "C<guestfs_txz_out>."
29455 #: ../src/guestfs-actions.pod:7041
29456 msgid "guestfs_tgz_in"
29460 #: ../src/guestfs-actions.pod:7043
29464 " guestfs_tgz_in (guestfs_h *g,\n"
29465 " const char *tarball,\n"
29466 " const char *directory);\n"
29471 #: ../src/guestfs-actions.pod:7051
29472 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
29476 #: ../src/guestfs-actions.pod:7057
29477 msgid "guestfs_tgz_out"
29481 #: ../src/guestfs-actions.pod:7059
29485 " guestfs_tgz_out (guestfs_h *g,\n"
29486 " const char *directory,\n"
29487 " const char *tarball);\n"
29492 #: ../src/guestfs-actions.pod:7067
29493 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
29497 #: ../src/guestfs-actions.pod:7073
29498 msgid "guestfs_touch"
29502 #: ../src/guestfs-actions.pod:7075
29506 " guestfs_touch (guestfs_h *g,\n"
29507 " const char *path);\n"
29512 #: ../src/guestfs-actions.pod:7090
29513 msgid "guestfs_truncate"
29517 #: ../src/guestfs-actions.pod:7092
29521 " guestfs_truncate (guestfs_h *g,\n"
29522 " const char *path);\n"
29527 #: ../src/guestfs-actions.pod:7103
29528 msgid "guestfs_truncate_size"
29532 #: ../src/guestfs-actions.pod:7105
29536 " guestfs_truncate_size (guestfs_h *g,\n"
29537 " const char *path,\n"
29538 " int64_t size);\n"
29543 #: ../src/guestfs-actions.pod:7113
29545 "If the current file size is less than C<size> then the file is extended to "
29546 "the required size with zero bytes. This creates a sparse file (ie. disk "
29547 "blocks are not allocated for the file until you write to it). To create a "
29548 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
29552 #: ../src/guestfs-actions.pod:7123
29553 msgid "guestfs_tune2fs_l"
29557 #: ../src/guestfs-actions.pod:7125
29561 " guestfs_tune2fs_l (guestfs_h *g,\n"
29562 " const char *device);\n"
29567 #: ../src/guestfs-actions.pod:7145
29568 msgid "guestfs_txz_in"
29572 #: ../src/guestfs-actions.pod:7147
29576 " guestfs_txz_in (guestfs_h *g,\n"
29577 " const char *tarball,\n"
29578 " const char *directory);\n"
29583 #: ../src/guestfs-actions.pod:7159
29584 msgid "guestfs_txz_out"
29588 #: ../src/guestfs-actions.pod:7161
29592 " guestfs_txz_out (guestfs_h *g,\n"
29593 " const char *directory,\n"
29594 " const char *tarball);\n"
29599 #: ../src/guestfs-actions.pod:7173
29600 msgid "guestfs_umask"
29604 #: ../src/guestfs-actions.pod:7175
29608 " guestfs_umask (guestfs_h *g,\n"
29614 #: ../src/guestfs-actions.pod:7191
29616 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
29617 "C<guestfs_mkdir>."
29621 #: ../src/guestfs-actions.pod:7200
29622 msgid "guestfs_umount"
29626 #: ../src/guestfs-actions.pod:7202
29630 " guestfs_umount (guestfs_h *g,\n"
29631 " const char *pathordevice);\n"
29636 #: ../src/guestfs-actions.pod:7214
29637 msgid "guestfs_umount_all"
29641 #: ../src/guestfs-actions.pod:7216
29645 " guestfs_umount_all (guestfs_h *g);\n"
29650 #: ../src/guestfs-actions.pod:7227
29651 msgid "guestfs_upload"
29655 #: ../src/guestfs-actions.pod:7229
29659 " guestfs_upload (guestfs_h *g,\n"
29660 " const char *filename,\n"
29661 " const char *remotefilename);\n"
29666 #: ../src/guestfs-actions.pod:7239
29667 msgid "See also C<guestfs_download>."
29671 #: ../src/guestfs-actions.pod:7250
29672 msgid "guestfs_upload_offset"
29676 #: ../src/guestfs-actions.pod:7252
29680 " guestfs_upload_offset (guestfs_h *g,\n"
29681 " const char *filename,\n"
29682 " const char *remotefilename,\n"
29683 " int64_t offset);\n"
29688 #: ../src/guestfs-actions.pod:7268
29690 "Note that there is no limit on the amount of data that can be uploaded with "
29691 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
29692 "full amount unless an error occurs."
29696 #: ../src/guestfs-actions.pod:7273
29697 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
29701 #: ../src/guestfs-actions.pod:7284
29702 msgid "guestfs_utimens"
29706 #: ../src/guestfs-actions.pod:7286
29710 " guestfs_utimens (guestfs_h *g,\n"
29711 " const char *path,\n"
29712 " int64_t atsecs,\n"
29713 " int64_t atnsecs,\n"
29714 " int64_t mtsecs,\n"
29715 " int64_t mtnsecs);\n"
29720 #: ../src/guestfs-actions.pod:7315 ../src/guestfs-structs.pod:175
29721 msgid "guestfs_version"
29725 #: ../src/guestfs-actions.pod:7317
29728 " struct guestfs_version *\n"
29729 " guestfs_version (guestfs_h *g);\n"
29734 #: ../src/guestfs-actions.pod:7345
29736 "I<Note:> Don't use this call to test for availability of features. In "
29737 "enterprise distributions we backport features from later versions into "
29738 "earlier versions, making this an unreliable way to test for features. Use "
29739 "C<guestfs_available> instead."
29743 #: ../src/guestfs-actions.pod:7351
29745 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
29746 "error. I<The caller must call C<guestfs_free_version> after use>."
29750 #: ../src/guestfs-actions.pod:7355
29751 msgid "(Added in 1.0.58)"
29755 #: ../src/guestfs-actions.pod:7357
29756 msgid "guestfs_vfs_label"
29760 #: ../src/guestfs-actions.pod:7359
29764 " guestfs_vfs_label (guestfs_h *g,\n"
29765 " const char *device);\n"
29770 #: ../src/guestfs-actions.pod:7368
29771 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
29775 #: ../src/guestfs-actions.pod:7373 ../src/guestfs-actions.pod:7410
29776 msgid "(Added in 1.3.18)"
29780 #: ../src/guestfs-actions.pod:7375
29781 msgid "guestfs_vfs_type"
29785 #: ../src/guestfs-actions.pod:7377
29789 " guestfs_vfs_type (guestfs_h *g,\n"
29790 " const char *device);\n"
29795 #: ../src/guestfs-actions.pod:7394
29796 msgid "guestfs_vfs_uuid"
29800 #: ../src/guestfs-actions.pod:7396
29804 " guestfs_vfs_uuid (guestfs_h *g,\n"
29805 " const char *device);\n"
29810 #: ../src/guestfs-actions.pod:7405
29811 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
29815 #: ../src/guestfs-actions.pod:7412
29816 msgid "guestfs_vg_activate"
29820 #: ../src/guestfs-actions.pod:7414
29824 " guestfs_vg_activate (guestfs_h *g,\n"
29826 " char *const *volgroups);\n"
29831 #: ../src/guestfs-actions.pod:7431
29832 msgid "guestfs_vg_activate_all"
29836 #: ../src/guestfs-actions.pod:7433
29840 " guestfs_vg_activate_all (guestfs_h *g,\n"
29841 " int activate);\n"
29846 #: ../src/guestfs-actions.pod:7446
29847 msgid "guestfs_vgcreate"
29851 #: ../src/guestfs-actions.pod:7448
29855 " guestfs_vgcreate (guestfs_h *g,\n"
29856 " const char *volgroup,\n"
29857 " char *const *physvols);\n"
29862 #: ../src/guestfs-actions.pod:7460
29863 msgid "guestfs_vglvuuids"
29867 #: ../src/guestfs-actions.pod:7462
29871 " guestfs_vglvuuids (guestfs_h *g,\n"
29872 " const char *vgname);\n"
29877 #: ../src/guestfs-actions.pod:7469
29879 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
29880 "associate logical volumes and volume groups."
29884 #: ../src/guestfs-actions.pod:7472
29885 msgid "See also C<guestfs_vgpvuuids>."
29889 #: ../src/guestfs-actions.pod:7480
29890 msgid "guestfs_vgpvuuids"
29894 #: ../src/guestfs-actions.pod:7482
29898 " guestfs_vgpvuuids (guestfs_h *g,\n"
29899 " const char *vgname);\n"
29904 #: ../src/guestfs-actions.pod:7489
29906 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
29907 "associate physical volumes and volume groups."
29911 #: ../src/guestfs-actions.pod:7492
29912 msgid "See also C<guestfs_vglvuuids>."
29916 #: ../src/guestfs-actions.pod:7500
29917 msgid "guestfs_vgremove"
29921 #: ../src/guestfs-actions.pod:7502
29925 " guestfs_vgremove (guestfs_h *g,\n"
29926 " const char *vgname);\n"
29931 #: ../src/guestfs-actions.pod:7515
29932 msgid "guestfs_vgrename"
29936 #: ../src/guestfs-actions.pod:7517
29940 " guestfs_vgrename (guestfs_h *g,\n"
29941 " const char *volgroup,\n"
29942 " const char *newvolgroup);\n"
29947 #: ../src/guestfs-actions.pod:7528
29948 msgid "guestfs_vgs"
29952 #: ../src/guestfs-actions.pod:7530
29956 " guestfs_vgs (guestfs_h *g);\n"
29961 #: ../src/guestfs-actions.pod:7539
29962 msgid "See also C<guestfs_vgs_full>."
29966 #: ../src/guestfs-actions.pod:7547
29967 msgid "guestfs_vgs_full"
29971 #: ../src/guestfs-actions.pod:7549
29974 " struct guestfs_lvm_vg_list *\n"
29975 " guestfs_vgs_full (guestfs_h *g);\n"
29980 #: ../src/guestfs-actions.pod:7555
29982 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
29983 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
29987 #: ../src/guestfs-actions.pod:7561
29988 msgid "guestfs_vgscan"
29992 #: ../src/guestfs-actions.pod:7563
29996 " guestfs_vgscan (guestfs_h *g);\n"
30001 #: ../src/guestfs-actions.pod:7573
30002 msgid "guestfs_vguuid"
30006 #: ../src/guestfs-actions.pod:7575
30010 " guestfs_vguuid (guestfs_h *g,\n"
30011 " const char *vgname);\n"
30016 #: ../src/guestfs-actions.pod:7586
30017 msgid "guestfs_wait_ready"
30021 #: ../src/guestfs-actions.pod:7588
30025 " guestfs_wait_ready (guestfs_h *g);\n"
30030 #: ../src/guestfs-actions.pod:7591
30032 "I<This function is deprecated.> In new code, use the L</guestfs_launch> call "
30037 #: ../src/guestfs-actions.pod:7598
30038 msgid "This function is a no op."
30042 #: ../src/guestfs-actions.pod:7600
30044 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
30045 "calling C<guestfs_launch> to wait for the launch to complete. However this "
30046 "is no longer necessary because C<guestfs_launch> now does the waiting."
30050 #: ../src/guestfs-actions.pod:7605
30052 "If you see any calls to this function in code then you can just remove them, "
30053 "unless you want to retain compatibility with older versions of the API."
30057 #: ../src/guestfs-actions.pod:7613
30058 msgid "guestfs_wc_c"
30062 #: ../src/guestfs-actions.pod:7615
30066 " guestfs_wc_c (guestfs_h *g,\n"
30067 " const char *path);\n"
30072 #: ../src/guestfs-actions.pod:7626
30073 msgid "guestfs_wc_l"
30077 #: ../src/guestfs-actions.pod:7628
30081 " guestfs_wc_l (guestfs_h *g,\n"
30082 " const char *path);\n"
30087 #: ../src/guestfs-actions.pod:7639
30088 msgid "guestfs_wc_w"
30092 #: ../src/guestfs-actions.pod:7641
30096 " guestfs_wc_w (guestfs_h *g,\n"
30097 " const char *path);\n"
30102 #: ../src/guestfs-actions.pod:7652
30103 msgid "guestfs_write"
30107 #: ../src/guestfs-actions.pod:7654
30111 " guestfs_write (guestfs_h *g,\n"
30112 " const char *path,\n"
30113 " const char *content,\n"
30114 " size_t content_size);\n"
30119 #: ../src/guestfs-actions.pod:7663
30120 msgid "See also C<guestfs_write_append>."
30124 #: ../src/guestfs-actions.pod:7672
30125 msgid "guestfs_write_append"
30129 #: ../src/guestfs-actions.pod:7674
30133 " guestfs_write_append (guestfs_h *g,\n"
30134 " const char *path,\n"
30135 " const char *content,\n"
30136 " size_t content_size);\n"
30141 #: ../src/guestfs-actions.pod:7683
30142 msgid "See also C<guestfs_write>."
30146 #: ../src/guestfs-actions.pod:7692
30147 msgid "guestfs_write_file"
30151 #: ../src/guestfs-actions.pod:7694
30155 " guestfs_write_file (guestfs_h *g,\n"
30156 " const char *path,\n"
30157 " const char *content,\n"
30163 #: ../src/guestfs-actions.pod:7700
30165 "I<This function is deprecated.> In new code, use the L</guestfs_write> call "
30170 #: ../src/guestfs-actions.pod:7725
30171 msgid "guestfs_zegrep"
30175 #: ../src/guestfs-actions.pod:7727
30179 " guestfs_zegrep (guestfs_h *g,\n"
30180 " const char *regex,\n"
30181 " const char *path);\n"
30186 #: ../src/guestfs-actions.pod:7744
30187 msgid "guestfs_zegrepi"
30191 #: ../src/guestfs-actions.pod:7746
30195 " guestfs_zegrepi (guestfs_h *g,\n"
30196 " const char *regex,\n"
30197 " const char *path);\n"
30202 #: ../src/guestfs-actions.pod:7763
30203 msgid "guestfs_zero"
30207 #: ../src/guestfs-actions.pod:7765
30211 " guestfs_zero (guestfs_h *g,\n"
30212 " const char *device);\n"
30217 #: ../src/guestfs-actions.pod:7779
30219 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
30220 "C<guestfs_is_zero_device>"
30224 #: ../src/guestfs-actions.pod:7791
30225 msgid "guestfs_zero_device"
30229 #: ../src/guestfs-actions.pod:7793
30233 " guestfs_zero_device (guestfs_h *g,\n"
30234 " const char *device);\n"
30239 #: ../src/guestfs-actions.pod:7797
30241 "This command writes zeroes over the entire C<device>. Compare with "
30242 "C<guestfs_zero> which just zeroes the first few blocks of a device."
30246 #: ../src/guestfs-actions.pod:7815
30247 msgid "(Added in 1.3.1)"
30251 #: ../src/guestfs-actions.pod:7817
30252 msgid "guestfs_zerofree"
30256 #: ../src/guestfs-actions.pod:7819
30260 " guestfs_zerofree (guestfs_h *g,\n"
30261 " const char *device);\n"
30266 #: ../src/guestfs-actions.pod:7838
30267 msgid "guestfs_zfgrep"
30271 #: ../src/guestfs-actions.pod:7840
30275 " guestfs_zfgrep (guestfs_h *g,\n"
30276 " const char *pattern,\n"
30277 " const char *path);\n"
30282 #: ../src/guestfs-actions.pod:7857
30283 msgid "guestfs_zfgrepi"
30287 #: ../src/guestfs-actions.pod:7859
30291 " guestfs_zfgrepi (guestfs_h *g,\n"
30292 " const char *pattern,\n"
30293 " const char *path);\n"
30298 #: ../src/guestfs-actions.pod:7876
30299 msgid "guestfs_zfile"
30303 #: ../src/guestfs-actions.pod:7878
30307 " guestfs_zfile (guestfs_h *g,\n"
30308 " const char *meth,\n"
30309 " const char *path);\n"
30314 #: ../src/guestfs-actions.pod:7883
30316 "I<This function is deprecated.> In new code, use the L</guestfs_file> call "
30321 #: ../src/guestfs-actions.pod:7895
30323 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
30328 #: ../src/guestfs-actions.pod:7903
30329 msgid "guestfs_zgrep"
30333 #: ../src/guestfs-actions.pod:7905
30337 " guestfs_zgrep (guestfs_h *g,\n"
30338 " const char *regex,\n"
30339 " const char *path);\n"
30344 #: ../src/guestfs-actions.pod:7922
30345 msgid "guestfs_zgrepi"
30349 #: ../src/guestfs-actions.pod:7924
30353 " guestfs_zgrepi (guestfs_h *g,\n"
30354 " const char *regex,\n"
30355 " const char *path);\n"
30360 #: ../src/guestfs-availability.pod:3
30365 #: ../src/guestfs-availability.pod:5
30367 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
30368 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
30369 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
30370 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
30371 "L</guestfs_aug_save> L</guestfs_aug_set>"
30375 #: ../src/guestfs-availability.pod:21
30380 #: ../src/guestfs-availability.pod:23
30381 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
30385 #: ../src/guestfs-availability.pod:26
30390 #: ../src/guestfs-availability.pod:28
30392 "The following functions: L</guestfs_inotify_add_watch> L</"
30393 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
30394 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
30398 #: ../src/guestfs-availability.pod:36
30399 msgid "B<linuxfsuuid>"
30403 #: ../src/guestfs-availability.pod:38
30405 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
30406 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
30410 #: ../src/guestfs-availability.pod:45
30411 msgid "B<linuxmodules>"
30415 #: ../src/guestfs-availability.pod:47
30416 msgid "The following functions: L</guestfs_modprobe>"
30420 #: ../src/guestfs-availability.pod:50
30421 msgid "B<linuxxattrs>"
30425 #: ../src/guestfs-availability.pod:52
30427 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
30428 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
30429 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
30430 "guestfs_setxattr>"
30434 #: ../src/guestfs-availability.pod:63
30439 #: ../src/guestfs-availability.pod:65
30441 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
30442 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
30443 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
30447 #: ../src/guestfs-availability.pod:74
30452 #: ../src/guestfs-availability.pod:76
30454 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
30455 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
30456 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
30457 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
30458 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
30459 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
30460 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
30464 #: ../src/guestfs-availability.pod:99
30469 #: ../src/guestfs-availability.pod:101
30471 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
30472 "guestfs_mknod_b> L</guestfs_mknod_c>"
30476 #: ../src/guestfs-availability.pod:107
30481 #: ../src/guestfs-availability.pod:109
30482 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
30486 #: ../src/guestfs-availability.pod:112
30487 msgid "B<ntfsprogs>"
30491 #: ../src/guestfs-availability.pod:114
30493 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
30494 "L</guestfs_ntfsresize_size>"
30498 #: ../src/guestfs-availability.pod:119
30499 msgid "B<realpath>"
30503 #: ../src/guestfs-availability.pod:121
30504 msgid "The following functions: L</guestfs_realpath>"
30508 #: ../src/guestfs-availability.pod:124
30513 #: ../src/guestfs-availability.pod:126
30515 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
30516 "guestfs_scrub_freespace>"
30520 #: ../src/guestfs-availability.pod:131
30525 #: ../src/guestfs-availability.pod:133
30526 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
30530 #: ../src/guestfs-availability.pod:137
30535 #: ../src/guestfs-availability.pod:139
30536 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
30540 #: ../src/guestfs-availability.pod:143
30541 msgid "B<zerofree>"
30545 #: ../src/guestfs-availability.pod:145
30546 msgid "The following functions: L</guestfs_zerofree>"
30550 #: ../src/guestfs-structs.pod:1
30551 msgid "guestfs_int_bool"
30555 #: ../src/guestfs-structs.pod:3
30558 " struct guestfs_int_bool {\n"
30566 #: ../src/guestfs-structs.pod:8
30569 " struct guestfs_int_bool_list {\n"
30570 " uint32_t len; /* Number of elements in list. */\n"
30571 " struct guestfs_int_bool *val; /* Elements. */\n"
30577 #: ../src/guestfs-structs.pod:13
30580 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
30581 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
30586 #: ../src/guestfs-structs.pod:16
30587 msgid "guestfs_lvm_pv"
30591 #: ../src/guestfs-structs.pod:18
30594 " struct guestfs_lvm_pv {\n"
30595 " char *pv_name;\n"
30596 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30597 " char pv_uuid[32];\n"
30599 " uint64_t pv_size;\n"
30600 " uint64_t dev_size;\n"
30601 " uint64_t pv_free;\n"
30602 " uint64_t pv_used;\n"
30603 " char *pv_attr;\n"
30604 " int64_t pv_pe_count;\n"
30605 " int64_t pv_pe_alloc_count;\n"
30606 " char *pv_tags;\n"
30607 " uint64_t pe_start;\n"
30608 " int64_t pv_mda_count;\n"
30609 " uint64_t pv_mda_free;\n"
30615 #: ../src/guestfs-structs.pod:36
30618 " struct guestfs_lvm_pv_list {\n"
30619 " uint32_t len; /* Number of elements in list. */\n"
30620 " struct guestfs_lvm_pv *val; /* Elements. */\n"
30626 #: ../src/guestfs-structs.pod:41
30629 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
30630 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
30635 #: ../src/guestfs-structs.pod:44
30636 msgid "guestfs_lvm_vg"
30640 #: ../src/guestfs-structs.pod:46
30643 " struct guestfs_lvm_vg {\n"
30644 " char *vg_name;\n"
30645 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30646 " char vg_uuid[32];\n"
30648 " char *vg_attr;\n"
30649 " uint64_t vg_size;\n"
30650 " uint64_t vg_free;\n"
30651 " char *vg_sysid;\n"
30652 " uint64_t vg_extent_size;\n"
30653 " int64_t vg_extent_count;\n"
30654 " int64_t vg_free_count;\n"
30655 " int64_t max_lv;\n"
30656 " int64_t max_pv;\n"
30657 " int64_t pv_count;\n"
30658 " int64_t lv_count;\n"
30659 " int64_t snap_count;\n"
30660 " int64_t vg_seqno;\n"
30661 " char *vg_tags;\n"
30662 " int64_t vg_mda_count;\n"
30663 " uint64_t vg_mda_free;\n"
30669 #: ../src/guestfs-structs.pod:69
30672 " struct guestfs_lvm_vg_list {\n"
30673 " uint32_t len; /* Number of elements in list. */\n"
30674 " struct guestfs_lvm_vg *val; /* Elements. */\n"
30680 #: ../src/guestfs-structs.pod:74
30683 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
30684 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
30689 #: ../src/guestfs-structs.pod:77
30690 msgid "guestfs_lvm_lv"
30694 #: ../src/guestfs-structs.pod:79
30697 " struct guestfs_lvm_lv {\n"
30698 " char *lv_name;\n"
30699 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30700 " char lv_uuid[32];\n"
30701 " char *lv_attr;\n"
30702 " int64_t lv_major;\n"
30703 " int64_t lv_minor;\n"
30704 " int64_t lv_kernel_major;\n"
30705 " int64_t lv_kernel_minor;\n"
30706 " uint64_t lv_size;\n"
30707 " int64_t seg_count;\n"
30709 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
30710 " float snap_percent;\n"
30711 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
30712 " float copy_percent;\n"
30713 " char *move_pv;\n"
30714 " char *lv_tags;\n"
30715 " char *mirror_log;\n"
30716 " char *modules;\n"
30722 #: ../src/guestfs-structs.pod:101
30725 " struct guestfs_lvm_lv_list {\n"
30726 " uint32_t len; /* Number of elements in list. */\n"
30727 " struct guestfs_lvm_lv *val; /* Elements. */\n"
30733 #: ../src/guestfs-structs.pod:106
30736 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
30737 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
30742 #: ../src/guestfs-structs.pod:111
30745 " struct guestfs_stat {\n"
30749 " int64_t nlink;\n"
30754 " int64_t blksize;\n"
30755 " int64_t blocks;\n"
30756 " int64_t atime;\n"
30757 " int64_t mtime;\n"
30758 " int64_t ctime;\n"
30764 #: ../src/guestfs-structs.pod:127
30767 " struct guestfs_stat_list {\n"
30768 " uint32_t len; /* Number of elements in list. */\n"
30769 " struct guestfs_stat *val; /* Elements. */\n"
30775 #: ../src/guestfs-structs.pod:132
30778 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
30779 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
30784 #: ../src/guestfs-structs.pod:137
30787 " struct guestfs_statvfs {\n"
30788 " int64_t bsize;\n"
30789 " int64_t frsize;\n"
30790 " int64_t blocks;\n"
30791 " int64_t bfree;\n"
30792 " int64_t bavail;\n"
30793 " int64_t files;\n"
30794 " int64_t ffree;\n"
30795 " int64_t favail;\n"
30798 " int64_t namemax;\n"
30804 #: ../src/guestfs-structs.pod:151
30807 " struct guestfs_statvfs_list {\n"
30808 " uint32_t len; /* Number of elements in list. */\n"
30809 " struct guestfs_statvfs *val; /* Elements. */\n"
30815 #: ../src/guestfs-structs.pod:156
30818 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
30819 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
30824 #: ../src/guestfs-structs.pod:159
30825 msgid "guestfs_dirent"
30829 #: ../src/guestfs-structs.pod:161
30832 " struct guestfs_dirent {\n"
30841 #: ../src/guestfs-structs.pod:167
30844 " struct guestfs_dirent_list {\n"
30845 " uint32_t len; /* Number of elements in list. */\n"
30846 " struct guestfs_dirent *val; /* Elements. */\n"
30852 #: ../src/guestfs-structs.pod:172
30855 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
30856 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
30861 #: ../src/guestfs-structs.pod:177
30864 " struct guestfs_version {\n"
30865 " int64_t major;\n"
30866 " int64_t minor;\n"
30867 " int64_t release;\n"
30874 #: ../src/guestfs-structs.pod:184
30877 " struct guestfs_version_list {\n"
30878 " uint32_t len; /* Number of elements in list. */\n"
30879 " struct guestfs_version *val; /* Elements. */\n"
30885 #: ../src/guestfs-structs.pod:189
30888 " void guestfs_free_version (struct guestfs_free_version *);\n"
30889 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
30894 #: ../src/guestfs-structs.pod:192
30895 msgid "guestfs_xattr"
30899 #: ../src/guestfs-structs.pod:194
30902 " struct guestfs_xattr {\n"
30903 " char *attrname;\n"
30904 " /* The next two fields describe a byte array. */\n"
30905 " uint32_t attrval_len;\n"
30906 " char *attrval;\n"
30912 #: ../src/guestfs-structs.pod:201
30915 " struct guestfs_xattr_list {\n"
30916 " uint32_t len; /* Number of elements in list. */\n"
30917 " struct guestfs_xattr *val; /* Elements. */\n"
30923 #: ../src/guestfs-structs.pod:206
30926 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
30927 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
30932 #: ../src/guestfs-structs.pod:209
30933 msgid "guestfs_inotify_event"
30937 #: ../src/guestfs-structs.pod:211
30940 " struct guestfs_inotify_event {\n"
30941 " int64_t in_wd;\n"
30942 " uint32_t in_mask;\n"
30943 " uint32_t in_cookie;\n"
30944 " char *in_name;\n"
30950 #: ../src/guestfs-structs.pod:218
30953 " struct guestfs_inotify_event_list {\n"
30954 " uint32_t len; /* Number of elements in list. */\n"
30955 " struct guestfs_inotify_event *val; /* Elements. */\n"
30961 #: ../src/guestfs-structs.pod:223
30964 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
30965 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
30970 #: ../src/guestfs-structs.pod:226
30971 msgid "guestfs_partition"
30975 #: ../src/guestfs-structs.pod:228
30978 " struct guestfs_partition {\n"
30979 " int32_t part_num;\n"
30980 " uint64_t part_start;\n"
30981 " uint64_t part_end;\n"
30982 " uint64_t part_size;\n"
30988 #: ../src/guestfs-structs.pod:235
30991 " struct guestfs_partition_list {\n"
30992 " uint32_t len; /* Number of elements in list. */\n"
30993 " struct guestfs_partition *val; /* Elements. */\n"
30999 #: ../src/guestfs-structs.pod:240
31002 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
31003 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
31008 #: ../src/guestfs-structs.pod:243
31009 msgid "guestfs_application"
31013 #: ../src/guestfs-structs.pod:245
31016 " struct guestfs_application {\n"
31017 " char *app_name;\n"
31018 " char *app_display_name;\n"
31019 " int32_t app_epoch;\n"
31020 " char *app_version;\n"
31021 " char *app_release;\n"
31022 " char *app_install_path;\n"
31023 " char *app_trans_path;\n"
31024 " char *app_publisher;\n"
31025 " char *app_url;\n"
31026 " char *app_source_package;\n"
31027 " char *app_summary;\n"
31028 " char *app_description;\n"
31034 #: ../src/guestfs-structs.pod:260
31037 " struct guestfs_application_list {\n"
31038 " uint32_t len; /* Number of elements in list. */\n"
31039 " struct guestfs_application *val; /* Elements. */\n"
31045 #: ../src/guestfs-structs.pod:265
31048 " void guestfs_free_application (struct guestfs_free_application *);\n"
31049 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
31054 #: ../src/guestfs.pod:5
31055 msgid "guestfs - Library for accessing and modifying virtual machine images"
31059 #: ../src/guestfs.pod:11
31062 " guestfs_h *g = guestfs_create ();\n"
31063 " guestfs_add_drive (g, \"guest.img\");\n"
31064 " guestfs_launch (g);\n"
31065 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
31066 " guestfs_touch (g, \"/hello\");\n"
31067 " guestfs_umount (g, \"/\");\n"
31068 " guestfs_close (g);\n"
31073 #: ../src/guestfs.pod:25
31075 "Libguestfs is a library for accessing and modifying guest disk images. "
31076 "Amongst the things this is good for: making batch configuration changes to "
31077 "guests, getting disk used/free statistics (see also: virt-df), migrating "
31078 "between virtualization systems (see also: virt-p2v), performing partial "
31079 "backups, performing partial guest clones, cloning guests and changing "
31080 "registry/UUID/hostname info, and much else besides."
31084 #: ../src/guestfs.pod:33
31086 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
31087 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
31088 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
31093 #: ../src/guestfs.pod:38
31095 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
31096 "what filesystem is in each LV, etc.). It can also run commands in the "
31097 "context of the guest. Also you can access filesystems over FUSE."
31101 #: ../src/guestfs.pod:43
31103 "Libguestfs is a library that can be linked with C and C++ management "
31104 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
31105 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
31110 #: ../src/guestfs.pod:48
31112 "You don't need to be root to use libguestfs, although obviously you do need "
31113 "enough permissions to access the disk images."
31117 #: ../src/guestfs.pod:51
31119 "Libguestfs is a large API because it can do many things. For a gentle "
31120 "introduction, please read the L</API OVERVIEW> section next."
31124 #: ../src/guestfs.pod:54
31126 "There are also some example programs in the L<guestfs-examples(3)> manual "
31131 #: ../src/guestfs.pod:57
31132 msgid "API OVERVIEW"
31136 #: ../src/guestfs.pod:59
31138 "This section provides a gentler overview of the libguestfs API. We also try "
31139 "to group API calls together, where that may not be obvious from reading "
31140 "about the individual calls in the main section of this manual."
31144 #: ../src/guestfs.pod:64
31149 #: ../src/guestfs.pod:66
31151 "Before you can use libguestfs calls, you have to create a handle. Then you "
31152 "must add at least one disk image to the handle, followed by launching the "
31153 "handle, then performing whatever operations you want, and finally closing "
31154 "the handle. By convention we use the single letter C<g> for the name of the "
31155 "handle variable, although of course you can use any name you want."
31159 #: ../src/guestfs.pod:73
31160 msgid "The general structure of all libguestfs-using programs looks like this:"
31164 #: ../src/guestfs.pod:76
31167 " guestfs_h *g = guestfs_create ();\n"
31172 #: ../src/guestfs.pod:78
31175 " /* Call guestfs_add_drive additional times if there are\n"
31176 " * multiple disk images.\n"
31178 " guestfs_add_drive (g, \"guest.img\");\n"
31183 #: ../src/guestfs.pod:83
31186 " /* Most manipulation calls won't work until you've launched\n"
31187 " * the handle 'g'. You have to do this _after_ adding drives\n"
31188 " * and _before_ other commands.\n"
31190 " guestfs_launch (g);\n"
31195 #: ../src/guestfs.pod:89
31198 " /* Now you can examine what partitions, LVs etc are available.\n"
31200 " char **partitions = guestfs_list_partitions (g);\n"
31201 " char **logvols = guestfs_lvs (g);\n"
31206 #: ../src/guestfs.pod:94
31209 " /* To access a filesystem in the image, you must mount it.\n"
31211 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
31216 #: ../src/guestfs.pod:98
31219 " /* Now you can perform filesystem actions on the guest\n"
31222 " guestfs_touch (g, \"/hello\");\n"
31227 #: ../src/guestfs.pod:103
31230 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
31231 " * it is done automatically when you close the handle. See\n"
31232 " * discussion of autosync in this page.\n"
31234 " guestfs_sync (g);\n"
31239 #: ../src/guestfs.pod:109
31242 " /* Close the handle 'g'. */\n"
31243 " guestfs_close (g);\n"
31248 #: ../src/guestfs.pod:112
31250 "The code above doesn't include any error checking. In real code you should "
31251 "check return values carefully for errors. In general all functions that "
31252 "return integers return C<-1> on error, and all functions that return "
31253 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
31254 "how to handle errors, and consult the documentation for each function call "
31255 "below to see precisely how they return error indications. See L<guestfs-"
31256 "examples(3)> for fully worked examples."
31260 #: ../src/guestfs.pod:121
31261 msgid "DISK IMAGES"
31265 #: ../src/guestfs.pod:123
31267 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
31268 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
31269 "actual block device, or simply an empty file of zeroes that you have created "
31270 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
31275 #: ../src/guestfs.pod:129
31277 "The call you should use in modern code for adding drives is L</"
31278 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
31279 "specifying that the format is raw, do:"
31283 #: ../src/guestfs.pod:133
31286 " guestfs_add_drive_opts (g, filename,\n"
31287 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
31293 #: ../src/guestfs.pod:137
31294 msgid "You can add a disk read-only using:"
31298 #: ../src/guestfs.pod:139
31301 " guestfs_add_drive_opts (g, filename,\n"
31302 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
31303 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
31309 #: ../src/guestfs.pod:144
31311 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
31312 "libguestfs won't modify the file."
31316 #: ../src/guestfs.pod:147
31318 "Be extremely cautious if the disk image is in use, eg. if it is being used "
31319 "by a virtual machine. Adding it read-write will almost certainly cause disk "
31320 "corruption, but adding it read-only is safe."
31324 #: ../src/guestfs.pod:151
31326 "You must add at least one disk image, and you may add multiple disk images. "
31327 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
31328 "first one you added), C</dev/sdb> (for the second one you added), etc."
31332 #: ../src/guestfs.pod:156
31334 "Once L</guestfs_launch> has been called you cannot add any more images. You "
31335 "can call L</guestfs_list_devices> to get a list of the device names, in the "
31336 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
31340 #: ../src/guestfs.pod:161
31345 #: ../src/guestfs.pod:163
31347 "Before you can read or write files, create directories and so on in a disk "
31348 "image that contains filesystems, you have to mount those filesystems using "
31349 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
31350 "a disk image contains (for example) one partition with a filesystem on that "
31351 "partition, then you can mount it directly:"
31355 #: ../src/guestfs.pod:170
31358 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
31363 #: ../src/guestfs.pod:172
31365 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
31366 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
31367 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
31368 "that these are libguestfs virtual devices, and are nothing to do with host "
31373 #: ../src/guestfs.pod:178
31375 "If you are given a disk image and you don't know what it contains then you "
31376 "have to find out. Libguestfs can do that too: use L</"
31377 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
31378 "LVs, and either try mounting each to see what is mountable, or else examine "
31379 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
31380 "filesystems, use L</guestfs_list_filesystems>."
31384 #: ../src/guestfs.pod:186
31386 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
31387 "L</INSPECTION> below). But you might find it easier to look at higher level "
31388 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
31392 #: ../src/guestfs.pod:191
31394 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
31395 "several other variations of the C<guestfs_mount_*> call."
31399 #: ../src/guestfs.pod:194
31400 msgid "FILESYSTEM ACCESS AND MODIFICATION"
31404 #: ../src/guestfs.pod:196
31406 "The majority of the libguestfs API consists of fairly low-level calls for "
31407 "accessing and modifying the files, directories, symlinks etc on mounted "
31408 "filesystems. There are over a hundred such calls which you can find listed "
31409 "in detail below in this man page, and we don't even pretend to cover them "
31410 "all in this overview."
31414 #: ../src/guestfs.pod:202
31416 "Specify filenames as full paths, starting with C<\"/\"> and including the "
31421 #: ../src/guestfs.pod:205
31423 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
31424 "the file called C<\"etc/passwd\"> then you could do:"
31428 #: ../src/guestfs.pod:208
31431 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
31436 #: ../src/guestfs.pod:210
31438 "This would return C<data> as a newly allocated buffer containing the full "
31439 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
31440 "or C<NULL> if there was an error."
31444 #: ../src/guestfs.pod:214
31446 "As another example, to create a top-level directory on that filesystem "
31447 "called C<\"var\"> you would do:"
31451 #: ../src/guestfs.pod:217
31454 " guestfs_mkdir (g, \"/var\");\n"
31459 #: ../src/guestfs.pod:219
31460 msgid "To create a symlink you could do:"
31464 #: ../src/guestfs.pod:221
31467 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
31468 " \"/etc/rc3.d/S30portmap\");\n"
31473 #: ../src/guestfs.pod:224
31475 "Libguestfs will reject attempts to use relative paths and there is no "
31476 "concept of a current working directory."
31480 #: ../src/guestfs.pod:227
31482 "Libguestfs can return errors in many situations: for example if the "
31483 "filesystem isn't writable, or if a file or directory that you requested "
31484 "doesn't exist. If you are using the C API (documented here) you have to "
31485 "check for those error conditions after each call. (Other language bindings "
31486 "turn these errors into exceptions)."
31490 #: ../src/guestfs.pod:233
31492 "File writes are affected by the per-handle umask, set by calling L</"
31493 "guestfs_umask> and defaulting to 022. See L</UMASK>."
31497 #: ../src/guestfs.pod:236
31498 msgid "PARTITIONING"
31502 #: ../src/guestfs.pod:238
31504 "Libguestfs contains API calls to read, create and modify partition tables on "
31509 #: ../src/guestfs.pod:241
31511 "In the common case where you want to create a single partition covering the "
31512 "whole disk, you should use the L</guestfs_part_disk> call:"
31516 #: ../src/guestfs.pod:245
31519 " const char *parttype = \"mbr\";\n"
31520 " if (disk_is_larger_than_2TB)\n"
31521 " parttype = \"gpt\";\n"
31522 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
31527 #: ../src/guestfs.pod:250
31529 "Obviously this effectively wipes anything that was on that disk image before."
31533 #: ../src/guestfs.pod:253
31538 #: ../src/guestfs.pod:255
31540 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
31541 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
31542 "you familiarize yourself with the concepts of physical volumes, volume "
31543 "groups and logical volumes."
31547 #: ../src/guestfs.pod:260
31549 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
31550 "tldp.org/HOWTO/LVM-HOWTO/>."
31554 #: ../src/guestfs.pod:263
31555 msgid "DOWNLOADING"
31559 #: ../src/guestfs.pod:265
31561 "Use L</guestfs_cat> to download small, text only files. This call is "
31562 "limited to files which are less than 2 MB and which cannot contain any ASCII "
31563 "NUL (C<\\0>) characters. However the API is very simple to use."
31567 #: ../src/guestfs.pod:269
31569 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
31570 "bit data, since it returns a (pointer, size) pair. However it is still "
31571 "limited to \"small\" files, less than 2 MB."
31575 #: ../src/guestfs.pod:273
31577 "L</guestfs_download> can be used to download any file, with no limits on "
31578 "content or size (even files larger than 4 GB)."
31582 #: ../src/guestfs.pod:276
31584 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
31588 #: ../src/guestfs.pod:279
31593 #: ../src/guestfs.pod:281
31595 "It's often the case that you want to write a file or files to the disk image."
31599 #: ../src/guestfs.pod:284
31601 "To write a small file with fixed content, use L</guestfs_write>. To create "
31602 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
31603 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
31604 "of other functions for creating test files, for example L</guestfs_fill> and "
31605 "L</guestfs_fill_pattern>."
31609 #: ../src/guestfs.pod:290
31611 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
31612 "file content or size (even files larger than 4 GB)."
31616 #: ../src/guestfs.pod:293
31618 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
31622 #: ../src/guestfs.pod:295
31624 "However the fastest way to upload I<large numbers of arbitrary files> is to "
31625 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
31626 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
31627 "in a predictable way (eg. adding it last after all other drives) then you "
31628 "can get the device name from L</guestfs_list_devices> and mount it directly "
31629 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
31630 "portable between kernel versions, and they don't support labels or UUIDs. "
31631 "If you want to pre-build an image or you need to mount it using a label or "
31632 "UUID, use an ISO image instead."
31636 #: ../src/guestfs.pod:306
31641 #: ../src/guestfs.pod:308
31643 "There are various different commands for copying between files and devices "
31644 "and in and out of the guest filesystem. These are summarised in the table "
31649 #: ../src/guestfs.pod:314
31650 msgid "B<file> to B<file>"
31654 #: ../src/guestfs.pod:316
31656 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
31657 "directories recursively."
31661 #: ../src/guestfs.pod:319
31662 msgid "B<file or device> to B<file or device>"
31666 #: ../src/guestfs.pod:321
31668 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
31669 "devices in the guest."
31673 #: ../src/guestfs.pod:324
31674 msgid "Example: duplicate the contents of an LV:"
31678 #: ../src/guestfs.pod:326
31681 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
31686 #: ../src/guestfs.pod:328
31688 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
31689 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
31690 "guestfs_copy_size>."
31694 #: ../src/guestfs.pod:332
31695 msgid "B<file on the host> to B<file or device>"
31699 #: ../src/guestfs.pod:334
31700 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
31704 #: ../src/guestfs.pod:336
31705 msgid "B<file or device> to B<file on the host>"
31709 #: ../src/guestfs.pod:338
31710 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
31714 #: ../src/guestfs.pod:342
31715 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
31719 #: ../src/guestfs.pod:344
31721 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
31722 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
31723 "appears you can only upload and download to files. However many Un*x-like "
31724 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
31725 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
31726 "and arbitrary file descriptor N."
31730 #: ../src/guestfs.pod:352
31731 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
31735 #: ../src/guestfs.pod:355
31738 " guestfs_download (g, filename, \"/dev/stdout\");\n"
31743 #: ../src/guestfs.pod:357
31744 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
31748 #: ../src/guestfs.pod:359
31751 " char devfd[64];\n"
31752 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
31753 " guestfs_tar_out (g, \"/\", devfd);\n"
31758 #: ../src/guestfs.pod:363
31759 msgid "LISTING FILES"
31763 #: ../src/guestfs.pod:365
31765 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
31766 "L<guestfish(1)>-equivalent command C<ll>)."
31770 #: ../src/guestfs.pod:368
31772 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
31773 "programs, as a flat list of strings."
31777 #: ../src/guestfs.pod:371
31779 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
31780 "directory, plus additional information about each one. It is more "
31781 "equivalent to using the L<readdir(3)> call on a local filesystem."
31785 #: ../src/guestfs.pod:375
31787 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
31791 #: ../src/guestfs.pod:378
31792 msgid "RUNNING COMMANDS"
31796 #: ../src/guestfs.pod:380
31798 "Although libguestfs is primarily an API for manipulating files inside guest "
31799 "images, we also provide some limited facilities for running commands inside "
31804 #: ../src/guestfs.pod:384
31805 msgid "There are many limitations to this:"
31809 #: ../src/guestfs.pod:390
31811 "The kernel version that the command runs under will be different from what "
31816 #: ../src/guestfs.pod:395
31818 "If the command needs to communicate with daemons, then most likely they "
31819 "won't be running."
31823 #: ../src/guestfs.pod:400
31824 msgid "The command will be running in limited memory."
31828 #: ../src/guestfs.pod:404
31830 "The network may not be available unless you enable it (see L</"
31831 "guestfs_set_network>)."
31835 #: ../src/guestfs.pod:409
31836 msgid "Only supports Linux guests (not Windows, BSD, etc)."
31840 #: ../src/guestfs.pod:413
31842 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
31846 #: ../src/guestfs.pod:418
31848 "For SELinux guests, you may need to enable SELinux and load policy first. "
31849 "See L</SELINUX> in this manpage."
31853 #: ../src/guestfs.pod:423
31855 "I<Security:> It is not safe to run commands from untrusted, possibly "
31856 "malicious guests. These commands may attempt to exploit your program by "
31857 "sending unexpected output. They could also try to exploit the Linux kernel "
31858 "or qemu provided by the libguestfs appliance. They could use the network "
31859 "provided by the libguestfs appliance to bypass ordinary network partitions "
31860 "and firewalls. They could use the elevated privileges or different SELinux "
31861 "context of your program to their advantage."
31865 #: ../src/guestfs.pod:432
31867 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
31868 "(a script which runs when the guest next boots normally), and to have this "
31869 "script run the commands you want in the normal context of the running guest, "
31870 "network security and so on. For information about other security issues, "
31871 "see L</SECURITY>."
31875 #: ../src/guestfs.pod:440
31877 "The two main API calls to run commands are L</guestfs_command> and L</"
31878 "guestfs_sh> (there are also variations)."
31882 #: ../src/guestfs.pod:443
31884 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
31885 "shell globs, redirections, etc will work."
31889 #: ../src/guestfs.pod:446
31890 msgid "CONFIGURATION FILES"
31894 #: ../src/guestfs.pod:448
31896 "To read and write configuration files in Linux guest filesystems, we "
31897 "strongly recommend using Augeas. For example, Augeas understands how to "
31898 "read and write, say, a Linux shadow password file or X.org configuration "
31899 "file, and so avoids you having to write that code."
31903 #: ../src/guestfs.pod:453
31905 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
31906 "document Augeas itself here because there is excellent documentation on the "
31907 "L<http://augeas.net/> website."
31911 #: ../src/guestfs.pod:457
31913 "If you don't want to use Augeas (you fool!) then try calling L</"
31914 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
31919 #: ../src/guestfs.pod:461
31924 #: ../src/guestfs.pod:463
31926 "We support SELinux guests. To ensure that labeling happens correctly in "
31927 "SELinux guests, you need to enable SELinux and load the guest's policy:"
31931 #: ../src/guestfs.pod:471
31932 msgid "Before launching, do:"
31936 #: ../src/guestfs.pod:473
31939 " guestfs_set_selinux (g, 1);\n"
31944 #: ../src/guestfs.pod:477
31946 "After mounting the guest's filesystem(s), load the policy. This is best "
31947 "done by running the L<load_policy(8)> command in the guest itself:"
31951 #: ../src/guestfs.pod:481
31954 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
31959 #: ../src/guestfs.pod:483
31961 "(Older versions of C<load_policy> require you to specify the name of the "
31966 #: ../src/guestfs.pod:488
31968 "Optionally, set the security context for the API. The correct security "
31969 "context to use can only be known by inspecting the guest. As an example:"
31973 #: ../src/guestfs.pod:492
31976 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
31981 #: ../src/guestfs.pod:496
31982 msgid "This will work for running commands and editing existing files."
31986 #: ../src/guestfs.pod:498
31988 "When new files are created, you may need to label them explicitly, for "
31989 "example by running the external command C<restorecon pathname>."
31993 #: ../src/guestfs.pod:502
31998 #: ../src/guestfs.pod:504
32000 "Certain calls are affected by the current file mode creation mask (the "
32001 "\"umask\"). In particular ones which create files or directories, such as "
32002 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
32003 "either the default mode that the file is created with or modifies the mode "
32008 #: ../src/guestfs.pod:510
32010 "The default umask is C<022>, so files are created with modes such as C<0644> "
32011 "and directories with C<0755>."
32015 #: ../src/guestfs.pod:513
32017 "There are two ways to avoid being affected by umask. Either set umask to 0 "
32018 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
32019 "guestfs_chmod> after creating each file or directory."
32023 #: ../src/guestfs.pod:517
32024 msgid "For more information about umask, see L<umask(2)>."
32028 #: ../src/guestfs.pod:521
32030 "Libguestfs allows you to access Linux guests which have been encrypted using "
32031 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
32032 "standard. This includes nearly all whole disk encryption systems used by "
32033 "modern Linux guests."
32037 #: ../src/guestfs.pod:527
32039 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
32040 "returns the string C<crypto_LUKS>)."
32044 #: ../src/guestfs.pod:530
32046 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
32047 "will require the passphrase!"
32051 #: ../src/guestfs.pod:533
32053 "Opening a LUKS device creates a new device mapper device called C</dev/"
32054 "mapper/mapname> (where C<mapname> is the string you supply to L</"
32055 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
32056 "from and encrypted to the underlying block device respectively."
32060 #: ../src/guestfs.pod:539
32062 "LVM volume groups on the device can be made visible by calling L</"
32063 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
32064 "(s) can now be mounted in the usual way."
32068 #: ../src/guestfs.pod:543
32070 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
32071 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
32072 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
32073 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
32074 "underlying encrypted block device)."
32078 #: ../src/guestfs.pod:550
32083 #: ../src/guestfs.pod:552
32085 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
32086 "contains operating systems, an install CD or a live CD. (These APIs used to "
32087 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
32088 "version 1.5.3 the most frequently used part of this library has been "
32089 "rewritten in C and moved into the core code)."
32093 #: ../src/guestfs.pod:559
32095 "Add all disks belonging to the unknown virtual machine and call L</"
32096 "guestfs_launch> in the usual way."
32100 #: ../src/guestfs.pod:562
32102 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
32103 "and certain heuristics, and returns a list of operating systems that were "
32104 "found. An empty list means none were found. A single element is the root "
32105 "filesystem of the operating system. For dual- or multi-boot guests, "
32106 "multiple roots can be returned, each one corresponding to a separate "
32107 "operating system. (Multi-boot virtual machines are extremely rare in the "
32108 "world of virtualization, but since this scenario can happen, we have built "
32109 "libguestfs to deal with it.)"
32113 #: ../src/guestfs.pod:571
32115 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
32116 "to get additional details about that operating system. For example, call L</"
32117 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
32118 "Windows and Linux-based operating systems respectively."
32122 #: ../src/guestfs.pod:577
32124 "Un*x-like and Linux-based operating systems usually consist of several "
32125 "filesystems which are mounted at boot time (for example, a separate boot "
32126 "partition mounted on C</boot>). The inspection rules are able to detect how "
32127 "filesystems correspond to mount points. Call "
32128 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
32129 "hash table like this example:"
32133 #: ../src/guestfs.pod:584
32136 " /boot => /dev/sda1\n"
32137 " / => /dev/vg_guest/lv_root\n"
32138 " /usr => /dev/vg_guest/lv_usr\n"
32143 #: ../src/guestfs.pod:588
32145 "The caller can then make calls to L</guestfs_mount_options> to mount the "
32146 "filesystems as suggested."
32150 #: ../src/guestfs.pod:591
32152 "Be careful to mount filesystems in the right order (eg. C</> before C</"
32153 "usr>). Sorting the keys of the hash by length, shortest first, should work."
32157 #: ../src/guestfs.pod:595
32159 "Inspection currently only works for some common operating systems. "
32160 "Contributors are welcome to send patches for other operating systems that we "
32161 "currently cannot detect."
32165 #: ../src/guestfs.pod:599
32167 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
32168 "for more details. The L</guestfs_inspect_os> function just ignores any "
32169 "encrypted devices."
32173 #: ../src/guestfs.pod:603
32175 "A note on the implementation: The call L</guestfs_inspect_os> performs "
32176 "inspection and caches the results in the guest handle. Subsequent calls to "
32177 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
32178 "read the disks. If you change the content of the guest disks, you can redo "
32179 "inspection by calling L</guestfs_inspect_os> again. (L</"
32180 "guestfs_inspect_list_applications> works a little differently from the other "
32181 "calls and does read the disks. See documentation for that function for "
32186 #: ../src/guestfs.pod:612
32187 msgid "INSPECTING INSTALL DISKS"
32191 #: ../src/guestfs.pod:614
32193 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
32198 #: ../src/guestfs.pod:617
32200 "Call L</guestfs_inspect_get_format> to return the format of the operating "
32201 "system, which currently can be C<installed> (a regular operating system) or "
32202 "C<installer> (some sort of install disk)."
32206 #: ../src/guestfs.pod:621
32208 "Further information is available about the operating system that can be "
32209 "installed using the regular inspection APIs like L</"
32210 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
32214 #: ../src/guestfs.pod:626
32216 "Some additional information specific to installer disks is also available "
32217 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
32218 "guestfs_inspect_is_multipart> calls."
32222 #: ../src/guestfs.pod:631
32223 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
32227 #: ../src/guestfs.pod:633
32229 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
32230 "ntfs-3g.org/> driver."
32234 #: ../src/guestfs.pod:636
32235 msgid "DRIVE LETTERS AND PATHS"
32239 #: ../src/guestfs.pod:638
32241 "DOS and Windows still use drive letters, and the filesystems are always "
32242 "treated as case insensitive by Windows itself, and therefore you might find "
32243 "a Windows configuration file referring to a path like C<c:\\windows"
32244 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
32245 "might be referred to as C</WINDOWS/System32>."
32249 #: ../src/guestfs.pod:644
32251 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
32252 "L</guestfs_inspect_get_drive_mappings>)"
32256 #: ../src/guestfs.pod:647
32258 "Dealing with separator characters (backslash vs forward slash) is outside "
32259 "the scope of libguestfs, but usually a simple character replacement will "
32264 #: ../src/guestfs.pod:651
32266 "To resolve the case insensitivity of paths, call L</"
32267 "guestfs_case_sensitive_path>."
32271 #: ../src/guestfs.pod:654
32272 msgid "ACCESSING THE WINDOWS REGISTRY"
32276 #: ../src/guestfs.pod:656
32278 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
32279 "files, through the library C<hivex> which is part of the libguestfs project "
32280 "although ships as a separate tarball. You have to locate and download the "
32281 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
32282 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
32283 "reg(1)> for more help on this issue."
32287 #: ../src/guestfs.pod:664
32288 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
32292 #: ../src/guestfs.pod:666
32294 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
32295 "provide something which looks like a Linux symlink. The way it tries to do "
32296 "the rewriting is described here:"
32300 #: ../src/guestfs.pod:670
32302 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
32307 #: ../src/guestfs.pod:672
32309 "The essential problem is that ntfs-3g simply does not have enough "
32310 "information to do a correct job. NTFS links can contain drive letters and "
32311 "references to external device GUIDs that ntfs-3g has no way of resolving. "
32312 "It is almost certainly the case that libguestfs callers should ignore what "
32313 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
32317 #: ../src/guestfs.pod:679
32319 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
32320 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
32321 "attribute, and read the raw reparse data from that (you can find the format "
32322 "documented in various places around the web)."
32326 #: ../src/guestfs.pod:684
32327 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
32331 #: ../src/guestfs.pod:686
32333 "There are other useful extended attributes that can be read from ntfs-3g "
32334 "filesystems (using L</guestfs_getxattr>). See:"
32338 #: ../src/guestfs.pod:689
32340 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
32344 #: ../src/guestfs.pod:691
32345 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
32349 #: ../src/guestfs.pod:693
32351 "Although we don't want to discourage you from using the C API, we will "
32352 "mention here that the same API is also available in other languages."
32356 #: ../src/guestfs.pod:696
32358 "The API is broadly identical in all supported languages. This means that "
32359 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
32360 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
32361 "OCaml. In other words, a straightforward, predictable isomorphism between "
32366 #: ../src/guestfs.pod:702
32368 "Error messages are automatically transformed into exceptions if the language "
32373 #: ../src/guestfs.pod:705
32375 "We don't try to \"object orientify\" parts of the API in OO languages, "
32376 "although contributors are welcome to write higher level APIs above what we "
32377 "provide in their favourite languages if they wish."
32381 #: ../src/guestfs.pod:711
32386 #: ../src/guestfs.pod:713
32388 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
32389 "identical to the C API. C++ classes and exceptions are not used."
32393 #: ../src/guestfs.pod:717
32398 #: ../src/guestfs.pod:719
32400 "The C# bindings are highly experimental. Please read the warnings at the "
32401 "top of C<csharp/Libguestfs.cs>."
32405 #: ../src/guestfs.pod:722
32410 #: ../src/guestfs.pod:724
32412 "This is the only language binding that is working but incomplete. Only "
32413 "calls which return simple integers have been bound in Haskell, and we are "
32414 "looking for help to complete this binding."
32418 #: ../src/guestfs.pod:728
32423 #: ../src/guestfs.pod:730
32425 "Full documentation is contained in the Javadoc which is distributed with "
32426 "libguestfs. For examples, see L<guestfs-java(3)>."
32430 #: ../src/guestfs.pod:733
32435 #: ../src/guestfs.pod:735
32436 msgid "See L<guestfs-ocaml(3)>."
32440 #: ../src/guestfs.pod:737
32445 #: ../src/guestfs.pod:739
32446 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
32450 #: ../src/guestfs.pod:741
32455 #: ../src/guestfs.pod:743
32457 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
32458 "the php-libguestfs package for your distribution."
32462 #: ../src/guestfs.pod:746
32463 msgid "The PHP binding only works correctly on 64 bit machines."
32467 #: ../src/guestfs.pod:748
32472 #: ../src/guestfs.pod:750
32473 msgid "See L<guestfs-python(3)>."
32477 #: ../src/guestfs.pod:752
32482 #: ../src/guestfs.pod:754
32483 msgid "See L<guestfs-ruby(3)>."
32487 #: ../src/guestfs.pod:756
32488 msgid "B<shell scripts>"
32492 #: ../src/guestfs.pod:758
32493 msgid "See L<guestfish(1)>."
32497 #: ../src/guestfs.pod:762
32498 msgid "LIBGUESTFS GOTCHAS"
32502 #: ../src/guestfs.pod:764
32504 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
32505 "system [...] that works in the way it is documented but is counterintuitive "
32506 "and almost invites mistakes.\""
32510 #: ../src/guestfs.pod:768
32512 "Since we developed libguestfs and the associated tools, there are several "
32513 "things we would have designed differently, but are now stuck with for "
32514 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
32515 "release, you can expect these to change. Beware of them."
32519 #: ../src/guestfs.pod:776
32520 msgid "Autosync / forgetting to sync."
32524 #: ../src/guestfs.pod:778
32526 "I<Update:> Autosync is enabled by default for all API users starting from "
32527 "libguestfs 1.5.24. This section only applies to older versions."
32531 #: ../src/guestfs.pod:781
32533 "When modifying a filesystem from C or another language, you B<must> unmount "
32534 "all filesystems and call L</guestfs_sync> explicitly before you close the "
32535 "libguestfs handle. You can also call:"
32539 #: ../src/guestfs.pod:785
32542 " guestfs_set_autosync (g, 1);\n"
32547 #: ../src/guestfs.pod:787
32549 "to have the unmount/sync done automatically for you when the handle 'g' is "
32550 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
32554 #: ../src/guestfs.pod:791
32556 "If you forget to do this, then it is entirely possible that your changes "
32557 "won't be written out, or will be partially written, or (very rarely) that "
32558 "you'll get disk corruption."
32562 #: ../src/guestfs.pod:795
32564 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
32565 "guestfish scripts that forget to sync will work just fine, which can make "
32566 "this very puzzling if you are trying to debug a problem."
32570 #: ../src/guestfs.pod:799
32571 msgid "Mount option C<-o sync> should not be the default."
32575 #: ../src/guestfs.pod:801
32577 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
32578 "However C<-o sync> does not add any reliability benefit, but does have a "
32579 "very large performance impact."
32583 #: ../src/guestfs.pod:805
32585 "The work around is to use L</guestfs_mount_options> and set the mount "
32586 "options that you actually want to use."
32590 #: ../src/guestfs.pod:808
32591 msgid "Read-only should be the default."
32595 #: ../src/guestfs.pod:810
32597 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
32598 "specify I<--rw> if you want to make changes to the image."
32602 #: ../src/guestfs.pod:813
32603 msgid "This would reduce the potential to corrupt live VM images."
32607 #: ../src/guestfs.pod:815
32609 "Note that many filesystems change the disk when you just mount and unmount, "
32610 "even if you didn't perform any writes. You need to use L</"
32611 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
32615 #: ../src/guestfs.pod:819
32616 msgid "guestfish command line is hard to use."
32620 #: ../src/guestfs.pod:821
32622 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
32623 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
32624 "exist, so it fails. In earlier versions of guestfish the error message was "
32625 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
32626 "we should have used C<guestfish -c command> to run commands."
32630 #: ../src/guestfs.pod:828
32631 msgid "guestfish megabyte modifiers don't work right on all commands"
32635 #: ../src/guestfs.pod:830
32637 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
32638 "other modifiers). What guestfish actually does is to multiply the number "
32639 "part by the modifier part and pass the result to the C API. However this "
32640 "doesn't work for a few APIs which aren't expecting bytes, but are already "
32641 "expecting some other unit (eg. megabytes)."
32645 #: ../src/guestfs.pod:837
32646 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
32650 #: ../src/guestfs.pod:839
32653 " lvcreate LV VG 100M\n"
32658 #: ../src/guestfs.pod:841
32660 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
32661 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
32662 "megabytes * megabytes) logical volume. The error message you get from this "
32663 "is also a little obscure."
32667 #: ../src/guestfs.pod:846
32669 "This could be fixed in the generator by specially marking parameters and "
32670 "return values which take bytes or other units."
32674 #: ../src/guestfs.pod:849
32675 msgid "Ambiguity between devices and paths"
32679 #: ../src/guestfs.pod:851
32681 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
32682 "sdb2>) and a similar pathname. A file might just happen to be called "
32683 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
32687 #: ../src/guestfs.pod:856
32689 "In the current API we usually resolve this ambiguity by having two separate "
32690 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
32691 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
32692 "detecting if the path supplied begins with C</dev/>."
32696 #: ../src/guestfs.pod:862
32698 "To avoid both the ambiguity and the need to duplicate some calls, we could "
32699 "make paths/devices into structured names. One way to do this would be to "
32700 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
32701 "aspect of grub. Another way would be to use a structured type, equivalent "
32702 "to this OCaml type:"
32706 #: ../src/guestfs.pod:868
32709 " type path = Path of string | Device of int | Partition of int * int\n"
32714 #: ../src/guestfs.pod:870
32715 msgid "which would allow you to pass arguments like:"
32719 #: ../src/guestfs.pod:872
32722 " Path \"/foo/bar\"\n"
32723 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
32724 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
32725 " Path \"/dev/sdb2\" (* not a device *)\n"
32730 #: ../src/guestfs.pod:877
32732 "As you can see there are still problems to resolve even with this "
32733 "representation. Also consider how it might work in guestfish."
32737 #: ../src/guestfs.pod:882
32738 msgid "KEYS AND PASSPHRASES"
32742 #: ../src/guestfs.pod:884
32744 "Certain libguestfs calls take a parameter that contains sensitive key "
32745 "material, passed in as a C string."
32749 #: ../src/guestfs.pod:887
32751 "In the future we would hope to change the libguestfs implementation so that "
32752 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
32753 "swap. However this is I<not> done at the moment, because of the complexity "
32754 "of such an implementation."
32758 #: ../src/guestfs.pod:892
32760 "Therefore you should be aware that any key parameter you pass to libguestfs "
32761 "might end up being written out to the swap partition. If this is a concern, "
32762 "scrub the swap partition or don't use libguestfs on encrypted devices."
32766 #: ../src/guestfs.pod:897
32767 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
32771 #: ../src/guestfs.pod:899
32773 "All high-level libguestfs actions are synchronous. If you want to use "
32774 "libguestfs asynchronously then you must create a thread."
32778 #: ../src/guestfs.pod:902
32780 "Only use the handle from a single thread. Either use the handle exclusively "
32781 "from one thread, or provide your own mutex so that two threads cannot issue "
32782 "calls on the same handle at the same time."
32786 #: ../src/guestfs.pod:906
32788 "See the graphical program guestfs-browser for one possible architecture for "
32789 "multithreaded programs using libvirt and libguestfs."
32793 #: ../src/guestfs.pod:909
32798 #: ../src/guestfs.pod:911
32800 "Libguestfs needs a supermin appliance, which it finds by looking along an "
32805 #: ../src/guestfs.pod:914
32807 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
32808 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
32812 #: ../src/guestfs.pod:917
32814 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
32815 "to change the directories that libguestfs will search in. The value is a "
32816 "colon-separated list of paths. The current directory is I<not> searched "
32817 "unless the path contains an empty element or C<.>. For example "
32818 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
32819 "then C</usr/lib/guestfs>."
32823 #: ../src/guestfs.pod:924
32824 msgid "QEMU WRAPPERS"
32828 #: ../src/guestfs.pod:926
32830 "If you want to compile your own qemu, run qemu from a non-standard location, "
32831 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
32836 #: ../src/guestfs.pod:930
32838 "There is one important rule to remember: you I<must C<exec qemu>> as the "
32839 "last command in the shell script (so that qemu replaces the shell and "
32840 "becomes the direct child of the libguestfs-using program). If you don't do "
32841 "this, then the qemu process won't be cleaned up correctly."
32845 #: ../src/guestfs.pod:935
32847 "Here is an example of a wrapper, where I have built my own copy of qemu from "
32852 #: ../src/guestfs.pod:938
32856 " qemudir=/home/rjones/d/qemu\n"
32857 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
32862 #: ../src/guestfs.pod:942
32864 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
32865 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
32870 #: ../src/guestfs.pod:946
32873 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
32878 #: ../src/guestfs.pod:948
32880 "Note that libguestfs also calls qemu with the -help and -version options in "
32881 "order to determine features."
32885 #: ../src/guestfs.pod:951
32886 msgid "ATTACHING TO RUNNING DAEMONS"
32890 #: ../src/guestfs.pod:953
32892 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
32893 "babies. Use with caution."
32897 #: ../src/guestfs.pod:956
32899 "I<Note (2):> This section explains how to attach to a running daemon from a "
32900 "low level perspective. For most users, simply using virt tools such as "
32901 "L<guestfish(1)> with the I<--live> option will \"just work\"."
32905 #: ../src/guestfs.pod:960
32906 msgid "Using guestfs_set_attach_method"
32910 #: ../src/guestfs.pod:962
32912 "By calling L</guestfs_set_attach_method> you can change how the library "
32913 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
32914 "ARCHITECTURE> for some background)."
32918 #: ../src/guestfs.pod:966
32920 "The normal attach method is C<appliance>, where a small appliance is created "
32921 "containing the daemon, and then the library connects to this."
32925 #: ../src/guestfs.pod:969
32927 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
32928 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
32929 "daemon over the Unix domain socket."
32933 #: ../src/guestfs.pod:973
32935 "The normal use for this is to connect to a running virtual machine that "
32936 "contains a C<guestfsd> daemon, and send commands so you can read and write "
32937 "files inside the live virtual machine."
32941 #: ../src/guestfs.pod:977
32942 msgid "Using guestfs_add_domain with live flag"
32946 #: ../src/guestfs.pod:979
32948 "L</guestfs_add_domain> provides some help for getting the correct attach "
32949 "method. If you pass the C<live> option to this function, then (if the "
32950 "virtual machine is running) it will examine the libvirt XML looking for a "
32951 "virtio-serial channel to connect to:"
32955 #: ../src/guestfs.pod:985
32962 " <channel type='unix'>\n"
32963 " <source mode='bind' path='/path/to/socket'/>\n"
32964 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
32973 #: ../src/guestfs.pod:997
32975 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
32976 "method to C<unix:/path/to/socket>."
32980 #: ../src/guestfs.pod:1000
32982 "Some of the libguestfs tools (including guestfish) support a I<--live> "
32983 "option which is passed through to L</guestfs_add_domain> thus allowing you "
32984 "to attach to and modify live virtual machines."
32988 #: ../src/guestfs.pod:1004
32990 "The virtual machine needs to have been set up beforehand so that it has the "
32991 "virtio-serial channel and so that guestfsd is running inside it."
32995 #: ../src/guestfs.pod:1008
32996 msgid "ABI GUARANTEE"
33000 #: ../src/guestfs.pod:1010
33002 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
33003 "actions as outlined in this section. Although we will deprecate some "
33004 "actions, for example if they get replaced by newer calls, we will keep the "
33005 "old actions forever. This allows you the developer to program in confidence "
33006 "against the libguestfs API."
33010 #: ../src/guestfs.pod:1016
33011 msgid "BLOCK DEVICE NAMING"
33015 #: ../src/guestfs.pod:1018
33017 "In the kernel there is now quite a profusion of schemata for naming block "
33018 "devices (in this context, by I<block device> I mean a physical or virtual "
33019 "hard drive). The original Linux IDE driver used names starting with C</dev/"
33020 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
33021 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
33022 "for the old IDE driver (particularly for SATA devices) those devices also "
33023 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
33024 "paravirtualized drivers. This has created several different naming systems, "
33025 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
33029 #: ../src/guestfs.pod:1030
33031 "As discussed above, libguestfs uses a qemu appliance running an embedded "
33032 "Linux kernel to access block devices. We can run a variety of appliances "
33033 "based on a variety of Linux kernels."
33037 #: ../src/guestfs.pod:1034
33039 "This causes a problem for libguestfs because many API calls use device or "
33040 "partition names. Working scripts and the recipe (example) scripts that we "
33041 "make available over the internet could fail if the naming scheme changes."
33045 #: ../src/guestfs.pod:1039
33047 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
33048 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
33049 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
33050 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
33054 #: ../src/guestfs.pod:1045
33056 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
33057 "L</guestfs_list_partitions> and similar calls return the true names of the "
33058 "devices and partitions as known to the appliance."
33062 #: ../src/guestfs.pod:1050
33063 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
33067 #: ../src/guestfs.pod:1052
33069 "Usually this translation is transparent. However in some (very rare) cases "
33070 "you may need to know the exact algorithm. Such cases include where you use "
33071 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
33072 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
33076 #: ../src/guestfs.pod:1058
33078 "The algorithm is applied only to I<parameters> which are known to be either "
33079 "device or partition names. Return values from functions such as L</"
33080 "guestfs_list_devices> are never changed."
33084 #: ../src/guestfs.pod:1066
33085 msgid "Is the string a parameter which is a device or partition name?"
33089 #: ../src/guestfs.pod:1070
33090 msgid "Does the string begin with C</dev/sd>?"
33094 #: ../src/guestfs.pod:1074
33096 "Does the named device exist? If so, we use that device. However if I<not> "
33097 "then we continue with this algorithm."
33101 #: ../src/guestfs.pod:1079
33102 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
33106 #: ../src/guestfs.pod:1081
33107 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
33111 #: ../src/guestfs.pod:1083
33112 msgid "If that named device exists, use it. If not, continue."
33116 #: ../src/guestfs.pod:1087
33117 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
33121 #: ../src/guestfs.pod:1089
33122 msgid "If that named device exists, use it. If not, return an error."
33126 #: ../src/guestfs.pod:1093
33127 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
33131 #: ../src/guestfs.pod:1095
33133 "Although the standard naming scheme and automatic translation is useful for "
33134 "simple programs and guestfish scripts, for larger programs it is best not to "
33135 "rely on this mechanism."
33139 #: ../src/guestfs.pod:1099
33141 "Where possible for maximum future portability programs using libguestfs "
33142 "should use these future-proof techniques:"
33146 #: ../src/guestfs.pod:1106
33148 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
33149 "device names, and then use those names directly."
33153 #: ../src/guestfs.pod:1109
33155 "Since those device names exist by definition, they will never be translated."
33159 #: ../src/guestfs.pod:1114
33161 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
33162 "filesystem labels."
33166 #: ../src/guestfs.pod:1119
33171 #: ../src/guestfs.pod:1121
33173 "This section discusses security implications of using libguestfs, "
33174 "particularly with untrusted or malicious guests or disk images."
33178 #: ../src/guestfs.pod:1124
33179 msgid "GENERAL SECURITY CONSIDERATIONS"
33183 #: ../src/guestfs.pod:1126
33185 "Be careful with any files or data that you download from a guest (by "
33186 "\"download\" we mean not just the L</guestfs_download> command but any "
33187 "command that reads files, filenames, directories or anything else from a "
33188 "disk image). An attacker could manipulate the data to fool your program "
33189 "into doing the wrong thing. Consider cases such as:"
33193 #: ../src/guestfs.pod:1136
33194 msgid "the data (file etc) not being present"
33198 #: ../src/guestfs.pod:1140
33199 msgid "being present but empty"
33203 #: ../src/guestfs.pod:1144
33204 msgid "being much larger than normal"
33208 #: ../src/guestfs.pod:1148
33209 msgid "containing arbitrary 8 bit data"
33213 #: ../src/guestfs.pod:1152
33214 msgid "being in an unexpected character encoding"
33218 #: ../src/guestfs.pod:1156
33219 msgid "containing homoglyphs."
33223 #: ../src/guestfs.pod:1160
33224 msgid "SECURITY OF MOUNTING FILESYSTEMS"
33228 #: ../src/guestfs.pod:1162
33230 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
33231 "(VFS) module can sometimes be escalated into exploits by deliberately "
33232 "creating a malicious, malformed filesystem. These exploits are very severe "
33233 "for two reasons. Firstly there are very many filesystem drivers in the "
33234 "kernel, and many of them are infrequently used and not much developer "
33235 "attention has been paid to the code. Linux userspace helps potential "
33236 "crackers by detecting the filesystem type and automatically choosing the "
33237 "right VFS driver, even if that filesystem type is obscure or unexpected for "
33238 "the administrator. Secondly, a kernel-level exploit is like a local root "
33239 "exploit (worse in some ways), giving immediate and total access to the "
33240 "system right down to the hardware level."
33244 #: ../src/guestfs.pod:1175
33246 "That explains why you should never mount a filesystem from an untrusted "
33247 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
33248 "inside a qemu virtual machine, usually running as a non-root user. The "
33249 "attacker would need to write a filesystem which first exploited the kernel, "
33250 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
33251 "the libguestfs protocol, and finally to be as serious as the host kernel "
33252 "exploit it would need to escalate its privileges to root. This multi-step "
33253 "escalation, performed by a static piece of data, is thought to be extremely "
33254 "hard to do, although we never say 'never' about security issues."
33258 #: ../src/guestfs.pod:1186
33260 "In any case callers can reduce the attack surface by forcing the filesystem "
33261 "type when mounting (use L</guestfs_mount_vfs>)."
33265 #: ../src/guestfs.pod:1189
33266 msgid "PROTOCOL SECURITY"
33270 #: ../src/guestfs.pod:1191
33272 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
33273 "defined upper message size. However a program that uses libguestfs must "
33274 "also take care - for example you can write a program that downloads a binary "
33275 "from a disk image and executes it locally, and no amount of protocol "
33276 "security will save you from the consequences."
33280 #: ../src/guestfs.pod:1197
33281 msgid "INSPECTION SECURITY"
33285 #: ../src/guestfs.pod:1199
33287 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
33288 "directly from the guest, and these could contain any 8 bit data. Callers "
33289 "should be careful to escape these before printing them to a structured file "
33290 "(for example, use HTML escaping if creating a web page)."
33294 #: ../src/guestfs.pod:1205
33296 "Guest configuration may be altered in unusual ways by the administrator of "
33297 "the virtual machine, and may not reflect reality (particularly for untrusted "
33298 "or actively malicious guests). For example we parse the hostname from "
33299 "configuration files like C</etc/sysconfig/network> that we find in the "
33300 "guest, but the guest administrator can easily manipulate these files to "
33301 "provide the wrong hostname."
33305 #: ../src/guestfs.pod:1213
33307 "The inspection API parses guest configuration using two external libraries: "
33308 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
33309 "designed to be robust in the face of malicious data, although denial of "
33310 "service attacks are still possible, for example with oversized configuration "
33315 #: ../src/guestfs.pod:1219
33316 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
33320 #: ../src/guestfs.pod:1221
33322 "Be very cautious about running commands from the guest. By running a "
33323 "command in the guest, you are giving CPU time to a binary that you do not "
33324 "control, under the same user account as the library, albeit wrapped in qemu "
33325 "virtualization. More information and alternatives can be found in the "
33326 "section L</RUNNING COMMANDS>."
33330 #: ../src/guestfs.pod:1227
33331 msgid "CVE-2010-3851"
33335 #: ../src/guestfs.pod:1229
33336 msgid "https://bugzilla.redhat.com/642934"
33340 #: ../src/guestfs.pod:1231
33342 "This security bug concerns the automatic disk format detection that qemu "
33343 "does on disk images."
33347 #: ../src/guestfs.pod:1234
33349 "A raw disk image is just the raw bytes, there is no header. Other disk "
33350 "images like qcow2 contain a special header. Qemu deals with this by looking "
33351 "for one of the known headers, and if none is found then assuming the disk "
33352 "image must be raw."
33356 #: ../src/guestfs.pod:1239
33358 "This allows a guest which has been given a raw disk image to write some "
33359 "other header. At next boot (or when the disk image is accessed by "
33360 "libguestfs) qemu would do autodetection and think the disk image format was, "
33361 "say, qcow2 based on the header written by the guest."
33365 #: ../src/guestfs.pod:1244
33367 "This in itself would not be a problem, but qcow2 offers many features, one "
33368 "of which is to allow a disk image to refer to another image (called the "
33369 "\"backing disk\"). It does this by placing the path to the backing disk "
33370 "into the qcow2 header. This path is not validated and could point to any "
33371 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
33372 "\"holes\" in the qcow2 disk image, which of course is completely under the "
33373 "control of the attacker."
33377 #: ../src/guestfs.pod:1252
33379 "In libguestfs this is rather hard to exploit except under two circumstances:"
33383 #: ../src/guestfs.pod:1259
33384 msgid "You have enabled the network or have opened the disk in write mode."
33388 #: ../src/guestfs.pod:1263
33390 "You are also running untrusted code from the guest (see L</RUNNING "
33395 #: ../src/guestfs.pod:1268
33397 "The way to avoid this is to specify the expected disk format when adding "
33398 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
33399 "should always do this if the disk is raw format, and it's a good idea for "
33404 #: ../src/guestfs.pod:1273
33406 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
33407 "format is fetched from libvirt and passed through."
33411 #: ../src/guestfs.pod:1276
33413 "For libguestfs tools, use the I<--format> command line parameter as "
33418 #: ../src/guestfs.pod:1279
33419 msgid "CONNECTION MANAGEMENT"
33423 #: ../src/guestfs.pod:1281
33424 msgid "guestfs_h *"
33428 #: ../src/guestfs.pod:1283
33430 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
33431 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
33432 "handle and release all resources used."
33436 #: ../src/guestfs.pod:1287
33438 "For information on using multiple handles and threads, see the section L</"
33439 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
33443 #: ../src/guestfs.pod:1290
33444 msgid "guestfs_create"
33448 #: ../src/guestfs.pod:1292
33451 " guestfs_h *guestfs_create (void);\n"
33456 #: ../src/guestfs.pod:1294
33457 msgid "Create a connection handle."
33461 #: ../src/guestfs.pod:1296
33463 "On success this returns a non-NULL pointer to a handle. On error it returns "
33468 #: ../src/guestfs.pod:1299
33470 "You have to \"configure\" the handle after creating it. This includes "
33471 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
33472 "handle at least once."
33476 #: ../src/guestfs.pod:1303
33477 msgid "After configuring the handle, you have to call L</guestfs_launch>."
33481 #: ../src/guestfs.pod:1305
33483 "You may also want to configure error handling for the handle. See the L</"
33484 "ERROR HANDLING> section below."
33488 #: ../src/guestfs.pod:1308
33489 msgid "guestfs_close"
33493 #: ../src/guestfs.pod:1310
33496 " void guestfs_close (guestfs_h *g);\n"
33501 #: ../src/guestfs.pod:1312
33502 msgid "This closes the connection handle and frees up all resources used."
33506 #: ../src/guestfs.pod:1314
33508 "If autosync was set on the handle and the handle was launched, then this "
33509 "implicitly calls various functions to unmount filesystems and sync the "
33510 "disk. See L</guestfs_set_autosync> for more details."
33514 #: ../src/guestfs.pod:1318
33515 msgid "If a close callback was set on the handle, then it is called."
33519 #: ../src/guestfs.pod:1320
33520 msgid "ERROR HANDLING"
33524 #: ../src/guestfs.pod:1322
33526 "API functions can return errors. For example, almost all functions that "
33527 "return C<int> will return C<-1> to indicate an error."
33531 #: ../src/guestfs.pod:1325
33533 "Additional information is available for errors: an error message string and "
33534 "optionally an error number (errno) if the thing that failed was a system "
33539 #: ../src/guestfs.pod:1329
33541 "You can get at the additional information about the last error on the handle "
33542 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
33543 "up an error handler with L</guestfs_set_error_handler>."
33547 #: ../src/guestfs.pod:1334
33549 "When the handle is created, a default error handler is installed which "
33550 "prints the error message string to C<stderr>. For small short-running "
33551 "command line programs it is sufficient to do:"
33555 #: ../src/guestfs.pod:1338
33558 " if (guestfs_launch (g) == -1)\n"
33559 " exit (EXIT_FAILURE);\n"
33564 #: ../src/guestfs.pod:1341
33566 "since the default error handler will ensure that an error message has been "
33567 "printed to C<stderr> before the program exits."
33571 #: ../src/guestfs.pod:1344
33573 "For other programs the caller will almost certainly want to install an "
33574 "alternate error handler or do error handling in-line like this:"
33578 #: ../src/guestfs.pod:1347
33581 " /* This disables the default behaviour of printing errors\n"
33583 " guestfs_set_error_handler (g, NULL, NULL);\n"
33588 #: ../src/guestfs.pod:1351
33591 " if (guestfs_launch (g) == -1) {\n"
33592 " /* Examine the error message and print it etc. */\n"
33593 " char *msg = guestfs_last_error (g);\n"
33594 " int errnum = guestfs_last_errno (g);\n"
33595 " fprintf (stderr, \"%s\", msg);\n"
33596 " if (errnum != 0)\n"
33597 " fprintf (stderr, \": %s\", strerror (errnum));\n"
33598 " fprintf (stderr, \"\\n\");\n"
33605 #: ../src/guestfs.pod:1362
33607 "Out of memory errors are handled differently. The default action is to call "
33608 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
33609 "guestfs_set_out_of_memory_handler>."
33613 #: ../src/guestfs.pod:1366
33615 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
33616 "because there is no handle if this happens there is no way to get additional "
33617 "error information. However L</guestfs_create> is supposed to be a "
33618 "lightweight operation which can only fail because of insufficient memory (it "
33619 "returns NULL in this case)."
33623 #: ../src/guestfs.pod:1372
33624 msgid "guestfs_last_error"
33628 #: ../src/guestfs.pod:1374
33631 " const char *guestfs_last_error (guestfs_h *g);\n"
33636 #: ../src/guestfs.pod:1376
33638 "This returns the last error message that happened on C<g>. If there has not "
33639 "been an error since the handle was created, then this returns C<NULL>."
33643 #: ../src/guestfs.pod:1380
33645 "The lifetime of the returned string is until the next error occurs, or L</"
33646 "guestfs_close> is called."
33650 #: ../src/guestfs.pod:1383
33651 msgid "guestfs_last_errno"
33655 #: ../src/guestfs.pod:1385
33658 " int guestfs_last_errno (guestfs_h *g);\n"
33663 #: ../src/guestfs.pod:1387
33664 msgid "This returns the last error number (errno) that happened on C<g>."
33668 #: ../src/guestfs.pod:1389
33669 msgid "If successful, an errno integer not equal to zero is returned."
33673 #: ../src/guestfs.pod:1391
33675 "If no error, this returns 0. This call can return 0 in three situations:"
33679 #: ../src/guestfs.pod:1398
33680 msgid "There has not been any error on the handle."
33684 #: ../src/guestfs.pod:1402
33686 "There has been an error but the errno was meaningless. This corresponds to "
33687 "the case where the error did not come from a failed system call, but for "
33688 "some other reason."
33692 #: ../src/guestfs.pod:1408
33694 "There was an error from a failed system call, but for some reason the errno "
33695 "was not captured and returned. This usually indicates a bug in libguestfs."
33699 #: ../src/guestfs.pod:1414
33701 "Libguestfs tries to convert the errno from inside the applicance into a "
33702 "corresponding errno for the caller (not entirely trivial: the appliance "
33703 "might be running a completely different operating system from the library "
33704 "and error numbers are not standardized across Un*xen). If this could not be "
33705 "done, then the error is translated to C<EINVAL>. In practice this should "
33706 "only happen in very rare circumstances."
33710 #: ../src/guestfs.pod:1422
33711 msgid "guestfs_set_error_handler"
33715 #: ../src/guestfs.pod:1424
33718 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
33720 " const char *msg);\n"
33721 " void guestfs_set_error_handler (guestfs_h *g,\n"
33722 " guestfs_error_handler_cb cb,\n"
33723 " void *opaque);\n"
33728 #: ../src/guestfs.pod:1431
33730 "The callback C<cb> will be called if there is an error. The parameters "
33731 "passed to the callback are an opaque data pointer and the error message "
33736 #: ../src/guestfs.pod:1435
33738 "C<errno> is not passed to the callback. To get that the callback must call "
33739 "L</guestfs_last_errno>."
33743 #: ../src/guestfs.pod:1438
33745 "Note that the message string C<msg> is freed as soon as the callback "
33746 "function returns, so if you want to stash it somewhere you must make your "
33751 #: ../src/guestfs.pod:1442
33752 msgid "The default handler prints messages on C<stderr>."
33756 #: ../src/guestfs.pod:1444
33757 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
33761 #: ../src/guestfs.pod:1446
33762 msgid "guestfs_get_error_handler"
33766 #: ../src/guestfs.pod:1448
33769 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
33770 " void **opaque_rtn);\n"
33775 #: ../src/guestfs.pod:1451
33776 msgid "Returns the current error handler callback."
33780 #: ../src/guestfs.pod:1453
33781 msgid "guestfs_set_out_of_memory_handler"
33785 #: ../src/guestfs.pod:1455
33788 " typedef void (*guestfs_abort_cb) (void);\n"
33789 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
33790 " guestfs_abort_cb);\n"
33795 #: ../src/guestfs.pod:1459
33797 "The callback C<cb> will be called if there is an out of memory situation. "
33798 "I<Note this callback must not return>."
33802 #: ../src/guestfs.pod:1462
33803 msgid "The default is to call L<abort(3)>."
33807 #: ../src/guestfs.pod:1464
33809 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
33813 #: ../src/guestfs.pod:1467
33814 msgid "guestfs_get_out_of_memory_handler"
33818 #: ../src/guestfs.pod:1469
33821 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
33826 #: ../src/guestfs.pod:1471
33827 msgid "This returns the current out of memory handler."
33831 #: ../src/guestfs.pod:1473
33836 #: ../src/guestfs.pod:1477
33841 #: ../src/guestfs.pod:1479
33846 #: ../src/guestfs.pod:1481
33847 msgid "AVAILABILITY"
33851 #: ../src/guestfs.pod:1483
33852 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
33856 #: ../src/guestfs.pod:1485
33858 "Using L</guestfs_available> you can test availability of the following "
33859 "groups of functions. This test queries the appliance to see if the "
33860 "appliance you are currently using supports the functionality."
33864 #: ../src/guestfs.pod:1490
33865 msgid "@AVAILABILITY@"
33869 #: ../src/guestfs.pod:1492
33870 msgid "GUESTFISH supported COMMAND"
33874 #: ../src/guestfs.pod:1494
33876 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
33877 "prints out the available groups and whether they are supported by this build "
33878 "of libguestfs. Note however that you have to do C<run> first."
33882 #: ../src/guestfs.pod:1499
33883 msgid "SINGLE CALLS AT COMPILE TIME"
33887 #: ../src/guestfs.pod:1501
33889 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
33890 "function, such as:"
33894 #: ../src/guestfs.pod:1504
33897 " #define LIBGUESTFS_HAVE_DD 1\n"
33902 #: ../src/guestfs.pod:1506
33903 msgid "if L</guestfs_dd> is available."
33907 #: ../src/guestfs.pod:1508
33909 "Before version 1.5.8, if you needed to test whether a single libguestfs "
33910 "function is available at compile time, we recommended using build tools such "
33911 "as autoconf or cmake. For example in autotools you could use:"
33915 #: ../src/guestfs.pod:1513
33918 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
33919 " AC_CHECK_FUNCS([guestfs_dd])\n"
33924 #: ../src/guestfs.pod:1516
33926 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
33931 #: ../src/guestfs.pod:1519
33932 msgid "SINGLE CALLS AT RUN TIME"
33936 #: ../src/guestfs.pod:1521
33938 "Testing at compile time doesn't guarantee that a function really exists in "
33939 "the library. The reason is that you might be dynamically linked against a "
33940 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
33941 "This situation unfortunately results in a segmentation fault, which is a "
33942 "shortcoming of the C dynamic linking system itself."
33946 #: ../src/guestfs.pod:1528
33948 "You can use L<dlopen(3)> to test if a function is available at run time, as "
33949 "in this example program (note that you still need the compile time check as "
33954 #: ../src/guestfs.pod:1532
33957 " #include <stdio.h>\n"
33958 " #include <stdlib.h>\n"
33959 " #include <unistd.h>\n"
33960 " #include <dlfcn.h>\n"
33961 " #include <guestfs.h>\n"
33966 #: ../src/guestfs.pod:1538
33971 " #ifdef LIBGUESTFS_HAVE_DD\n"
33973 " int has_function;\n"
33978 #: ../src/guestfs.pod:1544
33981 " /* Test if the function guestfs_dd is really available. */\n"
33982 " dl = dlopen (NULL, RTLD_LAZY);\n"
33984 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
33985 " exit (EXIT_FAILURE);\n"
33987 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
33993 #: ../src/guestfs.pod:1553
33996 " if (!has_function)\n"
33997 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
33999 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
34000 " /* Now it's safe to call\n"
34001 " guestfs_dd (g, \"foo\", \"bar\");\n"
34005 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
34012 #: ../src/guestfs.pod:1566
34014 "You may think the above is an awful lot of hassle, and it is. There are "
34015 "other ways outside of the C linking system to ensure that this kind of "
34016 "incompatibility never arises, such as using package versioning:"
34020 #: ../src/guestfs.pod:1571
34023 " Requires: libguestfs >= 1.0.80\n"
34028 #: ../src/guestfs.pod:1573
34029 msgid "CALLS WITH OPTIONAL ARGUMENTS"
34033 #: ../src/guestfs.pod:1575
34035 "A recent feature of the API is the introduction of calls which take optional "
34036 "arguments. In C these are declared 3 ways. The main way is as a call which "
34037 "takes variable arguments (ie. C<...>), as in this example:"
34041 #: ../src/guestfs.pod:1580
34044 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
34049 #: ../src/guestfs.pod:1582
34051 "Call this with a list of optional arguments, terminated by C<-1>. So to "
34052 "call with no optional arguments specified:"
34056 #: ../src/guestfs.pod:1585
34059 " guestfs_add_drive_opts (g, filename, -1);\n"
34064 #: ../src/guestfs.pod:1587
34065 msgid "With a single optional argument:"
34069 #: ../src/guestfs.pod:1589
34072 " guestfs_add_drive_opts (g, filename,\n"
34073 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
34079 #: ../src/guestfs.pod:1593
34084 #: ../src/guestfs.pod:1595
34087 " guestfs_add_drive_opts (g, filename,\n"
34088 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
34089 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
34095 #: ../src/guestfs.pod:1600
34097 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
34102 #: ../src/guestfs.pod:1603
34103 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
34107 #: ../src/guestfs.pod:1605
34109 "The second variant has the same name with the suffix C<_va>, which works the "
34110 "same way but takes a C<va_list>. See the C manual for details. For the "
34111 "example function, this is declared:"
34115 #: ../src/guestfs.pod:1609
34118 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
34119 " va_list args);\n"
34124 #: ../src/guestfs.pod:1612
34125 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
34129 #: ../src/guestfs.pod:1614
34131 "The third variant is useful where you need to construct these calls. You "
34132 "pass in a structure where you fill in the optional fields. The structure "
34133 "has a bitmask as the first element which you must set to indicate which "
34134 "fields you have filled in. For our example function the structure and call "
34139 #: ../src/guestfs.pod:1620
34142 " struct guestfs_add_drive_opts_argv {\n"
34143 " uint64_t bitmask;\n"
34145 " const char *format;\n"
34148 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
34149 " const struct guestfs_add_drive_opts_argv *optargs);\n"
34154 #: ../src/guestfs.pod:1629
34155 msgid "You could call it like this:"
34159 #: ../src/guestfs.pod:1631
34162 " struct guestfs_add_drive_opts_argv optargs = {\n"
34163 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
34164 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
34165 " .readonly = 1,\n"
34166 " .format = \"qcow2\"\n"
34172 #: ../src/guestfs.pod:1638
34175 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
34180 #: ../src/guestfs.pod:1646
34181 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
34185 #: ../src/guestfs.pod:1651
34186 msgid "You do not need to fill in all fields of the structure."
34190 #: ../src/guestfs.pod:1655
34192 "There must be a one-to-one correspondence between fields of the structure "
34193 "that are filled in, and bits set in the bitmask."
34197 #: ../src/guestfs.pod:1660
34198 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
34202 #: ../src/guestfs.pod:1662
34204 "In other languages, optional arguments are expressed in the way that is "
34205 "natural for that language. We refer you to the language-specific "
34206 "documentation for more details on that."
34210 #: ../src/guestfs.pod:1666
34211 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
34215 #: ../src/guestfs.pod:1668
34216 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
34220 #: ../src/guestfs.pod:1670
34222 "B<Note:> This section documents the generic event mechanism introduced in "
34223 "libguestfs 1.10, which you should use in new code if possible. The old "
34224 "functions C<guestfs_set_log_message_callback>, "
34225 "C<guestfs_set_subprocess_quit_callback>, "
34226 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
34227 "C<guestfs_set_progress_callback> are no longer documented in this manual "
34228 "page. Because of the ABI guarantee, the old functions continue to work."
34232 #: ../src/guestfs.pod:1679
34234 "Handles generate events when certain things happen, such as log messages "
34235 "being generated, progress messages during long-running operations, or the "
34236 "handle being closed. The API calls described below let you register a "
34237 "callback to be called when events happen. You can register multiple "
34238 "callbacks (for the same, different or overlapping sets of events), and "
34239 "individually remove callbacks. If callbacks are not removed, then they "
34240 "remain in force until the handle is closed."
34244 #: ../src/guestfs.pod:1687
34246 "In the current implementation, events are only generated synchronously: that "
34247 "means that events (and hence callbacks) can only happen while you are in the "
34248 "middle of making another libguestfs call. The callback is called in the "
34253 #: ../src/guestfs.pod:1692
34255 "Events may contain a payload, usually nothing (void), an array of 64 bit "
34256 "unsigned integers, or a message buffer. Payloads are discussed later on."
34260 #: ../src/guestfs.pod:1696
34261 msgid "CLASSES OF EVENTS"
34265 #: ../src/guestfs.pod:1700
34266 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
34270 #: ../src/guestfs.pod:1703
34272 "The callback function will be called while the handle is being closed "
34273 "(synchronously from L</guestfs_close>)."
34277 #: ../src/guestfs.pod:1706
34279 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
34280 "handles that are open when the program exits. This means that this callback "
34281 "might be called indirectly from L<exit(3)>, which can cause unexpected "
34282 "problems in higher-level languages (eg. if your HLL interpreter has already "
34283 "been cleaned up by the time this is called, and if your callback then jumps "
34284 "into some HLL function)."
34288 #: ../src/guestfs.pod:1713
34290 "If no callback is registered: the handle is closed without any callback "
34295 #: ../src/guestfs.pod:1716
34296 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
34300 #: ../src/guestfs.pod:1719
34302 "The callback function will be called when the child process quits, either "
34303 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
34304 "corresponds to a transition from any state to the CONFIG state)."
34308 #: ../src/guestfs.pod:1723 ../src/guestfs.pod:1732 ../src/guestfs.pod:1849
34309 msgid "If no callback is registered: the event is ignored."
34313 #: ../src/guestfs.pod:1725
34314 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
34318 #: ../src/guestfs.pod:1728
34320 "The callback function will be called when the child process becomes ready "
34321 "first time after it has been launched. (This corresponds to a transition "
34322 "from LAUNCHING to the READY state)."
34326 #: ../src/guestfs.pod:1734
34327 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
34331 #: ../src/guestfs.pod:1737
34333 "Some long-running operations can generate progress messages. If this "
34334 "callback is registered, then it will be called each time a progress message "
34335 "is generated (usually two seconds after the operation started, and three "
34336 "times per second thereafter until it completes, although the frequency may "
34337 "change in future versions)."
34341 #: ../src/guestfs.pod:1743
34343 "The callback receives in the payload four unsigned 64 bit numbers which are "
34344 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
34348 #: ../src/guestfs.pod:1746
34350 "The units of C<total> are not defined, although for some operations C<total> "
34351 "may relate in some way to the amount of data to be transferred (eg. in bytes "
34352 "or megabytes), and C<position> may be the portion which has been transferred."
34356 #: ../src/guestfs.pod:1751
34357 msgid "The only defined and stable parts of the API are:"
34361 #: ../src/guestfs.pod:1757
34363 "The callback can display to the user some type of progress bar or indicator "
34364 "which shows the ratio of C<position>:C<total>."
34368 #: ../src/guestfs.pod:1762
34369 msgid "0 E<lt>= C<position> E<lt>= C<total>"
34373 #: ../src/guestfs.pod:1766
34375 "If any progress notification is sent during a call, then a final progress "
34376 "notification is always sent when C<position> = C<total> (I<unless> the call "
34377 "fails with an error)."
34381 #: ../src/guestfs.pod:1770
34383 "This is to simplify caller code, so callers can easily set the progress "
34384 "indicator to \"100%\" at the end of the operation, without requiring special "
34385 "code to detect this case."
34389 #: ../src/guestfs.pod:1776
34391 "For some calls we are unable to estimate the progress of the call, but we "
34392 "can still generate progress messages to indicate activity. This is known as "
34393 "\"pulse mode\", and is directly supported by certain progress bar "
34394 "implementations (eg. GtkProgressBar)."
34398 #: ../src/guestfs.pod:1781
34400 "For these calls, zero or more progress messages are generated with "
34401 "C<position = 0> and C<total = 1>, followed by a final message with "
34402 "C<position = total = 1>."
34406 #: ../src/guestfs.pod:1785
34408 "As noted above, if the call fails with an error then the final message may "
34409 "not be generated."
34413 #: ../src/guestfs.pod:1790
34415 "The callback also receives the procedure number (C<proc_nr>) and serial "
34416 "number (C<serial>) of the call. These are only useful for debugging "
34417 "protocol issues, and the callback can normally ignore them. The callback "
34418 "may want to print these numbers in error messages or debugging messages."
34422 #: ../src/guestfs.pod:1796
34423 msgid "If no callback is registered: progress messages are discarded."
34427 #: ../src/guestfs.pod:1798
34428 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
34432 #: ../src/guestfs.pod:1801
34434 "The callback function is called whenever a log message is generated by qemu, "
34435 "the appliance kernel, guestfsd (daemon), or utility programs."
34439 #: ../src/guestfs.pod:1804
34441 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
34442 "guestfs_launch>) then additional debug messages are generated."
34446 #: ../src/guestfs.pod:1807 ../src/guestfs.pod:1821
34448 "If no callback is registered: the messages are discarded unless the verbose "
34449 "flag is set in which case they are sent to stderr. You can override the "
34450 "printing of verbose messages to stderr by setting up a callback."
34454 #: ../src/guestfs.pod:1812
34455 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
34459 #: ../src/guestfs.pod:1815
34461 "The callback function is called whenever a log message is generated by the "
34462 "library part of libguestfs."
34466 #: ../src/guestfs.pod:1818
34468 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
34469 "messages are generated."
34473 #: ../src/guestfs.pod:1826
34474 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
34478 #: ../src/guestfs.pod:1829
34480 "The callback function is called whenever a trace message is generated. This "
34481 "only applies if the trace flag (L</guestfs_set_trace>) is set."
34485 #: ../src/guestfs.pod:1832
34487 "If no callback is registered: the messages are sent to stderr. You can "
34488 "override the printing of trace messages to stderr by setting up a callback."
34492 #: ../src/guestfs.pod:1836
34493 msgid "GUESTFS_EVENT_ENTER (payload type: function name)"
34497 #: ../src/guestfs.pod:1839
34499 "The callback function is called whenever a libguestfs function is entered."
34503 #: ../src/guestfs.pod:1842
34505 "The payload is a string which contains the name of the function that we are "
34506 "entering (not including C<guestfs_> prefix)."
34510 #: ../src/guestfs.pod:1845
34512 "Note that libguestfs functions can call themselves, so you may see many "
34513 "events from a single call. A few libguestfs functions do not generate this "
34518 #: ../src/guestfs.pod:1853
34519 msgid "guestfs_set_event_callback"
34523 #: ../src/guestfs.pod:1855
34526 " int guestfs_set_event_callback (guestfs_h *g,\n"
34527 " guestfs_event_callback cb,\n"
34528 " uint64_t event_bitmask,\n"
34530 " void *opaque);\n"
34535 #: ../src/guestfs.pod:1861
34537 "This function registers a callback (C<cb>) for all event classes in the "
34538 "C<event_bitmask>."
34542 #: ../src/guestfs.pod:1864
34544 "For example, to register for all log message events, you could call this "
34545 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
34546 "To register a single callback for all possible classes of events, use "
34547 "C<GUESTFS_EVENT_ALL>."
34551 #: ../src/guestfs.pod:1870
34552 msgid "C<flags> should always be passed as 0."
34556 #: ../src/guestfs.pod:1872
34558 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
34559 "it for any purpose."
34563 #: ../src/guestfs.pod:1875
34565 "The return value is the event handle (an integer) which you can use to "
34566 "delete the callback (see below)."
34570 #: ../src/guestfs.pod:1878
34572 "If there is an error, this function returns C<-1>, and sets the error in the "
34573 "handle in the usual way (see L</guestfs_last_error> etc.)"
34577 #: ../src/guestfs.pod:1881
34579 "Callbacks remain in effect until they are deleted, or until the handle is "
34584 #: ../src/guestfs.pod:1884
34586 "In the case where multiple callbacks are registered for a particular event "
34587 "class, all of the callbacks are called. The order in which multiple "
34588 "callbacks are called is not defined."
34592 #: ../src/guestfs.pod:1888
34593 msgid "guestfs_delete_event_callback"
34597 #: ../src/guestfs.pod:1890
34600 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
34605 #: ../src/guestfs.pod:1892
34607 "Delete a callback that was previously registered. C<event_handle> should be "
34608 "the integer that was returned by a previous call to "
34609 "C<guestfs_set_event_callback> on the same handle."
34613 #: ../src/guestfs.pod:1896
34614 msgid "guestfs_event_callback"
34618 #: ../src/guestfs.pod:1898
34621 " typedef void (*guestfs_event_callback) (\n"
34624 " uint64_t event,\n"
34625 " int event_handle,\n"
34627 " const char *buf, size_t buf_len,\n"
34628 " const uint64_t *array, size_t array_len);\n"
34633 #: ../src/guestfs.pod:1907
34635 "This is the type of the event callback function that you have to provide."
34639 #: ../src/guestfs.pod:1910
34641 "The basic parameters are: the handle (C<g>), the opaque user pointer "
34642 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
34643 "handle, and C<flags> which in the current API you should ignore."
34647 #: ../src/guestfs.pod:1914
34649 "The remaining parameters contain the event payload (if any). Each event may "
34650 "contain a payload, which usually relates to the event class, but for future "
34651 "proofing your code should be written to handle any payload for any event "
34656 #: ../src/guestfs.pod:1919
34658 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
34659 "there is no message buffer). Note that this message buffer can contain "
34660 "arbitrary 8 bit data, including NUL bytes."
34664 #: ../src/guestfs.pod:1923
34666 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
34667 "moment this is only used for progress messages."
34671 #: ../src/guestfs.pod:1926
34672 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
34676 #: ../src/guestfs.pod:1928
34678 "One motivation for the generic event API was to allow GUI programs to "
34679 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
34680 "unconditionally to C<stderr>."
34684 #: ../src/guestfs.pod:1932
34686 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
34687 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
34688 "messages are not events; you must capture error messages separately)."
34692 #: ../src/guestfs.pod:1937
34694 "Programs have to set up a callback to capture the classes of events of "
34699 #: ../src/guestfs.pod:1940
34703 " guestfs_set_event_callback\n"
34704 " (g, message_callback,\n"
34705 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
34706 " GUESTFS_EVENT_TRACE,\n"
34707 " 0, NULL) == -1)\n"
34708 " if (eh == -1) {\n"
34709 " // handle error in the usual way\n"
34715 #: ../src/guestfs.pod:1950
34717 "The callback can then direct messages to the appropriate place. In this "
34718 "example, messages are directed to syslog:"
34722 #: ../src/guestfs.pod:1953
34726 " message_callback (\n"
34729 " uint64_t event,\n"
34730 " int event_handle,\n"
34732 " const char *buf, size_t buf_len,\n"
34733 " const uint64_t *array, size_t array_len)\n"
34735 " const int priority = LOG_USER|LOG_INFO;\n"
34736 " if (buf_len > 0)\n"
34737 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
34743 #: ../src/guestfs.pod:1968
34744 msgid "CANCELLING LONG TRANSFERS"
34748 #: ../src/guestfs.pod:1970
34750 "Some operations can be cancelled by the caller while they are in progress. "
34751 "Currently only operations that involve uploading or downloading data can be "
34752 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
34753 "parameters in the generator)."
34757 #: ../src/guestfs.pod:1975
34758 msgid "guestfs_user_cancel"
34762 #: ../src/guestfs.pod:1977
34765 " void guestfs_user_cancel (guestfs_h *g);\n"
34770 #: ../src/guestfs.pod:1979
34772 "C<guestfs_user_cancel> cancels the current upload or download operation."
34776 #: ../src/guestfs.pod:1982
34778 "Unlike most other libguestfs calls, this function is signal safe and thread "
34779 "safe. You can call it from a signal handler or from another thread, without "
34780 "needing to do any locking."
34784 #: ../src/guestfs.pod:1986
34786 "The transfer that was in progress (if there is one) will stop shortly "
34787 "afterwards, and will return an error. The errno (see L</"
34788 "guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
34789 "out if the operation was cancelled or failed because of another error."
34793 #: ../src/guestfs.pod:1992
34795 "No cleanup is performed: for example, if a file was being uploaded then "
34796 "after cancellation there may be a partially uploaded file. It is the "
34797 "caller's responsibility to clean up if necessary."
34801 #: ../src/guestfs.pod:1996
34802 msgid "There are two common places that you might call C<guestfs_user_cancel>."
34806 #: ../src/guestfs.pod:1998
34808 "In an interactive text-based program, you might call it from a C<SIGINT> "
34809 "signal handler so that pressing C<^C> cancels the current operation. (You "
34810 "also need to call L</guestfs_set_pgroup> so that child processes don't "
34811 "receive the C<^C> signal)."
34815 #: ../src/guestfs.pod:2003
34817 "In a graphical program, when the main thread is displaying a progress bar "
34818 "with a cancel button, wire up the cancel button to call this function."
34822 #: ../src/guestfs.pod:2007
34823 msgid "PRIVATE DATA AREA"
34827 #: ../src/guestfs.pod:2009
34829 "You can attach named pieces of private data to the libguestfs handle, fetch "
34830 "them by name, and walk over them, for the lifetime of the handle. This is "
34831 "called the private data area and is only available from the C API."
34835 #: ../src/guestfs.pod:2014
34836 msgid "To attach a named piece of data, use the following call:"
34840 #: ../src/guestfs.pod:2016
34843 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
34848 #: ../src/guestfs.pod:2018
34850 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
34851 "pointer (which can be C<NULL>). Any previous item with the same key is "
34856 #: ../src/guestfs.pod:2022
34858 "You can use any C<key> you want, but your key should I<not> start with an "
34859 "underscore character. Keys beginning with an underscore character are "
34860 "reserved for internal libguestfs purposes (eg. for implementing language "
34861 "bindings). It is recommended that you prefix the key with some unique "
34862 "string to avoid collisions with other users."
34866 #: ../src/guestfs.pod:2028
34867 msgid "To retrieve the pointer, use:"
34871 #: ../src/guestfs.pod:2030
34874 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
34879 #: ../src/guestfs.pod:2032
34881 "This function returns C<NULL> if either no data is found associated with "
34882 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
34887 #: ../src/guestfs.pod:2036
34889 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
34890 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
34891 "all. In particular, libguestfs does I<not> try to free the data when the "
34892 "handle is closed. If the data must be freed, then the caller must either "
34893 "free it before calling L</guestfs_close> or must set up a close callback to "
34894 "do it (see L</GUESTFS_EVENT_CLOSE>)."
34898 #: ../src/guestfs.pod:2043
34899 msgid "To walk over all entries, use these two functions:"
34903 #: ../src/guestfs.pod:2045
34906 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
34911 #: ../src/guestfs.pod:2047
34914 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
34919 #: ../src/guestfs.pod:2049
34921 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
34922 "not have any particular meaning -- keys are not returned in any defined "
34923 "order). A pointer to the key is returned in C<*key_rtn> and the "
34924 "corresponding data pointer is returned from the function. C<NULL> is "
34925 "returned if there are no keys stored in the handle."
34929 #: ../src/guestfs.pod:2055
34931 "C<guestfs_next_private> returns the next key, pointer pair. The return "
34932 "value of this function is also C<NULL> is there are no further entries to "
34937 #: ../src/guestfs.pod:2059
34938 msgid "Notes about walking over entries:"
34942 #: ../src/guestfs.pod:2065
34944 "You must not call C<guestfs_set_private> while walking over the entries."
34948 #: ../src/guestfs.pod:2070
34950 "The handle maintains an internal iterator which is reset when you call "
34951 "C<guestfs_first_private>. This internal iterator is invalidated when you "
34952 "call C<guestfs_set_private>."
34956 #: ../src/guestfs.pod:2076
34957 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
34961 #: ../src/guestfs.pod:2078
34964 " guestfs_set_private (g, key, NULL);\n"
34969 #: ../src/guestfs.pod:2080
34970 msgid "then that C<key> is not returned when walking."
34974 #: ../src/guestfs.pod:2084
34976 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
34977 "C<guestfs_next_private> or C<guestfs_set_private>."
34981 #: ../src/guestfs.pod:2090
34983 "The following example code shows how to print all keys and data pointers "
34984 "that are associated with the handle C<g>:"
34988 #: ../src/guestfs.pod:2093
34991 " const char *key;\n"
34992 " void *data = guestfs_first_private (g, &key);\n"
34993 " while (data != NULL)\n"
34995 " printf (\"key = %s, data = %p\\n\", key, data);\n"
34996 " data = guestfs_next_private (g, &key);\n"
35002 #: ../src/guestfs.pod:2101
35004 "More commonly you are only interested in keys that begin with an application-"
35005 "specific prefix C<foo_>. Modify the loop like so:"
35009 #: ../src/guestfs.pod:2104
35012 " const char *key;\n"
35013 " void *data = guestfs_first_private (g, &key);\n"
35014 " while (data != NULL)\n"
35016 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
35017 " printf (\"key = %s, data = %p\\n\", key, data);\n"
35018 " data = guestfs_next_private (g, &key);\n"
35024 #: ../src/guestfs.pod:2113
35026 "If you need to modify keys while walking, then you have to jump back to the "
35027 "beginning of the loop. For example, to delete all keys prefixed with "
35032 #: ../src/guestfs.pod:2117
35035 " const char *key;\n"
35038 " data = guestfs_first_private (g, &key);\n"
35039 " while (data != NULL)\n"
35041 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
35043 " guestfs_set_private (g, key, NULL);\n"
35044 " /* note that 'key' pointer is now invalid, and so is\n"
35045 " the internal iterator */\n"
35048 " data = guestfs_next_private (g, &key);\n"
35054 #: ../src/guestfs.pod:2133
35056 "Note that the above loop is guaranteed to terminate because the keys are "
35057 "being deleted, but other manipulations of keys within the loop might not "
35058 "terminate unless you also maintain an indication of which keys have been "
35063 #: ../src/guestfs.pod:2138 ../src/guestfs.pod:2143
35068 #: ../src/guestfs.pod:2140
35070 "<!-- old anchor for the next section --> <a name="
35071 "\"state_machine_and_low_level_event_api\"/>"
35075 #: ../src/guestfs.pod:2145
35076 msgid "ARCHITECTURE"
35080 #: ../src/guestfs.pod:2147
35082 "Internally, libguestfs is implemented by running an appliance (a special "
35083 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
35084 "process of the main program."
35088 #: ../src/guestfs.pod:2151
35091 " ___________________\n"
35093 " | main program |\n"
35095 " | | child process / appliance\n"
35096 " | | __________________________\n"
35098 " +-------------------+ RPC | +-----------------+ |\n"
35099 " | libguestfs <--------------------> guestfsd | |\n"
35100 " | | | +-----------------+ |\n"
35101 " \\___________________/ | | Linux kernel | |\n"
35102 " | +--^--------------+ |\n"
35103 " \\_________|________________/\n"
35105 " _______v______\n"
35108 " | disk image |\n"
35109 " \\______________/\n"
35114 #: ../src/guestfs.pod:2171
35116 "The library, linked to the main program, creates the child process and hence "
35117 "the appliance in the L</guestfs_launch> function."
35121 #: ../src/guestfs.pod:2174
35123 "Inside the appliance is a Linux kernel and a complete stack of userspace "
35124 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
35125 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
35126 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
35127 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
35128 "attached to the qemu process which translates device access by the "
35129 "appliance's Linux kernel into accesses to the image."
35133 #: ../src/guestfs.pod:2183
35135 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
35136 "Although the disk image you are attached to might also be used by some "
35137 "virtual machine, libguestfs doesn't know or care about this. (But you will "
35138 "care if both libguestfs's qemu process and your virtual machine are trying "
35139 "to update the disk image at the same time, since these usually results in "
35140 "massive disk corruption)."
35144 #: ../src/guestfs.pod:2190
35145 msgid "STATE MACHINE"
35149 #: ../src/guestfs.pod:2192
35150 msgid "libguestfs uses a state machine to model the child process:"
35154 #: ../src/guestfs.pod:2194
35158 " guestfs_create\n"
35166 " / | \\ \\ guestfs_launch\n"
35167 " / | _\\__V______\n"
35169 " / | | LAUNCHING |\n"
35170 " / | \\___________/\n"
35172 " / | guestfs_launch\n"
35174 " ______ / __|____V\n"
35175 " / \\ ------> / \\\n"
35176 " | BUSY | | READY |\n"
35177 " \\______/ <------ \\________/\n"
35182 #: ../src/guestfs.pod:2216
35184 "The normal transitions are (1) CONFIG (when the handle is created, but there "
35185 "is no child process), (2) LAUNCHING (when the child process is booting up), "
35186 "(3) alternating between READY and BUSY as commands are issued to, and "
35187 "carried out by, the child process."
35191 #: ../src/guestfs.pod:2221
35193 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
35194 "asynchronously at any time (eg. due to some internal error), and that causes "
35195 "the state to transition back to CONFIG."
35199 #: ../src/guestfs.pod:2225
35201 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
35202 "issued when in the CONFIG state."
35206 #: ../src/guestfs.pod:2228
35208 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
35209 "L</guestfs_launch> blocks until the child process is READY to accept "
35210 "commands (or until some failure or timeout). L</guestfs_launch> internally "
35211 "moves the state from CONFIG to LAUNCHING while it is running."
35215 #: ../src/guestfs.pod:2234
35217 "API actions such as L</guestfs_mount> can only be issued when in the READY "
35218 "state. These API calls block waiting for the command to be carried out (ie. "
35219 "the state to transition to BUSY and then back to READY). There are no non-"
35220 "blocking versions, and no way to issue more than one command per handle at "
35225 #: ../src/guestfs.pod:2240
35227 "Finally, the child process sends asynchronous messages back to the main "
35228 "program, such as kernel log messages. You can register a callback to "
35229 "receive these messages."
35233 #: ../src/guestfs.pod:2244
35238 #: ../src/guestfs.pod:2246
35239 msgid "COMMUNICATION PROTOCOL"
35243 #: ../src/guestfs.pod:2248
35245 "Don't rely on using this protocol directly. This section documents how it "
35246 "currently works, but it may change at any time."
35250 #: ../src/guestfs.pod:2251
35252 "The protocol used to talk between the library and the daemon running inside "
35253 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
35254 "1014, RFC 1832, RFC 4506)."
35258 #: ../src/guestfs.pod:2255
35260 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
35261 "this file is automatically generated)."
35265 #: ../src/guestfs.pod:2258
35267 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
35268 "and C<FileOut> parameters, which are handled with very simple request/reply "
35269 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
35270 "parameters, which use the same request and reply messages, but they may also "
35271 "be followed by files sent using a chunked encoding."
35275 #: ../src/guestfs.pod:2265
35276 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
35280 #: ../src/guestfs.pod:2267
35281 msgid "For ordinary functions, the request message is:"
35285 #: ../src/guestfs.pod:2269
35288 " total length (header + arguments,\n"
35289 " but not including the length word itself)\n"
35290 " struct guestfs_message_header (encoded as XDR)\n"
35291 " struct guestfs_<foo>_args (encoded as XDR)\n"
35296 #: ../src/guestfs.pod:2274
35298 "The total length field allows the daemon to allocate a fixed size buffer "
35299 "into which it slurps the rest of the message. As a result, the total length "
35300 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
35301 "effective size of any request is limited to somewhere under this size."
35305 #: ../src/guestfs.pod:2280
35307 "Note also that many functions don't take any arguments, in which case the "
35308 "C<guestfs_I<foo>_args> is completely omitted."
35312 #: ../src/guestfs.pod:2283
35314 "The header contains the procedure number (C<guestfs_proc>) which is how the "
35315 "receiver knows what type of args structure to expect, or none at all."
35319 #: ../src/guestfs.pod:2287
35321 "For functions that take optional arguments, the optional arguments are "
35322 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
35323 "arguments. A bitmask in the header indicates which optional arguments are "
35324 "meaningful. The bitmask is also checked to see if it contains bits set "
35325 "which the daemon does not know about (eg. if more optional arguments were "
35326 "added in a later version of the library), and this causes the call to be "
35331 #: ../src/guestfs.pod:2295
35332 msgid "The reply message for ordinary functions is:"
35336 #: ../src/guestfs.pod:2297
35339 " total length (header + ret,\n"
35340 " but not including the length word itself)\n"
35341 " struct guestfs_message_header (encoded as XDR)\n"
35342 " struct guestfs_<foo>_ret (encoded as XDR)\n"
35347 #: ../src/guestfs.pod:2302
35349 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
35350 "functions that return no formal return values."
35354 #: ../src/guestfs.pod:2305
35356 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
35360 #: ../src/guestfs.pod:2308
35362 "In the case of an error, a flag is set in the header, and the reply message "
35363 "is slightly changed:"
35367 #: ../src/guestfs.pod:2311
35370 " total length (header + error,\n"
35371 " but not including the length word itself)\n"
35372 " struct guestfs_message_header (encoded as XDR)\n"
35373 " struct guestfs_message_error (encoded as XDR)\n"
35378 #: ../src/guestfs.pod:2316
35380 "The C<guestfs_message_error> structure contains the error message as a "
35385 #: ../src/guestfs.pod:2319
35386 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
35390 #: ../src/guestfs.pod:2321
35392 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
35393 "The normal request message is sent (see above). However this is followed by "
35394 "a sequence of file chunks."
35398 #: ../src/guestfs.pod:2325
35401 " total length (header + arguments,\n"
35402 " but not including the length word itself,\n"
35403 " and not including the chunks)\n"
35404 " struct guestfs_message_header (encoded as XDR)\n"
35405 " struct guestfs_<foo>_args (encoded as XDR)\n"
35406 " sequence of chunks for FileIn param #0\n"
35407 " sequence of chunks for FileIn param #1 etc.\n"
35412 #: ../src/guestfs.pod:2333
35413 msgid "The \"sequence of chunks\" is:"
35417 #: ../src/guestfs.pod:2335
35420 " length of chunk (not including length word itself)\n"
35421 " struct guestfs_chunk (encoded as XDR)\n"
35422 " length of chunk\n"
35423 " struct guestfs_chunk (encoded as XDR)\n"
35425 " length of chunk\n"
35426 " struct guestfs_chunk (with data.data_len == 0)\n"
35431 #: ../src/guestfs.pod:2343
35433 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
35434 "is set in the final chunk to indicate either successful completion or early "
35439 #: ../src/guestfs.pod:2347
35441 "At time of writing there are no functions that have more than one FileIn "
35442 "parameter. However this is (theoretically) supported, by sending the "
35443 "sequence of chunks for each FileIn parameter one after another (from left to "
35448 #: ../src/guestfs.pod:2352
35450 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
35451 "transfer. The library does this by sending a chunk with a special flag set "
35452 "to indicate cancellation. When the daemon sees this, it cancels the whole "
35453 "RPC, does I<not> send any reply, and goes back to reading the next request."
35457 #: ../src/guestfs.pod:2358
35459 "The daemon may also cancel. It does this by writing a special word "
35460 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
35461 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
35462 "cancel chunk). The special word is chosen so that even if cancellation "
35463 "happens right at the end of the transfer (after the library has finished "
35464 "writing and has started listening for the reply), the \"spurious\" cancel "
35465 "flag will not be confused with the reply message."
35469 #: ../src/guestfs.pod:2367
35471 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
35472 "limit), and also files where the size is not known in advance (eg. from "
35473 "pipes or sockets). However the chunks are rather small "
35474 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
35475 "to keep much in memory."
35479 #: ../src/guestfs.pod:2373
35480 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
35484 #: ../src/guestfs.pod:2375
35486 "The protocol for FileOut parameters is exactly the same as for FileIn "
35487 "parameters, but with the roles of daemon and library reversed."
35491 #: ../src/guestfs.pod:2378
35494 " total length (header + ret,\n"
35495 " but not including the length word itself,\n"
35496 " and not including the chunks)\n"
35497 " struct guestfs_message_header (encoded as XDR)\n"
35498 " struct guestfs_<foo>_ret (encoded as XDR)\n"
35499 " sequence of chunks for FileOut param #0\n"
35500 " sequence of chunks for FileOut param #1 etc.\n"
35505 #: ../src/guestfs.pod:2386
35506 msgid "INITIAL MESSAGE"
35510 #: ../src/guestfs.pod:2388
35512 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
35513 "which indicates that the guest and daemon is alive. This is what L</"
35514 "guestfs_launch> waits for."
35518 #: ../src/guestfs.pod:2392
35519 msgid "PROGRESS NOTIFICATION MESSAGES"
35523 #: ../src/guestfs.pod:2394
35525 "The daemon may send progress notification messages at any time. These are "
35526 "distinguished by the normal length word being replaced by "
35527 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
35531 #: ../src/guestfs.pod:2398
35533 "The library turns them into progress callbacks (see L</"
35534 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
35539 #: ../src/guestfs.pod:2402
35541 "The daemon self-limits the frequency of progress messages it sends (see "
35542 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
35547 #: ../src/guestfs.pod:2406
35548 msgid "LIBGUESTFS VERSION NUMBERS"
35552 #: ../src/guestfs.pod:2408
35554 "Since April 2010, libguestfs has started to make separate development and "
35555 "stable releases, along with corresponding branches in our git repository. "
35556 "These separate releases can be identified by version number:"
35560 #: ../src/guestfs.pod:2413
35563 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
35564 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
35570 " | `-------- sub-version\n"
35572 " `------ always '1' because we don't change the ABI\n"
35577 #: ../src/guestfs.pod:2424
35578 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
35582 #: ../src/guestfs.pod:2426
35584 "As time passes we cherry pick fixes from the development branch and backport "
35585 "those into the stable branch, the effect being that the stable branch should "
35586 "get more stable and less buggy over time. So the stable releases are ideal "
35587 "for people who don't need new features but would just like the software to "
35592 #: ../src/guestfs.pod:2432
35593 msgid "Our criteria for backporting changes are:"
35597 #: ../src/guestfs.pod:2438
35599 "Documentation changes which don't affect any code are backported unless the "
35600 "documentation refers to a future feature which is not in stable."
35604 #: ../src/guestfs.pod:2444
35606 "Bug fixes which are not controversial, fix obvious problems, and have been "
35607 "well tested are backported."
35611 #: ../src/guestfs.pod:2449
35613 "Simple rearrangements of code which shouldn't affect how it works get "
35614 "backported. This is so that the code in the two branches doesn't get too "
35615 "far out of step, allowing us to backport future fixes more easily."
35619 #: ../src/guestfs.pod:2455
35621 "We I<don't> backport new features, new APIs, new tools etc, except in one "
35622 "exceptional case: the new feature is required in order to implement an "
35623 "important bug fix."
35627 #: ../src/guestfs.pod:2461
35629 "A new stable branch starts when we think the new features in development are "
35630 "substantial and compelling enough over the current stable branch to warrant "
35631 "it. When that happens we create new stable and development versions 1.N.0 "
35632 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
35633 "stable at this point, but by backporting fixes from development, that branch "
35634 "will stabilize over time."
35638 #: ../src/guestfs.pod:2469
35639 msgid "EXTENDING LIBGUESTFS"
35643 #: ../src/guestfs.pod:2471
35644 msgid "ADDING A NEW API ACTION"
35648 #: ../src/guestfs.pod:2473
35650 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
35651 "documentation) are generated, and this makes it easy to extend the "
35656 #: ../src/guestfs.pod:2477
35657 msgid "To add a new API action there are two changes:"
35661 #: ../src/guestfs.pod:2483
35663 "You need to add a description of the call (name, parameters, return type, "
35664 "tests, documentation) to C<generator/generator_actions.ml>."
35668 #: ../src/guestfs.pod:2486
35670 "There are two sorts of API action, depending on whether the call goes "
35671 "through to the daemon in the appliance, or is serviced entirely by the "
35672 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
35673 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
35674 "an example of the latter, since a trace flag is maintained in the handle and "
35675 "all tracing is done on the library side."
35679 #: ../src/guestfs.pod:2494
35681 "Most new actions are of the first type, and get added to the "
35682 "C<daemon_functions> list. Each function has a unique procedure number used "
35683 "in the RPC protocol which is assigned to that action when we publish "
35684 "libguestfs and cannot be reused. Take the latest procedure number and "
35689 #: ../src/guestfs.pod:2500
35691 "For library-only actions of the second type, add to the "
35692 "C<non_daemon_functions> list. Since these functions are serviced by the "
35693 "library and do not travel over the RPC mechanism to the daemon, these "
35694 "functions do not need a procedure number, and so the procedure number is set "
35699 #: ../src/guestfs.pod:2508
35700 msgid "Implement the action (in C):"
35704 #: ../src/guestfs.pod:2510
35706 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
35707 "C<daemon/> directory."
35711 #: ../src/guestfs.pod:2513
35713 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
35714 "(note: double underscore) in the C<src/> directory."
35718 #: ../src/guestfs.pod:2516
35719 msgid "In either case, use another function as an example of what to do."
35723 #: ../src/guestfs.pod:2520
35724 msgid "After making these changes, use C<make> to compile."
35728 #: ../src/guestfs.pod:2522
35730 "Note that you don't need to implement the RPC, language bindings, manual "
35731 "pages or anything else. It's all automatically generated from the OCaml "
35736 #: ../src/guestfs.pod:2526
35737 msgid "ADDING TESTS FOR AN API ACTION"
35741 #: ../src/guestfs.pod:2528
35743 "You can supply zero or as many tests as you want per API call. The tests "
35744 "can either be added as part of the API description (C<generator/"
35745 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
35746 "into C<regressions/>. Note that adding a script to C<regressions/> is "
35747 "slower, so if possible use the first method."
35751 #: ../src/guestfs.pod:2534
35753 "The following describes the test environment used when you add an API test "
35754 "in C<generator_actions.ml>."
35758 #: ../src/guestfs.pod:2537
35759 msgid "The test environment has 4 block devices:"
35763 #: ../src/guestfs.pod:2541
35764 msgid "C</dev/sda> 500MB"
35768 #: ../src/guestfs.pod:2543
35769 msgid "General block device for testing."
35773 #: ../src/guestfs.pod:2545
35774 msgid "C</dev/sdb> 50MB"
35778 #: ../src/guestfs.pod:2547
35780 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
35785 #: ../src/guestfs.pod:2550
35786 msgid "C</dev/sdc> 10MB"
35790 #: ../src/guestfs.pod:2552
35791 msgid "Used in a few tests where two block devices are needed."
35795 #: ../src/guestfs.pod:2554
35796 msgid "C</dev/sdd>"
35800 #: ../src/guestfs.pod:2556
35801 msgid "ISO with fixed content (see C<images/test.iso>)."
35805 #: ../src/guestfs.pod:2560
35807 "To be able to run the tests in a reasonable amount of time, the libguestfs "
35808 "appliance and block devices are reused between tests. So don't try testing "
35809 "L</guestfs_kill_subprocess> :-x"
35813 #: ../src/guestfs.pod:2564
35815 "Each test starts with an initial scenario, selected using one of the "
35816 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
35817 "initialize the disks mentioned above in a particular way as documented in "
35818 "C<generator_types.ml>. You should not assume anything about the previous "
35819 "contents of other disks that are not initialized."
35823 #: ../src/guestfs.pod:2570
35825 "You can add a prerequisite clause to any individual test. This is a run-"
35826 "time check, which, if it fails, causes the test to be skipped. Useful if "
35827 "testing a command which might not work on all variations of libguestfs "
35828 "builds. A test that has prerequisite of C<Always> means to run "
35833 #: ../src/guestfs.pod:2576
35835 "In addition, packagers can skip individual tests by setting environment "
35836 "variables before running C<make check>."
35840 #: ../src/guestfs.pod:2579
35843 " SKIP_TEST_<CMD>_<NUM>=1\n"
35848 #: ../src/guestfs.pod:2581
35849 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
35853 #: ../src/guestfs.pod:2583
35858 #: ../src/guestfs.pod:2585
35861 " SKIP_TEST_<CMD>=1\n"
35866 #: ../src/guestfs.pod:2587
35867 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
35871 #: ../src/guestfs.pod:2589
35872 msgid "Packagers can run only certain tests by setting for example:"
35876 #: ../src/guestfs.pod:2591
35879 " TEST_ONLY=\"vfs_type zerofree\"\n"
35884 #: ../src/guestfs.pod:2593
35886 "See C<capitests/tests.c> for more details of how these environment variables "
35891 #: ../src/guestfs.pod:2596
35892 msgid "DEBUGGING NEW API ACTIONS"
35896 #: ../src/guestfs.pod:2598
35897 msgid "Test new actions work before submitting them."
35901 #: ../src/guestfs.pod:2600
35902 msgid "You can use guestfish to try out new commands."
35906 #: ../src/guestfs.pod:2602
35908 "Debugging the daemon is a problem because it runs inside a minimal "
35909 "environment. However you can fprintf messages in the daemon to stderr, and "
35910 "they will show up if you use C<guestfish -v>."
35914 #: ../src/guestfs.pod:2606
35915 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
35919 #: ../src/guestfs.pod:2608
35921 "Our C source code generally adheres to some basic code-formatting "
35922 "conventions. The existing code base is not totally consistent on this "
35923 "front, but we do prefer that contributed code be formatted similarly. In "
35924 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
35925 "indentation level, and other than that, follow the K&R style."
35929 #: ../src/guestfs.pod:2614
35931 "If you use Emacs, add the following to one of one of your start-up files (e."
35932 "g., ~/.emacs), to help ensure that you get indentation right:"
35936 #: ../src/guestfs.pod:2617
35939 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
35940 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
35941 " (add-hook 'find-file-hook\n"
35942 " '(lambda () (if (and buffer-file-name\n"
35943 " (string-match \"/libguestfs\\\\>\"\n"
35944 " (buffer-file-name))\n"
35945 " (not (string-equal mode-name \"Change Log\"))\n"
35946 " (not (string-equal mode-name \"Makefile\")))\n"
35947 " (setq indent-tabs-mode nil))))\n"
35952 #: ../src/guestfs.pod:2627
35955 " ;;; When editing C sources in libguestfs, use this style.\n"
35956 " (defun libguestfs-c-mode ()\n"
35957 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
35959 " (c-set-style \"K&R\")\n"
35960 " (setq c-indent-level 2)\n"
35961 " (setq c-basic-offset 2))\n"
35962 " (add-hook 'c-mode-hook\n"
35963 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
35964 " (buffer-file-name))\n"
35965 " (libguestfs-c-mode))))\n"
35970 #: ../src/guestfs.pod:2639
35971 msgid "Enable warnings when compiling (and fix any problems this finds):"
35975 #: ../src/guestfs.pod:2642
35978 " ./configure --enable-gcc-warnings\n"
35983 #: ../src/guestfs.pod:2644
35984 msgid "Useful targets are:"
35988 #: ../src/guestfs.pod:2646
35991 " make syntax-check # checks the syntax of the C code\n"
35992 " make check # runs the test suite\n"
35997 #: ../src/guestfs.pod:2649
35998 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
36002 #: ../src/guestfs.pod:2651
36004 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
36005 "which are used to do shell quoting."
36009 #: ../src/guestfs.pod:2656
36014 #: ../src/guestfs.pod:2658
36016 "Simple shell quoted string. Any spaces or other shell characters are "
36021 #: ../src/guestfs.pod:2661
36026 #: ../src/guestfs.pod:2663
36028 "Same as C<%Q> except the string is treated as a path which is prefixed by "
36033 #: ../src/guestfs.pod:2670
36036 " asprintf (&cmd, \"cat %R\", path);\n"
36041 #: ../src/guestfs.pod:2672
36042 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
36046 #: ../src/guestfs.pod:2674
36048 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
36049 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
36050 "they are not passed via the shell (instead, straight to exec). You probably "
36051 "want to use the C<sysroot_path()> function however."
36055 #: ../src/guestfs.pod:2680
36056 msgid "SUBMITTING YOUR NEW API ACTIONS"
36060 #: ../src/guestfs.pod:2682
36062 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
36063 "libguestfs> and CC to L<rjones@redhat.com>."
36067 #: ../src/guestfs.pod:2686
36068 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
36072 #: ../src/guestfs.pod:2688
36073 msgid "We support i18n (gettext anyhow) in the library."
36077 #: ../src/guestfs.pod:2690
36079 "However many messages come from the daemon, and we don't translate those at "
36080 "the moment. One reason is that the appliance generally has all locale files "
36081 "removed from it, because they take up a lot of space. So we'd have to readd "
36082 "some of those, as well as copying our PO files into the appliance."
36086 #: ../src/guestfs.pod:2696
36088 "Debugging messages are never translated, since they are intended for the "
36093 #: ../src/guestfs.pod:2699
36094 msgid "SOURCE CODE SUBDIRECTORIES"
36098 #: ../src/guestfs.pod:2705
36099 msgid "The libguestfs appliance, build scripts and so on."
36103 #: ../src/guestfs.pod:2707
36104 msgid "C<capitests>"
36108 #: ../src/guestfs.pod:2709
36109 msgid "Automated tests of the C API."
36113 #: ../src/guestfs.pod:2711
36118 #: ../src/guestfs.pod:2713
36120 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
36125 #: ../src/guestfs.pod:2716
36130 #: ../src/guestfs.pod:2718
36132 "Safety and liveness tests of components that libguestfs depends upon (not of "
36133 "libguestfs itself). Mainly this is for qemu and the kernel."
36137 #: ../src/guestfs.pod:2721
36142 #: ../src/guestfs.pod:2723
36143 msgid "Outside contributions, experimental parts."
36147 #: ../src/guestfs.pod:2725
36152 #: ../src/guestfs.pod:2727
36154 "The daemon that runs inside the libguestfs appliance and carries out actions."
36158 #: ../src/guestfs.pod:2730
36163 #: ../src/guestfs.pod:2732
36164 msgid "L<virt-df(1)> command and documentation."
36168 #: ../src/guestfs.pod:2734
36173 #: ../src/guestfs.pod:2736
36174 msgid "L<virt-edit(1)> command and documentation."
36178 #: ../src/guestfs.pod:2738
36179 msgid "C<examples>"
36183 #: ../src/guestfs.pod:2740
36184 msgid "C API example code."
36188 #: ../src/guestfs.pod:2742
36193 #: ../src/guestfs.pod:2744
36195 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
36196 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
36197 "L<virt-tar-out(1)>."
36201 #: ../src/guestfs.pod:2748
36206 #: ../src/guestfs.pod:2750
36208 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
36212 #: ../src/guestfs.pod:2752
36213 msgid "C<generator>"
36217 #: ../src/guestfs.pod:2754
36219 "The crucially important generator, used to automatically generate large "
36220 "amounts of boilerplate C code for things like RPC and bindings."
36224 #: ../src/guestfs.pod:2757
36229 #: ../src/guestfs.pod:2759
36230 msgid "Files used by the test suite."
36234 #: ../src/guestfs.pod:2761
36235 msgid "Some \"phony\" guest images which we test against."
36239 #: ../src/guestfs.pod:2763
36240 msgid "C<inspector>"
36244 #: ../src/guestfs.pod:2765
36245 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
36249 #: ../src/guestfs.pod:2767
36254 #: ../src/guestfs.pod:2769
36255 msgid "Logo used on the website. The fish is called Arthur by the way."
36259 #: ../src/guestfs.pod:2771
36264 #: ../src/guestfs.pod:2773
36265 msgid "M4 macros used by autoconf."
36269 #: ../src/guestfs.pod:2775
36274 #: ../src/guestfs.pod:2777
36275 msgid "Translations of simple gettext strings."
36279 #: ../src/guestfs.pod:2779
36284 #: ../src/guestfs.pod:2781
36286 "The build infrastructure and PO files for translations of manpages and POD "
36287 "files. Eventually this will be combined with the C<po> directory, but that "
36288 "is rather complicated."
36292 #: ../src/guestfs.pod:2785
36293 msgid "C<regressions>"
36297 #: ../src/guestfs.pod:2787
36298 msgid "Regression tests."
36302 #: ../src/guestfs.pod:2789
36307 #: ../src/guestfs.pod:2791
36308 msgid "L<virt-rescue(1)> command and documentation."
36312 #: ../src/guestfs.pod:2793
36317 #: ../src/guestfs.pod:2795
36318 msgid "Source code to the C library."
36322 #: ../src/guestfs.pod:2797
36327 #: ../src/guestfs.pod:2799
36328 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
36332 #: ../src/guestfs.pod:2801
36333 msgid "C<test-tool>"
36337 #: ../src/guestfs.pod:2803
36339 "Test tool for end users to test if their qemu/kernel combination will work "
36344 #: ../src/guestfs.pod:2806
36349 #: ../src/guestfs.pod:2808
36354 #: ../src/guestfs.pod:2810
36359 #: ../src/guestfs.pod:2812
36364 #: ../src/guestfs.pod:2814
36369 #: ../src/guestfs.pod:2816
36374 #: ../src/guestfs.pod:2818
36379 #: ../src/guestfs.pod:2820
36384 #: ../src/guestfs.pod:2822
36385 msgid "Language bindings."
36389 #: ../src/guestfs.pod:2826
36390 msgid "MAKING A STABLE RELEASE"
36394 #: ../src/guestfs.pod:2828
36396 "When we make a stable release, there are several steps documented here. See "
36397 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
36402 #: ../src/guestfs.pod:2836
36404 "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
36408 #: ../src/guestfs.pod:2841
36409 msgid "Finalize RELEASE-NOTES."
36413 #: ../src/guestfs.pod:2845
36414 msgid "Update ROADMAP."
36418 #: ../src/guestfs.pod:2849
36419 msgid "Run C<src/api-support/update-from-tarballs.sh>."
36423 #: ../src/guestfs.pod:2853
36424 msgid "Push and pull from Transifex."
36428 #: ../src/guestfs.pod:2855
36433 #: ../src/guestfs.pod:2857
36441 #: ../src/guestfs.pod:2859
36442 msgid "to push the latest POT files to Transifex. Then run:"
36446 #: ../src/guestfs.pod:2861
36454 #: ../src/guestfs.pod:2863
36455 msgid "which is a wrapper to pull the latest translated C<*.po> files."
36459 #: ../src/guestfs.pod:2867
36461 "Create new stable and development directories under L<http://libguestfs.org/"
36466 #: ../src/guestfs.pod:2872
36467 msgid "Create the branch in git:"
36471 #: ../src/guestfs.pod:2874
36474 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
36475 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
36476 " git branch stable-1.XX\n"
36477 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
36482 #: ../src/guestfs.pod:2881
36487 #: ../src/guestfs.pod:2883
36488 msgid "PROTOCOL LIMITS"
36492 #: ../src/guestfs.pod:2885
36494 "Internally libguestfs uses a message-based protocol to pass API calls and "
36495 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
36496 "plenty more detail about this). The maximum message size used by the "
36497 "protocol is slightly less than 4 MB. For some API calls you may need to be "
36498 "aware of this limit. The API calls which may be affected are individually "
36499 "documented, with a link back to this section of the documentation."
36503 #: ../src/guestfs.pod:2893
36505 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
36506 "a simple string. Because this string is at some point internally encoded as "
36507 "a message, the maximum size that it can return is slightly under 4 MB. If "
36508 "the requested file is larger than this then you will get an error."
36512 #: ../src/guestfs.pod:2899
36514 "In order to transfer large files into and out of the guest filesystem, you "
36515 "need to use particular calls that support this. The sections L</UPLOADING> "
36516 "and L</DOWNLOADING> document how to do this."
36520 #: ../src/guestfs.pod:2903
36522 "You might also consider mounting the disk image using our FUSE filesystem "
36523 "support (L<guestmount(1)>)."
36527 #: ../src/guestfs.pod:2906
36528 msgid "MAXIMUM NUMBER OF DISKS"
36532 #: ../src/guestfs.pod:2908
36533 msgid "When using virtio disks (the default) the current limit is B<25> disks."
36537 #: ../src/guestfs.pod:2911
36539 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
36540 "slots. However febootstrap only understands disks with names C</dev/vda> "
36541 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
36546 #: ../src/guestfs.pod:2916
36548 "We are working to substantially raise this limit in future versions but it "
36549 "requires complex changes to qemu."
36553 #: ../src/guestfs.pod:2919
36555 "In future versions of libguestfs it should also be possible to \"hot plug\" "
36556 "disks (add and remove disks after calling L</guestfs_launch>). This also "
36557 "requires changes to qemu."
36561 #: ../src/guestfs.pod:2923
36562 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
36566 #: ../src/guestfs.pod:2925
36567 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
36571 #: ../src/guestfs.pod:2927
36573 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
36574 "vda>, and C</dev/vda1> through C</dev/vda15>)."
36578 #: ../src/guestfs.pod:2930
36580 "If you attach a disk with more than 15 partitions, the extra partitions are "
36581 "ignored by libguestfs."
36585 #: ../src/guestfs.pod:2933
36586 msgid "MAXIMUM SIZE OF A DISK"
36590 #: ../src/guestfs.pod:2935
36591 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
36595 #: ../src/guestfs.pod:2937
36597 "We have tested block devices up to 1 exabyte (2**60 or "
36598 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
36603 #: ../src/guestfs.pod:2941
36605 "Although libguestfs probably does not impose any limit, the underlying host "
36606 "storage will. If you store disk images on a host ext4 filesystem, then the "
36607 "maximum size will be limited by the maximum ext4 file size (currently 16 "
36608 "TB). If you store disk images as host logical volumes then you are limited "
36609 "by the maximum size of an LV."
36613 #: ../src/guestfs.pod:2947
36615 "For the hugest disk image files, we recommend using XFS on the host for "
36620 #: ../src/guestfs.pod:2950
36621 msgid "MAXIMUM SIZE OF A PARTITION"
36625 #: ../src/guestfs.pod:2952
36627 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
36628 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
36629 "address a partition located beyond 2 TB on the disk."
36633 #: ../src/guestfs.pod:2956
36635 "It is recommended that you use GPT partitions on disks which are larger than "
36636 "this size. GPT uses 64 bit sector numbers and so can address partitions "
36637 "which are theoretically larger than the largest disk we could support."
36641 #: ../src/guestfs.pod:2961
36642 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
36646 #: ../src/guestfs.pod:2963
36648 "This depends on the filesystem type. libguestfs itself does not impose any "
36649 "known limit. Consult Wikipedia or the filesystem documentation to find out "
36650 "what these limits are."
36654 #: ../src/guestfs.pod:2967
36655 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
36659 #: ../src/guestfs.pod:2969
36661 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
36662 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
36663 "uploads and downloads."
36667 #: ../src/guestfs.pod:2973
36668 msgid "INSPECTION LIMITS"
36672 #: ../src/guestfs.pod:2975
36674 "The inspection code has several arbitrary limits on things like the size of "
36675 "Windows Registry hive it will read, and the length of product name. These "
36676 "are intended to stop a malicious guest from consuming arbitrary amounts of "
36677 "memory and disk space on the host, and should not be reached in practice. "
36678 "See the source code for more information."
36682 #: ../src/guestfs.pod:3001
36684 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
36685 "effect as calling C<guestfs_set_verbose (g, 1)>."
36689 #: ../src/guestfs.pod:3013
36691 "Set the path that libguestfs uses to search for a supermin appliance. See "
36692 "the discussion of paths in section L</PATH> above."
36696 #: ../src/guestfs.pod:3022
36697 msgid "See also L</QEMU WRAPPERS> above."
36701 #: ../src/guestfs.pod:3026
36703 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
36704 "effect as calling C<guestfs_set_trace (g, 1)>."
36708 #: ../src/guestfs.pod:3044
36710 "L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-"
36711 "perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, L<guestfish(1)>, "
36712 "L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
36713 "L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)"
36714 ">, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
36715 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
36716 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
36717 "L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<http://libguestfs.org/>."
36721 #: ../src/guestfs.pod:3074
36723 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
36724 "(8)>, L<disktype(1)>."
36728 #: ../src/guestfs.pod:3081 ../tools/virt-make-fs.pl:553
36729 #: ../tools/virt-win-reg.pl:761
36734 #: ../src/guestfs.pod:3083
36735 msgid "To get a list of bugs against libguestfs use this link:"
36739 #: ../src/guestfs.pod:3085
36741 "L<https://bugzilla.redhat.com/buglist.cgi?"
36742 "component=libguestfs&product=Virtualization+Tools>"
36746 #: ../src/guestfs.pod:3087
36747 msgid "To report a new bug against libguestfs use this link:"
36751 #: ../src/guestfs.pod:3089
36753 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
36754 "component=libguestfs&product=Virtualization+Tools>"
36758 #: ../src/guestfs.pod:3091
36759 msgid "When reporting a bug, please check:"
36763 #: ../src/guestfs.pod:3097
36764 msgid "That the bug hasn't been reported already."
36768 #: ../src/guestfs.pod:3101
36769 msgid "That you are testing a recent version."
36773 #: ../src/guestfs.pod:3105
36774 msgid "Describe the bug accurately, and give a way to reproduce it."
36778 #: ../src/guestfs.pod:3109
36780 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
36785 #: ../test-tool/libguestfs-test-tool.pod:5
36786 msgid "libguestfs-test-tool - End user tests for libguestfs"
36790 #: ../test-tool/libguestfs-test-tool.pod:9
36793 " libguestfs-test-tool [--options]\n"
36798 #: ../test-tool/libguestfs-test-tool.pod:13
36800 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
36801 "and developers, to allow them to check basic libguestfs functionality is "
36802 "working. This is needed because libguestfs occasionally breaks for reasons "
36803 "beyond our control: usually because of changes in the underlying qemu or "
36804 "kernel packages, or the host environment."
36808 #: ../test-tool/libguestfs-test-tool.pod:20
36809 msgid "If you suspect a problem in libguestfs, then just run:"
36813 #: ../test-tool/libguestfs-test-tool.pod:22
36816 " libguestfs-test-tool\n"
36821 #: ../test-tool/libguestfs-test-tool.pod:24
36822 msgid "It will print lots of diagnostic messages."
36826 #: ../test-tool/libguestfs-test-tool.pod:26
36827 msgid "If it runs to completion successfully, you will see this near the end:"
36831 #: ../test-tool/libguestfs-test-tool.pod:28
36834 " ===== TEST FINISHED OK =====\n"
36839 #: ../test-tool/libguestfs-test-tool.pod:30
36840 msgid "and the test tool will exit with code 0."
36844 #: ../test-tool/libguestfs-test-tool.pod:32
36846 "If it fails (and/or exits with non-zero error code), please paste the "
36847 "B<complete, unedited> output of the test tool into a bug report. More "
36848 "information about reporting bugs can be found on the L<http://libguestfs.org/"
36853 #: ../test-tool/libguestfs-test-tool.pod:41
36858 #: ../test-tool/libguestfs-test-tool.pod:43
36859 msgid "Display short usage information and exit."
36863 #: ../test-tool/libguestfs-test-tool.pod:45
36864 msgid "I<--qemu qemu_binary>"
36868 #: ../test-tool/libguestfs-test-tool.pod:47
36870 "If you have downloaded another qemu binary, point this option at the full "
36871 "path of the binary to try it."
36875 #: ../test-tool/libguestfs-test-tool.pod:50
36876 msgid "I<--qemudir qemu_source_dir>"
36880 #: ../test-tool/libguestfs-test-tool.pod:52
36882 "If you have compiled qemu from source, point this option at the source "
36883 "directory to try it."
36887 #: ../test-tool/libguestfs-test-tool.pod:55
36888 msgid "I<--timeout N>"
36892 #: ../test-tool/libguestfs-test-tool.pod:57
36894 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
36895 "does not usually need to be adjusted unless your machine is very slow."
36899 #: ../test-tool/libguestfs-test-tool.pod:63
36900 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
36904 #: ../test-tool/libguestfs-test-tool.pod:65
36906 "If you have compiled another version of qemu from source and would like to "
36907 "try that, then you can use the I<--qemudir> option to point to the qemu "
36908 "source directory."
36912 #: ../test-tool/libguestfs-test-tool.pod:69
36914 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
36915 "option to point to the binary."
36919 #: ../test-tool/libguestfs-test-tool.pod:72
36921 "When using an alternate qemu with libguestfs, usually you would need to "
36922 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
36923 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
36924 "use either of the I<--qemudir> or I<--qemu> options."
36928 #: ../test-tool/libguestfs-test-tool.pod:79
36930 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
36931 "I<1> if there was an error."
36935 #: ../test-tool/libguestfs-test-tool.pod:84
36937 "For the full list of environment variables which may affect libguestfs, "
36938 "please see the L<guestfs(3)> manual page."
36942 #: ../test-tool/libguestfs-test-tool.pod:89
36943 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
36947 #: ../tools/virt-list-filesystems.pl:32
36949 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
36953 #: ../tools/virt-list-filesystems.pl:36
36956 " virt-list-filesystems [--options] domname\n"
36961 #: ../tools/virt-list-filesystems.pl:38
36964 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
36969 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
36971 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
36976 #: ../tools/virt-list-filesystems.pl:45
36978 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
36979 "are contained in a virtual machine or disk image."
36983 #: ../tools/virt-list-filesystems.pl:49
36985 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
36986 "functionality. For more complex cases you should look at the L<guestfish(1)"
36991 #: ../tools/virt-list-filesystems.pl:112
36993 "With this option, C<virt-list-filesystems> displays the type of each "
36994 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
36998 #: ../tools/virt-list-filesystems.pl:119
37003 #: ../tools/virt-list-filesystems.pl:123
37005 "Normally we only show mountable filesystems. If this option is given then "
37006 "swap devices are shown too."
37010 #: ../tools/virt-list-filesystems.pl:197
37012 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
37013 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
37014 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37018 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
37019 msgid "Copyright (C) 2009 Red Hat Inc."
37023 #: ../tools/virt-list-partitions.pl:32
37025 "virt-list-partitions - List partitions in a virtual machine or disk image"
37029 #: ../tools/virt-list-partitions.pl:36
37032 " virt-list-partitions [--options] domname\n"
37037 #: ../tools/virt-list-partitions.pl:38
37040 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
37045 #: ../tools/virt-list-partitions.pl:45
37047 "C<virt-list-partitions> is a command line tool to list the partitions that "
37048 "are contained in a virtual machine or disk image. It is mainly useful as a "
37049 "first step to using L<virt-resize(1)>."
37053 #: ../tools/virt-list-partitions.pl:50
37055 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
37056 "functionality. For more complex cases you should look at the L<guestfish(1)"
37061 #: ../tools/virt-list-partitions.pl:113
37062 msgid "Show sizes in human-readable form (eg. \"1G\")."
37066 #: ../tools/virt-list-partitions.pl:123
37068 "With this option, C<virt-list-partitions> displays the type and size of each "
37069 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
37073 #: ../tools/virt-list-partitions.pl:130
37078 #: ../tools/virt-list-partitions.pl:132
37083 #: ../tools/virt-list-partitions.pl:134
37085 "Display the total size of each block device (as a separate row or rows)."
37089 #: ../tools/virt-list-partitions.pl:267
37091 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
37092 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
37093 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37097 #: ../tools/virt-list-partitions.pl:283
37098 msgid "Copyright (C) 2009-2010 Red Hat Inc."
37102 #: ../tools/virt-make-fs.pl:37
37103 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
37107 #: ../tools/virt-make-fs.pl:41
37110 " virt-make-fs [--options] input.tar output.img\n"
37115 #: ../tools/virt-make-fs.pl:43
37118 " virt-make-fs [--options] input.tar.gz output.img\n"
37123 #: ../tools/virt-make-fs.pl:45
37126 " virt-make-fs [--options] directory output.img\n"
37131 #: ../tools/virt-make-fs.pl:49
37133 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
37134 "archive or some files in a directory. It is similar to tools like L<mkisofs"
37135 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
37136 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
37137 "you want to attach these filesystems to existing virtual machines (eg. to "
37138 "import large amounts of read-only data to a VM)."
37142 #: ../tools/virt-make-fs.pl:57
37143 msgid "Basic usage is:"
37147 #: ../tools/virt-make-fs.pl:59
37150 " virt-make-fs input output\n"
37155 #: ../tools/virt-make-fs.pl:61
37157 "where C<input> is either a directory containing files that you want to add, "
37158 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
37159 "C<output> is a disk image. The input type is detected automatically. The "
37160 "output disk image defaults to a raw ext2 image unless you specify extra "
37161 "flags (see L</OPTIONS> below)."
37165 #: ../tools/virt-make-fs.pl:67
37166 msgid "EXTRA SPACE"
37170 #: ../tools/virt-make-fs.pl:69
37172 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
37173 "the files that it contains, but might have extra space. Depending on how "
37174 "you are going to use the output, you might think this extra space is wasted "
37175 "and want to minimize it, or you might want to leave space so that more files "
37176 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
37177 "but you can use the I<--size> flag to leave space in the filesystem if you "
37182 #: ../tools/virt-make-fs.pl:77
37184 "An alternative way to leave extra space but not make the output image any "
37185 "bigger is to use an alternative disk image format (instead of the default "
37186 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
37187 "image format (check your hypervisor supports this before using it). This "
37188 "allows you to choose a large I<--size> but the extra space won't actually be "
37189 "allocated in the image until you try to store something in it."
37193 #: ../tools/virt-make-fs.pl:85
37195 "Don't forget that you can also use local commands including L<resize2fs(8)> "
37196 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
37197 "to build another image from scratch."
37201 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
37202 #: ../tools/virt-make-fs.pl:142
37207 #: ../tools/virt-make-fs.pl:91
37210 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
37215 #: ../tools/virt-make-fs.pl:93
37216 msgid "FILESYSTEM TYPE"
37220 #: ../tools/virt-make-fs.pl:95
37222 "The default filesystem type is C<ext2>. Just about any filesystem type that "
37223 "libguestfs supports can be used (but I<not> read-only formats like "
37224 "ISO9660). Here are some of the more common choices:"
37228 #: ../tools/virt-make-fs.pl:101
37233 #: ../tools/virt-make-fs.pl:103
37235 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
37236 "you are not going to use the filesystem in a way that requires the journal, "
37237 "then this is just wasted overhead."
37241 #: ../tools/virt-make-fs.pl:107
37242 msgid "I<ntfs> or I<vfat>"
37246 #: ../tools/virt-make-fs.pl:109
37247 msgid "Useful if exporting data to a Windows guest."
37251 #: ../tools/virt-make-fs.pl:111
37253 "I<Note for vfat>: The tar archive or local directory must only contain files "
37254 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
37255 "program running within libguestfs is unable to change the ownership of non-"
37256 "root files, since vfat itself does not support this."
37260 #: ../tools/virt-make-fs.pl:116
37265 #: ../tools/virt-make-fs.pl:118
37267 "Lower overhead than C<ext2>, but certain limitations on filename length and "
37268 "total filesystem size."
37272 #: ../tools/virt-make-fs.pl:125
37275 " virt-make-fs --type=minix input minixfs.img\n"
37280 #: ../tools/virt-make-fs.pl:127
37281 msgid "TO PARTITION OR NOT TO PARTITION"
37285 #: ../tools/virt-make-fs.pl:129
37286 msgid "Optionally virt-make-fs can add a partition table to the output disk."
37290 #: ../tools/virt-make-fs.pl:131
37292 "Adding a partition can make the disk image more compatible with certain "
37293 "virtualized operating systems which don't expect to see a filesystem "
37294 "directly located on a block device (Linux doesn't care and will happily "
37295 "handle both types)."
37299 #: ../tools/virt-make-fs.pl:136
37301 "On the other hand, if you have a partition table then the output image is no "
37302 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
37303 "directly on a partitioned disk image. (However libguestfs tools such as "
37304 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
37308 #: ../tools/virt-make-fs.pl:144
37309 msgid "Add an MBR partition:"
37313 #: ../tools/virt-make-fs.pl:146
37316 " virt-make-fs --partition -- input disk.img\n"
37321 #: ../tools/virt-make-fs.pl:148
37323 "If the output disk image could be terabyte-sized or larger, it's better to "
37324 "use an EFI/GPT-compatible partition table:"
37328 #: ../tools/virt-make-fs.pl:151
37331 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
37336 #: ../tools/virt-make-fs.pl:179
37337 msgid "Enable debugging information."
37341 #: ../tools/virt-make-fs.pl:185
37342 msgid "B<--size=E<lt>NE<gt>>"
37346 #: ../tools/virt-make-fs.pl:187
37347 msgid "B<--size=+E<lt>NE<gt>>"
37351 #: ../tools/virt-make-fs.pl:189
37352 msgid "B<-s E<lt>NE<gt>>"
37356 #: ../tools/virt-make-fs.pl:191
37357 msgid "B<-s +E<lt>NE<gt>>"
37361 #: ../tools/virt-make-fs.pl:193
37363 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
37367 #: ../tools/virt-make-fs.pl:196
37369 "If this option is I<not> given, then the output image will be just large "
37370 "enough to contain all the files, with not much wasted space."
37374 #: ../tools/virt-make-fs.pl:199
37376 "To choose a fixed size output disk, specify an absolute number followed by b/"
37377 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
37378 "Petabytes or Exabytes. This must be large enough to contain all the input "
37379 "files, else you will get an error."
37383 #: ../tools/virt-make-fs.pl:204
37385 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
37386 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
37387 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
37388 "the input files, and (approximately) an extra 200 MB free space."
37392 #: ../tools/virt-make-fs.pl:210
37394 "Note that virt-make-fs estimates free space, and therefore will not produce "
37395 "filesystems containing precisely the free space requested. (It is much more "
37396 "expensive and time-consuming to produce a filesystem which has precisely the "
37397 "desired free space)."
37401 #: ../tools/virt-make-fs.pl:219
37402 msgid "B<--format=E<lt>fmtE<gt>>"
37406 #: ../tools/virt-make-fs.pl:221
37407 msgid "B<-F E<lt>fmtE<gt>>"
37411 #: ../tools/virt-make-fs.pl:223
37412 msgid "Choose the output disk image format."
37416 #: ../tools/virt-make-fs.pl:225
37417 msgid "The default is C<raw> (raw disk image)."
37421 #: ../tools/virt-make-fs.pl:227
37423 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
37424 "that would really make sense here is C<qcow2>."
37428 #: ../tools/virt-make-fs.pl:234
37429 msgid "B<--type=E<lt>fsE<gt>>"
37433 #: ../tools/virt-make-fs.pl:236
37434 msgid "B<-t E<lt>fsE<gt>>"
37438 #: ../tools/virt-make-fs.pl:238
37439 msgid "Choose the output filesystem type."
37443 #: ../tools/virt-make-fs.pl:240
37444 msgid "The default is C<ext2>."
37448 #: ../tools/virt-make-fs.pl:242
37450 "Any filesystem which is supported read-write by libguestfs can be used here."
37454 #: ../tools/virt-make-fs.pl:249
37455 msgid "B<--partition>"
37459 #: ../tools/virt-make-fs.pl:251
37460 msgid "B<--partition=E<lt>parttypeE<gt>>"
37464 #: ../tools/virt-make-fs.pl:253
37466 "If specified, this flag adds an MBR partition table to the output disk image."
37470 #: ../tools/virt-make-fs.pl:256
37472 "You can change the partition table type, eg. I<--partition=gpt> for large "
37477 #: ../tools/virt-make-fs.pl:259
37479 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
37480 "might consider the next parameter to be the partition type. For example:"
37484 #: ../tools/virt-make-fs.pl:263
37487 " virt-make-fs --partition input.tar ...\n"
37492 #: ../tools/virt-make-fs.pl:265
37494 "would cause virt-make-fs to think you wanted to use a partition type of "
37495 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
37496 "dash) between options and the input file argument:"
37500 #: ../tools/virt-make-fs.pl:269
37503 " virt-make-fs --partition -- input.tar ...\n"
37508 #: ../tools/virt-make-fs.pl:541
37510 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
37511 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
37512 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
37516 #: ../tools/virt-make-fs.pl:555 ../tools/virt-win-reg.pl:763
37518 "When reporting bugs, please enable debugging and capture the I<complete> "
37523 #: ../tools/virt-make-fs.pl:558
37526 " export LIBGUESTFS_DEBUG=1\n"
37527 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
37532 #: ../tools/virt-make-fs.pl:561
37534 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
37539 #: ../tools/virt-tar.pl:33
37540 msgid "virt-tar - Extract or upload files to a virtual machine"
37544 #: ../tools/virt-tar.pl:37
37547 " virt-tar [--options] -x domname directory tarball\n"
37552 #: ../tools/virt-tar.pl:39
37555 " virt-tar [--options] -u domname tarball directory\n"
37560 #: ../tools/virt-tar.pl:41
37563 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
37568 #: ../tools/virt-tar.pl:43
37571 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
37576 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
37581 #: ../tools/virt-tar.pl:47
37583 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
37584 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
37588 #: ../tools/virt-tar.pl:52
37589 msgid "Download C</home> from the VM into a local tarball:"
37593 #: ../tools/virt-tar.pl:54
37596 " virt-tar -x domname /home home.tar\n"
37601 #: ../tools/virt-tar.pl:56
37604 " virt-tar -zx domname /home home.tar.gz\n"
37609 #: ../tools/virt-tar.pl:58
37610 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
37614 #: ../tools/virt-tar.pl:60
37617 " virt-tar -u domname uploadstuff.tar /tmp\n"
37622 #: ../tools/virt-tar.pl:62
37625 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
37630 #: ../tools/virt-tar.pl:66
37632 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
37633 "virtual machines. If you do this, you risk disk corruption in the VM. "
37634 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
37638 #: ../tools/virt-tar.pl:71
37640 "You can use I<-x> (extract) on live virtual machines, but you might get "
37641 "inconsistent results or errors if there is filesystem activity inside the "
37642 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
37643 "work, but the only way to guarantee consistent results is if the virtual "
37644 "machine is shut down."
37648 #: ../tools/virt-tar.pl:79
37650 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
37651 "parts of a guest filesystem. There are many possibilities: making backups, "
37652 "uploading data files, snooping on guest activity, fixing or customizing "
37657 #: ../tools/virt-tar.pl:84
37659 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
37660 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
37661 "should look at the L<guestfish(1)> tool."
37665 #: ../tools/virt-tar.pl:88
37667 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
37668 "its contents (recursively) from the virtual machine into a local tarball. "
37669 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
37670 "virtual machine. You cannot use these two options together."
37674 #: ../tools/virt-tar.pl:94
37676 "In addition, you may need to use the I<-z> (gZip) option to enable "
37677 "compression. When uploading, you have to specify I<-z> if the upload file "
37678 "is compressed because virt-tar won't detect this on its own."
37682 #: ../tools/virt-tar.pl:98
37684 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
37685 "example it cannot do PKZip files or bzip2 compression. If you want that "
37686 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
37687 "the L<libguestfs(3)> API)."
37691 #: ../tools/virt-tar.pl:160
37692 msgid "B<--extract>"
37696 #: ../tools/virt-tar.pl:162
37697 msgid "B<--download>"
37701 #: ../tools/virt-tar.pl:164
37706 #: ../tools/virt-tar.pl:166
37707 msgid "B<--upload>"
37711 #: ../tools/virt-tar.pl:168
37713 "Use I<-x> to extract (download) a directory from a virtual machine to a "
37718 #: ../tools/virt-tar.pl:171
37720 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
37721 "Please read the L</WARNING> section above before using this option."
37725 #: ../tools/virt-tar.pl:175
37726 msgid "You must specify exactly one of these options."
37730 #: ../tools/virt-tar.pl:181
37735 #: ../tools/virt-tar.pl:183
37740 #: ../tools/virt-tar.pl:185
37741 msgid "Specify that the input or output tarball is gzip-compressed."
37745 #: ../tools/virt-tar.pl:298
37747 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
37748 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
37749 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
37754 #: ../tools/virt-win-reg.pl:37
37756 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
37760 #: ../tools/virt-win-reg.pl:41
37763 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
37768 #: ../tools/virt-win-reg.pl:43
37771 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
37776 #: ../tools/virt-win-reg.pl:45
37779 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
37784 #: ../tools/virt-win-reg.pl:47
37787 " virt-win-reg --merge domname [input.reg ...]\n"
37792 #: ../tools/virt-win-reg.pl:49
37795 " virt-win-reg [--options] disk.img ... # instead of domname\n"
37800 #: ../tools/virt-win-reg.pl:53
37802 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
37803 "virtual machines. If you do this, you I<will> get irreversible disk "
37804 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
37805 "but doesn't catch all cases."
37809 #: ../tools/virt-win-reg.pl:58
37811 "Modifying the Windows Registry is an inherently risky operation. The format "
37812 "is deliberately obscure and undocumented, and Registry changes can leave the "
37813 "system unbootable. Therefore when using the I<--merge> option, make sure "
37814 "you have a reliable backup first."
37818 #: ../tools/virt-win-reg.pl:65
37820 "This program can export and merge Windows Registry entries from a Windows "
37825 #: ../tools/virt-win-reg.pl:68
37827 "The first parameter is the libvirt guest name or the raw disk image of a "
37832 #: ../tools/virt-win-reg.pl:71
37834 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
37835 "exported (recursively). For example:"
37839 #: ../tools/virt-win-reg.pl:74
37842 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
37847 #: ../tools/virt-win-reg.pl:76
37849 "You can also display single values from within registry keys, for example:"
37853 #: ../tools/virt-win-reg.pl:79
37856 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
37857 " $ virt-win-reg Windows7 $cvkey ProductName\n"
37858 " Windows 7 Enterprise\n"
37863 #: ../tools/virt-win-reg.pl:83
37865 "With I<--merge>, you can merge a textual regedit file into the Windows "
37870 #: ../tools/virt-win-reg.pl:86
37873 " $ virt-win-reg --merge Windows7 changes.reg\n"
37878 #: ../tools/virt-win-reg.pl:90
37880 "This program is only meant for simple access to the registry. If you want "
37881 "to do complicated things with the registry, we suggest you download the "
37882 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
37883 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
37884 "L<hivexregedit(1)>."
37888 #: ../tools/virt-win-reg.pl:159
37893 #: ../tools/virt-win-reg.pl:161
37895 "In merge mode, this merges a textual regedit file into the Windows Registry "
37896 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
37897 "displays or exports Registry entries instead."
37901 #: ../tools/virt-win-reg.pl:165
37903 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
37904 "result in disk corruption. However exporting (without this flag) is always "
37909 #: ../tools/virt-win-reg.pl:173
37910 msgid "B<--encoding> UTF-16LE|ASCII"
37914 #: ../tools/virt-win-reg.pl:175
37916 "When merging (only), you may need to specify the encoding for strings to be "
37917 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
37918 "(3)/ENCODING STRINGS>."
37922 #: ../tools/virt-win-reg.pl:179
37924 "The default is to use UTF-16LE, which should work with recent versions of "
37929 #: ../tools/virt-win-reg.pl:186
37930 msgid "B<--unsafe-printable-strings>"
37934 #: ../tools/virt-win-reg.pl:188
37936 "When exporting (only), assume strings are UTF-16LE and print them as strings "
37937 "instead of hex sequences. Remove the final zero codepoint from strings if "
37942 #: ../tools/virt-win-reg.pl:192
37944 "This is unsafe and does not preserve the fidelity of strings in the original "
37945 "Registry for various reasons:"
37949 #: ../tools/virt-win-reg.pl:199
37951 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
37952 "other encodings will be corrupted by this transformation."
37956 #: ../tools/virt-win-reg.pl:204
37958 "Assumes that everything which has type 1 or 2 is really a string and that "
37959 "everything else is not a string, but the type field in real Registries is "
37964 #: ../tools/virt-win-reg.pl:210
37966 "Loses information about whether a zero codepoint followed the string in the "
37971 #: ../tools/virt-win-reg.pl:215
37973 "This all happens because the Registry itself contains no information about "
37974 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
37978 #: ../tools/virt-win-reg.pl:219
37980 "You should only use this option for quick hacking and debugging of the "
37981 "Registry contents, and I<never> use it if the output is going to be passed "
37982 "into another program or stored in another Registry."
37986 #: ../tools/virt-win-reg.pl:556
37987 msgid "SUPPORTED SYSTEMS"
37991 #: ../tools/virt-win-reg.pl:558
37993 "The program currently supports Windows NT-derived guests starting with "
37994 "Windows XP through to at least Windows 7."
37998 #: ../tools/virt-win-reg.pl:561
37999 msgid "The following Registry keys are supported:"
38003 #: ../tools/virt-win-reg.pl:565
38004 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
38008 #: ../tools/virt-win-reg.pl:567
38009 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
38013 #: ../tools/virt-win-reg.pl:569
38014 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
38018 #: ../tools/virt-win-reg.pl:571
38019 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
38023 #: ../tools/virt-win-reg.pl:573
38024 msgid "C<HKEY_USERS\\.DEFAULT>"
38028 #: ../tools/virt-win-reg.pl:575
38029 msgid "C<HKEY_USERS\\I<SID>>"
38033 #: ../tools/virt-win-reg.pl:577
38034 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
38038 #: ../tools/virt-win-reg.pl:579
38039 msgid "C<HKEY_USERS\\I<username>>"
38043 #: ../tools/virt-win-reg.pl:581
38045 "where I<username> is a local user name (this is a libguestfs extension)."
38049 #: ../tools/virt-win-reg.pl:585
38051 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
38056 #: ../tools/virt-win-reg.pl:588
38058 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
38059 "supported (there is no \"current user\")."
38063 #: ../tools/virt-win-reg.pl:591
38068 #: ../tools/virt-win-reg.pl:593
38070 "C<virt-win-reg> expects that regedit files have already been reencoded in "
38071 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
38072 "style line endings. Since Windows regedit files are often in UTF-16LE with "
38073 "Windows-style line endings, you may need to reencode the whole file before "
38074 "or after processing."
38078 #: ../tools/virt-win-reg.pl:599
38080 "To reencode a file from Windows format to Linux (before processing it with "
38081 "the I<--merge> option), you would do something like this:"
38085 #: ../tools/virt-win-reg.pl:602
38088 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
38093 #: ../tools/virt-win-reg.pl:604
38095 "To go in the opposite direction, after exporting and before sending the file "
38096 "to a Windows user, do something like this:"
38100 #: ../tools/virt-win-reg.pl:607
38103 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
38108 #: ../tools/virt-win-reg.pl:609
38109 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
38113 #: ../tools/virt-win-reg.pl:611
38115 "If you are unsure about the current encoding, use the L<file(1)> command. "
38116 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
38117 "style (CRLF) line endings, like this:"
38121 #: ../tools/virt-win-reg.pl:615
38124 " $ file software.reg\n"
38125 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
38126 " with CRLF line terminators\n"
38131 #: ../tools/virt-win-reg.pl:619
38132 msgid "This file would need conversion before you could I<--merge> it."
38136 #: ../tools/virt-win-reg.pl:621
38137 msgid "CurrentControlSet etc."
38141 #: ../tools/virt-win-reg.pl:623
38143 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
38144 "Registry at the level of the hive file, and therefore you cannot modify "
38149 #: ../tools/virt-win-reg.pl:627
38151 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
38152 "circumstances it might refer to another control set. The way to find out is "
38153 "to look at the C<HKLM\\SYSTEM\\Select> key:"
38157 #: ../tools/virt-win-reg.pl:631
38160 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
38161 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
38162 " \"Current\"=dword:00000001\n"
38163 " \"Default\"=dword:00000001\n"
38164 " \"Failed\"=dword:00000000\n"
38165 " \"LastKnownGood\"=dword:00000002\n"
38170 #: ../tools/virt-win-reg.pl:638
38171 msgid "\"Current\" is the one which Windows will choose when it boots."
38175 #: ../tools/virt-win-reg.pl:640
38177 "Similarly, other C<Current...> keys in the path may need to be replaced."
38181 #: ../tools/virt-win-reg.pl:643
38182 msgid "WINDOWS TIPS"
38186 #: ../tools/virt-win-reg.pl:645
38188 "Note that some of these tips modify the guest disk image. The guest I<must> "
38189 "be shut off, else you will get disk corruption."
38193 #: ../tools/virt-win-reg.pl:648
38194 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
38198 #: ../tools/virt-win-reg.pl:650
38200 "Prepare a DOS batch script, VBScript or executable. Upload this using "
38201 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
38202 "is uploaded into C<C:\\>:"
38206 #: ../tools/virt-win-reg.pl:654
38209 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
38214 #: ../tools/virt-win-reg.pl:656
38215 msgid "Prepare a regedit file containing the registry change:"
38219 #: ../tools/virt-win-reg.pl:658
38222 " cat > test.reg <<'EOF'\n"
38223 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
38224 " \"Test\"=\"c:\\\\test.bat\"\n"
38230 #: ../tools/virt-win-reg.pl:663
38232 "In this example we use the key C<RunOnce> which means that the script will "
38233 "run precisely once when the first user logs in. If you want it to run every "
38234 "time a user logs in, replace C<RunOnce> with C<Run>."
38238 #: ../tools/virt-win-reg.pl:667
38239 msgid "Now update the registry:"
38243 #: ../tools/virt-win-reg.pl:669
38246 " virt-win-reg --merge WindowsGuest test.reg\n"
38251 #: ../tools/virt-win-reg.pl:671
38252 msgid "INSTALLING A SERVICE"
38256 #: ../tools/virt-win-reg.pl:673
38258 "This section assumes you are familiar with Windows services, and you either "
38259 "have a program which handles the Windows Service Control Protocol directly "
38260 "or you want to run any program using a service wrapper like SrvAny or the "
38265 #: ../tools/virt-win-reg.pl:678
38267 "First upload the program and optionally the service wrapper. In this case "
38268 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
38272 #: ../tools/virt-win-reg.pl:682
38275 " guestfish -i -d WindowsGuest <<EOF\n"
38276 " upload rhsrvany.exe /rhsrvany.exe\n"
38277 " upload test.exe /test.exe\n"
38283 #: ../tools/virt-win-reg.pl:687
38285 "Prepare a regedit file containing the registry changes. In this example, "
38286 "the first registry change is needed for the service itself or the service "
38287 "wrapper (if used). The second registry change is only needed because I am "
38288 "using the RHSrvAny service wrapper."
38292 #: ../tools/virt-win-reg.pl:692
38295 " cat > service.reg <<'EOF'\n"
38296 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
38297 " \"Type\"=dword:00000010\n"
38298 " \"Start\"=dword:00000002\n"
38299 " \"ErrorControl\"=dword:00000001\n"
38300 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
38301 " \"DisplayName\"=\"RHSrvAny\"\n"
38302 " \"ObjectName\"=\"NetworkService\"\n"
38307 #: ../tools/virt-win-reg.pl:701
38310 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
38311 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
38312 " \"PWD\"=\"c:\\\\Temp\"\n"
38318 #: ../tools/virt-win-reg.pl:712
38320 "For use of C<ControlSet001> see the section above in this manual page. You "
38321 "may need to adjust this according to the control set that is in use by the "
38326 #: ../tools/virt-win-reg.pl:718
38328 "C<\"ObjectName\"> controls the privileges that the service will have. An "
38329 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
38330 "privileged account."
38334 #: ../tools/virt-win-reg.pl:724
38336 "For the meaning of the magic numbers, see this Microsoft KB article: "
38337 "L<http://support.microsoft.com/kb/103000>."
38341 #: ../tools/virt-win-reg.pl:729
38342 msgid "Update the registry:"
38346 #: ../tools/virt-win-reg.pl:731
38349 " virt-win-reg --merge WindowsGuest service.reg\n"
38354 #: ../tools/virt-win-reg.pl:735
38356 "Be careful when passing parameters containing C<\\> (backslash) in the "
38357 "shell. Usually you will have to use 'single quotes' or double backslashes "
38358 "(but not both) to protect them from the shell."
38362 #: ../tools/virt-win-reg.pl:739
38363 msgid "Paths and value names are case-insensitive."
38367 #: ../tools/virt-win-reg.pl:748
38369 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
38370 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
38371 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
38375 #: ../tools/virt-win-reg.pl:766
38378 " export LIBGUESTFS_DEBUG=1\n"
38379 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
38384 #: ../tools/virt-win-reg.pl:769
38386 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."