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 10:15+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:2652
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 to edit, and C<file> is the full path to the file."
640 #: ../cat/virt-cat.pod:192 ../cat/virt-filesystems.pod:365
641 #: ../cat/virt-ls.pod:483 ../df/virt-df.pod:215 ../edit/virt-edit.pod:342
642 #: ../inspector/virt-inspector.pod:352 ../rescue/virt-rescue.pod:262
643 #: ../resize/virt-resize.pod:568 ../tools/virt-list-filesystems.pl:188
644 #: ../tools/virt-list-partitions.pl:258 ../tools/virt-make-fs.pl:532
645 #: ../tools/virt-tar.pl:289 ../tools/virt-win-reg.pl:733
646 msgid "SHELL QUOTING"
650 #: ../cat/virt-cat.pod:194 ../cat/virt-filesystems.pod:367
651 #: ../cat/virt-ls.pod:485 ../df/virt-df.pod:217 ../edit/virt-edit.pod:344
652 #: ../inspector/virt-inspector.pod:354 ../rescue/virt-rescue.pod:264
653 #: ../resize/virt-resize.pod:570 ../tools/virt-list-filesystems.pl:190
654 #: ../tools/virt-list-partitions.pl:260 ../tools/virt-make-fs.pl:534
655 #: ../tools/virt-tar.pl:291 ../tools/virt-win-reg.pl:741
657 "Libvirt guest names can contain arbitrary characters, some of which have "
658 "meaning to the shell such as C<#> and space. You may need to quote or "
659 "escape these characters on the command line. See the shell manual page L<sh"
664 #: ../cat/virt-cat.pod:199 ../cat/virt-filesystems.pod:372
665 #: ../cat/virt-ls.pod:490 ../df/virt-df.pod:222 ../edit/virt-edit.pod:349
666 #: ../fish/guestfish.pod:1081 ../fuse/guestmount.pod:303
667 #: ../inspector/virt-inspector.pod:375 ../resize/virt-resize.pod:575
668 #: ../test-tool/libguestfs-test-tool.pod:77
673 #: ../cat/virt-cat.pod:201 ../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:577
678 "This program returns 0 if successful, or non-zero if there was an error."
682 #: ../cat/virt-cat.pod:204 ../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:580 ../ruby/examples/guestfs-ruby.pod:36
692 #: ../src/guestfs.pod:3026 ../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:206
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:213 ../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:601
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:215 ../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:603 ../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:217 ../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:605 ../ruby/examples/guestfs-ruby.pod:51
737 #: ../src/guestfs.pod:3102 ../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:219 ../inspector/virt-inspector.pod:405
746 #: ../resize/virt-resize.pod:607
747 msgid "Copyright (C) 2010-2011 Red Hat Inc."
751 #: ../cat/virt-cat.pod:221 ../cat/virt-filesystems.pod:396
752 #: ../cat/virt-ls.pod:515 ../df/virt-df.pod:243 ../edit/virt-edit.pod:376
753 #: ../fish/guestfish.pod: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:609 ../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:226 ../cat/virt-filesystems.pod:401
770 #: ../cat/virt-ls.pod:520 ../df/virt-df.pod:248 ../edit/virt-edit.pod:381
771 #: ../fish/guestfish.pod: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:614 ../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:231 ../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:619 ../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:15 ../src/guestfs-actions.pod:22
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:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
2436 #: ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763
2437 #: ../src/guestfs.pod:1773 ../src/guestfs.pod:2047 ../src/guestfs.pod:2052
2438 #: ../src/guestfs.pod:2058 ../src/guestfs.pod:2066 ../src/guestfs.pod:2420
2439 #: ../src/guestfs.pod:2426 ../src/guestfs.pod:2431 ../src/guestfs.pod:2437
2440 #: ../src/guestfs.pod:2818 ../src/guestfs.pod:2823 ../src/guestfs.pod:2827
2441 #: ../src/guestfs.pod:2831 ../src/guestfs.pod:2835 ../src/guestfs.pod:2849
2442 #: ../src/guestfs.pod:2854 ../src/guestfs.pod:3079 ../src/guestfs.pod:3083
2443 #: ../src/guestfs.pod:3087 ../src/guestfs.pod:3091
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:2965
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:3098
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:3100
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:3107
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:3112
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:3117
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:11 ../src/guestfs-actions.pod:1922
3524 #: ../src/guestfs-actions.pod:2860 ../src/guestfs.pod:1639
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:7
4093 msgid "This function adds a virtual CD-ROM disk image to the guest."
4097 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:9
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 "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:35 ../src/guestfs-actions.pod:257
4136 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1518
4137 #: ../src/guestfs-actions.pod:2013 ../src/guestfs-actions.pod:2034
4138 #: ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4952
4139 #: ../src/guestfs-actions.pod:5170 ../src/guestfs-actions.pod:5260
4140 #: ../src/guestfs-actions.pod:6549 ../src/guestfs-actions.pod:6579
4141 #: ../src/guestfs-actions.pod:6612 ../src/guestfs-actions.pod:6671
4142 #: ../src/guestfs-actions.pod:7607 ../src/guestfs-actions.pod:7719
4143 #: ../src/guestfs-actions.pod:7897
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:7713
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:1505 ../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:1509
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 "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:2004
6965 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6969 #: ../fish/guestfish-actions.pod:1348
6971 "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:2025
6991 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6995 #: ../fish/guestfish-actions.pod:1362
6997 "This function is deprecated. In new code, use the L</vfs_uuid> call instead."
7001 #: ../fish/guestfish-actions.pod:1369
7006 #: ../fish/guestfish-actions.pod:1371
7014 #: ../fish/guestfish-actions.pod:1373 ../src/guestfs-actions.pod:2045
7016 "This gets the memory size in megabytes allocated to the qemu subprocess."
7020 #: ../fish/guestfish-actions.pod:1376
7022 "If L</set-memsize> was not called on this handle, and if "
7023 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7024 "value for memsize."
7028 #: ../fish/guestfish-actions.pod:1380 ../fish/guestfish-actions.pod:1437
7029 #: ../fish/guestfish-actions.pod:4168 ../fish/guestfish-actions.pod:4270
7030 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2144
7031 #: ../src/guestfs-actions.pod:6298 ../src/guestfs-actions.pod:6424
7033 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7037 #: ../fish/guestfish-actions.pod:1383
7042 #: ../fish/guestfish-actions.pod:1385
7050 #: ../fish/guestfish-actions.pod:1387 ../src/guestfs-actions.pod:2064
7051 msgid "This returns the enable network flag."
7055 #: ../fish/guestfish-actions.pod:1389
7060 #: ../fish/guestfish-actions.pod:1391
7068 #: ../fish/guestfish-actions.pod:1393 ../src/guestfs-actions.pod:2075
7069 msgid "Return the current search path."
7073 #: ../fish/guestfish-actions.pod:1395 ../src/guestfs-actions.pod:2077
7075 "This is always non-NULL. If it wasn't set already, then this will return "
7080 #: ../fish/guestfish-actions.pod:1398
7085 #: ../fish/guestfish-actions.pod:1400
7093 #: ../fish/guestfish-actions.pod:1402 ../src/guestfs-actions.pod:2090
7094 msgid "This returns the process group flag."
7098 #: ../fish/guestfish-actions.pod:1404
7103 #: ../fish/guestfish-actions.pod:1406
7108 #: ../fish/guestfish-actions.pod:1408
7116 #: ../fish/guestfish-actions.pod:1410 ../src/guestfs-actions.pod:2101
7118 "Return the process ID of the qemu subprocess. If there is no qemu "
7119 "subprocess, then this will return an error."
7123 #: ../fish/guestfish-actions.pod:1413 ../src/guestfs-actions.pod:2104
7124 msgid "This is an internal call used for debugging and testing."
7128 #: ../fish/guestfish-actions.pod:1415
7133 #: ../fish/guestfish-actions.pod:1417
7141 #: ../fish/guestfish-actions.pod:1419 ../src/guestfs-actions.pod:2115
7142 msgid "Return the current qemu binary."
7146 #: ../fish/guestfish-actions.pod:1421 ../src/guestfs-actions.pod:2117
7148 "This is always non-NULL. If it wasn't set already, then this will return "
7149 "the default qemu binary name."
7153 #: ../fish/guestfish-actions.pod:1424
7154 msgid "get-recovery-proc"
7158 #: ../fish/guestfish-actions.pod:1426
7161 " get-recovery-proc\n"
7166 #: ../fish/guestfish-actions.pod:1428 ../src/guestfs-actions.pod:2130
7167 msgid "Return the recovery process enabled flag."
7171 #: ../fish/guestfish-actions.pod:1430
7176 #: ../fish/guestfish-actions.pod:1432
7184 #: ../fish/guestfish-actions.pod:1434
7186 "This returns the current setting of the selinux flag which is passed to the "
7187 "appliance at boot time. See L</set-selinux>."
7191 #: ../fish/guestfish-actions.pod:1440
7196 #: ../fish/guestfish-actions.pod:1442
7204 #: ../fish/guestfish-actions.pod:1444 ../src/guestfs-actions.pod:2156
7206 "This returns the current state as an opaque integer. This is only useful "
7207 "for printing debug and internal error messages."
7211 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2367
7212 #: ../fish/guestfish-actions.pod:2385 ../fish/guestfish-actions.pod:2423
7213 #: ../fish/guestfish-actions.pod:2439 ../src/guestfs-actions.pod:2159
7214 #: ../src/guestfs-actions.pod:3439 ../src/guestfs-actions.pod:3468
7215 #: ../src/guestfs-actions.pod:3529 ../src/guestfs-actions.pod:3556
7216 msgid "For more information on states, see L<guestfs(3)>."
7220 #: ../fish/guestfish-actions.pod:1449
7225 #: ../fish/guestfish-actions.pod:1451
7233 #: ../fish/guestfish-actions.pod:1453 ../src/guestfs-actions.pod:2170
7234 msgid "Return the command trace flag."
7238 #: ../fish/guestfish-actions.pod:1455
7243 #: ../fish/guestfish-actions.pod:1457
7251 #: ../fish/guestfish-actions.pod:1459
7253 "Return the current umask. By default the umask is C<022> unless it has been "
7254 "set by calling L</umask>."
7258 #: ../fish/guestfish-actions.pod:1462
7263 #: ../fish/guestfish-actions.pod:1464
7271 #: ../fish/guestfish-actions.pod:1466 ../src/guestfs-actions.pod:2193
7272 msgid "This returns the verbose messages flag."
7276 #: ../fish/guestfish-actions.pod:1468
7281 #: ../fish/guestfish-actions.pod:1470
7289 #: ../fish/guestfish-actions.pod:1472 ../src/guestfs-actions.pod:2204
7290 msgid "This gets the SELinux security context of the daemon."
7294 #: ../fish/guestfish-actions.pod:1474
7295 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
7299 #: ../fish/guestfish-actions.pod:1477
7304 #: ../fish/guestfish-actions.pod:1479
7307 " getxattr path name\n"
7312 #: ../fish/guestfish-actions.pod:1481
7314 "Get a single extended attribute from file C<path> named C<name>. This call "
7315 "follows symlinks. If you want to lookup an extended attribute for the "
7316 "symlink itself, use L</lgetxattr>."
7320 #: ../fish/guestfish-actions.pod:1485 ../fish/guestfish-actions.pod:2512
7322 "Normally it is better to get all extended attributes from a file in one go "
7323 "by calling L</getxattrs>. However some Linux filesystem implementations are "
7324 "buggy and do not provide a way to list out attributes. For these "
7325 "filesystems (notably ntfs-3g) you have to know the names of the extended "
7326 "attributes you want in advance and call this function."
7330 #: ../fish/guestfish-actions.pod:1492 ../fish/guestfish-actions.pod:2519
7331 #: ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:3689
7333 "Extended attribute values are blobs of binary data. If there is no extended "
7334 "attribute named C<name>, this returns an error."
7338 #: ../fish/guestfish-actions.pod:1495
7339 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
7343 #: ../fish/guestfish-actions.pod:1497
7348 #: ../fish/guestfish-actions.pod:1499
7356 #: ../fish/guestfish-actions.pod:1501 ../src/guestfs-actions.pod:2250
7358 "This call lists the extended attributes of the file or directory C<path>."
7362 #: ../fish/guestfish-actions.pod:1504 ../src/guestfs-actions.pod:2253
7364 "At the system call level, this is a combination of the L<listxattr(2)> and "
7365 "L<getxattr(2)> calls."
7369 #: ../fish/guestfish-actions.pod:1507
7370 msgid "See also: L</lgetxattrs>, L<attr(5)>."
7374 #: ../fish/guestfish-actions.pod:1509
7379 #: ../fish/guestfish-actions.pod:1511
7382 " glob-expand pattern\n"
7387 #: ../fish/guestfish-actions.pod:1513 ../src/guestfs-actions.pod:2270
7389 "This command searches for all the pathnames matching C<pattern> according to "
7390 "the wildcard expansion rules used by the shell."
7394 #: ../fish/guestfish-actions.pod:1517 ../src/guestfs-actions.pod:2274
7396 "If no paths match, then this returns an empty list (note: not an error)."
7400 #: ../fish/guestfish-actions.pod:1520 ../src/guestfs-actions.pod:2277
7402 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
7403 "GLOB_BRACE>. See that manual page for more details."
7407 #: ../fish/guestfish-actions.pod:1524
7412 #: ../fish/guestfish-actions.pod:1526
7415 " grep regex path\n"
7420 #: ../fish/guestfish-actions.pod:1528 ../src/guestfs-actions.pod:2294
7421 msgid "This calls the external C<grep> program and returns the matching lines."
7425 #: ../fish/guestfish-actions.pod:1534
7430 #: ../fish/guestfish-actions.pod:1536
7433 " grepi regex path\n"
7438 #: ../fish/guestfish-actions.pod:1538 ../src/guestfs-actions.pod:2313
7440 "This calls the external C<grep -i> program and returns the matching lines."
7444 #: ../fish/guestfish-actions.pod:1544
7445 msgid "grub-install"
7449 #: ../fish/guestfish-actions.pod:1546
7452 " grub-install root device\n"
7457 #: ../fish/guestfish-actions.pod:1548 ../src/guestfs-actions.pod:2332
7459 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7460 "the root directory being C<root>."
7464 #: ../fish/guestfish-actions.pod:1551 ../src/guestfs-actions.pod:2335
7466 "Note: If grub-install reports the error \"No suitable drive was found in the "
7467 "generated device map.\" it may be that you need to create a C</boot/grub/"
7468 "device.map> file first that contains the mapping between grub device names "
7469 "and Linux device names. It is usually sufficient to create a file "
7474 #: ../fish/guestfish-actions.pod:1558 ../src/guestfs-actions.pod:2342
7482 #: ../fish/guestfish-actions.pod:1560 ../src/guestfs-actions.pod:2344
7483 msgid "replacing C</dev/vda> with the name of the installation device."
7487 #: ../fish/guestfish-actions.pod:1562
7492 #: ../fish/guestfish-actions.pod:1564
7500 #: ../fish/guestfish-actions.pod:1566 ../src/guestfs-actions.pod:2356
7502 "This command returns up to the first 10 lines of a file as a list of strings."
7506 #: ../fish/guestfish-actions.pod:1572
7511 #: ../fish/guestfish-actions.pod:1574
7514 " head-n nrlines path\n"
7519 #: ../fish/guestfish-actions.pod:1576 ../src/guestfs-actions.pod:2375
7521 "If the parameter C<nrlines> is a positive number, this returns the first "
7522 "C<nrlines> lines of the file C<path>."
7526 #: ../fish/guestfish-actions.pod:1579 ../src/guestfs-actions.pod:2378
7528 "If the parameter C<nrlines> is a negative number, this returns lines from "
7529 "the file C<path>, excluding the last C<nrlines> lines."
7533 #: ../fish/guestfish-actions.pod:1582 ../fish/guestfish-actions.pod:4648
7534 #: ../src/guestfs-actions.pod:2381 ../src/guestfs-actions.pod:6996
7535 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7539 #: ../fish/guestfish-actions.pod:1587
7544 #: ../fish/guestfish-actions.pod:1589
7552 #: ../fish/guestfish-actions.pod:1591 ../src/guestfs-actions.pod:2398
7554 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
7555 "readable, canonical hex dump of the file."
7559 #: ../fish/guestfish-actions.pod:1597
7564 #: ../fish/guestfish-actions.pod:1599
7567 " initrd-cat initrdpath filename\n"
7572 #: ../fish/guestfish-actions.pod:1601 ../src/guestfs-actions.pod:2417
7574 "This command unpacks the file C<filename> from the initrd file called "
7575 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7580 #: ../fish/guestfish-actions.pod:1605 ../src/guestfs-actions.pod:2421
7582 "For example, in guestfish you could use the following command to examine the "
7583 "boot script (usually called C</init>) contained in a Linux initrd or "
7588 #: ../fish/guestfish-actions.pod:1609 ../src/guestfs-actions.pod:2425
7591 " initrd-cat /boot/initrd-<version>.img init\n"
7596 #: ../fish/guestfish-actions.pod:1611
7597 msgid "See also L</initrd-list>."
7601 #: ../fish/guestfish-actions.pod:1616
7606 #: ../fish/guestfish-actions.pod:1618
7609 " initrd-list path\n"
7614 #: ../fish/guestfish-actions.pod:1620 ../src/guestfs-actions.pod:2444
7615 msgid "This command lists out files contained in an initrd."
7619 #: ../fish/guestfish-actions.pod:1622 ../src/guestfs-actions.pod:2446
7621 "The files are listed without any initial C</> character. The files are "
7622 "listed in the order they appear (not necessarily alphabetical). Directory "
7623 "names are listed as separate items."
7627 #: ../fish/guestfish-actions.pod:1626 ../src/guestfs-actions.pod:2450
7629 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7630 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7635 #: ../fish/guestfish-actions.pod:1630
7636 msgid "inotify-add-watch"
7640 #: ../fish/guestfish-actions.pod:1632
7643 " inotify-add-watch path mask\n"
7648 #: ../fish/guestfish-actions.pod:1634 ../src/guestfs-actions.pod:2467
7649 msgid "Watch C<path> for the events listed in C<mask>."
7653 #: ../fish/guestfish-actions.pod:1636 ../src/guestfs-actions.pod:2469
7655 "Note that if C<path> is a directory then events within that directory are "
7656 "watched, but this does I<not> happen recursively (in subdirectories)."
7660 #: ../fish/guestfish-actions.pod:1640 ../src/guestfs-actions.pod:2473
7662 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7663 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7667 #: ../fish/guestfish-actions.pod:1644
7668 msgid "inotify-close"
7672 #: ../fish/guestfish-actions.pod:1646
7680 #: ../fish/guestfish-actions.pod:1648 ../src/guestfs-actions.pod:2486
7682 "This closes the inotify handle which was previously opened by inotify_init. "
7683 "It removes all watches, throws away any pending events, and deallocates all "
7688 #: ../fish/guestfish-actions.pod:1652
7689 msgid "inotify-files"
7693 #: ../fish/guestfish-actions.pod:1654
7701 #: ../fish/guestfish-actions.pod:1656
7703 "This function is a helpful wrapper around L</inotify-read> which just "
7704 "returns a list of pathnames of objects that were touched. The returned "
7705 "pathnames are sorted and deduplicated."
7709 #: ../fish/guestfish-actions.pod:1660
7710 msgid "inotify-init"
7714 #: ../fish/guestfish-actions.pod:1662
7717 " inotify-init maxevents\n"
7722 #: ../fish/guestfish-actions.pod:1664 ../src/guestfs-actions.pod:2515
7724 "This command creates a new inotify handle. The inotify subsystem can be "
7725 "used to notify events which happen to objects in the guest filesystem."
7729 #: ../fish/guestfish-actions.pod:1668
7731 "C<maxevents> is the maximum number of events which will be queued up between "
7732 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
7733 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
7734 "default was 16384 events. Beyond this limit, the kernel throws away events, "
7735 "but records the fact that it threw them away by setting a flag "
7736 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
7740 #: ../fish/guestfish-actions.pod:1678
7742 "Before any events are generated, you have to add some watches to the "
7743 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
7744 "L</inotify-watch-all>."
7748 #: ../fish/guestfish-actions.pod:1684
7750 "Queued up events should be read periodically by calling L</inotify-read> (or "
7751 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
7752 "If you don't read the events out often enough then you risk the internal "
7753 "queue overflowing."
7757 #: ../fish/guestfish-actions.pod:1691
7759 "The handle should be closed after use by calling L</inotify-close>. This "
7760 "also removes any watches automatically."
7764 #: ../fish/guestfish-actions.pod:1695 ../src/guestfs-actions.pod:2546
7766 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7767 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7768 "that there is one global inotify handle per libguestfs instance."
7772 #: ../fish/guestfish-actions.pod:1700
7773 msgid "inotify-read"
7777 #: ../fish/guestfish-actions.pod:1702
7785 #: ../fish/guestfish-actions.pod:1704 ../src/guestfs-actions.pod:2560
7787 "Return the complete queue of events that have happened since the previous "
7792 #: ../fish/guestfish-actions.pod:1707 ../src/guestfs-actions.pod:2563
7793 msgid "If no events have happened, this returns an empty list."
7797 #: ../fish/guestfish-actions.pod:1709 ../src/guestfs-actions.pod:2565
7799 "I<Note>: In order to make sure that all events have been read, you must call "
7800 "this function repeatedly until it returns an empty list. The reason is that "
7801 "the call will read events up to the maximum appliance-to-host message size "
7802 "and leave remaining events in the queue."
7806 #: ../fish/guestfish-actions.pod:1715
7807 msgid "inotify-rm-watch"
7811 #: ../fish/guestfish-actions.pod:1717
7814 " inotify-rm-watch wd\n"
7819 #: ../fish/guestfish-actions.pod:1719
7820 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
7824 #: ../fish/guestfish-actions.pod:1722
7825 msgid "inspect-get-arch"
7829 #: ../fish/guestfish-actions.pod:1724
7832 " inspect-get-arch root\n"
7837 #: ../fish/guestfish-actions.pod:1726
7839 "This returns the architecture of the inspected operating system. The "
7840 "possible return values are listed under L</file-architecture>."
7844 #: ../fish/guestfish-actions.pod:1730 ../src/guestfs-actions.pod:2600
7846 "If the architecture could not be determined, then the string C<unknown> is "
7851 #: ../fish/guestfish-actions.pod:1733 ../fish/guestfish-actions.pod:1816
7852 #: ../fish/guestfish-actions.pod:1895 ../fish/guestfish-actions.pod:1907
7853 #: ../fish/guestfish-actions.pod:1991 ../fish/guestfish-actions.pod:2052
7854 #: ../fish/guestfish-actions.pod:2073 ../fish/guestfish-actions.pod:2087
7855 #: ../fish/guestfish-actions.pod:2127 ../fish/guestfish-actions.pod:2159
7856 #: ../fish/guestfish-actions.pod:2172 ../fish/guestfish-actions.pod:2185
7857 #: ../fish/guestfish-actions.pod:2195 ../fish/guestfish-actions.pod:2205
7858 #: ../fish/guestfish-actions.pod:2217 ../fish/guestfish-actions.pod:2313
7859 #: ../fish/guestfish-actions.pod:2347 ../src/guestfs-actions.pod:2603
7860 #: ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2797
7861 #: ../src/guestfs-actions.pod:2816 ../src/guestfs-actions.pod:2947
7862 #: ../src/guestfs-actions.pod:3030 ../src/guestfs-actions.pod:3058
7863 #: ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3132
7864 #: ../src/guestfs-actions.pod:3172 ../src/guestfs-actions.pod:3192
7865 #: ../src/guestfs-actions.pod:3212 ../src/guestfs-actions.pod:3229
7866 #: ../src/guestfs-actions.pod:3245 ../src/guestfs-actions.pod:3263
7867 #: ../src/guestfs-actions.pod:3365 ../src/guestfs-actions.pod:3406
7868 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7872 #: ../fish/guestfish-actions.pod:1735
7873 msgid "inspect-get-distro"
7877 #: ../fish/guestfish-actions.pod:1737
7880 " inspect-get-distro root\n"
7885 #: ../fish/guestfish-actions.pod:1739 ../src/guestfs-actions.pod:2616
7887 "This returns the distro (distribution) of the inspected operating system."
7891 #: ../fish/guestfish-actions.pod:1742 ../src/guestfs-actions.pod:2619
7892 msgid "Currently defined distros are:"
7896 #: ../fish/guestfish-actions.pod:1746 ../src/guestfs-actions.pod:2623
7897 msgid "\"archlinux\""
7901 #: ../fish/guestfish-actions.pod:1748 ../src/guestfs-actions.pod:2625
7906 #: ../fish/guestfish-actions.pod:1750 ../src/guestfs-actions.pod:2627
7911 #: ../fish/guestfish-actions.pod:1752 ../src/guestfs-actions.pod:2629
7916 #: ../fish/guestfish-actions.pod:1754 ../src/guestfs-actions.pod:2631
7921 #: ../fish/guestfish-actions.pod:1756 ../src/guestfs-actions.pod:2633
7926 #: ../fish/guestfish-actions.pod:1758 ../src/guestfs-actions.pod:2635
7931 #: ../fish/guestfish-actions.pod:1760 ../src/guestfs-actions.pod:2637
7936 #: ../fish/guestfish-actions.pod:1762 ../src/guestfs-actions.pod:2639
7941 #: ../fish/guestfish-actions.pod:1764 ../src/guestfs-actions.pod:2641
7946 #: ../fish/guestfish-actions.pod:1766 ../src/guestfs-actions.pod:2643
7947 msgid "\"linuxmint\""
7951 #: ../fish/guestfish-actions.pod:1768 ../src/guestfs-actions.pod:2645
7956 #: ../fish/guestfish-actions.pod:1770 ../src/guestfs-actions.pod:2647
7957 msgid "\"mandriva\""
7961 #: ../fish/guestfish-actions.pod:1772 ../src/guestfs-actions.pod:2649
7966 #: ../fish/guestfish-actions.pod:1774 ../src/guestfs-actions.pod:2651
7971 #: ../fish/guestfish-actions.pod:1776 ../src/guestfs-actions.pod:2653
7976 #: ../fish/guestfish-actions.pod:1778 ../src/guestfs-actions.pod:2655
7981 #: ../fish/guestfish-actions.pod:1780 ../src/guestfs-actions.pod:2657
7986 #: ../fish/guestfish-actions.pod:1782 ../src/guestfs-actions.pod:2659
7987 msgid "\"redhat-based\""
7991 #: ../fish/guestfish-actions.pod:1784 ../src/guestfs-actions.pod:2661
7992 msgid "Some Red Hat-derived distro."
7996 #: ../fish/guestfish-actions.pod:1786 ../src/guestfs-actions.pod:2663
8001 #: ../fish/guestfish-actions.pod:1788 ../src/guestfs-actions.pod:2665
8002 msgid "Red Hat Enterprise Linux."
8006 #: ../fish/guestfish-actions.pod:1790 ../src/guestfs-actions.pod:2667
8007 msgid "\"scientificlinux\""
8011 #: ../fish/guestfish-actions.pod:1792 ../src/guestfs-actions.pod:2669
8012 msgid "Scientific Linux."
8016 #: ../fish/guestfish-actions.pod:1794 ../src/guestfs-actions.pod:2671
8017 msgid "\"slackware\""
8021 #: ../fish/guestfish-actions.pod:1796 ../src/guestfs-actions.pod:2673
8026 #: ../fish/guestfish-actions.pod:1798 ../src/guestfs-actions.pod:2675
8031 #: ../fish/guestfish-actions.pod:1800 ../src/guestfs-actions.pod:2677
8036 #: ../fish/guestfish-actions.pod:1802 ../fish/guestfish-actions.pod:1886
8037 #: ../fish/guestfish-actions.pod:2150 ../src/guestfs-actions.pod:2679
8038 #: ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:3163
8043 #: ../fish/guestfish-actions.pod:1804 ../src/guestfs-actions.pod:2681
8044 msgid "The distro could not be determined."
8048 #: ../fish/guestfish-actions.pod:1806 ../fish/guestfish-actions.pod:2142
8049 #: ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:3155
8054 #: ../fish/guestfish-actions.pod:1808 ../src/guestfs-actions.pod:2685
8056 "Windows does not have distributions. This string is returned if the OS type "
8061 #: ../fish/guestfish-actions.pod:1813 ../fish/guestfish-actions.pod:1892
8062 #: ../fish/guestfish-actions.pod:2156 ../src/guestfs-actions.pod:2690
8063 #: ../src/guestfs-actions.pod:2794 ../src/guestfs-actions.pod:3169
8065 "Future versions of libguestfs may return other strings here. The caller "
8066 "should be prepared to handle any string."
8070 #: ../fish/guestfish-actions.pod:1818
8071 msgid "inspect-get-drive-mappings"
8075 #: ../fish/guestfish-actions.pod:1820
8078 " inspect-get-drive-mappings root\n"
8083 #: ../fish/guestfish-actions.pod:1822 ../src/guestfs-actions.pod:2706
8085 "This call is useful for Windows which uses a primitive system of assigning "
8086 "drive letters (like \"C:\") to partitions. This inspection API examines the "
8087 "Windows Registry to find out how disks/partitions are mapped to drive "
8088 "letters, and returns a hash table as in the example below:"
8092 #: ../fish/guestfish-actions.pod:1828 ../src/guestfs-actions.pod:2712
8102 #: ../fish/guestfish-actions.pod:1832 ../src/guestfs-actions.pod:2716
8104 "Note that keys are drive letters. For Windows, the key is case insensitive "
8105 "and just contains the drive letter, without the customary colon separator "
8110 #: ../fish/guestfish-actions.pod:1836 ../src/guestfs-actions.pod:2720
8112 "In future we may support other operating systems that also used drive "
8113 "letters, but the keys for those might not be case insensitive and might be "
8114 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
8119 #: ../fish/guestfish-actions.pod:1841 ../src/guestfs-actions.pod:2725
8121 "For Windows guests, currently only hard drive mappings are returned. "
8122 "Removable disks (eg. DVD-ROMs) are ignored."
8126 #: ../fish/guestfish-actions.pod:1844 ../src/guestfs-actions.pod:2728
8128 "For guests that do not use drive mappings, or if the drive mappings could "
8129 "not be determined, this returns an empty hash table."
8133 #: ../fish/guestfish-actions.pod:1847
8135 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8136 "get-mountpoints>, L</inspect-get-filesystems>."
8140 #: ../fish/guestfish-actions.pod:1851
8141 msgid "inspect-get-filesystems"
8145 #: ../fish/guestfish-actions.pod:1853
8148 " inspect-get-filesystems root\n"
8153 #: ../fish/guestfish-actions.pod:1855 ../src/guestfs-actions.pod:2749
8155 "This returns a list of all the filesystems that we think are associated with "
8156 "this operating system. This includes the root filesystem, other ordinary "
8157 "filesystems, and non-mounted devices like swap partitions."
8161 #: ../fish/guestfish-actions.pod:1860 ../src/guestfs-actions.pod:2754
8163 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8164 "to be shared between operating systems."
8168 #: ../fish/guestfish-actions.pod:1863
8170 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8175 #: ../fish/guestfish-actions.pod:1866
8176 msgid "inspect-get-format"
8180 #: ../fish/guestfish-actions.pod:1868
8183 " inspect-get-format root\n"
8188 #: ../fish/guestfish-actions.pod:1870 ../src/guestfs-actions.pod:2772
8190 "This returns the format of the inspected operating system. You can use it "
8191 "to detect install images, live CDs and similar."
8195 #: ../fish/guestfish-actions.pod:1873 ../src/guestfs-actions.pod:2775
8196 msgid "Currently defined formats are:"
8200 #: ../fish/guestfish-actions.pod:1877 ../src/guestfs-actions.pod:2779
8201 msgid "\"installed\""
8205 #: ../fish/guestfish-actions.pod:1879 ../src/guestfs-actions.pod:2781
8206 msgid "This is an installed operating system."
8210 #: ../fish/guestfish-actions.pod:1881 ../src/guestfs-actions.pod:2783
8211 msgid "\"installer\""
8215 #: ../fish/guestfish-actions.pod:1883 ../src/guestfs-actions.pod:2785
8217 "The disk image being inspected is not an installed operating system, but a "
8218 "I<bootable> install disk, live CD, or similar."
8222 #: ../fish/guestfish-actions.pod:1888 ../src/guestfs-actions.pod:2790
8223 msgid "The format of this disk image is not known."
8227 #: ../fish/guestfish-actions.pod:1897
8228 msgid "inspect-get-hostname"
8232 #: ../fish/guestfish-actions.pod:1899
8235 " inspect-get-hostname root\n"
8240 #: ../fish/guestfish-actions.pod:1901 ../src/guestfs-actions.pod:2810
8242 "This function returns the hostname of the operating system as found by "
8243 "inspection of the guest's configuration files."
8247 #: ../fish/guestfish-actions.pod:1904 ../src/guestfs-actions.pod:2813
8249 "If the hostname could not be determined, then the string C<unknown> is "
8254 #: ../fish/guestfish-actions.pod:1909
8255 msgid "inspect-get-icon"
8259 #: ../fish/guestfish-actions.pod:1911
8262 " inspect-get-icon root [favicon:..] [highquality:..]\n"
8267 #: ../fish/guestfish-actions.pod:1913 ../src/guestfs-actions.pod:2839
8269 "This function returns an icon corresponding to the inspected operating "
8270 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
8271 "to PNG if necessary)."
8275 #: ../fish/guestfish-actions.pod:1917 ../src/guestfs-actions.pod:2843
8277 "If it was not possible to get an icon this function returns a zero-length "
8278 "(non-NULL) buffer. I<Callers must check for this case>."
8282 #: ../fish/guestfish-actions.pod:1920 ../src/guestfs-actions.pod:2846
8284 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
8285 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
8286 "this file will be returned. You can disable favicons by passing the "
8287 "optional C<favicon> boolean as false (default is true)."
8291 #: ../fish/guestfish-actions.pod:1926 ../src/guestfs-actions.pod:2852
8293 "If finding the favicon fails, then we look in other places in the guest for "
8298 #: ../fish/guestfish-actions.pod:1929 ../src/guestfs-actions.pod:2855
8300 "If the optional C<highquality> boolean is true then only high quality icons "
8301 "are returned, which means only icons of high resolution with an alpha "
8302 "channel. The default (false) is to return any icon we can, even if it is of "
8303 "substandard quality."
8307 #: ../fish/guestfish-actions.pod:1940 ../src/guestfs-actions.pod:2866
8309 "Unlike most other inspection API calls, the guest's disks must be mounted up "
8310 "before you call this, since it needs to read information from the guest "
8311 "filesystem during the call."
8315 #: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:2872
8317 "B<Security:> The icon data comes from the untrusted guest, and should be "
8318 "treated with caution. PNG files have been known to contain exploits. "
8319 "Ensure that libpng (or other relevant libraries) are fully up to date before "
8320 "trying to process or display the icon."
8324 #: ../fish/guestfish-actions.pod:1954 ../src/guestfs-actions.pod:2880
8326 "The PNG image returned can be any size. It might not be square. Libguestfs "
8327 "tries to return the largest, highest quality icon available. The "
8328 "application must scale the icon to the required size."
8332 #: ../fish/guestfish-actions.pod:1961 ../src/guestfs-actions.pod:2887
8334 "Extracting icons from Windows guests requires the external C<wrestool> "
8335 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
8336 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
8337 "installed separately."
8341 #: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:2894
8343 "Operating system icons are usually trademarks. Seek legal advice before "
8344 "using trademarks in applications."
8348 #: ../fish/guestfish-actions.pod:1975
8349 msgid "inspect-get-major-version"
8353 #: ../fish/guestfish-actions.pod:1977
8356 " inspect-get-major-version root\n"
8361 #: ../fish/guestfish-actions.pod:1979 ../src/guestfs-actions.pod:2935
8363 "This returns the major version number of the inspected operating system."
8367 #: ../fish/guestfish-actions.pod:1982 ../src/guestfs-actions.pod:2938
8369 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8370 "popular public names used by the operating system. Notably the operating "
8371 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8372 "1). You can find out the real versions corresponding to releases of Windows "
8373 "by consulting Wikipedia or MSDN."
8377 #: ../fish/guestfish-actions.pod:1989 ../fish/guestfish-actions.pod:2000
8378 #: ../src/guestfs-actions.pod:2945 ../src/guestfs-actions.pod:2962
8379 msgid "If the version could not be determined, then C<0> is returned."
8383 #: ../fish/guestfish-actions.pod:1993
8384 msgid "inspect-get-minor-version"
8388 #: ../fish/guestfish-actions.pod:1995
8391 " inspect-get-minor-version root\n"
8396 #: ../fish/guestfish-actions.pod:1997 ../src/guestfs-actions.pod:2959
8398 "This returns the minor version number of the inspected operating system."
8402 #: ../fish/guestfish-actions.pod:2002
8404 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8405 "get-major-version>."
8409 #: ../fish/guestfish-actions.pod:2005
8410 msgid "inspect-get-mountpoints"
8414 #: ../fish/guestfish-actions.pod:2007
8417 " inspect-get-mountpoints root\n"
8422 #: ../fish/guestfish-actions.pod:2009 ../src/guestfs-actions.pod:2977
8424 "This returns a hash of where we think the filesystems associated with this "
8425 "operating system should be mounted. Callers should note that this is at "
8426 "best an educated guess made by reading configuration files such as C</etc/"
8427 "fstab>. I<In particular note> that this may return filesystems which are "
8428 "non-existent or not mountable and callers should be prepared to handle or "
8429 "ignore failures if they try to mount them."
8433 #: ../fish/guestfish-actions.pod:2018 ../src/guestfs-actions.pod:2986
8435 "Each element in the returned hashtable has a key which is the path of the "
8436 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8437 "mounted there (eg. C</dev/sda1>)."
8441 #: ../fish/guestfish-actions.pod:2023 ../src/guestfs-actions.pod:2991
8443 "Non-mounted devices such as swap devices are I<not> returned in this list."
8447 #: ../fish/guestfish-actions.pod:2026
8449 "For operating systems like Windows which still use drive letters, this call "
8450 "will only return an entry for the first drive \"mounted on\" C</>. For "
8451 "information about the mapping of drive letters to partitions, see L</inspect-"
8452 "get-drive-mappings>."
8456 #: ../fish/guestfish-actions.pod:2032
8458 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8463 #: ../fish/guestfish-actions.pod:2035
8464 msgid "inspect-get-package-format"
8468 #: ../fish/guestfish-actions.pod:2037
8471 " inspect-get-package-format root\n"
8476 #: ../fish/guestfish-actions.pod:2039
8478 "This function and L</inspect-get-package-management> return the package "
8479 "format and package management tool used by the inspected operating system. "
8480 "For example for Fedora these functions would return C<rpm> (package format) "
8481 "and C<yum> (package management)."
8485 #: ../fish/guestfish-actions.pod:2045 ../src/guestfs-actions.pod:3023
8487 "This returns the string C<unknown> if we could not determine the package "
8488 "format I<or> if the operating system does not have a real packaging system "
8493 #: ../fish/guestfish-actions.pod:2049 ../src/guestfs-actions.pod:3027
8495 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
8496 "Future versions of libguestfs may return other strings."
8500 #: ../fish/guestfish-actions.pod:2054
8501 msgid "inspect-get-package-management"
8505 #: ../fish/guestfish-actions.pod:2056
8508 " inspect-get-package-management root\n"
8513 #: ../fish/guestfish-actions.pod:2058
8515 "L</inspect-get-package-format> and this function return the package format "
8516 "and package management tool used by the inspected operating system. For "
8517 "example for Fedora these functions would return C<rpm> (package format) and "
8518 "C<yum> (package management)."
8522 #: ../fish/guestfish-actions.pod:2064 ../src/guestfs-actions.pod:3049
8524 "This returns the string C<unknown> if we could not determine the package "
8525 "management tool I<or> if the operating system does not have a real packaging "
8526 "system (eg. Windows)."
8530 #: ../fish/guestfish-actions.pod:2068 ../src/guestfs-actions.pod:3053
8532 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8533 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
8534 "libguestfs may return other strings."
8538 #: ../fish/guestfish-actions.pod:2075
8539 msgid "inspect-get-product-name"
8543 #: ../fish/guestfish-actions.pod:2077
8546 " inspect-get-product-name root\n"
8551 #: ../fish/guestfish-actions.pod:2079 ../src/guestfs-actions.pod:3071
8553 "This returns the product name of the inspected operating system. The "
8554 "product name is generally some freeform string which can be displayed to the "
8555 "user, but should not be parsed by programs."
8559 #: ../fish/guestfish-actions.pod:2084 ../src/guestfs-actions.pod:3076
8561 "If the product name could not be determined, then the string C<unknown> is "
8566 #: ../fish/guestfish-actions.pod:2089
8567 msgid "inspect-get-product-variant"
8571 #: ../fish/guestfish-actions.pod:2091
8574 " inspect-get-product-variant root\n"
8579 #: ../fish/guestfish-actions.pod:2093 ../src/guestfs-actions.pod:3092
8580 msgid "This returns the product variant of the inspected operating system."
8584 #: ../fish/guestfish-actions.pod:2096 ../src/guestfs-actions.pod:3095
8586 "For Windows guests, this returns the contents of the Registry key C<HKLM"
8587 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
8588 "is usually a string such as C<Client> or C<Server> (other values are "
8589 "possible). This can be used to distinguish consumer and enterprise versions "
8590 "of Windows that have the same version number (for example, Windows 7 and "
8591 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
8592 "the latter is C<Server>)."
8596 #: ../fish/guestfish-actions.pod:2105 ../src/guestfs-actions.pod:3104
8598 "For enterprise Linux guests, in future we intend this to return the product "
8599 "variant such as C<Desktop>, C<Server> and so on. But this is not "
8600 "implemented at present."
8604 #: ../fish/guestfish-actions.pod:2109 ../src/guestfs-actions.pod:3108
8606 "If the product variant could not be determined, then the string C<unknown> "
8611 #: ../fish/guestfish-actions.pod:2112
8613 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8614 "get-product-name>, L</inspect-get-major-version>."
8618 #: ../fish/guestfish-actions.pod:2116
8619 msgid "inspect-get-roots"
8623 #: ../fish/guestfish-actions.pod:2118
8626 " inspect-get-roots\n"
8631 #: ../fish/guestfish-actions.pod:2120
8633 "This function is a convenient way to get the list of root devices, as "
8634 "returned from a previous call to L</inspect-os>, but without redoing the "
8635 "whole inspection process."
8639 #: ../fish/guestfish-actions.pod:2124
8641 "This returns an empty list if either no root devices were found or the "
8642 "caller has not called L</inspect-os>."
8646 #: ../fish/guestfish-actions.pod:2129
8647 msgid "inspect-get-type"
8651 #: ../fish/guestfish-actions.pod:2131
8654 " inspect-get-type root\n"
8659 #: ../fish/guestfish-actions.pod:2133 ../src/guestfs-actions.pod:3146
8661 "This returns the type of the inspected operating system. Currently defined "
8666 #: ../fish/guestfish-actions.pod:2138 ../src/guestfs-actions.pod:3151
8671 #: ../fish/guestfish-actions.pod:2140 ../src/guestfs-actions.pod:3153
8672 msgid "Any Linux-based operating system."
8676 #: ../fish/guestfish-actions.pod:2144 ../src/guestfs-actions.pod:3157
8677 msgid "Any Microsoft Windows operating system."
8681 #: ../fish/guestfish-actions.pod:2146 ../src/guestfs-actions.pod:3159
8686 #: ../fish/guestfish-actions.pod:2148 ../src/guestfs-actions.pod:3161
8691 #: ../fish/guestfish-actions.pod:2152 ../src/guestfs-actions.pod:3165
8692 msgid "The operating system type could not be determined."
8696 #: ../fish/guestfish-actions.pod:2161
8697 msgid "inspect-get-windows-current-control-set"
8701 #: ../fish/guestfish-actions.pod:2163
8704 " inspect-get-windows-current-control-set root\n"
8709 #: ../fish/guestfish-actions.pod:2165 ../src/guestfs-actions.pod:3185
8711 "This returns the Windows CurrentControlSet of the inspected guest. The "
8712 "CurrentControlSet is a registry key name such as C<ControlSet001>."
8716 #: ../fish/guestfish-actions.pod:2168 ../src/guestfs-actions.pod:3188
8718 "This call assumes that the guest is Windows and that the Registry could be "
8719 "examined by inspection. If this is not the case then an error is returned."
8723 #: ../fish/guestfish-actions.pod:2174
8724 msgid "inspect-get-windows-systemroot"
8728 #: ../fish/guestfish-actions.pod:2176
8731 " inspect-get-windows-systemroot root\n"
8736 #: ../fish/guestfish-actions.pod:2178 ../src/guestfs-actions.pod:3205
8738 "This returns the Windows systemroot of the inspected guest. The systemroot "
8739 "is a directory path such as C</WINDOWS>."
8743 #: ../fish/guestfish-actions.pod:2181 ../src/guestfs-actions.pod:3208
8745 "This call assumes that the guest is Windows and that the systemroot could be "
8746 "determined by inspection. If this is not the case then an error is returned."
8750 #: ../fish/guestfish-actions.pod:2187
8751 msgid "inspect-is-live"
8755 #: ../fish/guestfish-actions.pod:2189
8758 " inspect-is-live root\n"
8763 #: ../fish/guestfish-actions.pod:2191
8765 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8766 "then this returns true if a live image was detected on the disk."
8770 #: ../fish/guestfish-actions.pod:2197
8771 msgid "inspect-is-multipart"
8775 #: ../fish/guestfish-actions.pod:2199
8778 " inspect-is-multipart root\n"
8783 #: ../fish/guestfish-actions.pod:2201
8785 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8786 "then this returns true if the disk is part of a set."
8790 #: ../fish/guestfish-actions.pod:2207
8791 msgid "inspect-is-netinst"
8795 #: ../fish/guestfish-actions.pod:2209
8798 " inspect-is-netinst root\n"
8803 #: ../fish/guestfish-actions.pod:2211
8805 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8806 "then this returns true if the disk is a network installer, ie. not a self-"
8807 "contained install CD but one which is likely to require network access to "
8808 "complete the install."
8812 #: ../fish/guestfish-actions.pod:2219
8813 msgid "inspect-list-applications"
8817 #: ../fish/guestfish-actions.pod:2221
8820 " inspect-list-applications root\n"
8825 #: ../fish/guestfish-actions.pod:2223 ../src/guestfs-actions.pod:3275
8826 msgid "Return the list of applications installed in the operating system."
8830 #: ../fish/guestfish-actions.pod:2225
8832 "I<Note:> This call works differently from other parts of the inspection "
8833 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
8834 "then mount up the disks, before calling this. Listing applications is a "
8835 "significantly more difficult operation which requires access to the full "
8836 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
8837 "are just returning data cached in the libguestfs handle, this call actually "
8838 "reads parts of the mounted filesystems during the call."
8842 #: ../fish/guestfish-actions.pod:2235 ../src/guestfs-actions.pod:3287
8844 "This returns an empty list if the inspection code was not able to determine "
8845 "the list of applications."
8849 #: ../fish/guestfish-actions.pod:2238 ../src/guestfs-actions.pod:3290
8850 msgid "The application structure contains the following fields:"
8854 #: ../fish/guestfish-actions.pod:2242 ../src/guestfs-actions.pod:3294
8859 #: ../fish/guestfish-actions.pod:2244 ../src/guestfs-actions.pod:3296
8861 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8862 "guests, this is the package name."
8866 #: ../fish/guestfish-actions.pod:2247 ../src/guestfs-actions.pod:3299
8867 msgid "C<app_display_name>"
8871 #: ../fish/guestfish-actions.pod:2249 ../src/guestfs-actions.pod:3301
8873 "The display name of the application, sometimes localized to the install "
8874 "language of the guest operating system."
8878 #: ../fish/guestfish-actions.pod:2252 ../src/guestfs-actions.pod:3304
8880 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8881 "to display something can use C<app_name> instead."
8885 #: ../fish/guestfish-actions.pod:2255 ../src/guestfs-actions.pod:3307
8886 msgid "C<app_epoch>"
8890 #: ../fish/guestfish-actions.pod:2257 ../src/guestfs-actions.pod:3309
8892 "For package managers which use epochs, this contains the epoch of the "
8893 "package (an integer). If unavailable, this is returned as C<0>."
8897 #: ../fish/guestfish-actions.pod:2260 ../src/guestfs-actions.pod:3312
8898 msgid "C<app_version>"
8902 #: ../fish/guestfish-actions.pod:2262 ../src/guestfs-actions.pod:3314
8904 "The version string of the application or package. If unavailable this is "
8905 "returned as an empty string C<\"\">."
8909 #: ../fish/guestfish-actions.pod:2265 ../src/guestfs-actions.pod:3317
8910 msgid "C<app_release>"
8914 #: ../fish/guestfish-actions.pod:2267 ../src/guestfs-actions.pod:3319
8916 "The release string of the application or package, for package managers that "
8917 "use this. If unavailable this is returned as an empty string C<\"\">."
8921 #: ../fish/guestfish-actions.pod:2271 ../src/guestfs-actions.pod:3323
8922 msgid "C<app_install_path>"
8926 #: ../fish/guestfish-actions.pod:2273 ../src/guestfs-actions.pod:3325
8928 "The installation path of the application (on operating systems such as "
8929 "Windows which use installation paths). This path is in the format used by "
8930 "the guest operating system, it is not a libguestfs path."
8934 #: ../fish/guestfish-actions.pod:2278 ../src/guestfs-actions.pod:3330
8935 msgid "If unavailable this is returned as an empty string C<\"\">."
8939 #: ../fish/guestfish-actions.pod:2280 ../src/guestfs-actions.pod:3332
8940 msgid "C<app_trans_path>"
8944 #: ../fish/guestfish-actions.pod:2282 ../src/guestfs-actions.pod:3334
8946 "The install path translated into a libguestfs path. If unavailable this is "
8947 "returned as an empty string C<\"\">."
8951 #: ../fish/guestfish-actions.pod:2285 ../src/guestfs-actions.pod:3337
8952 msgid "C<app_publisher>"
8956 #: ../fish/guestfish-actions.pod:2287 ../src/guestfs-actions.pod:3339
8958 "The name of the publisher of the application, for package managers that use "
8959 "this. If unavailable this is returned as an empty string C<\"\">."
8963 #: ../fish/guestfish-actions.pod:2291 ../src/guestfs-actions.pod:3343
8968 #: ../fish/guestfish-actions.pod:2293 ../src/guestfs-actions.pod:3345
8970 "The URL (eg. upstream URL) of the application. If unavailable this is "
8971 "returned as an empty string C<\"\">."
8975 #: ../fish/guestfish-actions.pod:2296 ../src/guestfs-actions.pod:3348
8976 msgid "C<app_source_package>"
8980 #: ../fish/guestfish-actions.pod:2298 ../src/guestfs-actions.pod:3350
8982 "For packaging systems which support this, the name of the source package. "
8983 "If unavailable this is returned as an empty string C<\"\">."
8987 #: ../fish/guestfish-actions.pod:2301 ../src/guestfs-actions.pod:3353
8988 msgid "C<app_summary>"
8992 #: ../fish/guestfish-actions.pod:2303 ../src/guestfs-actions.pod:3355
8994 "A short (usually one line) description of the application or package. If "
8995 "unavailable this is returned as an empty string C<\"\">."
8999 #: ../fish/guestfish-actions.pod:2306 ../src/guestfs-actions.pod:3358
9000 msgid "C<app_description>"
9004 #: ../fish/guestfish-actions.pod:2308 ../src/guestfs-actions.pod:3360
9006 "A longer description of the application or package. If unavailable this is "
9007 "returned as an empty string C<\"\">."
9011 #: ../fish/guestfish-actions.pod:2315
9016 #: ../fish/guestfish-actions.pod:2317
9024 #: ../fish/guestfish-actions.pod:2319 ../src/guestfs-actions.pod:3378
9026 "This function uses other libguestfs functions and certain heuristics to "
9027 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9028 "for operating systems."
9032 #: ../fish/guestfish-actions.pod:2323 ../src/guestfs-actions.pod:3382
9033 msgid "The list returned is empty if no operating systems were found."
9037 #: ../fish/guestfish-actions.pod:2325 ../src/guestfs-actions.pod:3384
9039 "If one operating system was found, then this returns a list with a single "
9040 "element, which is the name of the root filesystem of this operating system. "
9041 "It is also possible for this function to return a list containing more than "
9042 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9043 "element being the root filesystem of one of the operating systems."
9047 #: ../fish/guestfish-actions.pod:2332
9049 "You can pass the root string(s) returned to other L</inspect-get-*> "
9050 "functions in order to query further information about each operating system, "
9051 "such as the name and version."
9055 #: ../fish/guestfish-actions.pod:2337
9057 "This function uses other libguestfs features such as L</mount-ro> and L</"
9058 "umount-all> in order to mount and unmount filesystems and look at the "
9059 "contents. This should be called with no disks currently mounted. The "
9060 "function may also use Augeas, so any existing Augeas handle will be closed."
9064 #: ../fish/guestfish-actions.pod:2343 ../src/guestfs-actions.pod:3402
9066 "This function cannot decrypt encrypted disks. The caller must do that first "
9067 "(supplying the necessary keys) if the disk is encrypted."
9071 #: ../fish/guestfish-actions.pod:2349 ../fish/guestfish-actions.pod:2547
9072 #: ../fish/guestfish-actions.pod:2606
9073 msgid "See also L</list-filesystems>."
9077 #: ../fish/guestfish-actions.pod:2351
9082 #: ../fish/guestfish-actions.pod:2353
9085 " is-blockdev path\n"
9090 #: ../fish/guestfish-actions.pod:2355 ../src/guestfs-actions.pod:3422
9092 "This returns C<true> if and only if there is a block device with the given "
9097 #: ../fish/guestfish-actions.pod:2358 ../fish/guestfish-actions.pod:2376
9098 #: ../fish/guestfish-actions.pod:2395 ../fish/guestfish-actions.pod:2404
9099 #: ../fish/guestfish-actions.pod:2414 ../fish/guestfish-actions.pod:2448
9100 #: ../fish/guestfish-actions.pod:2457
9101 msgid "See also L</stat>."
9105 #: ../fish/guestfish-actions.pod:2360
9110 #: ../fish/guestfish-actions.pod:2362
9118 #: ../fish/guestfish-actions.pod:2364 ../src/guestfs-actions.pod:3436
9120 "This returns true iff this handle is busy processing a command (in the "
9125 #: ../fish/guestfish-actions.pod:2369
9130 #: ../fish/guestfish-actions.pod:2371
9133 " is-chardev path\n"
9138 #: ../fish/guestfish-actions.pod:2373 ../src/guestfs-actions.pod:3451
9140 "This returns C<true> if and only if there is a character device with the "
9141 "given C<path> name."
9145 #: ../fish/guestfish-actions.pod:2378
9150 #: ../fish/guestfish-actions.pod:2380
9158 #: ../fish/guestfish-actions.pod:2382 ../src/guestfs-actions.pod:3465
9160 "This returns true iff this handle is being configured (in the C<CONFIG> "
9165 #: ../fish/guestfish-actions.pod:2387
9170 #: ../fish/guestfish-actions.pod:2389
9178 #: ../fish/guestfish-actions.pod:2391 ../src/guestfs-actions.pod:3480
9180 "This returns C<true> if and only if there is a directory with the given "
9181 "C<path> name. Note that it returns false for other objects like files."
9185 #: ../fish/guestfish-actions.pod:2397
9190 #: ../fish/guestfish-actions.pod:2399
9198 #: ../fish/guestfish-actions.pod:2401 ../src/guestfs-actions.pod:3496
9200 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9201 "given C<path> name."
9205 #: ../fish/guestfish-actions.pod:2406
9210 #: ../fish/guestfish-actions.pod:2408
9218 #: ../fish/guestfish-actions.pod:2410 ../src/guestfs-actions.pod:3511
9220 "This returns C<true> if and only if there is a regular file with the given "
9221 "C<path> name. Note that it returns false for other objects like directories."
9225 #: ../fish/guestfish-actions.pod:2416
9226 msgid "is-launching"
9230 #: ../fish/guestfish-actions.pod:2418
9238 #: ../fish/guestfish-actions.pod:2420 ../src/guestfs-actions.pod:3526
9240 "This returns true iff this handle is launching the subprocess (in the "
9241 "C<LAUNCHING> state)."
9245 #: ../fish/guestfish-actions.pod:2425
9250 #: ../fish/guestfish-actions.pod:2427
9258 #: ../fish/guestfish-actions.pod:2429 ../src/guestfs-actions.pod:3541
9260 "This command tests whether C<device> is a logical volume, and returns true "
9261 "iff this is the case."
9265 #: ../fish/guestfish-actions.pod:2432
9270 #: ../fish/guestfish-actions.pod:2434
9278 #: ../fish/guestfish-actions.pod:2436 ../src/guestfs-actions.pod:3553
9280 "This returns true iff this handle is ready to accept commands (in the "
9285 #: ../fish/guestfish-actions.pod:2441
9290 #: ../fish/guestfish-actions.pod:2443
9298 #: ../fish/guestfish-actions.pod:2445 ../src/guestfs-actions.pod:3568
9300 "This returns C<true> if and only if there is a Unix domain socket with the "
9301 "given C<path> name."
9305 #: ../fish/guestfish-actions.pod:2450
9310 #: ../fish/guestfish-actions.pod:2452
9313 " is-symlink path\n"
9318 #: ../fish/guestfish-actions.pod:2454 ../src/guestfs-actions.pod:3583
9320 "This returns C<true> if and only if there is a symbolic link with the given "
9325 #: ../fish/guestfish-actions.pod:2459
9330 #: ../fish/guestfish-actions.pod:2461
9338 #: ../fish/guestfish-actions.pod:2463 ../src/guestfs-actions.pod:3598
9340 "This returns true iff the file exists and the file is empty or it contains "
9345 #: ../fish/guestfish-actions.pod:2466
9346 msgid "is-zero-device"
9350 #: ../fish/guestfish-actions.pod:2468
9353 " is-zero-device device\n"
9358 #: ../fish/guestfish-actions.pod:2470 ../src/guestfs-actions.pod:3611
9359 msgid "This returns true iff the device exists and contains all zero bytes."
9363 #: ../fish/guestfish-actions.pod:2472 ../src/guestfs-actions.pod:3613
9364 msgid "Note that for large devices this can take a long time to run."
9368 #: ../fish/guestfish-actions.pod:2474
9369 msgid "kill-subprocess"
9373 #: ../fish/guestfish-actions.pod:2476
9376 " kill-subprocess\n"
9381 #: ../fish/guestfish-actions.pod:2478 ../src/guestfs-actions.pod:3624
9382 msgid "This kills the qemu subprocess. You should never need to call this."
9386 #: ../fish/guestfish-actions.pod:2480
9391 #: ../fish/guestfish-actions.pod:2482
9396 #: ../fish/guestfish-actions.pod:2484
9404 #: ../fish/guestfish-actions.pod:2486 ../src/guestfs-actions.pod:3635
9406 "Internally libguestfs is implemented by running a virtual machine using "
9411 #: ../fish/guestfish-actions.pod:2489 ../src/guestfs-actions.pod:3638
9413 "You should call this after configuring the handle (eg. adding drives) but "
9414 "before performing any actions."
9418 #: ../fish/guestfish-actions.pod:2492
9423 #: ../fish/guestfish-actions.pod:2494
9426 " lchown owner group path\n"
9431 #: ../fish/guestfish-actions.pod:2496
9433 "Change the file owner to C<owner> and group to C<group>. This is like L</"
9434 "chown> but if C<path> is a symlink then the link itself is changed, not the "
9439 #: ../fish/guestfish-actions.pod:2504
9444 #: ../fish/guestfish-actions.pod:2506
9447 " lgetxattr path name\n"
9452 #: ../fish/guestfish-actions.pod:2508 ../src/guestfs-actions.pod:3678
9454 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
9455 "is a symlink, then this call returns an extended attribute from the symlink."
9459 #: ../fish/guestfish-actions.pod:2522
9460 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
9464 #: ../fish/guestfish-actions.pod:2524
9469 #: ../fish/guestfish-actions.pod:2526
9472 " lgetxattrs path\n"
9477 #: ../fish/guestfish-actions.pod:2528
9479 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
9480 "it returns the extended attributes of the link itself."
9484 #: ../fish/guestfish-actions.pod:2532
9489 #: ../fish/guestfish-actions.pod:2534
9497 #: ../fish/guestfish-actions.pod:2536 ../src/guestfs-actions.pod:3721
9499 "List all 9p filesystems attached to the guest. A list of mount tags is "
9504 #: ../fish/guestfish-actions.pod:2539
9505 msgid "list-devices"
9509 #: ../fish/guestfish-actions.pod:2541
9517 #: ../fish/guestfish-actions.pod:2543 ../src/guestfs-actions.pod:3735
9518 msgid "List all the block devices."
9522 #: ../fish/guestfish-actions.pod:2545 ../src/guestfs-actions.pod:3737
9523 msgid "The full block device names are returned, eg. C</dev/sda>."
9527 #: ../fish/guestfish-actions.pod:2549
9528 msgid "list-dm-devices"
9532 #: ../fish/guestfish-actions.pod:2551
9535 " list-dm-devices\n"
9540 #: ../fish/guestfish-actions.pod:2553 ../src/guestfs-actions.pod:3752
9541 msgid "List all device mapper devices."
9545 #: ../fish/guestfish-actions.pod:2555
9547 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
9548 "previous call to L</luks-open>."
9552 #: ../fish/guestfish-actions.pod:2558
9554 "Device mapper devices which correspond to logical volumes are I<not> "
9555 "returned in this list. Call L</lvs> if you want to list logical volumes."
9559 #: ../fish/guestfish-actions.pod:2562
9560 msgid "list-filesystems"
9564 #: ../fish/guestfish-actions.pod:2564
9567 " list-filesystems\n"
9572 #: ../fish/guestfish-actions.pod:2566 ../src/guestfs-actions.pod:3772
9574 "This inspection command looks for filesystems on partitions, block devices "
9575 "and logical volumes, returning a list of devices containing filesystems and "
9580 #: ../fish/guestfish-actions.pod:2570 ../src/guestfs-actions.pod:3776
9582 "The return value is a hash, where the keys are the devices containing "
9583 "filesystems, and the values are the filesystem types. For example:"
9587 #: ../fish/guestfish-actions.pod:2574 ../src/guestfs-actions.pod:3780
9590 " \"/dev/sda1\" => \"ntfs\"\n"
9591 " \"/dev/sda2\" => \"ext2\"\n"
9592 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9593 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9598 #: ../fish/guestfish-actions.pod:2579 ../src/guestfs-actions.pod:3785
9600 "The value can have the special value \"unknown\", meaning the content of the "
9601 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9605 #: ../fish/guestfish-actions.pod:2583
9607 "This command runs other libguestfs commands, which might include L</mount> "
9608 "and L</umount>, and therefore you should use this soon after launch and only "
9609 "when nothing is mounted."
9613 #: ../fish/guestfish-actions.pod:2587
9615 "Not all of the filesystems returned will be mountable. In particular, swap "
9616 "partitions are returned in the list. Also this command does not check that "
9617 "each filesystem found is valid and mountable, and some filesystems might be "
9618 "mountable but require special options. Filesystems may not all belong to a "
9619 "single logical operating system (use L</inspect-os> to look for OSes)."
9623 #: ../fish/guestfish-actions.pod:2595
9624 msgid "list-partitions"
9628 #: ../fish/guestfish-actions.pod:2597
9631 " list-partitions\n"
9636 #: ../fish/guestfish-actions.pod:2599 ../src/guestfs-actions.pod:3814
9637 msgid "List all the partitions detected on all block devices."
9641 #: ../fish/guestfish-actions.pod:2601 ../src/guestfs-actions.pod:3816
9642 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9646 #: ../fish/guestfish-actions.pod:2603
9648 "This does not return logical volumes. For that you will need to call L</"
9653 #: ../fish/guestfish-actions.pod:2608
9658 #: ../fish/guestfish-actions.pod:2610
9666 #: ../fish/guestfish-actions.pod:2612 ../src/guestfs-actions.pod:3835
9668 "List the files in C<directory> (relative to the root directory, there is no "
9669 "cwd) in the format of 'ls -la'."
9673 #: ../fish/guestfish-actions.pod:2615 ../src/guestfs-actions.pod:3838
9675 "This command is mostly useful for interactive sessions. It is I<not> "
9676 "intended that you try to parse the output string."
9680 #: ../fish/guestfish-actions.pod:2618
9685 #: ../fish/guestfish-actions.pod:2620
9688 " ln target linkname\n"
9693 #: ../fish/guestfish-actions.pod:2622 ../src/guestfs-actions.pod:3853
9694 msgid "This command creates a hard link using the C<ln> command."
9698 #: ../fish/guestfish-actions.pod:2624
9703 #: ../fish/guestfish-actions.pod:2626
9706 " ln-f target linkname\n"
9711 #: ../fish/guestfish-actions.pod:2628 ../src/guestfs-actions.pod:3866
9713 "This command creates a hard link using the C<ln -f> command. The I<-f> "
9714 "option removes the link (C<linkname>) if it exists already."
9718 #: ../fish/guestfish-actions.pod:2631
9723 #: ../fish/guestfish-actions.pod:2633
9726 " ln-s target linkname\n"
9731 #: ../fish/guestfish-actions.pod:2635 ../src/guestfs-actions.pod:3880
9732 msgid "This command creates a symbolic link using the C<ln -s> command."
9736 #: ../fish/guestfish-actions.pod:2637
9741 #: ../fish/guestfish-actions.pod:2639
9744 " ln-sf target linkname\n"
9749 #: ../fish/guestfish-actions.pod:2641 ../src/guestfs-actions.pod:3893
9751 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
9752 "option removes the link (C<linkname>) if it exists already."
9756 #: ../fish/guestfish-actions.pod:2644
9757 msgid "lremovexattr"
9761 #: ../fish/guestfish-actions.pod:2646
9764 " lremovexattr xattr path\n"
9769 #: ../fish/guestfish-actions.pod:2648
9771 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
9772 "it removes an extended attribute of the link itself."
9776 #: ../fish/guestfish-actions.pod:2652
9781 #: ../fish/guestfish-actions.pod:2654
9789 #: ../fish/guestfish-actions.pod:2656 ../src/guestfs-actions.pod:3921
9791 "List the files in C<directory> (relative to the root directory, there is no "
9792 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
9796 #: ../fish/guestfish-actions.pod:2660
9798 "This command is mostly useful for interactive sessions. Programs should "
9799 "probably use L</readdir> instead."
9803 #: ../fish/guestfish-actions.pod:2663
9808 #: ../fish/guestfish-actions.pod:2665
9811 " lsetxattr xattr val vallen path\n"
9816 #: ../fish/guestfish-actions.pod:2667
9818 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
9819 "sets an extended attribute of the link itself."
9823 #: ../fish/guestfish-actions.pod:2671
9828 #: ../fish/guestfish-actions.pod:2673
9836 #: ../fish/guestfish-actions.pod:2675 ../fish/guestfish-actions.pod:4483
9837 #: ../src/guestfs-actions.pod:3957 ../src/guestfs-actions.pod:6736
9838 msgid "Returns file information for the given C<path>."
9842 #: ../fish/guestfish-actions.pod:2677
9844 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
9845 "the link is stat-ed, not the file it refers to."
9849 #: ../fish/guestfish-actions.pod:2681 ../src/guestfs-actions.pod:3963
9850 msgid "This is the same as the C<lstat(2)> system call."
9854 #: ../fish/guestfish-actions.pod:2683
9859 #: ../fish/guestfish-actions.pod:2685
9862 " lstatlist path 'names ...'\n"
9867 #: ../fish/guestfish-actions.pod:2687
9869 "This call allows you to perform the L</lstat> operation on multiple files, "
9870 "where all files are in the directory C<path>. C<names> is the list of files "
9871 "from this directory."
9875 #: ../fish/guestfish-actions.pod:2691 ../src/guestfs-actions.pod:3982
9877 "On return you get a list of stat structs, with a one-to-one correspondence "
9878 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9879 "then the C<ino> field of that structure is set to C<-1>."
9883 #: ../fish/guestfish-actions.pod:2696
9885 "This call is intended for programs that want to efficiently list a directory "
9886 "contents without making many round-trips. See also L</lxattrlist> for a "
9887 "similarly efficient call for getting extended attributes. Very long "
9888 "directory listings might cause the protocol message size to be exceeded, "
9889 "causing this call to fail. The caller must split up such requests into "
9890 "smaller groups of names."
9894 #: ../fish/guestfish-actions.pod:2704
9895 msgid "luks-add-key"
9899 #: ../fish/guestfish-actions.pod:2706
9902 " luks-add-key device keyslot\n"
9907 #: ../fish/guestfish-actions.pod:2708 ../src/guestfs-actions.pod:4010
9909 "This command adds a new key on LUKS device C<device>. C<key> is any "
9910 "existing key, and is used to access the device. C<newkey> is the new key to "
9911 "add. C<keyslot> is the key slot that will be replaced."
9915 #: ../fish/guestfish-actions.pod:2713
9917 "Note that if C<keyslot> already contains a key, then this command will "
9918 "fail. You have to use L</luks-kill-slot> first to remove that key."
9922 #: ../fish/guestfish-actions.pod:2717 ../fish/guestfish-actions.pod:2739
9923 #: ../fish/guestfish-actions.pod:2752 ../fish/guestfish-actions.pod:2766
9924 #: ../fish/guestfish-actions.pod:2792 ../fish/guestfish-actions.pod:2802
9926 "This command has one or more key or passphrase parameters. Guestfish will "
9927 "prompt for these separately."
9931 #: ../fish/guestfish-actions.pod:2720
9936 #: ../fish/guestfish-actions.pod:2722
9939 " luks-close device\n"
9944 #: ../fish/guestfish-actions.pod:2724
9946 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
9947 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
9948 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
9953 #: ../fish/guestfish-actions.pod:2730
9958 #: ../fish/guestfish-actions.pod:2732
9961 " luks-format device keyslot\n"
9966 #: ../fish/guestfish-actions.pod:2734 ../src/guestfs-actions.pod:4051
9968 "This command erases existing data on C<device> and formats the device as a "
9969 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9970 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9974 #: ../fish/guestfish-actions.pod:2742 ../fish/guestfish-actions.pod:2755
9975 #: ../fish/guestfish-actions.pod:2842 ../fish/guestfish-actions.pod:3503
9976 #: ../fish/guestfish-actions.pod:4029 ../fish/guestfish-actions.pod:4354
9977 #: ../fish/guestfish-actions.pod:4377 ../fish/guestfish-actions.pod:4399
9978 #: ../fish/guestfish-actions.pod:5145 ../src/guestfs-actions.pod:4058
9979 #: ../src/guestfs-actions.pod:4081 ../src/guestfs-actions.pod:4224
9980 #: ../src/guestfs-actions.pod:5327 ../src/guestfs-actions.pod:6115
9981 #: ../src/guestfs-actions.pod:6543 ../src/guestfs-actions.pod:6573
9982 #: ../src/guestfs-actions.pod:6606 ../src/guestfs-actions.pod:7812
9984 "B<This command is dangerous. Without careful use you can easily destroy all "
9989 #: ../fish/guestfish-actions.pod:2745
9990 msgid "luks-format-cipher"
9994 #: ../fish/guestfish-actions.pod:2747
9997 " luks-format-cipher device keyslot cipher\n"
10002 #: ../fish/guestfish-actions.pod:2749
10004 "This command is the same as L</luks-format> but it also allows you to set "
10005 "the C<cipher> used."
10009 #: ../fish/guestfish-actions.pod:2758
10010 msgid "luks-kill-slot"
10014 #: ../fish/guestfish-actions.pod:2760
10017 " luks-kill-slot device keyslot\n"
10022 #: ../fish/guestfish-actions.pod:2762 ../src/guestfs-actions.pod:4098
10024 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10025 "device C<device>. C<key> must be one of the I<other> keys."
10029 #: ../fish/guestfish-actions.pod:2769
10034 #: ../fish/guestfish-actions.pod:2771
10037 " luks-open device mapname\n"
10042 #: ../fish/guestfish-actions.pod:2773 ../src/guestfs-actions.pod:4118
10044 "This command opens a block device which has been encrypted according to the "
10045 "Linux Unified Key Setup (LUKS) standard."
10049 #: ../fish/guestfish-actions.pod:2776 ../src/guestfs-actions.pod:4121
10050 msgid "C<device> is the encrypted block device or partition."
10054 #: ../fish/guestfish-actions.pod:2778 ../src/guestfs-actions.pod:4123
10056 "The caller must supply one of the keys associated with the LUKS block "
10057 "device, in the C<key> parameter."
10061 #: ../fish/guestfish-actions.pod:2781 ../src/guestfs-actions.pod:4126
10063 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10064 "writes to this block device are decrypted from and encrypted to the "
10065 "underlying C<device> respectively."
10069 #: ../fish/guestfish-actions.pod:2785
10071 "If this block device contains LVM volume groups, then calling L</vgscan> "
10072 "followed by L</vg-activate-all> will make them visible."
10076 #: ../fish/guestfish-actions.pod:2789
10077 msgid "Use L</list-dm-devices> to list all device mapper devices."
10081 #: ../fish/guestfish-actions.pod:2795
10082 msgid "luks-open-ro"
10086 #: ../fish/guestfish-actions.pod:2797
10089 " luks-open-ro device mapname\n"
10094 #: ../fish/guestfish-actions.pod:2799
10096 "This is the same as L</luks-open> except that a read-only mapping is created."
10100 #: ../fish/guestfish-actions.pod:2805
10105 #: ../fish/guestfish-actions.pod:2807
10108 " lvcreate logvol volgroup mbytes\n"
10113 #: ../fish/guestfish-actions.pod:2809 ../src/guestfs-actions.pod:4172
10115 "This creates an LVM logical volume called C<logvol> on the volume group "
10116 "C<volgroup>, with C<size> megabytes."
10120 #: ../fish/guestfish-actions.pod:2812
10121 msgid "lvm-canonical-lv-name"
10125 #: ../fish/guestfish-actions.pod:2814
10128 " lvm-canonical-lv-name lvname\n"
10133 #: ../fish/guestfish-actions.pod:2816 ../src/guestfs-actions.pod:4185
10135 "This converts alternative naming schemes for LVs that you might find to the "
10136 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10141 #: ../fish/guestfish-actions.pod:2820 ../src/guestfs-actions.pod:4189
10143 "This command returns an error if the C<lvname> parameter does not refer to a "
10148 #: ../fish/guestfish-actions.pod:2823
10149 msgid "See also L</is-lv>."
10153 #: ../fish/guestfish-actions.pod:2825
10154 msgid "lvm-clear-filter"
10158 #: ../fish/guestfish-actions.pod:2827
10161 " lvm-clear-filter\n"
10166 #: ../fish/guestfish-actions.pod:2829
10168 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
10173 #: ../fish/guestfish-actions.pod:2832 ../fish/guestfish-actions.pod:2863
10174 #: ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4249
10176 "This command also clears the LVM cache and performs a volume group scan."
10180 #: ../fish/guestfish-actions.pod:2835
10181 msgid "lvm-remove-all"
10185 #: ../fish/guestfish-actions.pod:2837
10188 " lvm-remove-all\n"
10193 #: ../fish/guestfish-actions.pod:2839 ../src/guestfs-actions.pod:4219
10195 "This command removes all LVM logical volumes, volume groups and physical "
10200 #: ../fish/guestfish-actions.pod:2845
10201 msgid "lvm-set-filter"
10205 #: ../fish/guestfish-actions.pod:2847
10208 " lvm-set-filter 'devices ...'\n"
10213 #: ../fish/guestfish-actions.pod:2849 ../src/guestfs-actions.pod:4235
10215 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10216 "block devices in the list C<devices>, and will ignore all other attached "
10221 #: ../fish/guestfish-actions.pod:2853 ../src/guestfs-actions.pod:4239
10223 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10224 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10225 "there are two types of duplication possible: either cloned PVs/VGs which "
10226 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10227 "same name. In normal operation you cannot create this situation, but you "
10228 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10229 "inside the LVM metadata."
10233 #: ../fish/guestfish-actions.pod:2866 ../src/guestfs-actions.pod:4252
10234 msgid "You can filter whole block devices or individual partitions."
10238 #: ../fish/guestfish-actions.pod:2868 ../src/guestfs-actions.pod:4254
10240 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10241 "filesystem), even if you are not filtering out that VG."
10245 #: ../fish/guestfish-actions.pod:2872
10250 #: ../fish/guestfish-actions.pod:2874
10253 " lvremove device\n"
10258 #: ../fish/guestfish-actions.pod:2876 ../src/guestfs-actions.pod:4268
10260 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10261 "LV, such as C</dev/VG/LV>."
10265 #: ../fish/guestfish-actions.pod:2879 ../src/guestfs-actions.pod:4271
10267 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10272 #: ../fish/guestfish-actions.pod:2882
10277 #: ../fish/guestfish-actions.pod:2884
10280 " lvrename logvol newlogvol\n"
10285 #: ../fish/guestfish-actions.pod:2886 ../src/guestfs-actions.pod:4285
10286 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10290 #: ../fish/guestfish-actions.pod:2888
10295 #: ../fish/guestfish-actions.pod:2890
10298 " lvresize device mbytes\n"
10303 #: ../fish/guestfish-actions.pod:2892 ../src/guestfs-actions.pod:4298
10305 "This resizes (expands or shrinks) an existing LVM logical volume to "
10306 "C<mbytes>. When reducing, data in the reduced part is lost."
10310 #: ../fish/guestfish-actions.pod:2896
10311 msgid "lvresize-free"
10315 #: ../fish/guestfish-actions.pod:2898
10318 " lvresize-free lv percent\n"
10323 #: ../fish/guestfish-actions.pod:2900 ../src/guestfs-actions.pod:4313
10325 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10326 "remaining free space in the volume group. Commonly you would call this with "
10327 "pc = 100 which expands the logical volume as much as possible, using all "
10328 "remaining free space in the volume group."
10332 #: ../fish/guestfish-actions.pod:2906
10337 #: ../fish/guestfish-actions.pod:2908
10345 #: ../fish/guestfish-actions.pod:2910 ../src/guestfs-actions.pod:4328
10347 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10352 #: ../fish/guestfish-actions.pod:2913 ../src/guestfs-actions.pod:4331
10354 "This returns a list of the logical volume device names (eg. C</dev/"
10355 "VolGroup00/LogVol00>)."
10359 #: ../fish/guestfish-actions.pod:2916
10360 msgid "See also L</lvs-full>, L</list-filesystems>."
10364 #: ../fish/guestfish-actions.pod:2918
10369 #: ../fish/guestfish-actions.pod:2920
10377 #: ../fish/guestfish-actions.pod:2922 ../src/guestfs-actions.pod:4347
10379 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10380 "(8)> command. The \"full\" version includes all fields."
10384 #: ../fish/guestfish-actions.pod:2925
10389 #: ../fish/guestfish-actions.pod:2927
10397 #: ../fish/guestfish-actions.pod:2929 ../src/guestfs-actions.pod:4362
10398 msgid "This command returns the UUID of the LVM LV C<device>."
10402 #: ../fish/guestfish-actions.pod:2931
10407 #: ../fish/guestfish-actions.pod:2933
10410 " lxattrlist path 'names ...'\n"
10415 #: ../fish/guestfish-actions.pod:2935 ../src/guestfs-actions.pod:4376
10417 "This call allows you to get the extended attributes of multiple files, where "
10418 "all files are in the directory C<path>. C<names> is the list of files from "
10423 #: ../fish/guestfish-actions.pod:2939 ../src/guestfs-actions.pod:4380
10425 "On return you get a flat list of xattr structs which must be interpreted "
10426 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10427 "C<attrval> in this struct is zero-length to indicate there was an error "
10428 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10429 "number (the number of following attributes for this file, which could be C<"
10430 "\"0\">). Then after the first xattr struct are the zero or more attributes "
10431 "for the first named file. This repeats for the second and subsequent files."
10435 #: ../fish/guestfish-actions.pod:2949
10437 "This call is intended for programs that want to efficiently list a directory "
10438 "contents without making many round-trips. See also L</lstatlist> for a "
10439 "similarly efficient call for getting standard stats. Very long directory "
10440 "listings might cause the protocol message size to be exceeded, causing this "
10441 "call to fail. The caller must split up such requests into smaller groups of "
10446 #: ../fish/guestfish-actions.pod:2957
10451 #: ../fish/guestfish-actions.pod:2959
10459 #: ../fish/guestfish-actions.pod:2961 ../src/guestfs-actions.pod:4410
10460 msgid "Create a directory named C<path>."
10464 #: ../fish/guestfish-actions.pod:2963
10469 #: ../fish/guestfish-actions.pod:2965
10472 " mkdir-mode path mode\n"
10477 #: ../fish/guestfish-actions.pod:2967 ../src/guestfs-actions.pod:4423
10479 "This command creates a directory, setting the initial permissions of the "
10480 "directory to C<mode>."
10484 #: ../fish/guestfish-actions.pod:2970 ../src/guestfs-actions.pod:4426
10486 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10487 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10492 #: ../fish/guestfish-actions.pod:2974
10493 msgid "See also L</mkdir>, L</umask>"
10497 #: ../fish/guestfish-actions.pod:2976
10502 #: ../fish/guestfish-actions.pod:2978
10510 #: ../fish/guestfish-actions.pod:2980 ../src/guestfs-actions.pod:4442
10512 "Create a directory named C<path>, creating any parent directories as "
10513 "necessary. This is like the C<mkdir -p> shell command."
10517 #: ../fish/guestfish-actions.pod:2983
10522 #: ../fish/guestfish-actions.pod:2985
10525 " mkdtemp template\n"
10530 #: ../fish/guestfish-actions.pod:2987 ../src/guestfs-actions.pod:4455
10532 "This command creates a temporary directory. The C<template> parameter "
10533 "should be a full pathname for the temporary directory name with the final "
10534 "six characters being \"XXXXXX\"."
10538 #: ../fish/guestfish-actions.pod:2992 ../src/guestfs-actions.pod:4460
10540 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10541 "being suitable for Windows filesystems."
10545 #: ../fish/guestfish-actions.pod:2995 ../src/guestfs-actions.pod:4463
10546 msgid "The name of the temporary directory that was created is returned."
10550 #: ../fish/guestfish-actions.pod:2998 ../src/guestfs-actions.pod:4466
10551 msgid "The temporary directory is created with mode 0700 and is owned by root."
10555 #: ../fish/guestfish-actions.pod:3001 ../src/guestfs-actions.pod:4469
10557 "The caller is responsible for deleting the temporary directory and its "
10558 "contents after use."
10562 #: ../fish/guestfish-actions.pod:3004 ../src/guestfs-actions.pod:4472
10563 msgid "See also: L<mkdtemp(3)>"
10567 #: ../fish/guestfish-actions.pod:3006
10572 #: ../fish/guestfish-actions.pod:3008
10575 " mke2fs-J fstype blocksize device journal\n"
10580 #: ../fish/guestfish-actions.pod:3010 ../src/guestfs-actions.pod:4488
10582 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10583 "C<journal>. It is equivalent to the command:"
10587 #: ../fish/guestfish-actions.pod:3014 ../src/guestfs-actions.pod:4492
10590 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10595 #: ../fish/guestfish-actions.pod:3016
10596 msgid "See also L</mke2journal>."
10600 #: ../fish/guestfish-actions.pod:3018
10605 #: ../fish/guestfish-actions.pod:3020
10608 " mke2fs-JL fstype blocksize device label\n"
10613 #: ../fish/guestfish-actions.pod:3022 ../src/guestfs-actions.pod:4509
10615 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10616 "the journal labeled C<label>."
10620 #: ../fish/guestfish-actions.pod:3025
10621 msgid "See also L</mke2journal-L>."
10625 #: ../fish/guestfish-actions.pod:3027
10630 #: ../fish/guestfish-actions.pod:3029
10633 " mke2fs-JU fstype blocksize device uuid\n"
10638 #: ../fish/guestfish-actions.pod:3031 ../src/guestfs-actions.pod:4527
10640 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10641 "the journal with UUID C<uuid>."
10645 #: ../fish/guestfish-actions.pod:3034
10646 msgid "See also L</mke2journal-U>."
10650 #: ../fish/guestfish-actions.pod:3036
10651 msgid "mke2journal"
10655 #: ../fish/guestfish-actions.pod:3038
10658 " mke2journal blocksize device\n"
10663 #: ../fish/guestfish-actions.pod:3040 ../src/guestfs-actions.pod:4543
10665 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10670 #: ../fish/guestfish-actions.pod:3043 ../src/guestfs-actions.pod:4546
10673 " mke2fs -O journal_dev -b blocksize device\n"
10678 #: ../fish/guestfish-actions.pod:3045
10679 msgid "mke2journal-L"
10683 #: ../fish/guestfish-actions.pod:3047
10686 " mke2journal-L blocksize label device\n"
10691 #: ../fish/guestfish-actions.pod:3049 ../src/guestfs-actions.pod:4560
10692 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10696 #: ../fish/guestfish-actions.pod:3051
10697 msgid "mke2journal-U"
10701 #: ../fish/guestfish-actions.pod:3053
10704 " mke2journal-U blocksize uuid device\n"
10709 #: ../fish/guestfish-actions.pod:3055 ../src/guestfs-actions.pod:4574
10710 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10714 #: ../fish/guestfish-actions.pod:3057
10719 #: ../fish/guestfish-actions.pod:3059
10722 " mkfifo mode path\n"
10727 #: ../fish/guestfish-actions.pod:3061
10729 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10730 "is just a convenient wrapper around L</mknod>."
10734 #: ../fish/guestfish-actions.pod:3067
10739 #: ../fish/guestfish-actions.pod:3069
10742 " mkfs fstype device\n"
10747 #: ../fish/guestfish-actions.pod:3071 ../src/guestfs-actions.pod:4604
10749 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10750 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10754 #: ../fish/guestfish-actions.pod:3075
10759 #: ../fish/guestfish-actions.pod:3077
10762 " mkfs-b fstype blocksize device\n"
10767 #: ../fish/guestfish-actions.pod:3079
10769 "This call is similar to L</mkfs>, but it allows you to control the block "
10770 "size of the resulting filesystem. Supported block sizes depend on the "
10771 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10775 #: ../fish/guestfish-actions.pod:3084 ../fish/guestfish-actions.pod:3111
10776 #: ../src/guestfs-actions.pod:4625 ../src/guestfs-actions.pod:4670
10778 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10783 #: ../fish/guestfish-actions.pod:3087
10785 "This function is deprecated. In new code, use the L</mkfs_opts> call "
10790 #: ../fish/guestfish-actions.pod:3094
10795 #: ../fish/guestfish-actions.pod:3096
10798 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
10803 #: ../fish/guestfish-actions.pod:3098 ../src/guestfs-actions.pod:4657
10805 "This function creates a filesystem on C<device>. The filesystem type is "
10806 "C<fstype>, for example C<ext3>."
10810 #: ../fish/guestfish-actions.pod:3105 ../src/guestfs-actions.pod:4664
10811 msgid "C<blocksize>"
10815 #: ../fish/guestfish-actions.pod:3107 ../src/guestfs-actions.pod:4666
10817 "The filesystem block size. Supported block sizes depend on the filesystem "
10818 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
10823 #: ../fish/guestfish-actions.pod:3114 ../src/guestfs-actions.pod:4673
10824 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
10828 #: ../fish/guestfish-actions.pod:3116 ../src/guestfs-actions.pod:4675
10829 msgid "C<features>"
10833 #: ../fish/guestfish-actions.pod:3118 ../src/guestfs-actions.pod:4677
10834 msgid "This passes the I<-O> parameter to the external mkfs program."
10838 #: ../fish/guestfish-actions.pod:3120 ../src/guestfs-actions.pod:4679
10840 "For certain filesystem types, this allows extra filesystem features to be "
10841 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
10845 #: ../fish/guestfish-actions.pod:3124 ../src/guestfs-actions.pod:4683
10847 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
10852 #: ../fish/guestfish-actions.pod:3127 ../src/guestfs-actions.pod:4686
10857 #: ../fish/guestfish-actions.pod:3129 ../src/guestfs-actions.pod:4688
10859 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
10860 "sets the inode size (only for ext2/3/4 filesystems at present)."
10864 #: ../fish/guestfish-actions.pod:3132 ../src/guestfs-actions.pod:4691
10865 msgid "C<sectorsize>"
10869 #: ../fish/guestfish-actions.pod:3134 ../src/guestfs-actions.pod:4693
10871 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
10872 "sets sector size for ufs filesystem."
10876 #: ../fish/guestfish-actions.pod:3141
10877 msgid "mkmountpoint"
10881 #: ../fish/guestfish-actions.pod:3143
10884 " mkmountpoint exemptpath\n"
10889 #: ../fish/guestfish-actions.pod:3145
10891 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
10892 "to create extra mountpoints before mounting the first filesystem."
10896 #: ../fish/guestfish-actions.pod:3149 ../src/guestfs-actions.pod:4736
10898 "These calls are I<only> necessary in some very limited circumstances, mainly "
10899 "the case where you want to mount a mix of unrelated and/or read-only "
10900 "filesystems together."
10904 #: ../fish/guestfish-actions.pod:3153 ../src/guestfs-actions.pod:4740
10906 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10907 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10908 "inside that. You can unpack this as follows in guestfish:"
10912 #: ../fish/guestfish-actions.pod:3158 ../src/guestfs-actions.pod:4745
10915 " add-ro Fedora-11-i686-Live.iso\n"
10917 " mkmountpoint /cd\n"
10918 " mkmountpoint /sqsh\n"
10919 " mkmountpoint /ext3fs\n"
10920 " mount /dev/sda /cd\n"
10921 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10922 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10927 #: ../fish/guestfish-actions.pod:3167 ../src/guestfs-actions.pod:4754
10928 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10932 #: ../fish/guestfish-actions.pod:3169
10934 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
10935 "unexpected errors if you try to mix these calls. It is safest to manually "
10936 "unmount filesystems and remove mountpoints after use."
10940 #: ../fish/guestfish-actions.pod:3173
10942 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
10943 "for this to work for manual mountpoints, you must ensure that the innermost "
10944 "mountpoints have the longest pathnames, as in the example code above."
10948 #: ../fish/guestfish-actions.pod:3178 ../src/guestfs-actions.pod:4765
10950 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10954 #: ../fish/guestfish-actions.pod:3180
10956 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
10957 "L</umount-all> to be called when the handle is closed which can also trigger "
10962 #: ../fish/guestfish-actions.pod:3184
10967 #: ../fish/guestfish-actions.pod:3186
10970 " mknod mode devmajor devminor path\n"
10975 #: ../fish/guestfish-actions.pod:3188 ../src/guestfs-actions.pod:4784
10977 "This call creates block or character special devices, or named pipes (FIFOs)."
10981 #: ../fish/guestfish-actions.pod:3191 ../src/guestfs-actions.pod:4787
10983 "The C<mode> parameter should be the mode, using the standard constants. "
10984 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10985 "used when creating block and character special devices."
10989 #: ../fish/guestfish-actions.pod:3196
10991 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10992 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10993 "regular file). These constants are available in the standard Linux header "
10994 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
10995 "wrappers around this command which bitwise OR in the appropriate constant "
11000 #: ../fish/guestfish-actions.pod:3206
11005 #: ../fish/guestfish-actions.pod:3208
11008 " mknod-b mode devmajor devminor path\n"
11013 #: ../fish/guestfish-actions.pod:3210
11015 "This call creates a block device node called C<path> with mode C<mode> and "
11016 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11017 "wrapper around L</mknod>."
11021 #: ../fish/guestfish-actions.pod:3216
11026 #: ../fish/guestfish-actions.pod:3218
11029 " mknod-c mode devmajor devminor path\n"
11034 #: ../fish/guestfish-actions.pod:3220
11036 "This call creates a char device node called C<path> with mode C<mode> and "
11037 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11038 "wrapper around L</mknod>."
11042 #: ../fish/guestfish-actions.pod:3226
11047 #: ../fish/guestfish-actions.pod:3228
11055 #: ../fish/guestfish-actions.pod:3230 ../src/guestfs-actions.pod:4850
11056 msgid "Create a swap partition on C<device>."
11060 #: ../fish/guestfish-actions.pod:3232
11065 #: ../fish/guestfish-actions.pod:3234
11068 " mkswap-L label device\n"
11073 #: ../fish/guestfish-actions.pod:3236 ../src/guestfs-actions.pod:4863
11074 msgid "Create a swap partition on C<device> with label C<label>."
11078 #: ../fish/guestfish-actions.pod:3238 ../src/guestfs-actions.pod:4865
11080 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
11081 "sda>), just to a partition. This appears to be a limitation of the kernel "
11086 #: ../fish/guestfish-actions.pod:3242
11091 #: ../fish/guestfish-actions.pod:3244
11094 " mkswap-U uuid device\n"
11099 #: ../fish/guestfish-actions.pod:3246 ../src/guestfs-actions.pod:4880
11100 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11104 #: ../fish/guestfish-actions.pod:3248
11105 msgid "mkswap-file"
11109 #: ../fish/guestfish-actions.pod:3250
11112 " mkswap-file path\n"
11117 #: ../fish/guestfish-actions.pod:3252 ../src/guestfs-actions.pod:4892
11118 msgid "Create a swap file."
11122 #: ../fish/guestfish-actions.pod:3254
11124 "This command just writes a swap file signature to an existing file. To "
11125 "create the file itself, use something like L</fallocate>."
11129 #: ../fish/guestfish-actions.pod:3257
11134 #: ../fish/guestfish-actions.pod:3259
11137 " modprobe modulename\n"
11142 #: ../fish/guestfish-actions.pod:3261 ../src/guestfs-actions.pod:4907
11143 msgid "This loads a kernel module in the appliance."
11147 #: ../fish/guestfish-actions.pod:3263 ../src/guestfs-actions.pod:4909
11149 "The kernel module must have been whitelisted when libguestfs was built (see "
11150 "C<appliance/kmod.whitelist.in> in the source)."
11154 #: ../fish/guestfish-actions.pod:3266
11159 #: ../fish/guestfish-actions.pod:3268
11162 " mount device mountpoint\n"
11167 #: ../fish/guestfish-actions.pod:3270 ../src/guestfs-actions.pod:4923
11169 "Mount a guest disk at a position in the filesystem. Block devices are named "
11170 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11171 "those block devices contain partitions, they will have the usual names (eg. "
11172 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11176 #: ../fish/guestfish-actions.pod:3276 ../src/guestfs-actions.pod:4929
11178 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11179 "mounted on C</> before others can be mounted. Other filesystems can only be "
11180 "mounted on directories which already exist."
11184 #: ../fish/guestfish-actions.pod:3281 ../src/guestfs-actions.pod:4934
11186 "The mounted filesystem is writable, if we have sufficient permissions on the "
11187 "underlying device."
11191 #: ../fish/guestfish-actions.pod:3284
11193 "B<Important note:> When you use this call, the filesystem options C<sync> "
11194 "and C<noatime> are set implicitly. This was originally done because we "
11195 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11196 "very large negative performance impact and negligible effect on "
11197 "reliability. Therefore we recommend that you avoid using L</mount> in any "
11198 "code that needs performance, and instead use L</mount-options> (use an empty "
11199 "string for the first parameter if you don't want any options)."
11203 #: ../fish/guestfish-actions.pod:3294
11205 "This function is deprecated. In new code, use the L</mount_options> call "
11210 #: ../fish/guestfish-actions.pod:3301
11215 #: ../fish/guestfish-actions.pod:3303
11218 " mount-9p mounttag mountpoint [options:..]\n"
11223 #: ../fish/guestfish-actions.pod:3305 ../src/guestfs-actions.pod:4973
11225 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
11230 #: ../fish/guestfish-actions.pod:3308 ../src/guestfs-actions.pod:4976
11232 "If required, C<trans=virtio> will be automatically added to the options. "
11233 "Any other options required can be passed in the optional C<options> "
11238 #: ../fish/guestfish-actions.pod:3314
11243 #: ../fish/guestfish-actions.pod:3316
11246 " mount-loop file mountpoint\n"
11251 #: ../fish/guestfish-actions.pod:3318 ../src/guestfs-actions.pod:5015
11253 "This command lets you mount C<file> (a filesystem image in a file) on a "
11254 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11259 #: ../fish/guestfish-actions.pod:3322
11260 msgid "mount-options"
11264 #: ../fish/guestfish-actions.pod:3324
11267 " mount-options options device mountpoint\n"
11272 #: ../fish/guestfish-actions.pod:3326
11274 "This is the same as the L</mount> command, but it allows you to set the "
11275 "mount options as for the L<mount(8)> I<-o> flag."
11279 #: ../fish/guestfish-actions.pod:3330 ../src/guestfs-actions.pod:5035
11281 "If the C<options> parameter is an empty string, then no options are passed "
11282 "(all options default to whatever the filesystem uses)."
11286 #: ../fish/guestfish-actions.pod:3334
11291 #: ../fish/guestfish-actions.pod:3336
11294 " mount-ro device mountpoint\n"
11299 #: ../fish/guestfish-actions.pod:3338
11301 "This is the same as the L</mount> command, but it mounts the filesystem with "
11302 "the read-only (I<-o ro>) flag."
11306 #: ../fish/guestfish-actions.pod:3341
11311 #: ../fish/guestfish-actions.pod:3343
11314 " mount-vfs options vfstype device mountpoint\n"
11319 #: ../fish/guestfish-actions.pod:3345
11321 "This is the same as the L</mount> command, but it allows you to set both the "
11322 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
11326 #: ../fish/guestfish-actions.pod:3349
11327 msgid "mountpoints"
11331 #: ../fish/guestfish-actions.pod:3351
11339 #: ../fish/guestfish-actions.pod:3353
11341 "This call is similar to L</mounts>. That call returns a list of devices. "
11342 "This one returns a hash table (map) of device name to directory where the "
11343 "device is mounted."
11347 #: ../fish/guestfish-actions.pod:3357
11352 #: ../fish/guestfish-actions.pod:3359
11360 #: ../fish/guestfish-actions.pod:3361 ../src/guestfs-actions.pod:5096
11362 "This returns the list of currently mounted filesystems. It returns the list "
11363 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11367 #: ../fish/guestfish-actions.pod:3364 ../src/guestfs-actions.pod:5099
11368 msgid "Some internal mounts are not shown."
11372 #: ../fish/guestfish-actions.pod:3366
11373 msgid "See also: L</mountpoints>"
11377 #: ../fish/guestfish-actions.pod:3368
11382 #: ../fish/guestfish-actions.pod:3370
11390 #: ../fish/guestfish-actions.pod:3372 ../src/guestfs-actions.pod:5116
11392 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11393 "destination filename or destination directory."
11397 #: ../fish/guestfish-actions.pod:3375
11398 msgid "ntfs-3g-probe"
11402 #: ../fish/guestfish-actions.pod:3377
11405 " ntfs-3g-probe true|false device\n"
11410 #: ../fish/guestfish-actions.pod:3379 ../src/guestfs-actions.pod:5130
11412 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11413 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
11414 "write, and some cannot be mounted at all)."
11418 #: ../fish/guestfish-actions.pod:3383 ../src/guestfs-actions.pod:5134
11420 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11421 "can be mounted read-write. Set it to false if you want to test if the "
11422 "volume can be mounted read-only."
11426 #: ../fish/guestfish-actions.pod:3387 ../src/guestfs-actions.pod:5138
11428 "The return value is an integer which C<0> if the operation would succeed, or "
11429 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11433 #: ../fish/guestfish-actions.pod:3391
11438 #: ../fish/guestfish-actions.pod:3393
11441 " ntfsresize device\n"
11446 #: ../fish/guestfish-actions.pod:3395 ../fish/guestfish-actions.pod:3419
11447 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5191
11449 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11450 "size of the underlying device."
11454 #: ../fish/guestfish-actions.pod:3398 ../src/guestfs-actions.pod:5155
11456 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
11457 "consistency check (for safety). You have to boot into Windows to perform "
11458 "this check and clear this condition. Furthermore, ntfsresize refuses to "
11459 "resize filesystems which have been marked in this way. So in effect it is "
11460 "not possible to call ntfsresize multiple times on a single filesystem "
11461 "without booting into Windows between each resize."
11465 #: ../fish/guestfish-actions.pod:3406 ../fish/guestfish-actions.pod:3445
11466 #: ../src/guestfs-actions.pod:5163 ../src/guestfs-actions.pod:5217
11467 msgid "See also L<ntfsresize(8)>."
11471 #: ../fish/guestfish-actions.pod:3408 ../fish/guestfish-actions.pod:3456
11473 "This function is deprecated. In new code, use the L</ntfsresize_opts> call "
11478 #: ../fish/guestfish-actions.pod:3415
11479 msgid "ntfsresize-opts"
11483 #: ../fish/guestfish-actions.pod:3417
11486 " ntfsresize-opts device [size:..] [force:..]\n"
11491 #: ../fish/guestfish-actions.pod:3428 ../src/guestfs-actions.pod:5200
11493 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
11494 "resized to fit the container (eg. partition)."
11498 #: ../fish/guestfish-actions.pod:3431 ../src/guestfs-actions.pod:5203
11503 #: ../fish/guestfish-actions.pod:3433 ../src/guestfs-actions.pod:5205
11505 "If this option is true, then force the resize of the filesystem even if the "
11506 "filesystem is marked as requiring a consistency check."
11510 #: ../fish/guestfish-actions.pod:3436
11512 "After the resize operation, the filesystem is always marked as requiring a "
11513 "consistency check (for safety). You have to boot into Windows to perform "
11514 "this check and clear this condition. If you I<don't> set the C<force> "
11515 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
11516 "a single filesystem without booting into Windows between each resize."
11520 #: ../fish/guestfish-actions.pod:3449
11521 msgid "ntfsresize-size"
11525 #: ../fish/guestfish-actions.pod:3451
11528 " ntfsresize-size device size\n"
11533 #: ../fish/guestfish-actions.pod:3453
11535 "This command is the same as L</ntfsresize> except that it allows you to "
11536 "specify the new size (in bytes) explicitly."
11540 #: ../fish/guestfish-actions.pod:3463
11545 #: ../fish/guestfish-actions.pod:3465
11548 " part-add device prlogex startsect endsect\n"
11553 #: ../fish/guestfish-actions.pod:3467
11555 "This command adds a partition to C<device>. If there is no partition table "
11556 "on the device, call L</part-init> first."
11560 #: ../fish/guestfish-actions.pod:3470 ../src/guestfs-actions.pod:5278
11562 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11563 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11564 "C<logical>) and C<e> (or C<extended>) partition types."
11568 #: ../fish/guestfish-actions.pod:3475 ../src/guestfs-actions.pod:5283
11570 "C<startsect> and C<endsect> are the start and end of the partition in "
11571 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11572 "from the end of the disk (C<-1> is the last sector)."
11576 #: ../fish/guestfish-actions.pod:3479
11578 "Creating a partition which covers the whole disk is not so easy. Use L</"
11579 "part-disk> to do that."
11583 #: ../fish/guestfish-actions.pod:3482
11588 #: ../fish/guestfish-actions.pod:3484
11591 " part-del device partnum\n"
11596 #: ../fish/guestfish-actions.pod:3486 ../src/guestfs-actions.pod:5301
11597 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11601 #: ../fish/guestfish-actions.pod:3488 ../src/guestfs-actions.pod:5303
11603 "Note that in the case of MBR partitioning, deleting an extended partition "
11604 "also deletes any logical partitions it contains."
11608 #: ../fish/guestfish-actions.pod:3492
11613 #: ../fish/guestfish-actions.pod:3494
11616 " part-disk device parttype\n"
11621 #: ../fish/guestfish-actions.pod:3496
11623 "This command is simply a combination of L</part-init> followed by L</part-"
11624 "add> to create a single primary partition covering the whole disk."
11628 #: ../fish/guestfish-actions.pod:3500
11630 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11631 "possible values are described in L</part-init>."
11635 #: ../fish/guestfish-actions.pod:3506
11636 msgid "part-get-bootable"
11640 #: ../fish/guestfish-actions.pod:3508
11643 " part-get-bootable device partnum\n"
11648 #: ../fish/guestfish-actions.pod:3510 ../src/guestfs-actions.pod:5339
11650 "This command returns true if the partition C<partnum> on C<device> has the "
11651 "bootable flag set."
11655 #: ../fish/guestfish-actions.pod:3513
11656 msgid "See also L</part-set-bootable>."
11660 #: ../fish/guestfish-actions.pod:3515
11661 msgid "part-get-mbr-id"
11665 #: ../fish/guestfish-actions.pod:3517
11668 " part-get-mbr-id device partnum\n"
11673 #: ../fish/guestfish-actions.pod:3519 ../src/guestfs-actions.pod:5355
11675 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11676 "partition C<partnum>."
11680 #: ../fish/guestfish-actions.pod:3522 ../fish/guestfish-actions.pod:3666
11682 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11683 "undefined results for other partition table types (see L</part-get-"
11688 #: ../fish/guestfish-actions.pod:3526
11689 msgid "part-get-parttype"
11693 #: ../fish/guestfish-actions.pod:3528
11696 " part-get-parttype device\n"
11701 #: ../fish/guestfish-actions.pod:3530 ../src/guestfs-actions.pod:5372
11703 "This command examines the partition table on C<device> and returns the "
11704 "partition table type (format) being used."
11708 #: ../fish/guestfish-actions.pod:3533
11710 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11711 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11712 "possible, although unusual. See L</part-init> for a full list."
11716 #: ../fish/guestfish-actions.pod:3538
11721 #: ../fish/guestfish-actions.pod:3540
11724 " part-init device parttype\n"
11729 #: ../fish/guestfish-actions.pod:3542 ../src/guestfs-actions.pod:5392
11731 "This creates an empty partition table on C<device> of one of the partition "
11732 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11733 "(for large disks)."
11737 #: ../fish/guestfish-actions.pod:3546
11739 "Initially there are no partitions. Following this, you should call L</part-"
11740 "add> for each partition required."
11744 #: ../fish/guestfish-actions.pod:3549 ../src/guestfs-actions.pod:5399
11745 msgid "Possible values for C<parttype> are:"
11749 #: ../fish/guestfish-actions.pod:3553 ../src/guestfs-actions.pod:5403
11754 #: ../fish/guestfish-actions.pod:3555 ../src/guestfs-actions.pod:5405
11759 #: ../fish/guestfish-actions.pod:3557 ../src/guestfs-actions.pod:5407
11760 msgid "Intel EFI / GPT partition table."
11764 #: ../fish/guestfish-actions.pod:3559 ../src/guestfs-actions.pod:5409
11766 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11767 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11768 "the C<mbr> format."
11772 #: ../fish/guestfish-actions.pod:3563 ../src/guestfs-actions.pod:5413
11777 #: ../fish/guestfish-actions.pod:3565 ../src/guestfs-actions.pod:5415
11782 #: ../fish/guestfish-actions.pod:3567 ../src/guestfs-actions.pod:5417
11784 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11785 "Windows. This partition type will B<only> work for device sizes up to 2 "
11786 "TB. For large disks we recommend using C<gpt>."
11790 #: ../fish/guestfish-actions.pod:3574 ../src/guestfs-actions.pod:5424
11792 "Other partition table types that may work but are not supported include:"
11796 #: ../fish/guestfish-actions.pod:3579 ../src/guestfs-actions.pod:5429
11801 #: ../fish/guestfish-actions.pod:3581 ../src/guestfs-actions.pod:5431
11802 msgid "AIX disk labels."
11806 #: ../fish/guestfish-actions.pod:3583 ../src/guestfs-actions.pod:5433
11811 #: ../fish/guestfish-actions.pod:3585 ../src/guestfs-actions.pod:5435
11816 #: ../fish/guestfish-actions.pod:3587 ../src/guestfs-actions.pod:5437
11817 msgid "Amiga \"Rigid Disk Block\" format."
11821 #: ../fish/guestfish-actions.pod:3589 ../src/guestfs-actions.pod:5439
11826 #: ../fish/guestfish-actions.pod:3591 ../src/guestfs-actions.pod:5441
11827 msgid "BSD disk labels."
11831 #: ../fish/guestfish-actions.pod:3593 ../src/guestfs-actions.pod:5443
11836 #: ../fish/guestfish-actions.pod:3595 ../src/guestfs-actions.pod:5445
11837 msgid "DASD, used on IBM mainframes."
11841 #: ../fish/guestfish-actions.pod:3597 ../src/guestfs-actions.pod:5447
11846 #: ../fish/guestfish-actions.pod:3599 ../src/guestfs-actions.pod:5449
11847 msgid "MIPS/SGI volumes."
11851 #: ../fish/guestfish-actions.pod:3601 ../src/guestfs-actions.pod:5451
11856 #: ../fish/guestfish-actions.pod:3603 ../src/guestfs-actions.pod:5453
11857 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11861 #: ../fish/guestfish-actions.pod:3605 ../src/guestfs-actions.pod:5455
11866 #: ../fish/guestfish-actions.pod:3607 ../src/guestfs-actions.pod:5457
11867 msgid "NEC PC-98 format, common in Japan apparently."
11871 #: ../fish/guestfish-actions.pod:3609 ../src/guestfs-actions.pod:5459
11876 #: ../fish/guestfish-actions.pod:3611 ../src/guestfs-actions.pod:5461
11877 msgid "Sun disk labels."
11881 #: ../fish/guestfish-actions.pod:3615
11886 #: ../fish/guestfish-actions.pod:3617
11889 " part-list device\n"
11894 #: ../fish/guestfish-actions.pod:3619 ../src/guestfs-actions.pod:5475
11896 "This command parses the partition table on C<device> and returns the list of "
11897 "partitions found."
11901 #: ../fish/guestfish-actions.pod:3622 ../src/guestfs-actions.pod:5478
11902 msgid "The fields in the returned structure are:"
11906 #: ../fish/guestfish-actions.pod:3626 ../src/guestfs-actions.pod:5482
11907 msgid "B<part_num>"
11911 #: ../fish/guestfish-actions.pod:3628 ../src/guestfs-actions.pod:5484
11912 msgid "Partition number, counting from 1."
11916 #: ../fish/guestfish-actions.pod:3630 ../src/guestfs-actions.pod:5486
11917 msgid "B<part_start>"
11921 #: ../fish/guestfish-actions.pod:3632
11923 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11924 "the device's sector size, see L</blockdev-getss>."
11928 #: ../fish/guestfish-actions.pod:3635 ../src/guestfs-actions.pod:5491
11929 msgid "B<part_end>"
11933 #: ../fish/guestfish-actions.pod:3637 ../src/guestfs-actions.pod:5493
11934 msgid "End of the partition in bytes."
11938 #: ../fish/guestfish-actions.pod:3639 ../src/guestfs-actions.pod:5495
11939 msgid "B<part_size>"
11943 #: ../fish/guestfish-actions.pod:3641 ../src/guestfs-actions.pod:5497
11944 msgid "Size of the partition in bytes."
11948 #: ../fish/guestfish-actions.pod:3645
11949 msgid "part-set-bootable"
11953 #: ../fish/guestfish-actions.pod:3647
11956 " part-set-bootable device partnum true|false\n"
11961 #: ../fish/guestfish-actions.pod:3649 ../src/guestfs-actions.pod:5515
11963 "This sets the bootable flag on partition numbered C<partnum> on device "
11964 "C<device>. Note that partitions are numbered from 1."
11968 #: ../fish/guestfish-actions.pod:3652 ../src/guestfs-actions.pod:5518
11970 "The bootable flag is used by some operating systems (notably Windows) to "
11971 "determine which partition to boot from. It is by no means universally "
11976 #: ../fish/guestfish-actions.pod:3656
11977 msgid "part-set-mbr-id"
11981 #: ../fish/guestfish-actions.pod:3658
11984 " part-set-mbr-id device partnum idbyte\n"
11989 #: ../fish/guestfish-actions.pod:3660 ../src/guestfs-actions.pod:5534
11991 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11992 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11993 "documentation are in fact hexadecimal numbers, but usually documented "
11994 "without any leading \"0x\" which might be confusing."
11998 #: ../fish/guestfish-actions.pod:3670
11999 msgid "part-set-name"
12003 #: ../fish/guestfish-actions.pod:3672
12006 " part-set-name device partnum name\n"
12011 #: ../fish/guestfish-actions.pod:3674 ../src/guestfs-actions.pod:5556
12013 "This sets the partition name on partition numbered C<partnum> on device "
12014 "C<device>. Note that partitions are numbered from 1."
12018 #: ../fish/guestfish-actions.pod:3677 ../src/guestfs-actions.pod:5559
12020 "The partition name can only be set on certain types of partition table. "
12021 "This works on C<gpt> but not on C<mbr> partitions."
12025 #: ../fish/guestfish-actions.pod:3680
12026 msgid "part-to-dev"
12030 #: ../fish/guestfish-actions.pod:3682
12033 " part-to-dev partition\n"
12038 #: ../fish/guestfish-actions.pod:3684 ../src/guestfs-actions.pod:5572
12040 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12041 "partition number, returning the device name (eg. \"/dev/sdb\")."
12045 #: ../fish/guestfish-actions.pod:3688
12047 "The named partition must exist, for example as a string returned from L</"
12048 "list-partitions>."
12052 #: ../fish/guestfish-actions.pod:3691
12053 msgid "ping-daemon"
12057 #: ../fish/guestfish-actions.pod:3693
12065 #: ../fish/guestfish-actions.pod:3695 ../src/guestfs-actions.pod:5589
12067 "This is a test probe into the guestfs daemon running inside the qemu "
12068 "subprocess. Calling this function checks that the daemon responds to the "
12069 "ping message, without affecting the daemon or attached block device(s) in "
12074 #: ../fish/guestfish-actions.pod:3700
12079 #: ../fish/guestfish-actions.pod:3702
12082 " pread path count offset\n"
12087 #: ../fish/guestfish-actions.pod:3704 ../src/guestfs-actions.pod:5607
12089 "This command lets you read part of a file. It reads C<count> bytes of the "
12090 "file, starting at C<offset>, from file C<path>."
12094 #: ../fish/guestfish-actions.pod:3707 ../fish/guestfish-actions.pod:3722
12095 #: ../src/guestfs-actions.pod:5610 ../src/guestfs-actions.pod:5636
12097 "This may read fewer bytes than requested. For further details see the "
12098 "L<pread(2)> system call."
12102 #: ../fish/guestfish-actions.pod:3710
12103 msgid "See also L</pwrite>, L</pread-device>."
12107 #: ../fish/guestfish-actions.pod:3715
12108 msgid "pread-device"
12112 #: ../fish/guestfish-actions.pod:3717
12115 " pread-device device count offset\n"
12120 #: ../fish/guestfish-actions.pod:3719 ../src/guestfs-actions.pod:5633
12122 "This command lets you read part of a file. It reads C<count> bytes of "
12123 "C<device>, starting at C<offset>."
12127 #: ../fish/guestfish-actions.pod:3725
12128 msgid "See also L</pread>."
12132 #: ../fish/guestfish-actions.pod:3730
12137 #: ../fish/guestfish-actions.pod:3732
12140 " pvcreate device\n"
12145 #: ../fish/guestfish-actions.pod:3734 ../src/guestfs-actions.pod:5656
12147 "This creates an LVM physical volume on the named C<device>, where C<device> "
12148 "should usually be a partition name such as C</dev/sda1>."
12152 #: ../fish/guestfish-actions.pod:3738
12157 #: ../fish/guestfish-actions.pod:3740
12160 " pvremove device\n"
12165 #: ../fish/guestfish-actions.pod:3742 ../src/guestfs-actions.pod:5670
12167 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12172 #: ../fish/guestfish-actions.pod:3745 ../src/guestfs-actions.pod:5673
12174 "The implementation uses the C<pvremove> command which refuses to wipe "
12175 "physical volumes that contain any volume groups, so you have to remove those "
12180 #: ../fish/guestfish-actions.pod:3749
12185 #: ../fish/guestfish-actions.pod:3751
12188 " pvresize device\n"
12193 #: ../fish/guestfish-actions.pod:3753 ../src/guestfs-actions.pod:5687
12195 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12196 "the new size of the underlying device."
12200 #: ../fish/guestfish-actions.pod:3756
12201 msgid "pvresize-size"
12205 #: ../fish/guestfish-actions.pod:3758
12208 " pvresize-size device size\n"
12213 #: ../fish/guestfish-actions.pod:3760
12215 "This command is the same as L</pvresize> except that it allows you to "
12216 "specify the new size (in bytes) explicitly."
12220 #: ../fish/guestfish-actions.pod:3763
12225 #: ../fish/guestfish-actions.pod:3765
12233 #: ../fish/guestfish-actions.pod:3767 ../src/guestfs-actions.pod:5713
12235 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12240 #: ../fish/guestfish-actions.pod:3770 ../src/guestfs-actions.pod:5716
12242 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12247 #: ../fish/guestfish-actions.pod:3773
12248 msgid "See also L</pvs-full>."
12252 #: ../fish/guestfish-actions.pod:3775
12257 #: ../fish/guestfish-actions.pod:3777
12265 #: ../fish/guestfish-actions.pod:3779 ../src/guestfs-actions.pod:5732
12267 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12268 "(8)> command. The \"full\" version includes all fields."
12272 #: ../fish/guestfish-actions.pod:3782
12277 #: ../fish/guestfish-actions.pod:3784
12285 #: ../fish/guestfish-actions.pod:3786 ../src/guestfs-actions.pod:5747
12286 msgid "This command returns the UUID of the LVM PV C<device>."
12290 #: ../fish/guestfish-actions.pod:3788
12295 #: ../fish/guestfish-actions.pod:3790
12298 " pwrite path content offset\n"
12303 #: ../fish/guestfish-actions.pod:3792 ../src/guestfs-actions.pod:5763
12305 "This command writes to part of a file. It writes the data buffer C<content> "
12306 "to the file C<path> starting at offset C<offset>."
12310 #: ../fish/guestfish-actions.pod:3795 ../src/guestfs-actions.pod:5766
12312 "This command implements the L<pwrite(2)> system call, and like that system "
12313 "call it may not write the full data requested. The return value is the "
12314 "number of bytes that were actually written to the file. This could even be "
12315 "0, although short writes are unlikely for regular files in ordinary "
12320 #: ../fish/guestfish-actions.pod:3801
12321 msgid "See also L</pread>, L</pwrite-device>."
12325 #: ../fish/guestfish-actions.pod:3806
12326 msgid "pwrite-device"
12330 #: ../fish/guestfish-actions.pod:3808
12333 " pwrite-device device content offset\n"
12338 #: ../fish/guestfish-actions.pod:3810 ../src/guestfs-actions.pod:5790
12340 "This command writes to part of a device. It writes the data buffer "
12341 "C<content> to C<device> starting at offset C<offset>."
12345 #: ../fish/guestfish-actions.pod:3813 ../src/guestfs-actions.pod:5793
12347 "This command implements the L<pwrite(2)> system call, and like that system "
12348 "call it may not write the full data requested (although short writes to disk "
12349 "devices and partitions are probably impossible with standard Linux kernels)."
12353 #: ../fish/guestfish-actions.pod:3818
12354 msgid "See also L</pwrite>."
12358 #: ../fish/guestfish-actions.pod:3823
12363 #: ../fish/guestfish-actions.pod:3825
12366 " read-file path\n"
12371 #: ../fish/guestfish-actions.pod:3827 ../src/guestfs-actions.pod:5814
12372 msgid "This calls returns the contents of the file C<path> as a buffer."
12376 #: ../fish/guestfish-actions.pod:3830
12378 "Unlike L</cat>, this function can correctly handle files that contain "
12379 "embedded ASCII NUL characters. However unlike L</download>, this function "
12380 "is limited in the total size of file that can be handled."
12384 #: ../fish/guestfish-actions.pod:3838
12389 #: ../fish/guestfish-actions.pod:3840
12392 " read-lines path\n"
12397 #: ../fish/guestfish-actions.pod:3844 ../src/guestfs-actions.pod:5839
12399 "The file contents are returned as a list of lines. Trailing C<LF> and "
12400 "C<CRLF> character sequences are I<not> returned."
12404 #: ../fish/guestfish-actions.pod:3847
12406 "Note that this function cannot correctly handle binary files (specifically, "
12407 "files containing C<\\0> character which is treated as end of line). For "
12408 "those you need to use the L</read-file> function which has a more complex "
12413 #: ../fish/guestfish-actions.pod:3852
12418 #: ../fish/guestfish-actions.pod:3854
12426 #: ../fish/guestfish-actions.pod:3856 ../src/guestfs-actions.pod:5859
12427 msgid "This returns the list of directory entries in directory C<dir>."
12431 #: ../fish/guestfish-actions.pod:3858 ../src/guestfs-actions.pod:5861
12433 "All entries in the directory are returned, including C<.> and C<..>. The "
12434 "entries are I<not> sorted, but returned in the same order as the underlying "
12439 #: ../fish/guestfish-actions.pod:3862 ../src/guestfs-actions.pod:5865
12441 "Also this call returns basic file type information about each file. The "
12442 "C<ftyp> field will contain one of the following characters:"
12446 #: ../fish/guestfish-actions.pod:3867 ../src/guestfs-actions.pod:5870
12451 #: ../fish/guestfish-actions.pod:3869 ../src/guestfs-actions.pod:5872
12452 msgid "Block special"
12456 #: ../fish/guestfish-actions.pod:3871 ../src/guestfs-actions.pod:5874
12461 #: ../fish/guestfish-actions.pod:3873 ../src/guestfs-actions.pod:5876
12462 msgid "Char special"
12466 #: ../fish/guestfish-actions.pod:3875 ../src/guestfs-actions.pod:5878
12471 #: ../fish/guestfish-actions.pod:3877 ../src/guestfs-actions.pod:5880
12476 #: ../fish/guestfish-actions.pod:3879 ../src/guestfs-actions.pod:5882
12481 #: ../fish/guestfish-actions.pod:3881 ../src/guestfs-actions.pod:5884
12482 msgid "FIFO (named pipe)"
12486 #: ../fish/guestfish-actions.pod:3883 ../src/guestfs-actions.pod:5886
12491 #: ../fish/guestfish-actions.pod:3885 ../src/guestfs-actions.pod:5888
12492 msgid "Symbolic link"
12496 #: ../fish/guestfish-actions.pod:3887 ../src/guestfs-actions.pod:5890
12501 #: ../fish/guestfish-actions.pod:3889 ../src/guestfs-actions.pod:5892
12502 msgid "Regular file"
12506 #: ../fish/guestfish-actions.pod:3891 ../src/guestfs-actions.pod:5894
12511 #: ../fish/guestfish-actions.pod:3893 ../src/guestfs-actions.pod:5896
12516 #: ../fish/guestfish-actions.pod:3895 ../src/guestfs-actions.pod:5898
12521 #: ../fish/guestfish-actions.pod:3897 ../src/guestfs-actions.pod:5900
12522 msgid "Unknown file type"
12526 #: ../fish/guestfish-actions.pod:3899 ../src/guestfs-actions.pod:5902
12531 #: ../fish/guestfish-actions.pod:3901 ../src/guestfs-actions.pod:5904
12533 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12537 #: ../fish/guestfish-actions.pod:3906
12539 "This function is primarily intended for use by programs. To get a simple "
12540 "list of names, use L</ls>. To get a printable directory for human "
12541 "consumption, use L</ll>."
12545 #: ../fish/guestfish-actions.pod:3910
12550 #: ../fish/guestfish-actions.pod:3912
12558 #: ../fish/guestfish-actions.pod:3914 ../src/guestfs-actions.pod:5925
12559 msgid "This command reads the target of a symbolic link."
12563 #: ../fish/guestfish-actions.pod:3916
12564 msgid "readlinklist"
12568 #: ../fish/guestfish-actions.pod:3918
12571 " readlinklist path 'names ...'\n"
12576 #: ../fish/guestfish-actions.pod:3920 ../src/guestfs-actions.pod:5939
12578 "This call allows you to do a C<readlink> operation on multiple files, where "
12579 "all files are in the directory C<path>. C<names> is the list of files from "
12584 #: ../fish/guestfish-actions.pod:3924 ../src/guestfs-actions.pod:5943
12586 "On return you get a list of strings, with a one-to-one correspondence to the "
12587 "C<names> list. Each string is the value of the symbolic link."
12591 #: ../fish/guestfish-actions.pod:3928 ../src/guestfs-actions.pod:5947
12593 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12594 "result string is the empty string C<\"\">. However the whole operation is "
12595 "completed even if there were C<readlink(2)> errors, and so you can call this "
12596 "function with names where you don't know if they are symbolic links already "
12597 "(albeit slightly less efficient)."
12601 #: ../fish/guestfish-actions.pod:3935 ../src/guestfs-actions.pod:5954
12603 "This call is intended for programs that want to efficiently list a directory "
12604 "contents without making many round-trips. Very long directory listings "
12605 "might cause the protocol message size to be exceeded, causing this call to "
12606 "fail. The caller must split up such requests into smaller groups of names."
12610 #: ../fish/guestfish-actions.pod:3942
12615 #: ../fish/guestfish-actions.pod:3944
12623 #: ../fish/guestfish-actions.pod:3946 ../src/guestfs-actions.pod:5973
12625 "Return the canonicalized absolute pathname of C<path>. The returned path "
12626 "has no C<.>, C<..> or symbolic link path elements."
12630 #: ../fish/guestfish-actions.pod:3949
12631 msgid "removexattr"
12635 #: ../fish/guestfish-actions.pod:3951
12638 " removexattr xattr path\n"
12643 #: ../fish/guestfish-actions.pod:3953 ../src/guestfs-actions.pod:5988
12645 "This call removes the extended attribute named C<xattr> of the file C<path>."
12649 #: ../fish/guestfish-actions.pod:3956
12650 msgid "See also: L</lremovexattr>, L<attr(5)>."
12654 #: ../fish/guestfish-actions.pod:3958
12659 #: ../fish/guestfish-actions.pod:3960
12662 " resize2fs device\n"
12667 #: ../fish/guestfish-actions.pod:3962 ../src/guestfs-actions.pod:6003
12669 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12670 "underlying device."
12674 #: ../fish/guestfish-actions.pod:3965
12676 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
12677 "before calling this command. For unknown reasons C<resize2fs> sometimes "
12678 "gives an error about this and sometimes not. In any case, it is always safe "
12679 "to call L</e2fsck-f> before calling this function."
12683 #: ../fish/guestfish-actions.pod:3971
12684 msgid "resize2fs-M"
12688 #: ../fish/guestfish-actions.pod:3973
12691 " resize2fs-M device\n"
12696 #: ../fish/guestfish-actions.pod:3975
12698 "This command is the same as L</resize2fs>, but the filesystem is resized to "
12699 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
12704 #: ../fish/guestfish-actions.pod:3979
12706 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
12707 "and read the C<Block size> and C<Block count> values. These two numbers, "
12708 "multiplied together, give the resulting size of the minimal filesystem in "
12713 #: ../fish/guestfish-actions.pod:3984
12714 msgid "resize2fs-size"
12718 #: ../fish/guestfish-actions.pod:3986
12721 " resize2fs-size device size\n"
12726 #: ../fish/guestfish-actions.pod:3988
12728 "This command is the same as L</resize2fs> except that it allows you to "
12729 "specify the new size (in bytes) explicitly."
12733 #: ../fish/guestfish-actions.pod:3991
12738 #: ../fish/guestfish-actions.pod:3993
12746 #: ../fish/guestfish-actions.pod:3995 ../src/guestfs-actions.pod:6055
12747 msgid "Remove the single file C<path>."
12751 #: ../fish/guestfish-actions.pod:3997
12756 #: ../fish/guestfish-actions.pod:3999
12764 #: ../fish/guestfish-actions.pod:4001 ../src/guestfs-actions.pod:6067
12766 "Remove the file or directory C<path>, recursively removing the contents if "
12767 "its a directory. This is like the C<rm -rf> shell command."
12771 #: ../fish/guestfish-actions.pod:4005
12776 #: ../fish/guestfish-actions.pod:4007
12784 #: ../fish/guestfish-actions.pod:4009 ../src/guestfs-actions.pod:6081
12785 msgid "Remove the single directory C<path>."
12789 #: ../fish/guestfish-actions.pod:4011
12790 msgid "rmmountpoint"
12794 #: ../fish/guestfish-actions.pod:4013
12797 " rmmountpoint exemptpath\n"
12802 #: ../fish/guestfish-actions.pod:4015
12804 "This calls removes a mountpoint that was previously created with L</"
12805 "mkmountpoint>. See L</mkmountpoint> for full details."
12809 #: ../fish/guestfish-actions.pod:4019
12810 msgid "scrub-device"
12814 #: ../fish/guestfish-actions.pod:4021
12817 " scrub-device device\n"
12822 #: ../fish/guestfish-actions.pod:4023 ../src/guestfs-actions.pod:6107
12824 "This command writes patterns over C<device> to make data retrieval more "
12829 #: ../fish/guestfish-actions.pod:4026 ../fish/guestfish-actions.pod:4041
12830 #: ../fish/guestfish-actions.pod:4054 ../src/guestfs-actions.pod:6110
12831 #: ../src/guestfs-actions.pod:6131 ../src/guestfs-actions.pod:6150
12833 "It is an interface to the L<scrub(1)> program. See that manual page for "
12838 #: ../fish/guestfish-actions.pod:4032
12843 #: ../fish/guestfish-actions.pod:4034
12846 " scrub-file file\n"
12851 #: ../fish/guestfish-actions.pod:4036 ../src/guestfs-actions.pod:6126
12853 "This command writes patterns over a file to make data retrieval more "
12858 #: ../fish/guestfish-actions.pod:4039 ../src/guestfs-actions.pod:6129
12859 msgid "The file is I<removed> after scrubbing."
12863 #: ../fish/guestfish-actions.pod:4044
12864 msgid "scrub-freespace"
12868 #: ../fish/guestfish-actions.pod:4046
12871 " scrub-freespace dir\n"
12876 #: ../fish/guestfish-actions.pod:4048
12878 "This command creates the directory C<dir> and then fills it with files until "
12879 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
12880 "deletes them. The intention is to scrub any free space on the partition "
12881 "containing C<dir>."
12885 #: ../fish/guestfish-actions.pod:4057
12890 #: ../fish/guestfish-actions.pod:4059
12895 #: ../fish/guestfish-actions.pod:4061
12898 " set-append append\n"
12903 #: ../fish/guestfish-actions.pod:4063 ../src/guestfs-actions.pod:6163
12905 "This function is used to add additional options to the guest kernel command "
12910 #: ../fish/guestfish-actions.pod:4066 ../src/guestfs-actions.pod:6166
12912 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12913 "environment variable."
12917 #: ../fish/guestfish-actions.pod:4069 ../src/guestfs-actions.pod:6169
12919 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12920 "(libguestfs always adds a few of its own)."
12924 #: ../fish/guestfish-actions.pod:4072
12925 msgid "set-attach-method"
12929 #: ../fish/guestfish-actions.pod:4074
12930 msgid "attach-method"
12934 #: ../fish/guestfish-actions.pod:4076
12937 " set-attach-method attachmethod\n"
12942 #: ../fish/guestfish-actions.pod:4078 ../src/guestfs-actions.pod:6182
12944 "Set the method that libguestfs uses to connect to the back end guestfsd "
12945 "daemon. Possible methods are:"
12949 #: ../fish/guestfish-actions.pod:4083 ../src/guestfs-actions.pod:6187
12950 #: ../src/guestfs.pod:2687
12951 msgid "C<appliance>"
12955 #: ../fish/guestfish-actions.pod:4085 ../src/guestfs-actions.pod:6189
12957 "Launch an appliance and connect to it. This is the ordinary method and the "
12962 #: ../fish/guestfish-actions.pod:4088 ../src/guestfs-actions.pod:6192
12963 msgid "C<unix:I<path>>"
12967 #: ../fish/guestfish-actions.pod:4090 ../src/guestfs-actions.pod:6194
12968 msgid "Connect to the Unix domain socket I<path>."
12972 #: ../fish/guestfish-actions.pod:4092 ../src/guestfs-actions.pod:6196
12974 "This method lets you connect to an existing daemon or (using virtio-serial) "
12975 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
12976 "RUNNING DAEMONS>."
12980 #: ../fish/guestfish-actions.pod:4098
12981 msgid "set-autosync"
12985 #: ../fish/guestfish-actions.pod:4100
12990 #: ../fish/guestfish-actions.pod:4102
12993 " set-autosync true|false\n"
12998 #: ../fish/guestfish-actions.pod:4104 ../src/guestfs-actions.pod:6212
13000 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13001 "effort attempt to make filesystems consistent and synchronized when the "
13002 "handle is closed (also if the program exits without closing handles)."
13006 #: ../fish/guestfish-actions.pod:4109 ../src/guestfs-actions.pod:6217
13008 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13009 "disabled by default)."
13013 #: ../fish/guestfish-actions.pod:4112
13018 #: ../fish/guestfish-actions.pod:4114
13023 #: ../fish/guestfish-actions.pod:4116
13026 " set-direct true|false\n"
13031 #: ../fish/guestfish-actions.pod:4118 ../src/guestfs-actions.pod:6230
13033 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13034 "passed directly through to the appliance once it is launched."
13038 #: ../fish/guestfish-actions.pod:4122
13040 "One consequence of this is that log messages aren't caught by the library "
13041 "and handled by L</set-log-message-callback>, but go straight to stdout."
13045 #: ../fish/guestfish-actions.pod:4126 ../src/guestfs-actions.pod:6238
13046 msgid "You probably don't want to use this unless you know what you are doing."
13050 #: ../fish/guestfish-actions.pod:4129 ../src/guestfs-actions.pod:6241
13051 msgid "The default is disabled."
13055 #: ../fish/guestfish-actions.pod:4131
13056 msgid "set-e2label"
13060 #: ../fish/guestfish-actions.pod:4133
13063 " set-e2label device label\n"
13068 #: ../fish/guestfish-actions.pod:4135 ../src/guestfs-actions.pod:6254
13070 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13071 "C<label>. Filesystem labels are limited to 16 characters."
13075 #: ../fish/guestfish-actions.pod:4139
13077 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
13078 "label on a filesystem."
13082 #: ../fish/guestfish-actions.pod:4142
13087 #: ../fish/guestfish-actions.pod:4144
13090 " set-e2uuid device uuid\n"
13095 #: ../fish/guestfish-actions.pod:4146 ../src/guestfs-actions.pod:6272
13097 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13098 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13099 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13103 #: ../fish/guestfish-actions.pod:4151
13105 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
13106 "UUID of a filesystem."
13110 #: ../fish/guestfish-actions.pod:4154
13111 msgid "set-memsize"
13115 #: ../fish/guestfish-actions.pod:4156
13120 #: ../fish/guestfish-actions.pod:4158
13123 " set-memsize memsize\n"
13128 #: ../fish/guestfish-actions.pod:4160
13130 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13131 "This only has any effect if called before L</launch>."
13135 #: ../fish/guestfish-actions.pod:4164 ../src/guestfs-actions.pod:6294
13137 "You can also change this by setting the environment variable "
13138 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13142 #: ../fish/guestfish-actions.pod:4171
13143 msgid "set-network"
13147 #: ../fish/guestfish-actions.pod:4173
13152 #: ../fish/guestfish-actions.pod:4175
13155 " set-network true|false\n"
13160 #: ../fish/guestfish-actions.pod:4177 ../src/guestfs-actions.pod:6311
13162 "If C<network> is true, then the network is enabled in the libguestfs "
13163 "appliance. The default is false."
13167 #: ../fish/guestfish-actions.pod:4180 ../src/guestfs-actions.pod:6314
13169 "This affects whether commands are able to access the network (see L<guestfs"
13170 "(3)/RUNNING COMMANDS>)."
13174 #: ../fish/guestfish-actions.pod:4183
13176 "You must call this before calling L</launch>, otherwise it has no effect."
13180 #: ../fish/guestfish-actions.pod:4186
13185 #: ../fish/guestfish-actions.pod:4190
13188 " set-path searchpath\n"
13193 #: ../fish/guestfish-actions.pod:4192 ../src/guestfs-actions.pod:6330
13194 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13198 #: ../fish/guestfish-actions.pod:4194 ../src/guestfs-actions.pod:6332
13200 "The default is C<$libdir/guestfs> unless overridden by setting "
13201 "C<LIBGUESTFS_PATH> environment variable."
13205 #: ../fish/guestfish-actions.pod:4197 ../src/guestfs-actions.pod:6335
13206 msgid "Setting C<path> to C<NULL> restores the default path."
13210 #: ../fish/guestfish-actions.pod:4199
13215 #: ../fish/guestfish-actions.pod:4201
13220 #: ../fish/guestfish-actions.pod:4203
13223 " set-pgroup true|false\n"
13228 #: ../fish/guestfish-actions.pod:4205 ../src/guestfs-actions.pod:6347
13230 "If C<pgroup> is true, child processes are placed into their own process "
13235 #: ../fish/guestfish-actions.pod:4208 ../src/guestfs-actions.pod:6350
13237 "The practical upshot of this is that signals like C<SIGINT> (from users "
13238 "pressing C<^C>) won't be received by the child process."
13242 #: ../fish/guestfish-actions.pod:4211 ../src/guestfs-actions.pod:6353
13244 "The default for this flag is false, because usually you want C<^C> to kill "
13249 #: ../fish/guestfish-actions.pod:4214
13254 #: ../fish/guestfish-actions.pod:4216
13259 #: ../fish/guestfish-actions.pod:4218
13267 #: ../fish/guestfish-actions.pod:4220 ../src/guestfs-actions.pod:6366
13268 msgid "Set the qemu binary that we will use."
13272 #: ../fish/guestfish-actions.pod:4222 ../src/guestfs-actions.pod:6368
13274 "The default is chosen when the library was compiled by the configure script."
13278 #: ../fish/guestfish-actions.pod:4225 ../src/guestfs-actions.pod:6371
13280 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13285 #: ../fish/guestfish-actions.pod:4228 ../src/guestfs-actions.pod:6374
13286 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13290 #: ../fish/guestfish-actions.pod:4230 ../src/guestfs-actions.pod:6376
13292 "Note that you should call this function as early as possible after creating "
13293 "the handle. This is because some pre-launch operations depend on testing "
13294 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13295 "don't retest features, and so you might see inconsistent results. Using the "
13296 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13297 "the qemu binary at the same time as the handle is created."
13301 #: ../fish/guestfish-actions.pod:4238
13302 msgid "set-recovery-proc"
13306 #: ../fish/guestfish-actions.pod:4240
13307 msgid "recovery-proc"
13311 #: ../fish/guestfish-actions.pod:4242
13314 " set-recovery-proc true|false\n"
13319 #: ../fish/guestfish-actions.pod:4244
13321 "If this is called with the parameter C<false> then L</launch> does not "
13322 "create a recovery process. The purpose of the recovery process is to stop "
13323 "runaway qemu processes in the case where the main program aborts abruptly."
13327 #: ../fish/guestfish-actions.pod:4249
13329 "This only has any effect if called before L</launch>, and the default is "
13334 #: ../fish/guestfish-actions.pod:4252 ../src/guestfs-actions.pod:6402
13336 "About the only time when you would want to disable this is if the main "
13337 "process will fork itself into the background (\"daemonize\" itself). In "
13338 "this case the recovery process thinks that the main program has disappeared "
13339 "and so kills qemu, which is not very helpful."
13343 #: ../fish/guestfish-actions.pod:4258
13344 msgid "set-selinux"
13348 #: ../fish/guestfish-actions.pod:4260
13353 #: ../fish/guestfish-actions.pod:4262
13356 " set-selinux true|false\n"
13361 #: ../fish/guestfish-actions.pod:4264 ../src/guestfs-actions.pod:6418
13363 "This sets the selinux flag that is passed to the appliance at boot time. "
13364 "The default is C<selinux=0> (disabled)."
13368 #: ../fish/guestfish-actions.pod:4267 ../src/guestfs-actions.pod:6421
13370 "Note that if SELinux is enabled, it is always in Permissive mode "
13371 "(C<enforcing=0>)."
13375 #: ../fish/guestfish-actions.pod:4273
13380 #: ../fish/guestfish-actions.pod:4275
13385 #: ../fish/guestfish-actions.pod:4277
13388 " set-trace true|false\n"
13393 #: ../fish/guestfish-actions.pod:4279 ../src/guestfs-actions.pod:6437
13395 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
13396 "return values are traced."
13400 #: ../fish/guestfish-actions.pod:4282 ../src/guestfs-actions.pod:6440
13402 "If you want to trace C API calls into libguestfs (and other libraries) then "
13403 "possibly a better way is to use the external ltrace(1) command."
13407 #: ../fish/guestfish-actions.pod:4286 ../src/guestfs-actions.pod:6444
13409 "Command traces are disabled unless the environment variable "
13410 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13414 #: ../fish/guestfish-actions.pod:4289
13416 "Trace messages are normally sent to C<stderr>, unless you register a "
13417 "callback to send them somewhere else (see L</set-event-callback>)."
13421 #: ../fish/guestfish-actions.pod:4293
13422 msgid "set-verbose"
13426 #: ../fish/guestfish-actions.pod:4295
13431 #: ../fish/guestfish-actions.pod:4297
13434 " set-verbose true|false\n"
13439 #: ../fish/guestfish-actions.pod:4299 ../src/guestfs-actions.pod:6461
13440 msgid "If C<verbose> is true, this turns on verbose messages."
13444 #: ../fish/guestfish-actions.pod:4301 ../src/guestfs-actions.pod:6463
13446 "Verbose messages are disabled unless the environment variable "
13447 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13451 #: ../fish/guestfish-actions.pod:4304
13453 "Verbose messages are normally sent to C<stderr>, unless you register a "
13454 "callback to send them somewhere else (see L</set-event-callback>)."
13458 #: ../fish/guestfish-actions.pod:4308
13463 #: ../fish/guestfish-actions.pod:4310
13466 " setcon context\n"
13471 #: ../fish/guestfish-actions.pod:4312 ../src/guestfs-actions.pod:6480
13473 "This sets the SELinux security context of the daemon to the string "
13478 #: ../fish/guestfish-actions.pod:4315 ../src/guestfs-actions.pod:6483
13479 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13483 #: ../fish/guestfish-actions.pod:4317
13488 #: ../fish/guestfish-actions.pod:4319
13491 " setxattr xattr val vallen path\n"
13496 #: ../fish/guestfish-actions.pod:4321 ../src/guestfs-actions.pod:6498
13498 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13499 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13503 #: ../fish/guestfish-actions.pod:4325
13504 msgid "See also: L</lsetxattr>, L<attr(5)>."
13508 #: ../fish/guestfish-actions.pod:4327
13513 #: ../fish/guestfish-actions.pod:4329
13516 " sfdisk device cyls heads sectors 'lines ...'\n"
13521 #: ../fish/guestfish-actions.pod:4331 ../src/guestfs-actions.pod:6518
13523 "This is a direct interface to the L<sfdisk(8)> program for creating "
13524 "partitions on block devices."
13528 #: ../fish/guestfish-actions.pod:4334 ../src/guestfs-actions.pod:6521
13529 msgid "C<device> should be a block device, for example C</dev/sda>."
13533 #: ../fish/guestfish-actions.pod:4336 ../src/guestfs-actions.pod:6523
13535 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13536 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
13537 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13538 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13539 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13540 "the kernel) cannot work out the right geometry and you will need to tell it."
13544 #: ../fish/guestfish-actions.pod:4344 ../src/guestfs-actions.pod:6531
13546 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13547 "refer to the L<sfdisk(8)> manpage."
13551 #: ../fish/guestfish-actions.pod:4347 ../src/guestfs-actions.pod:6534
13553 "To create a single partition occupying the whole disk, you would pass "
13554 "C<lines> as a single element list, when the single element being the string "
13559 #: ../fish/guestfish-actions.pod:4351
13560 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
13564 #: ../fish/guestfish-actions.pod:4357 ../fish/guestfish-actions.pod:4380
13565 #: ../fish/guestfish-actions.pod:4402
13567 "This function is deprecated. In new code, use the L</part_add> call instead."
13571 #: ../fish/guestfish-actions.pod:4364
13576 #: ../fish/guestfish-actions.pod:4366
13579 " sfdiskM device 'lines ...'\n"
13584 #: ../fish/guestfish-actions.pod:4368
13586 "This is a simplified interface to the L</sfdisk> command, where partition "
13587 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
13588 "you don't need to specify the cyls, heads and sectors parameters which were "
13589 "rarely if ever used anyway."
13593 #: ../fish/guestfish-actions.pod:4374
13594 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
13598 #: ../fish/guestfish-actions.pod:4387
13603 #: ../fish/guestfish-actions.pod:4389
13606 " sfdisk-N device partnum cyls heads sectors line\n"
13611 #: ../fish/guestfish-actions.pod:4391 ../src/guestfs-actions.pod:6596
13613 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13614 "(note: C<n> counts from 1)."
13618 #: ../fish/guestfish-actions.pod:4394
13620 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
13621 "cyls/heads/sectors parameters."
13625 #: ../fish/guestfish-actions.pod:4397
13626 msgid "See also: L</part-add>"
13630 #: ../fish/guestfish-actions.pod:4409
13631 msgid "sfdisk-disk-geometry"
13635 #: ../fish/guestfish-actions.pod:4411
13638 " sfdisk-disk-geometry device\n"
13643 #: ../fish/guestfish-actions.pod:4413
13645 "This displays the disk geometry of C<device> read from the partition table. "
13646 "Especially in the case where the underlying block device has been resized, "
13647 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
13648 "kernel-geometry>)."
13652 #: ../fish/guestfish-actions.pod:4418 ../fish/guestfish-actions.pod:4427
13653 #: ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6645
13654 msgid "The result is in human-readable format, and not designed to be parsed."
13658 #: ../fish/guestfish-actions.pod:4421
13659 msgid "sfdisk-kernel-geometry"
13663 #: ../fish/guestfish-actions.pod:4423
13666 " sfdisk-kernel-geometry device\n"
13671 #: ../fish/guestfish-actions.pod:4425 ../src/guestfs-actions.pod:6643
13672 msgid "This displays the kernel's idea of the geometry of C<device>."
13676 #: ../fish/guestfish-actions.pod:4430
13681 #: ../fish/guestfish-actions.pod:4432
13684 " sfdisk-l device\n"
13689 #: ../fish/guestfish-actions.pod:4434 ../src/guestfs-actions.pod:6659
13691 "This displays the partition table on C<device>, in the human-readable output "
13692 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13696 #: ../fish/guestfish-actions.pod:4438
13697 msgid "See also: L</part-list>"
13701 #: ../fish/guestfish-actions.pod:4440
13703 "This function is deprecated. In new code, use the L</part_list> call "
13708 #: ../fish/guestfish-actions.pod:4447
13713 #: ../fish/guestfish-actions.pod:4449
13721 #: ../fish/guestfish-actions.pod:4451 ../src/guestfs-actions.pod:6683
13723 "This call runs a command from the guest filesystem via the guest's C</bin/"
13728 #: ../fish/guestfish-actions.pod:4454
13729 msgid "This is like L</command>, but passes the command to:"
13733 #: ../fish/guestfish-actions.pod:4456 ../src/guestfs-actions.pod:6688
13736 " /bin/sh -c \"command\"\n"
13741 #: ../fish/guestfish-actions.pod:4458 ../src/guestfs-actions.pod:6690
13743 "Depending on the guest's shell, this usually results in wildcards being "
13744 "expanded, shell expressions being interpolated and so on."
13748 #: ../fish/guestfish-actions.pod:4462
13749 msgid "All the provisos about L</command> apply to this call."
13753 #: ../fish/guestfish-actions.pod:4464
13758 #: ../fish/guestfish-actions.pod:4466
13761 " sh-lines command\n"
13766 #: ../fish/guestfish-actions.pod:4468
13767 msgid "This is the same as L</sh>, but splits the result into a list of lines."
13771 #: ../fish/guestfish-actions.pod:4471
13772 msgid "See also: L</command-lines>"
13776 #: ../fish/guestfish-actions.pod:4473
13781 #: ../fish/guestfish-actions.pod:4475
13789 #: ../fish/guestfish-actions.pod:4477 ../src/guestfs-actions.pod:6724
13790 msgid "Sleep for C<secs> seconds."
13794 #: ../fish/guestfish-actions.pod:4479
13799 #: ../fish/guestfish-actions.pod:4481
13807 #: ../fish/guestfish-actions.pod:4485 ../src/guestfs-actions.pod:6738
13808 msgid "This is the same as the C<stat(2)> system call."
13812 #: ../fish/guestfish-actions.pod:4487
13817 #: ../fish/guestfish-actions.pod:4489
13825 #: ../fish/guestfish-actions.pod:4491 ../src/guestfs-actions.pod:6752
13827 "Returns file system statistics for any mounted file system. C<path> should "
13828 "be a file or directory in the mounted file system (typically it is the mount "
13829 "point itself, but it doesn't need to be)."
13833 #: ../fish/guestfish-actions.pod:4495 ../src/guestfs-actions.pod:6756
13834 msgid "This is the same as the C<statvfs(2)> system call."
13838 #: ../fish/guestfish-actions.pod:4497
13843 #: ../fish/guestfish-actions.pod:4499
13851 #: ../fish/guestfish-actions.pod:4501 ../src/guestfs-actions.pod:6770
13853 "This runs the L<strings(1)> command on a file and returns the list of "
13854 "printable strings found."
13858 #: ../fish/guestfish-actions.pod:4507
13863 #: ../fish/guestfish-actions.pod:4509
13866 " strings-e encoding path\n"
13871 #: ../fish/guestfish-actions.pod:4511
13873 "This is like the L</strings> command, but allows you to specify the encoding "
13874 "of strings that are looked for in the source file C<path>."
13878 #: ../fish/guestfish-actions.pod:4515 ../src/guestfs-actions.pod:6793
13879 msgid "Allowed encodings are:"
13883 #: ../fish/guestfish-actions.pod:4519 ../src/guestfs-actions.pod:6797
13888 #: ../fish/guestfish-actions.pod:4521
13890 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13891 "ISO-8859-X (this is what L</strings> uses)."
13895 #: ../fish/guestfish-actions.pod:4524 ../src/guestfs-actions.pod:6802
13900 #: ../fish/guestfish-actions.pod:4526 ../src/guestfs-actions.pod:6804
13901 msgid "Single 8-bit-byte characters."
13905 #: ../fish/guestfish-actions.pod:4528 ../src/guestfs-actions.pod:6806
13910 #: ../fish/guestfish-actions.pod:4530 ../src/guestfs-actions.pod:6808
13911 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13915 #: ../fish/guestfish-actions.pod:4533 ../src/guestfs-actions.pod:6811
13916 msgid "l (lower case letter L)"
13920 #: ../fish/guestfish-actions.pod:4535 ../src/guestfs-actions.pod:6813
13922 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13923 "examining binaries in Windows guests."
13927 #: ../fish/guestfish-actions.pod:4538 ../src/guestfs-actions.pod:6816
13932 #: ../fish/guestfish-actions.pod:4540 ../src/guestfs-actions.pod:6818
13933 msgid "32-bit big endian such as UCS-4BE."
13937 #: ../fish/guestfish-actions.pod:4542 ../src/guestfs-actions.pod:6820
13942 #: ../fish/guestfish-actions.pod:4544 ../src/guestfs-actions.pod:6822
13943 msgid "32-bit little endian such as UCS-4LE."
13947 #: ../fish/guestfish-actions.pod:4548 ../src/guestfs-actions.pod:6826
13948 msgid "The returned strings are transcoded to UTF-8."
13952 #: ../fish/guestfish-actions.pod:4553
13953 msgid "swapoff-device"
13957 #: ../fish/guestfish-actions.pod:4555
13960 " swapoff-device device\n"
13965 #: ../fish/guestfish-actions.pod:4557
13967 "This command disables the libguestfs appliance swap device or partition "
13968 "named C<device>. See L</swapon-device>."
13972 #: ../fish/guestfish-actions.pod:4561
13973 msgid "swapoff-file"
13977 #: ../fish/guestfish-actions.pod:4563
13980 " swapoff-file file\n"
13985 #: ../fish/guestfish-actions.pod:4565 ../src/guestfs-actions.pod:6857
13986 msgid "This command disables the libguestfs appliance swap on file."
13990 #: ../fish/guestfish-actions.pod:4567
13991 msgid "swapoff-label"
13995 #: ../fish/guestfish-actions.pod:4569
13998 " swapoff-label label\n"
14003 #: ../fish/guestfish-actions.pod:4571 ../src/guestfs-actions.pod:6869
14005 "This command disables the libguestfs appliance swap on labeled swap "
14010 #: ../fish/guestfish-actions.pod:4574
14011 msgid "swapoff-uuid"
14015 #: ../fish/guestfish-actions.pod:4576
14018 " swapoff-uuid uuid\n"
14023 #: ../fish/guestfish-actions.pod:4578 ../src/guestfs-actions.pod:6882
14025 "This command disables the libguestfs appliance swap partition with the given "
14030 #: ../fish/guestfish-actions.pod:4581
14031 msgid "swapon-device"
14035 #: ../fish/guestfish-actions.pod:4583
14038 " swapon-device device\n"
14043 #: ../fish/guestfish-actions.pod:4585
14045 "This command enables the libguestfs appliance to use the swap device or "
14046 "partition named C<device>. The increased memory is made available for all "
14047 "commands, for example those run using L</command> or L</sh>."
14051 #: ../fish/guestfish-actions.pod:4590 ../src/guestfs-actions.pod:6900
14053 "Note that you should not swap to existing guest swap partitions unless you "
14054 "know what you are doing. They may contain hibernation information, or other "
14055 "information that the guest doesn't want you to trash. You also risk leaking "
14056 "information about the host to the guest this way. Instead, attach a new "
14057 "host device to the guest and swap on that."
14061 #: ../fish/guestfish-actions.pod:4597
14062 msgid "swapon-file"
14066 #: ../fish/guestfish-actions.pod:4599
14069 " swapon-file file\n"
14074 #: ../fish/guestfish-actions.pod:4601
14076 "This command enables swap to a file. See L</swapon-device> for other notes."
14080 #: ../fish/guestfish-actions.pod:4604
14081 msgid "swapon-label"
14085 #: ../fish/guestfish-actions.pod:4606
14088 " swapon-label label\n"
14093 #: ../fish/guestfish-actions.pod:4608
14095 "This command enables swap to a labeled swap partition. See L</swapon-"
14096 "device> for other notes."
14100 #: ../fish/guestfish-actions.pod:4611
14101 msgid "swapon-uuid"
14105 #: ../fish/guestfish-actions.pod:4613
14108 " swapon-uuid uuid\n"
14113 #: ../fish/guestfish-actions.pod:4615
14115 "This command enables swap to a swap partition with the given UUID. See L</"
14116 "swapon-device> for other notes."
14120 #: ../fish/guestfish-actions.pod:4618
14125 #: ../fish/guestfish-actions.pod:4620
14133 #: ../fish/guestfish-actions.pod:4622 ../src/guestfs-actions.pod:6955
14135 "This syncs the disk, so that any writes are flushed through to the "
14136 "underlying disk image."
14140 #: ../fish/guestfish-actions.pod:4625 ../src/guestfs-actions.pod:6958
14142 "You should always call this if you have modified a disk image, before "
14143 "closing the handle."
14147 #: ../fish/guestfish-actions.pod:4628
14152 #: ../fish/guestfish-actions.pod:4630
14160 #: ../fish/guestfish-actions.pod:4632 ../src/guestfs-actions.pod:6971
14162 "This command returns up to the last 10 lines of a file as a list of strings."
14166 #: ../fish/guestfish-actions.pod:4638
14171 #: ../fish/guestfish-actions.pod:4640
14174 " tail-n nrlines path\n"
14179 #: ../fish/guestfish-actions.pod:4642 ../src/guestfs-actions.pod:6990
14181 "If the parameter C<nrlines> is a positive number, this returns the last "
14182 "C<nrlines> lines of the file C<path>."
14186 #: ../fish/guestfish-actions.pod:4645 ../src/guestfs-actions.pod:6993
14188 "If the parameter C<nrlines> is a negative number, this returns lines from "
14189 "the file C<path>, starting with the C<-nrlines>th line."
14193 #: ../fish/guestfish-actions.pod:4653
14198 #: ../fish/guestfish-actions.pod:4655
14201 " tar-in (tarfile|-) directory\n"
14206 #: ../fish/guestfish-actions.pod:4657 ../src/guestfs-actions.pod:7014
14208 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14209 "tar file) into C<directory>."
14213 #: ../fish/guestfish-actions.pod:4660
14214 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
14218 #: ../fish/guestfish-actions.pod:4665
14223 #: ../fish/guestfish-actions.pod:4667
14226 " tar-out directory (tarfile|-)\n"
14231 #: ../fish/guestfish-actions.pod:4669 ../src/guestfs-actions.pod:7031
14233 "This command packs the contents of C<directory> and downloads it to local "
14238 #: ../fish/guestfish-actions.pod:4672
14239 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
14243 #: ../fish/guestfish-actions.pod:4677
14248 #: ../fish/guestfish-actions.pod:4679
14251 " tgz-in (tarball|-) directory\n"
14256 #: ../fish/guestfish-actions.pod:4681 ../src/guestfs-actions.pod:7048
14258 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14259 "tar file) into C<directory>."
14263 #: ../fish/guestfish-actions.pod:4684
14264 msgid "To upload an uncompressed tarball, use L</tar-in>."
14268 #: ../fish/guestfish-actions.pod:4688
14273 #: ../fish/guestfish-actions.pod:4690
14276 " tgz-out directory (tarball|-)\n"
14281 #: ../fish/guestfish-actions.pod:4692 ../src/guestfs-actions.pod:7064
14283 "This command packs the contents of C<directory> and downloads it to local "
14288 #: ../fish/guestfish-actions.pod:4695
14289 msgid "To download an uncompressed tarball, use L</tar-out>."
14293 #: ../fish/guestfish-actions.pod:4699
14298 #: ../fish/guestfish-actions.pod:4701
14306 #: ../fish/guestfish-actions.pod:4703 ../src/guestfs-actions.pod:7079
14308 "Touch acts like the L<touch(1)> command. It can be used to update the "
14309 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14314 #: ../fish/guestfish-actions.pod:4707 ../src/guestfs-actions.pod:7083
14316 "This command only works on regular files, and will fail on other file types "
14317 "such as directories, symbolic links, block special etc."
14321 #: ../fish/guestfish-actions.pod:4710
14326 #: ../fish/guestfish-actions.pod:4712
14334 #: ../fish/guestfish-actions.pod:4714 ../src/guestfs-actions.pod:7096
14336 "This command truncates C<path> to a zero-length file. The file must exist "
14341 #: ../fish/guestfish-actions.pod:4717
14342 msgid "truncate-size"
14346 #: ../fish/guestfish-actions.pod:4719
14349 " truncate-size path size\n"
14354 #: ../fish/guestfish-actions.pod:4721 ../src/guestfs-actions.pod:7110
14356 "This command truncates C<path> to size C<size> bytes. The file must exist "
14361 #: ../fish/guestfish-actions.pod:4724
14363 "If the current file size is less than C<size> then the file is extended to "
14364 "the required size with zero bytes. This creates a sparse file (ie. disk "
14365 "blocks are not allocated for the file until you write to it). To create a "
14366 "non-sparse file of zeroes, use L</fallocate64> instead."
14370 #: ../fish/guestfish-actions.pod:4730
14375 #: ../fish/guestfish-actions.pod:4732
14378 " tune2fs-l device\n"
14383 #: ../fish/guestfish-actions.pod:4734 ../src/guestfs-actions.pod:7129
14385 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14390 #: ../fish/guestfish-actions.pod:4737 ../src/guestfs-actions.pod:7132
14392 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14393 "for more details. The list of fields returned isn't clearly defined, and "
14394 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14395 "and the filesystem itself."
14399 #: ../fish/guestfish-actions.pod:4742
14404 #: ../fish/guestfish-actions.pod:4744
14407 " txz-in (tarball|-) directory\n"
14412 #: ../fish/guestfish-actions.pod:4746 ../src/guestfs-actions.pod:7152
14414 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14415 "tar file) into C<directory>."
14419 #: ../fish/guestfish-actions.pod:4751
14424 #: ../fish/guestfish-actions.pod:4753
14427 " txz-out directory (tarball|-)\n"
14432 #: ../fish/guestfish-actions.pod:4755 ../src/guestfs-actions.pod:7166
14434 "This command packs the contents of C<directory> and downloads it to local "
14435 "file C<tarball> (as an xz compressed tar archive)."
14439 #: ../fish/guestfish-actions.pod:4760
14444 #: ../fish/guestfish-actions.pod:4762
14452 #: ../fish/guestfish-actions.pod:4764 ../src/guestfs-actions.pod:7179
14454 "This function sets the mask used for creating new files and device nodes to "
14459 #: ../fish/guestfish-actions.pod:4767 ../src/guestfs-actions.pod:7182
14461 "Typical umask values would be C<022> which creates new files with "
14462 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14463 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14467 #: ../fish/guestfish-actions.pod:4772 ../src/guestfs-actions.pod:7187
14469 "The default umask is C<022>. This is important because it means that "
14470 "directories and device nodes will be created with C<0644> or C<0755> mode "
14471 "even if you specify C<0777>."
14475 #: ../fish/guestfish-actions.pod:4776
14476 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
14480 #: ../fish/guestfish-actions.pod:4779 ../src/guestfs-actions.pod:7194
14481 msgid "This call returns the previous umask."
14485 #: ../fish/guestfish-actions.pod:4781
14490 #: ../fish/guestfish-actions.pod:4783
14495 #: ../fish/guestfish-actions.pod:4785
14498 " umount pathordevice\n"
14503 #: ../fish/guestfish-actions.pod:4787 ../src/guestfs-actions.pod:7206
14505 "This unmounts the given filesystem. The filesystem may be specified either "
14506 "by its mountpoint (path) or the device which contains the filesystem."
14510 #: ../fish/guestfish-actions.pod:4791
14515 #: ../fish/guestfish-actions.pod:4793
14516 msgid "unmount-all"
14520 #: ../fish/guestfish-actions.pod:4795
14528 #: ../fish/guestfish-actions.pod:4797 ../src/guestfs-actions.pod:7219
14529 msgid "This unmounts all mounted filesystems."
14533 #: ../fish/guestfish-actions.pod:4799 ../src/guestfs-actions.pod:7221
14534 msgid "Some internal mounts are not unmounted by this call."
14538 #: ../fish/guestfish-actions.pod:4801
14543 #: ../fish/guestfish-actions.pod:4803
14546 " upload (filename|-) remotefilename\n"
14551 #: ../fish/guestfish-actions.pod:4805 ../fish/guestfish-actions.pod:4818
14552 #: ../src/guestfs-actions.pod:7234 ../src/guestfs-actions.pod:7258
14553 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14557 #: ../fish/guestfish-actions.pod:4810
14558 msgid "See also L</download>."
14562 #: ../fish/guestfish-actions.pod:4814
14563 msgid "upload-offset"
14567 #: ../fish/guestfish-actions.pod:4816
14570 " upload-offset (filename|-) remotefilename offset\n"
14575 #: ../fish/guestfish-actions.pod:4821 ../src/guestfs-actions.pod:7261
14577 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14578 "The intention is to overwrite parts of existing files or devices, although "
14579 "if a non-existant file is specified then it is created with a \"hole\" "
14580 "before C<offset>. The size of the data written is implicit in the size of "
14581 "the source C<filename>."
14585 #: ../fish/guestfish-actions.pod:4828
14587 "Note that there is no limit on the amount of data that can be uploaded with "
14588 "this call, unlike with L</pwrite>, and this call always writes the full "
14589 "amount unless an error occurs."
14593 #: ../fish/guestfish-actions.pod:4833
14594 msgid "See also L</upload>, L</pwrite>."
14598 #: ../fish/guestfish-actions.pod:4837
14603 #: ../fish/guestfish-actions.pod:4839
14606 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
14611 #: ../fish/guestfish-actions.pod:4841 ../src/guestfs-actions.pod:7294
14612 msgid "This command sets the timestamps of a file with nanosecond precision."
14616 #: ../fish/guestfish-actions.pod:4844 ../src/guestfs-actions.pod:7297
14618 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14623 #: ../fish/guestfish-actions.pod:4847 ../src/guestfs-actions.pod:7300
14625 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14626 "nanoseconds from the epoch."
14630 #: ../fish/guestfish-actions.pod:4850 ../src/guestfs-actions.pod:7303
14632 "If the C<*nsecs> field contains the special value C<-1> then the "
14633 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14634 "ignored in this case)."
14638 #: ../fish/guestfish-actions.pod:4854 ../src/guestfs-actions.pod:7307
14640 "If the C<*nsecs> field contains the special value C<-2> then the "
14641 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14646 #: ../fish/guestfish-actions.pod:4858
14651 #: ../fish/guestfish-actions.pod:4860
14659 #: ../fish/guestfish-actions.pod:4862 ../src/guestfs-actions.pod:7320
14661 "Return the libguestfs version number that the program is linked against."
14665 #: ../fish/guestfish-actions.pod:4865 ../src/guestfs-actions.pod:7323
14667 "Note that because of dynamic linking this is not necessarily the version of "
14668 "libguestfs that you compiled against. You can compile the program, and then "
14669 "at runtime dynamically link against a completely different C<libguestfs.so> "
14674 #: ../fish/guestfish-actions.pod:4870 ../src/guestfs-actions.pod:7328
14676 "This call was added in version C<1.0.58>. In previous versions of "
14677 "libguestfs there was no way to get the version number. From C code you can "
14678 "use dynamic linker functions to find out if this symbol exists (if it "
14679 "doesn't, then it's an earlier version)."
14683 #: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7334
14685 "The call returns a structure with four elements. The first three (C<major>, "
14686 "C<minor> and C<release>) are numbers and correspond to the usual version "
14687 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14688 "but may be used for distro-specific information."
14692 #: ../fish/guestfish-actions.pod:4882 ../src/guestfs-actions.pod:7340
14694 "To construct the original version string: C<$major.$minor.$release$extra>"
14698 #: ../fish/guestfish-actions.pod:4885 ../src/guestfs-actions.pod:7343
14699 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14703 #: ../fish/guestfish-actions.pod:4887
14705 "I<Note:> Don't use this call to test for availability of features. In "
14706 "enterprise distributions we backport features from later versions into "
14707 "earlier versions, making this an unreliable way to test for features. Use "
14708 "L</available> instead."
14712 #: ../fish/guestfish-actions.pod:4893
14717 #: ../fish/guestfish-actions.pod:4895
14720 " vfs-label device\n"
14725 #: ../fish/guestfish-actions.pod:4897 ../src/guestfs-actions.pod:7363
14726 msgid "This returns the filesystem label of the filesystem on C<device>."
14730 #: ../fish/guestfish-actions.pod:4900 ../src/guestfs-actions.pod:7366
14731 msgid "If the filesystem is unlabeled, this returns the empty string."
14735 #: ../fish/guestfish-actions.pod:4902
14736 msgid "To find a filesystem from the label, use L</findfs-label>."
14740 #: ../fish/guestfish-actions.pod:4904
14745 #: ../fish/guestfish-actions.pod:4906
14748 " vfs-type device\n"
14753 #: ../fish/guestfish-actions.pod:4908 ../src/guestfs-actions.pod:7381
14755 "This command gets the filesystem type corresponding to the filesystem on "
14760 #: ../fish/guestfish-actions.pod:4911 ../src/guestfs-actions.pod:7384
14762 "For most filesystems, the result is the name of the Linux VFS module which "
14763 "would be used to mount this filesystem if you mounted it without specifying "
14764 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14768 #: ../fish/guestfish-actions.pod:4916
14773 #: ../fish/guestfish-actions.pod:4918
14776 " vfs-uuid device\n"
14781 #: ../fish/guestfish-actions.pod:4920 ../src/guestfs-actions.pod:7400
14782 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14786 #: ../fish/guestfish-actions.pod:4923 ../src/guestfs-actions.pod:7403
14787 msgid "If the filesystem does not have a UUID, this returns the empty string."
14791 #: ../fish/guestfish-actions.pod:4925
14792 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
14796 #: ../fish/guestfish-actions.pod:4927
14797 msgid "vg-activate"
14801 #: ../fish/guestfish-actions.pod:4929
14804 " vg-activate true|false 'volgroups ...'\n"
14809 #: ../fish/guestfish-actions.pod:4931 ../src/guestfs-actions.pod:7419
14811 "This command activates or (if C<activate> is false) deactivates all logical "
14812 "volumes in the listed volume groups C<volgroups>."
14816 #: ../fish/guestfish-actions.pod:4934 ../src/guestfs-actions.pod:7422
14817 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14821 #: ../fish/guestfish-actions.pod:4936 ../src/guestfs-actions.pod:7424
14823 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14824 "activated or deactivated."
14828 #: ../fish/guestfish-actions.pod:4939
14829 msgid "vg-activate-all"
14833 #: ../fish/guestfish-actions.pod:4941
14836 " vg-activate-all true|false\n"
14841 #: ../fish/guestfish-actions.pod:4943 ../src/guestfs-actions.pod:7437
14843 "This command activates or (if C<activate> is false) deactivates all logical "
14844 "volumes in all volume groups."
14848 #: ../fish/guestfish-actions.pod:4946 ../src/guestfs-actions.pod:7440
14849 msgid "This command is the same as running C<vgchange -a y|n>"
14853 #: ../fish/guestfish-actions.pod:4948
14858 #: ../fish/guestfish-actions.pod:4950
14861 " vgcreate volgroup 'physvols ...'\n"
14866 #: ../fish/guestfish-actions.pod:4952 ../src/guestfs-actions.pod:7453
14868 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14869 "of physical volumes C<physvols>."
14873 #: ../fish/guestfish-actions.pod:4955
14878 #: ../fish/guestfish-actions.pod:4957
14881 " vglvuuids vgname\n"
14886 #: ../fish/guestfish-actions.pod:4959 ../src/guestfs-actions.pod:7466
14888 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14889 "volumes created in this volume group."
14893 #: ../fish/guestfish-actions.pod:4962
14895 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
14896 "logical volumes and volume groups."
14900 #: ../fish/guestfish-actions.pod:4965
14901 msgid "See also L</vgpvuuids>."
14905 #: ../fish/guestfish-actions.pod:4967
14910 #: ../fish/guestfish-actions.pod:4969
14913 " vgpvuuids vgname\n"
14918 #: ../fish/guestfish-actions.pod:4971 ../src/guestfs-actions.pod:7486
14920 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14921 "volumes that this volume group resides on."
14925 #: ../fish/guestfish-actions.pod:4974
14927 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
14928 "physical volumes and volume groups."
14932 #: ../fish/guestfish-actions.pod:4977
14933 msgid "See also L</vglvuuids>."
14937 #: ../fish/guestfish-actions.pod:4979
14942 #: ../fish/guestfish-actions.pod:4981
14945 " vgremove vgname\n"
14950 #: ../fish/guestfish-actions.pod:4983 ../src/guestfs-actions.pod:7506
14951 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14955 #: ../fish/guestfish-actions.pod:4985 ../src/guestfs-actions.pod:7508
14957 "This also forcibly removes all logical volumes in the volume group (if any)."
14961 #: ../fish/guestfish-actions.pod:4988
14966 #: ../fish/guestfish-actions.pod:4990
14969 " vgrename volgroup newvolgroup\n"
14974 #: ../fish/guestfish-actions.pod:4992 ../src/guestfs-actions.pod:7522
14975 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14979 #: ../fish/guestfish-actions.pod:4994
14984 #: ../fish/guestfish-actions.pod:4996
14992 #: ../fish/guestfish-actions.pod:4998 ../src/guestfs-actions.pod:7533
14994 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
14999 #: ../fish/guestfish-actions.pod:5001 ../src/guestfs-actions.pod:7536
15001 "This returns a list of just the volume group names that were detected (eg. "
15006 #: ../fish/guestfish-actions.pod:5004
15007 msgid "See also L</vgs-full>."
15011 #: ../fish/guestfish-actions.pod:5006
15016 #: ../fish/guestfish-actions.pod:5008
15024 #: ../fish/guestfish-actions.pod:5010 ../src/guestfs-actions.pod:7552
15026 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15027 "> command. The \"full\" version includes all fields."
15031 #: ../fish/guestfish-actions.pod:5013
15036 #: ../fish/guestfish-actions.pod:5015
15044 #: ../fish/guestfish-actions.pod:5017 ../src/guestfs-actions.pod:7566
15046 "This rescans all block devices and rebuilds the list of LVM physical "
15047 "volumes, volume groups and logical volumes."
15051 #: ../fish/guestfish-actions.pod:5020
15056 #: ../fish/guestfish-actions.pod:5022
15064 #: ../fish/guestfish-actions.pod:5024 ../src/guestfs-actions.pod:7579
15065 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15069 #: ../fish/guestfish-actions.pod:5026
15074 #: ../fish/guestfish-actions.pod:5028
15082 #: ../fish/guestfish-actions.pod:5030 ../src/guestfs-actions.pod:7619
15084 "This command counts the characters in a file, using the C<wc -c> external "
15089 #: ../fish/guestfish-actions.pod:5033
15094 #: ../fish/guestfish-actions.pod:5035
15102 #: ../fish/guestfish-actions.pod:5037 ../src/guestfs-actions.pod:7632
15104 "This command counts the lines in a file, using the C<wc -l> external command."
15108 #: ../fish/guestfish-actions.pod:5040
15113 #: ../fish/guestfish-actions.pod:5042
15121 #: ../fish/guestfish-actions.pod:5044 ../src/guestfs-actions.pod:7645
15123 "This command counts the words in a file, using the C<wc -w> external command."
15127 #: ../fish/guestfish-actions.pod:5047
15132 #: ../fish/guestfish-actions.pod:5049
15135 " write path content\n"
15140 #: ../fish/guestfish-actions.pod:5051 ../src/guestfs-actions.pod:7660
15142 "This call creates a file called C<path>. The content of the file is the "
15143 "string C<content> (which can contain any 8 bit data)."
15147 #: ../fish/guestfish-actions.pod:5054
15148 msgid "See also L</write-append>."
15152 #: ../fish/guestfish-actions.pod:5059
15153 msgid "write-append"
15157 #: ../fish/guestfish-actions.pod:5061
15160 " write-append path content\n"
15165 #: ../fish/guestfish-actions.pod:5063 ../src/guestfs-actions.pod:7680
15167 "This call appends C<content> to the end of file C<path>. If C<path> does "
15168 "not exist, then a new file is created."
15172 #: ../fish/guestfish-actions.pod:5066
15173 msgid "See also L</write>."
15177 #: ../fish/guestfish-actions.pod:5071
15182 #: ../fish/guestfish-actions.pod:5073
15185 " write-file path content size\n"
15190 #: ../fish/guestfish-actions.pod:5075 ../src/guestfs-actions.pod:7700
15192 "This call creates a file called C<path>. The contents of the file is the "
15193 "string C<content> (which can contain any 8 bit data), with length C<size>."
15197 #: ../fish/guestfish-actions.pod:5079 ../src/guestfs-actions.pod:7704
15199 "As a special case, if C<size> is C<0> then the length is calculated using "
15200 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15204 #: ../fish/guestfish-actions.pod:5083 ../src/guestfs-actions.pod:7708
15206 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15207 "I<not> work, even if the length is specified."
15211 #: ../fish/guestfish-actions.pod:5089
15213 "This function is deprecated. In new code, use the L</write> call instead."
15217 #: ../fish/guestfish-actions.pod:5096
15222 #: ../fish/guestfish-actions.pod:5098
15225 " zegrep regex path\n"
15230 #: ../fish/guestfish-actions.pod:5100 ../src/guestfs-actions.pod:7732
15232 "This calls the external C<zegrep> program and returns the matching lines."
15236 #: ../fish/guestfish-actions.pod:5106
15241 #: ../fish/guestfish-actions.pod:5108
15244 " zegrepi regex path\n"
15249 #: ../fish/guestfish-actions.pod:5110 ../src/guestfs-actions.pod:7751
15251 "This calls the external C<zegrep -i> program and returns the matching lines."
15255 #: ../fish/guestfish-actions.pod:5116
15260 #: ../fish/guestfish-actions.pod:5118
15268 #: ../fish/guestfish-actions.pod:5120 ../src/guestfs-actions.pod:7769
15269 msgid "This command writes zeroes over the first few blocks of C<device>."
15273 #: ../fish/guestfish-actions.pod:5122 ../src/guestfs-actions.pod:7771
15275 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15276 "securely wipe the device). It should be sufficient to remove any partition "
15277 "tables, filesystem superblocks and so on."
15281 #: ../fish/guestfish-actions.pod:5126 ../fish/guestfish-actions.pod:5141
15282 #: ../src/guestfs-actions.pod:7775 ../src/guestfs-actions.pod:7801
15284 "If blocks are already zero, then this command avoids writing zeroes. This "
15285 "prevents the underlying device from becoming non-sparse or growing "
15290 #: ../fish/guestfish-actions.pod:5130
15291 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
15295 #: ../fish/guestfish-actions.pod:5133
15296 msgid "zero-device"
15300 #: ../fish/guestfish-actions.pod:5135
15303 " zero-device device\n"
15308 #: ../fish/guestfish-actions.pod:5137
15310 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
15311 "which just zeroes the first few blocks of a device."
15315 #: ../fish/guestfish-actions.pod:5148
15320 #: ../fish/guestfish-actions.pod:5150
15323 " zerofree device\n"
15328 #: ../fish/guestfish-actions.pod:5152 ../src/guestfs-actions.pod:7823
15330 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15331 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15332 "possible to compress the filesystem more effectively."
15336 #: ../fish/guestfish-actions.pod:5157 ../src/guestfs-actions.pod:7828
15337 msgid "You should B<not> run this program if the filesystem is mounted."
15341 #: ../fish/guestfish-actions.pod:5160 ../src/guestfs-actions.pod:7831
15343 "It is possible that using this program can damage the filesystem or data on "
15348 #: ../fish/guestfish-actions.pod:5163
15353 #: ../fish/guestfish-actions.pod:5165
15356 " zfgrep pattern path\n"
15361 #: ../fish/guestfish-actions.pod:5167 ../src/guestfs-actions.pod:7845
15363 "This calls the external C<zfgrep> program and returns the matching lines."
15367 #: ../fish/guestfish-actions.pod:5173
15372 #: ../fish/guestfish-actions.pod:5175
15375 " zfgrepi pattern path\n"
15380 #: ../fish/guestfish-actions.pod:5177 ../src/guestfs-actions.pod:7864
15382 "This calls the external C<zfgrep -i> program and returns the matching lines."
15386 #: ../fish/guestfish-actions.pod:5183
15391 #: ../fish/guestfish-actions.pod:5185
15394 " zfile meth path\n"
15399 #: ../fish/guestfish-actions.pod:5187 ../src/guestfs-actions.pod:7883
15401 "This command runs C<file> after first decompressing C<path> using C<method>."
15405 #: ../fish/guestfish-actions.pod:5190 ../src/guestfs-actions.pod:7886
15406 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15410 #: ../fish/guestfish-actions.pod:5192
15412 "Since 1.0.63, use L</file> instead which can now process compressed files."
15416 #: ../fish/guestfish-actions.pod:5195
15418 "This function is deprecated. In new code, use the L</file> call instead."
15422 #: ../fish/guestfish-actions.pod:5202
15427 #: ../fish/guestfish-actions.pod:5204
15430 " zgrep regex path\n"
15435 #: ../fish/guestfish-actions.pod:5206 ../src/guestfs-actions.pod:7910
15437 "This calls the external C<zgrep> program and returns the matching lines."
15441 #: ../fish/guestfish-actions.pod:5212
15446 #: ../fish/guestfish-actions.pod:5214
15449 " zgrepi regex path\n"
15454 #: ../fish/guestfish-actions.pod:5216 ../src/guestfs-actions.pod:7929
15456 "This calls the external C<zgrep -i> program and returns the matching lines."
15460 #: ../fish/guestfish-commands.pod:1
15465 #: ../fish/guestfish-commands.pod:3
15470 #: ../fish/guestfish-commands.pod:5
15473 " alloc filename size\n"
15478 #: ../fish/guestfish-commands.pod:7
15480 "This creates an empty (zeroed) file of the given size, and then adds so it "
15481 "can be further examined."
15485 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
15486 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
15490 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
15491 msgid "Size can be specified using standard suffixes, eg. C<1M>."
15495 #: ../fish/guestfish-commands.pod:14
15497 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
15498 "image, see L</PREPARED DISK IMAGES>."
15502 #: ../fish/guestfish-commands.pod:17
15507 #: ../fish/guestfish-commands.pod:19
15510 " copy-in local [local ...] /remotedir\n"
15515 #: ../fish/guestfish-commands.pod:21
15517 "C<copy-in> copies local files or directories recursively into the disk "
15518 "image, placing them in the directory called C</remotedir> (which must "
15519 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
15520 "other commands as necessary."
15524 #: ../fish/guestfish-commands.pod:26
15526 "Multiple local files and directories can be specified, but the last "
15527 "parameter must always be a remote directory. Wildcards cannot be used."
15531 #: ../fish/guestfish-commands.pod:30
15536 #: ../fish/guestfish-commands.pod:32
15539 " copy-out remote [remote ...] localdir\n"
15544 #: ../fish/guestfish-commands.pod:34
15546 "C<copy-out> copies remote files or directories recursively out of the disk "
15547 "image, placing them on the host disk in a local directory called C<localdir> "
15548 "(which must exist). This guestfish meta-command turns into a sequence of L</"
15549 "download>, L</tar-out> and other commands as necessary."
15553 #: ../fish/guestfish-commands.pod:40
15555 "Multiple remote files and directories can be specified, but the last "
15556 "parameter must always be a local directory. To download to the current "
15557 "directory, use C<.> as in:"
15561 #: ../fish/guestfish-commands.pod:44
15564 " copy-out /home .\n"
15569 #: ../fish/guestfish-commands.pod:46
15571 "Wildcards cannot be used in the ordinary command, but you can use them with "
15572 "the help of L</glob> like this:"
15576 #: ../fish/guestfish-commands.pod:49
15579 " glob copy-out /home/* .\n"
15584 #: ../fish/guestfish-commands.pod:51
15589 #: ../fish/guestfish-commands.pod:53
15592 " display filename\n"
15597 #: ../fish/guestfish-commands.pod:55
15599 "Use C<display> (a graphical display program) to display an image file. It "
15600 "downloads the file, and runs C<display> on it."
15604 #: ../fish/guestfish-commands.pod:58
15606 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
15607 "environment variable. For example to use the GNOME display program:"
15611 #: ../fish/guestfish-commands.pod:61
15614 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
15619 #: ../fish/guestfish-commands.pod:63
15620 msgid "See also L<display(1)>."
15624 #: ../fish/guestfish-commands.pod:65
15629 #: ../fish/guestfish-commands.pod:67
15632 " echo [params ...]\n"
15637 #: ../fish/guestfish-commands.pod:69
15638 msgid "This echos the parameters to the terminal."
15642 #: ../fish/guestfish-commands.pod:71
15647 #: ../fish/guestfish-commands.pod:73
15652 #: ../fish/guestfish-commands.pod:75
15657 #: ../fish/guestfish-commands.pod:77
15665 #: ../fish/guestfish-commands.pod:79
15667 "This is used to edit a file. It downloads the file, edits it locally using "
15668 "your editor, then uploads the result."
15672 #: ../fish/guestfish-commands.pod:82
15674 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
15675 "or C<emacs> you will get those corresponding editors."
15679 #: ../fish/guestfish-commands.pod:86
15684 #: ../fish/guestfish-commands.pod:88
15687 " glob command args...\n"
15692 #: ../fish/guestfish-commands.pod:90
15694 "Expand wildcards in any paths in the args list, and run C<command> "
15695 "repeatedly on each matching path."
15699 #: ../fish/guestfish-commands.pod:93
15700 msgid "See L</WILDCARDS AND GLOBBING>."
15704 #: ../fish/guestfish-commands.pod:95
15709 #: ../fish/guestfish-commands.pod:97
15712 " hexedit <filename|device>\n"
15713 " hexedit <filename|device> <max>\n"
15714 " hexedit <filename|device> <start> <max>\n"
15719 #: ../fish/guestfish-commands.pod:101
15721 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
15726 #: ../fish/guestfish-commands.pod:104
15728 "This command works by downloading potentially the whole file or device, "
15729 "editing it locally, then uploading it. If the file or device is large, you "
15730 "have to specify which part you wish to edit by using C<max> and/or C<start> "
15731 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
15732 "usual modifiers allowed such as C<1M> (1 megabyte)."
15736 #: ../fish/guestfish-commands.pod:111
15737 msgid "For example to edit the first few sectors of a disk you might do:"
15741 #: ../fish/guestfish-commands.pod:114
15744 " hexedit /dev/sda 1M\n"
15749 #: ../fish/guestfish-commands.pod:116
15751 "which would allow you to edit anywhere within the first megabyte of the disk."
15755 #: ../fish/guestfish-commands.pod:119
15756 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
15760 #: ../fish/guestfish-commands.pod:121
15763 " hexedit /dev/sda1 0x400 0x400\n"
15768 #: ../fish/guestfish-commands.pod:123
15769 msgid "(assuming the superblock is in the standard location)."
15773 #: ../fish/guestfish-commands.pod:125
15775 "This command requires the external L<hexedit(1)> program. You can specify "
15776 "another program to use by setting the C<HEXEDITOR> environment variable."
15780 #: ../fish/guestfish-commands.pod:129
15781 msgid "See also L</hexdump>."
15785 #: ../fish/guestfish-commands.pod:131
15790 #: ../fish/guestfish-commands.pod:133
15798 #: ../fish/guestfish-commands.pod:135
15800 "Change the local directory, ie. the current directory of guestfish itself."
15804 #: ../fish/guestfish-commands.pod:138
15805 msgid "Note that C<!cd> won't do what you might expect."
15809 #: ../fish/guestfish-commands.pod:140
15814 #: ../fish/guestfish-commands.pod:142
15819 #: ../fish/guestfish-commands.pod:144
15827 #: ../fish/guestfish-commands.pod:146
15828 msgid "Opens the manual page for guestfish."
15832 #: ../fish/guestfish-commands.pod:148
15837 #: ../fish/guestfish-commands.pod:150
15842 #: ../fish/guestfish-commands.pod:152
15850 #: ../fish/guestfish-commands.pod:154
15858 #: ../fish/guestfish-commands.pod:156
15859 msgid "This is used to view a file."
15863 #: ../fish/guestfish-commands.pod:158
15865 "The default viewer is C<$PAGER>. However if you use the alternate command "
15866 "C<less> you will get the C<less> command specifically."
15870 #: ../fish/guestfish-commands.pod:161
15875 #: ../fish/guestfish-commands.pod:163
15883 #: ../fish/guestfish-commands.pod:165
15885 "Close and reopen the libguestfs handle. It is not necessary to use this "
15886 "normally, because the handle is closed properly when guestfish exits. "
15887 "However this is occasionally useful for testing."
15891 #: ../fish/guestfish-commands.pod:169
15896 #: ../fish/guestfish-commands.pod:171
15899 " sparse filename size\n"
15904 #: ../fish/guestfish-commands.pod:173
15906 "This creates an empty sparse file of the given size, and then adds so it can "
15907 "be further examined."
15911 #: ../fish/guestfish-commands.pod:176
15913 "In all respects it works the same as the L</alloc> command, except that the "
15914 "image file is allocated sparsely, which means that disk blocks are not "
15915 "assigned to the file until they are needed. Sparse disk files only use "
15916 "space when written to, but they are slower and there is a danger you could "
15917 "run out of real disk space during a write operation."
15921 #: ../fish/guestfish-commands.pod:186
15926 #: ../fish/guestfish-commands.pod:188
15934 #: ../fish/guestfish-commands.pod:190
15936 "This command returns a list of the optional groups known to the daemon, and "
15937 "indicates which ones are supported by this build of the libguestfs appliance."
15941 #: ../fish/guestfish-commands.pod:194
15942 msgid "See also L<guestfs(3)/AVAILABILITY>."
15946 #: ../fish/guestfish-commands.pod:196
15951 #: ../fish/guestfish-commands.pod:198
15954 " time command args...\n"
15959 #: ../fish/guestfish-commands.pod:200
15961 "Run the command as usual, but print the elapsed time afterwards. This can "
15962 "be useful for benchmarking operations."
15966 #: ../fish/guestfish.pod:5
15967 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
15971 #: ../fish/guestfish.pod:9
15974 " guestfish [--options] [commands]\n"
15979 #: ../fish/guestfish.pod:11
15987 #: ../fish/guestfish.pod:13
15990 " guestfish [--ro|--rw] -a disk.img\n"
15995 #: ../fish/guestfish.pod:15
15998 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16003 #: ../fish/guestfish.pod:17
16006 " guestfish -d libvirt-domain\n"
16011 #: ../fish/guestfish.pod:19
16014 " guestfish [--ro|--rw] -a disk.img -i\n"
16019 #: ../fish/guestfish.pod:21
16022 " guestfish -d libvirt-domain -i\n"
16027 #: ../fish/guestfish.pod:25
16029 "Using guestfish in read/write mode on live virtual machines can be "
16030 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16031 "option to use guestfish safely if the disk image or virtual machine might be "
16036 #: ../fish/guestfish.pod:32
16038 "Guestfish is a shell and command-line tool for examining and modifying "
16039 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16040 "functionality of the guestfs API, see L<guestfs(3)>."
16044 #: ../fish/guestfish.pod:36
16046 "Guestfish gives you structured access to the libguestfs API, from shell "
16047 "scripts or the command line or interactively. If you want to rescue a "
16048 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16053 #: ../fish/guestfish.pod:43
16054 msgid "As an interactive shell"
16058 #: ../fish/guestfish.pod:45
16066 #: ../fish/guestfish.pod:47
16069 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16070 " editing virtual machine filesystems.\n"
16075 #: ../fish/guestfish.pod:50
16078 " Type: 'help' for a list of commands\n"
16079 " 'man' to read the manual\n"
16080 " 'quit' to quit the shell\n"
16085 #: ../fish/guestfish.pod:54
16088 " ><fs> add-ro disk.img\n"
16090 " ><fs> list-filesystems\n"
16091 " /dev/sda1: ext4\n"
16092 " /dev/vg_guest/lv_root: ext4\n"
16093 " /dev/vg_guest/lv_swap: swap\n"
16094 " ><fs> mount /dev/vg_guest/lv_root /\n"
16095 " ><fs> cat /etc/fstab\n"
16097 " # Created by anaconda\n"
16104 #: ../fish/guestfish.pod:67
16105 msgid "From shell scripts"
16109 #: ../fish/guestfish.pod:69
16110 msgid "Create a new C</etc/motd> file in a guest or disk image:"
16114 #: ../fish/guestfish.pod:71
16117 " guestfish <<_EOF_\n"
16120 " mount /dev/vg_guest/lv_root /\n"
16121 " write /etc/motd \"Welcome, new users\"\n"
16127 #: ../fish/guestfish.pod:78
16128 msgid "List the LVM logical volumes in a disk image:"
16132 #: ../fish/guestfish.pod:80
16135 " guestfish -a disk.img --ro <<_EOF_\n"
16143 #: ../fish/guestfish.pod:85
16144 msgid "List all the filesystems in a disk image:"
16148 #: ../fish/guestfish.pod:87
16151 " guestfish -a disk.img --ro <<_EOF_\n"
16153 " list-filesystems\n"
16159 #: ../fish/guestfish.pod:92
16160 msgid "On one command line"
16164 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
16165 msgid "Update C</etc/resolv.conf> in a guest:"
16169 #: ../fish/guestfish.pod:96
16173 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16174 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16179 #: ../fish/guestfish.pod:100
16180 msgid "Edit C</boot/grub/grub.conf> interactively:"
16184 #: ../fish/guestfish.pod:102
16187 " guestfish --rw --add disk.img \\\n"
16188 " --mount /dev/vg_guest/lv_root \\\n"
16189 " --mount /dev/sda1:/boot \\\n"
16190 " edit /boot/grub/grub.conf\n"
16195 #: ../fish/guestfish.pod:107
16196 msgid "Mount disks automatically"
16200 #: ../fish/guestfish.pod:109
16202 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
16206 #: ../fish/guestfish.pod:112
16209 " guestfish --ro -a disk.img -i cat /etc/group\n"
16214 #: ../fish/guestfish.pod:114
16217 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16222 #: ../fish/guestfish.pod:116
16223 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16227 #: ../fish/guestfish.pod:118
16230 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16235 #: ../fish/guestfish.pod:120
16236 msgid "As a script interpreter"
16240 #: ../fish/guestfish.pod:122
16241 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16245 #: ../fish/guestfish.pod:124
16248 " #!/usr/bin/guestfish -f\n"
16249 " sparse test1.img 100M\n"
16251 " part-disk /dev/sda mbr\n"
16252 " mkfs ext2 /dev/sda1\n"
16257 #: ../fish/guestfish.pod:130
16258 msgid "Start with a prepared disk"
16262 #: ../fish/guestfish.pod:132
16264 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16265 "single ext2-formatted partition:"
16269 #: ../fish/guestfish.pod:135
16272 " guestfish -N fs\n"
16277 #: ../fish/guestfish.pod:137
16278 msgid "To list what is available do:"
16282 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1009
16285 " guestfish -N help | less\n"
16290 #: ../fish/guestfish.pod:141
16291 msgid "Remote control"
16295 #: ../fish/guestfish.pod:143
16298 " eval \"`guestfish --listen`\"\n"
16299 " guestfish --remote add-ro disk.img\n"
16300 " guestfish --remote run\n"
16301 " guestfish --remote lvs\n"
16306 #: ../fish/guestfish.pod:154
16307 msgid "Displays general help on options."
16311 #: ../fish/guestfish.pod:158
16312 msgid "B<--cmd-help>"
16316 #: ../fish/guestfish.pod:160
16317 msgid "Lists all available guestfish commands."
16321 #: ../fish/guestfish.pod:162
16326 #: ../fish/guestfish.pod:164
16327 msgid "B<--cmd-help cmd>"
16331 #: ../fish/guestfish.pod:166
16332 msgid "Displays detailed help on a single command C<cmd>."
16336 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:87
16337 msgid "B<-a image>"
16341 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:89
16342 msgid "B<--add image>"
16346 #: ../fish/guestfish.pod:172
16347 msgid "Add a block device or virtual machine image to the shell."
16351 #: ../fish/guestfish.pod:177
16353 "Using this flag is mostly equivalent to using the C<add> command, with "
16354 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
16355 "the I<--format=...> flag was given."
16359 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:100
16361 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16362 "URI to use. The default is to use the default libvirt connection."
16366 #: ../fish/guestfish.pod:189
16371 #: ../fish/guestfish.pod:191
16373 "If using the I<--listen> option and a csh-like shell, use this option. See "
16374 "section L</REMOTE CONTROL AND CSH> below."
16378 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:104
16379 msgid "B<-d libvirt-domain>"
16383 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:106
16384 msgid "B<--domain libvirt-domain>"
16388 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:108
16390 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16391 "used, then any libvirt domain can be used. However in write mode, only "
16392 "libvirt domains which are shut down can be named here."
16396 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:112
16397 msgid "Domain UUIDs can be used instead of names."
16401 #: ../fish/guestfish.pod:204
16403 "Using this flag is mostly equivalent to using the C<add-domain> command, "
16404 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
16405 "if the I<--format:...> flag was given."
16409 #: ../fish/guestfish.pod:208
16414 #: ../fish/guestfish.pod:210
16415 msgid "B<--no-dest-paths>"
16419 #: ../fish/guestfish.pod:212
16421 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16422 "to hit the tab key to complete paths on the guest filesystem, but this "
16423 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16424 "allow this feature to be disabled."
16428 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:128
16430 "When prompting for keys and passphrases, guestfish normally turns echoing "
16431 "off so you cannot see what you are typing. If you are not worried about "
16432 "Tempest attacks and there is no one else in the room you can specify this "
16433 "flag to see what you are typing."
16437 #: ../fish/guestfish.pod:224
16442 #: ../fish/guestfish.pod:226
16443 msgid "B<--file file>"
16447 #: ../fish/guestfish.pod:228
16448 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16452 #: ../fish/guestfish.pod:231
16455 " #!/usr/bin/guestfish -f\n"
16460 #: ../fish/guestfish.pod:244
16463 " guestfish --format=raw -a disk.img\n"
16468 #: ../fish/guestfish.pod:248
16471 " guestfish --format=raw -a disk.img --format -a another.img\n"
16476 #: ../fish/guestfish.pod:253
16478 "If you have untrusted raw-format guest disk images, you should use this "
16479 "option to specify the disk format. This avoids a possible security problem "
16480 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16484 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:157
16485 msgid "B<--inspector>"
16489 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:159
16491 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16492 "system and mount filesystems as they would be mounted on the real virtual "
16497 #: ../fish/guestfish.pod:266
16498 msgid "Typical usage is either:"
16502 #: ../fish/guestfish.pod:268
16505 " guestfish -d myguest -i\n"
16510 #: ../fish/guestfish.pod:270
16511 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16515 #: ../fish/guestfish.pod:272
16518 " guestfish --ro -d myguest -i\n"
16523 #: ../fish/guestfish.pod:274
16524 msgid "(for active domains, readonly), or specify the block device directly:"
16528 #: ../fish/guestfish.pod:276
16531 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16536 #: ../fish/guestfish.pod:278
16538 "Note that the command line syntax changed slightly over older versions of "
16539 "guestfish. You can still use the old syntax:"
16543 #: ../fish/guestfish.pod:281
16546 " guestfish [--ro] -i disk.img\n"
16551 #: ../fish/guestfish.pod:283
16554 " guestfish [--ro] -i libvirt-domain\n"
16559 #: ../fish/guestfish.pod:285
16561 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
16562 "then using other commands to mount the filesystems that were found."
16566 #: ../fish/guestfish.pod:294
16567 msgid "B<--listen>"
16571 #: ../fish/guestfish.pod:296
16573 "Fork into the background and listen for remote commands. See section L</"
16574 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16578 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:168
16583 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:170
16585 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
16586 "ATTACHING TO RUNNING DAEMONS>)."
16590 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:173
16591 msgid "B<-m dev[:mountpoint[:options]]>"
16595 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:175
16596 msgid "B<--mount dev[:mountpoint[:options]]>"
16600 #: ../fish/guestfish.pod:308
16601 msgid "Mount the named partition or logical volume on the given mountpoint."
16605 #: ../fish/guestfish.pod:310
16606 msgid "If the mountpoint is omitted, it defaults to C</>."
16610 #: ../fish/guestfish.pod:312
16611 msgid "You have to mount something on C</> before most commands will work."
16615 #: ../fish/guestfish.pod:314
16617 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16622 #: ../fish/guestfish.pod:317
16624 "If you don't know what filesystems a disk image contains, you can either run "
16625 "guestfish without this option, then list the partitions, filesystems and LVs "
16626 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
16627 "commands), or you can use the L<virt-filesystems(1)> program."
16631 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:183
16633 "The third (and rarely used) part of the mount parameter is the list of mount "
16634 "options used to mount the underlying filesystem. If this is not given, then "
16635 "the mount options are either the empty string or C<ro> (the latter if the "
16636 "I<--ro> flag is used). By specifying the mount options, you override this "
16637 "default choice. Probably the only time you would use this is to enable ACLs "
16638 "and/or extended attributes if the filesystem can support them:"
16642 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:191
16645 " -m /dev/sda1:/:acl,user_xattr\n"
16650 #: ../fish/guestfish.pod:333
16651 msgid "Using this flag is equivalent to using the C<mount-options> command."
16655 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:193
16656 #: ../resize/virt-resize.pod:358
16661 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:195
16662 msgid "B<--no-sync>"
16666 #: ../fish/guestfish.pod:339
16668 "Disable autosync. This is enabled by default. See the discussion of "
16669 "autosync in the L<guestfs(3)> manpage."
16673 #: ../fish/guestfish.pod:342
16678 #: ../fish/guestfish.pod:344
16679 msgid "B<--new type>"
16683 #: ../fish/guestfish.pod:346
16688 #: ../fish/guestfish.pod:348
16690 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16691 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16692 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16697 #: ../fish/guestfish.pod:353
16698 msgid "B<--progress-bars>"
16702 #: ../fish/guestfish.pod:355
16703 msgid "Enable progress bars, even when guestfish is used non-interactively."
16707 #: ../fish/guestfish.pod:357
16709 "Progress bars are enabled by default when guestfish is used as an "
16710 "interactive shell."
16714 #: ../fish/guestfish.pod:360
16715 msgid "B<--no-progress-bars>"
16719 #: ../fish/guestfish.pod:362
16720 msgid "Disable progress bars."
16724 #: ../fish/guestfish.pod:364
16725 msgid "B<--remote[=pid]>"
16729 #: ../fish/guestfish.pod:366
16731 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16732 "CONTROL GUESTFISH OVER A SOCKET> below."
16736 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:239
16737 #: ../rescue/virt-rescue.pod:161
16742 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:241
16743 #: ../rescue/virt-rescue.pod:163
16748 #: ../fish/guestfish.pod:373
16750 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16751 "mounts are done read-only."
16755 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
16757 "The option must always be used if the disk image or virtual machine might be "
16758 "running, and is generally recommended in cases where you don't need write "
16759 "access to the disk."
16763 #: ../fish/guestfish.pod:380
16765 "Note that prepared disk images created with I<-N> are not affected by this "
16766 "option. Also commands like C<add> are not affected - you have to specify "
16767 "the C<readonly:true> option explicitly if you need it."
16771 #: ../fish/guestfish.pod:384
16772 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
16776 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:253
16777 #: ../rescue/virt-rescue.pod:173
16778 msgid "B<--selinux>"
16782 #: ../fish/guestfish.pod:388
16783 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16787 #: ../fish/guestfish.pod:394
16789 "Enable very verbose messages. This is particularly useful if you find a bug."
16793 #: ../fish/guestfish.pod:401
16794 msgid "Display the guestfish / libguestfs version number and exit."
16798 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:269
16799 #: ../rescue/virt-rescue.pod:190
16804 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:271
16805 #: ../rescue/virt-rescue.pod:192
16810 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:273
16812 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16813 "mounts are done read-write."
16817 #: ../fish/guestfish.pod:410
16818 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
16822 #: ../fish/guestfish.pod:414
16823 msgid "Echo each command before executing it."
16827 #: ../fish/guestfish.pod:418
16828 msgid "COMMANDS ON COMMAND LINE"
16832 #: ../fish/guestfish.pod:420
16834 "Any additional (non-option) arguments are treated as commands to execute."
16838 #: ../fish/guestfish.pod:423
16840 "Commands to execute should be separated by a colon (C<:>), where the colon "
16841 "is a separate parameter. Thus:"
16845 #: ../fish/guestfish.pod:426
16848 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16853 #: ../fish/guestfish.pod:428
16855 "If there are no additional arguments, then we enter a shell, either an "
16856 "interactive shell with a prompt (if the input is a terminal) or a non-"
16857 "interactive shell."
16861 #: ../fish/guestfish.pod:432
16863 "In either command line mode or non-interactive shell, the first command that "
16864 "gives an error causes the whole shell to exit. In interactive mode (with a "
16865 "prompt) if a command fails, you can continue to enter commands."
16869 #: ../fish/guestfish.pod:437
16870 msgid "USING launch (OR run)"
16874 #: ../fish/guestfish.pod:439
16876 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16877 "then launch it, then mount any disks you need, and finally issue actions/"
16878 "commands. So the general order of the day is:"
16882 #: ../fish/guestfish.pod:447
16883 msgid "add or -a/--add"
16887 #: ../fish/guestfish.pod:451
16888 msgid "launch (aka run)"
16892 #: ../fish/guestfish.pod:455
16893 msgid "mount or -m/--mount"
16897 #: ../fish/guestfish.pod:459
16898 msgid "any other commands"
16902 #: ../fish/guestfish.pod:463
16904 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16905 "guest before mounting or performing any other commands."
16909 #: ../fish/guestfish.pod:466
16911 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16912 "I<--new> options were given then C<run> is done automatically, simply "
16913 "because guestfish can't perform the action you asked for without doing this."
16917 #: ../fish/guestfish.pod:471
16918 msgid "OPENING DISKS FOR READ AND WRITE"
16922 #: ../fish/guestfish.pod:473
16924 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
16925 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
16926 "I<-i> and I<-m> open disk images read-only or for writing."
16930 #: ../fish/guestfish.pod:478
16932 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
16933 "opening disk images supplied on the command line for write. To open a disk "
16934 "image read-only you have to do I<-a image --ro>."
16938 #: ../fish/guestfish.pod:482
16940 "This matters: If you accidentally open a live VM disk image writable then "
16941 "you will cause irreversible disk corruption."
16945 #: ../fish/guestfish.pod:485
16947 "In a future libguestfs we intend to change the default the other way. Disk "
16948 "images will be opened read-only. You will have to either specify "
16949 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
16950 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
16951 "access for disk images specified by those other command line options."
16955 #: ../fish/guestfish.pod:492
16957 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
16958 "which does nothing (it is already the default). However it is highly "
16959 "recommended that you use this option to indicate that you need write access, "
16960 "and prepare your scripts for the day when this option will be required for "
16965 #: ../fish/guestfish.pod:498
16967 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
16968 "other libguestfs program apart from guestfish and guestmount."
16972 #: ../fish/guestfish.pod:501
16977 #: ../fish/guestfish.pod:503
16979 "You can quote ordinary parameters using either single or double quotes. For "
16984 #: ../fish/guestfish.pod:506
16987 " add \"file with a space.img\"\n"
16992 #: ../fish/guestfish.pod:508
16995 " rm '/file name'\n"
17000 #: ../fish/guestfish.pod:510
17008 #: ../fish/guestfish.pod:512
17010 "A few commands require a list of strings to be passed. For these, use a "
17011 "whitespace-separated list, enclosed in quotes. Strings containing "
17012 "whitespace to be passed through must be enclosed in single quotes. A "
17013 "literal single quote must be escaped with a backslash."
17017 #: ../fish/guestfish.pod:517
17020 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17021 " command \"/bin/echo 'foo bar'\"\n"
17022 " command \"/bin/echo \\'foo\\'\"\n"
17027 #: ../fish/guestfish.pod:521
17028 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
17032 #: ../fish/guestfish.pod:523
17034 "In double-quoted arguments (only) use backslash to insert special characters:"
17038 #: ../fish/guestfish.pod:528
17043 #: ../fish/guestfish.pod:530
17044 msgid "Alert (bell) character."
17048 #: ../fish/guestfish.pod:532
17053 #: ../fish/guestfish.pod:534
17054 msgid "Backspace character."
17058 #: ../fish/guestfish.pod:536
17063 #: ../fish/guestfish.pod:538
17064 msgid "Form feed character."
17068 #: ../fish/guestfish.pod:540
17073 #: ../fish/guestfish.pod:542
17074 msgid "Newline character."
17078 #: ../fish/guestfish.pod:544
17083 #: ../fish/guestfish.pod:546
17084 msgid "Carriage return character."
17088 #: ../fish/guestfish.pod:548
17093 #: ../fish/guestfish.pod:550
17094 msgid "Horizontal tab character."
17098 #: ../fish/guestfish.pod:552
17103 #: ../fish/guestfish.pod:554
17104 msgid "Vertical tab character."
17108 #: ../fish/guestfish.pod:556
17113 #: ../fish/guestfish.pod:558
17114 msgid "A literal double quote character."
17118 #: ../fish/guestfish.pod:560
17123 #: ../fish/guestfish.pod:562
17125 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
17130 #: ../fish/guestfish.pod:565
17135 #: ../fish/guestfish.pod:567
17137 "A character with hex value I<hh>. There must be precisely 2 hex digits."
17141 #: ../fish/guestfish.pod:570
17143 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
17148 #: ../fish/guestfish.pod:573
17153 #: ../fish/guestfish.pod:575
17154 msgid "A literal backslash character."
17158 #: ../fish/guestfish.pod:579
17159 msgid "OPTIONAL ARGUMENTS"
17163 #: ../fish/guestfish.pod:581
17165 "Some commands take optional arguments. These arguments appear in this "
17166 "documentation as C<[argname:..]>. You can use them as in these examples:"
17170 #: ../fish/guestfish.pod:585
17173 " add-drive-opts filename\n"
17178 #: ../fish/guestfish.pod:587
17181 " add-drive-opts filename readonly:true\n"
17186 #: ../fish/guestfish.pod:589
17189 " add-drive-opts filename format:qcow2 readonly:false\n"
17194 #: ../fish/guestfish.pod:591
17196 "Each optional argument can appear at most once. All optional arguments must "
17197 "appear after the required ones."
17201 #: ../fish/guestfish.pod:594
17206 #: ../fish/guestfish.pod:596
17208 "This section applies to all commands which can take integers as parameters."
17212 #: ../fish/guestfish.pod:599
17213 msgid "SIZE SUFFIX"
17217 #: ../fish/guestfish.pod:601
17219 "When the command takes a parameter measured in bytes, you can use one of the "
17220 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17224 #: ../fish/guestfish.pod:607
17225 msgid "B<k> or B<K> or B<KiB>"
17229 #: ../fish/guestfish.pod:609
17230 msgid "The size in kilobytes (multiplied by 1024)."
17234 #: ../fish/guestfish.pod:611
17239 #: ../fish/guestfish.pod:613
17240 msgid "The size in SI 1000 byte units."
17244 #: ../fish/guestfish.pod:615
17245 msgid "B<M> or B<MiB>"
17249 #: ../fish/guestfish.pod:617
17250 msgid "The size in megabytes (multiplied by 1048576)."
17254 #: ../fish/guestfish.pod:619
17259 #: ../fish/guestfish.pod:621
17260 msgid "The size in SI 1000000 byte units."
17264 #: ../fish/guestfish.pod:623
17265 msgid "B<G> or B<GiB>"
17269 #: ../fish/guestfish.pod:625
17270 msgid "The size in gigabytes (multiplied by 2**30)."
17274 #: ../fish/guestfish.pod:627
17279 #: ../fish/guestfish.pod:629
17280 msgid "The size in SI 10**9 byte units."
17284 #: ../fish/guestfish.pod:631
17285 msgid "B<T> or B<TiB>"
17289 #: ../fish/guestfish.pod:633
17290 msgid "The size in terabytes (multiplied by 2**40)."
17294 #: ../fish/guestfish.pod:635
17299 #: ../fish/guestfish.pod:637
17300 msgid "The size in SI 10**12 byte units."
17304 #: ../fish/guestfish.pod:639
17305 msgid "B<P> or B<PiB>"
17309 #: ../fish/guestfish.pod:641
17310 msgid "The size in petabytes (multiplied by 2**50)."
17314 #: ../fish/guestfish.pod:643
17319 #: ../fish/guestfish.pod:645
17320 msgid "The size in SI 10**15 byte units."
17324 #: ../fish/guestfish.pod:647
17325 msgid "B<E> or B<EiB>"
17329 #: ../fish/guestfish.pod:649
17330 msgid "The size in exabytes (multiplied by 2**60)."
17334 #: ../fish/guestfish.pod:651
17339 #: ../fish/guestfish.pod:653
17340 msgid "The size in SI 10**18 byte units."
17344 #: ../fish/guestfish.pod:655
17345 msgid "B<Z> or B<ZiB>"
17349 #: ../fish/guestfish.pod:657
17350 msgid "The size in zettabytes (multiplied by 2**70)."
17354 #: ../fish/guestfish.pod:659
17359 #: ../fish/guestfish.pod:661
17360 msgid "The size in SI 10**21 byte units."
17364 #: ../fish/guestfish.pod:663
17365 msgid "B<Y> or B<YiB>"
17369 #: ../fish/guestfish.pod:665
17370 msgid "The size in yottabytes (multiplied by 2**80)."
17374 #: ../fish/guestfish.pod:667
17379 #: ../fish/guestfish.pod:669
17380 msgid "The size in SI 10**24 byte units."
17384 #: ../fish/guestfish.pod:675
17387 " truncate-size /file 1G\n"
17392 #: ../fish/guestfish.pod:677
17393 msgid "would truncate the file to 1 gigabyte."
17397 #: ../fish/guestfish.pod:679
17399 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
17400 "the parameter to L</memsize> is specified in megabytes already). Adding a "
17401 "suffix will probably not do what you expect."
17405 #: ../fish/guestfish.pod:683
17406 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17410 #: ../fish/guestfish.pod:685
17412 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17413 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17417 #: ../fish/guestfish.pod:688
17420 " 1234 decimal number 1234\n"
17421 " 02322 octal number, equivalent to decimal 1234\n"
17422 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17427 #: ../fish/guestfish.pod:692
17429 "When using the C<chmod> command, you almost always want to specify an octal "
17430 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17431 "L<chmod(1)> program):"
17435 #: ../fish/guestfish.pod:696
17438 " chmod 0777 /public # OK\n"
17439 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17444 #: ../fish/guestfish.pod:699
17446 "Commands that return numbers usually print them in decimal, but some "
17447 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17448 "octal, preceeded by C<0>)."
17452 #: ../fish/guestfish.pod:703
17453 msgid "WILDCARDS AND GLOBBING"
17457 #: ../fish/guestfish.pod:705
17459 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17460 "(globbing) by default. So for example the following will not do what you "
17465 #: ../fish/guestfish.pod:709
17473 #: ../fish/guestfish.pod:711
17475 "Assuming you don't have a directory called literally C</home/*> then the "
17476 "above command will return an error."
17480 #: ../fish/guestfish.pod:714
17481 msgid "To perform wildcard expansion, use the C<glob> command."
17485 #: ../fish/guestfish.pod:716
17488 " glob rm-rf /home/*\n"
17493 #: ../fish/guestfish.pod:718
17495 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17496 "many times), equivalent to:"
17500 #: ../fish/guestfish.pod:721
17503 " rm-rf /home/jim\n"
17504 " rm-rf /home/joe\n"
17505 " rm-rf /home/mary\n"
17510 #: ../fish/guestfish.pod:725
17511 msgid "C<glob> only works on simple guest paths and not on device names."
17515 #: ../fish/guestfish.pod:727
17517 "If you have several parameters, each containing a wildcard, then glob will "
17518 "perform a Cartesian product."
17522 #: ../fish/guestfish.pod:730
17527 #: ../fish/guestfish.pod:732
17529 "Any line which starts with a I<#> character is treated as a comment and "
17530 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17531 "a command. For example:"
17535 #: ../fish/guestfish.pod:736
17538 " # this is a comment\n"
17539 " # this is a comment\n"
17540 " foo # NOT a comment\n"
17545 #: ../fish/guestfish.pod:740
17546 msgid "Blank lines are also ignored."
17550 #: ../fish/guestfish.pod:742
17551 msgid "RUNNING COMMANDS LOCALLY"
17555 #: ../fish/guestfish.pod:744
17557 "Any line which starts with a I<!> character is treated as a command sent to "
17558 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17562 #: ../fish/guestfish.pod:748
17566 " tgz-out /remote local/remote-data.tar.gz\n"
17571 #: ../fish/guestfish.pod:751
17573 "will create a directory C<local> on the host, and then export the contents "
17574 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17575 "(See C<tgz-out>)."
17579 #: ../fish/guestfish.pod:755
17581 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17582 "effect, due to the way that subprocesses work in Unix."
17586 #: ../fish/guestfish.pod:758
17587 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
17591 #: ../fish/guestfish.pod:760
17593 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
17594 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
17595 "and executed as guestfish commands."
17599 #: ../fish/guestfish.pod:764
17601 "Thus you can use shell script to construct arbitrary guestfish commands "
17602 "which are then parsed by guestfish."
17606 #: ../fish/guestfish.pod:767
17608 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
17609 "through C</foo.100>) using guestfish commands alone. However this is simple "
17610 "if we use a shell script to create the guestfish commands for us:"
17614 #: ../fish/guestfish.pod:772
17617 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
17622 #: ../fish/guestfish.pod:774
17623 msgid "or with names like C</foo.001>:"
17627 #: ../fish/guestfish.pod:776
17630 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
17635 #: ../fish/guestfish.pod:778
17637 "When using guestfish interactively it can be helpful to just run the shell "
17638 "script first (ie. remove the initial C<E<lt>> character so it is just an "
17639 "ordinary I<!> local command), see what guestfish commands it would run, and "
17640 "when you are happy with those prepend the C<E<lt>> character to run the "
17641 "guestfish commands for real."
17645 #: ../fish/guestfish.pod:784
17650 #: ../fish/guestfish.pod:786
17652 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17653 "command (a guestfish command) to the second command (any host command). For "
17658 #: ../fish/guestfish.pod:790
17661 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17666 #: ../fish/guestfish.pod:792
17668 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17669 "program). The above command would list all accounts in the guest filesystem "
17670 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17674 #: ../fish/guestfish.pod:797
17677 " hexdump /bin/ls | head\n"
17678 " list-devices | tail -1\n"
17679 " tgz-out / - | tar ztf -\n"
17684 #: ../fish/guestfish.pod:801
17686 "The space before the pipe symbol is required, any space after the pipe "
17687 "symbol is optional. Everything after the pipe symbol is just passed "
17688 "straight to the host shell, so it can contain redirections, globs and "
17689 "anything else that makes sense on the host side."
17693 #: ../fish/guestfish.pod:806
17695 "To use a literal argument which begins with a pipe symbol, you have to quote "
17700 #: ../fish/guestfish.pod:809
17708 #: ../fish/guestfish.pod:811
17709 msgid "HOME DIRECTORIES"
17713 #: ../fish/guestfish.pod:813
17715 "If a parameter starts with the character C<~> then the tilde may be expanded "
17716 "as a home directory path (either C<~> for the current user's home directory, "
17717 "or C<~user> for another user)."
17721 #: ../fish/guestfish.pod:817
17723 "Note that home directory expansion happens for users known I<on the host>, "
17724 "not in the guest filesystem."
17728 #: ../fish/guestfish.pod:820
17730 "To use a literal argument which begins with a tilde, you have to quote it, "
17735 #: ../fish/guestfish.pod:823
17743 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:519
17744 msgid "ENCRYPTED DISKS"
17748 #: ../fish/guestfish.pod:827
17750 "Libguestfs has some support for Linux guests encrypted according to the "
17751 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17752 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
17753 "LUKS is supported."
17757 #: ../fish/guestfish.pod:832
17758 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17762 #: ../fish/guestfish.pod:834
17765 " ><fs> vfs-type /dev/sda2\n"
17771 #: ../fish/guestfish.pod:837
17773 "Then open those devices using L</luks-open>. This creates a device-mapper "
17774 "device called C</dev/mapper/luksdev>."
17778 #: ../fish/guestfish.pod:840
17781 " ><fs> luks-open /dev/sda2 luksdev\n"
17782 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17787 #: ../fish/guestfish.pod:843
17789 "Finally you have to tell LVM to scan for volume groups on the newly created "
17794 #: ../fish/guestfish.pod:846
17798 " vg-activate-all true\n"
17803 #: ../fish/guestfish.pod:849
17804 msgid "The logical volume(s) can now be mounted in the usual way."
17808 #: ../fish/guestfish.pod:851
17810 "Before closing a LUKS device you must unmount any logical volumes on it and "
17811 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17812 "one. Then you can close the mapper device:"
17816 #: ../fish/guestfish.pod:855
17819 " vg-activate false /dev/VG\n"
17820 " luks-close /dev/mapper/luksdev\n"
17825 #: ../fish/guestfish.pod:860
17827 "If a path is prefixed with C<win:> then you can use Windows-style drive "
17828 "letters and paths (with some limitations). The following commands are "
17833 #: ../fish/guestfish.pod:864
17836 " file /WINDOWS/system32/config/system.LOG\n"
17841 #: ../fish/guestfish.pod:866
17844 " file win:\\windows\\system32\\config\\system.log\n"
17849 #: ../fish/guestfish.pod:868
17852 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
17857 #: ../fish/guestfish.pod:870
17859 "The parameter is rewritten \"behind the scenes\" by looking up the position "
17860 "where the drive is mounted, prepending that to the path, changing all "
17861 "backslash characters to forward slash, then resolving the result using L</"
17862 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
17863 "the parameter might be rewritten like this:"
17867 #: ../fish/guestfish.pod:876
17870 " win:e:\\foo\\bar => /e/FOO/bar\n"
17875 #: ../fish/guestfish.pod:878
17876 msgid "This only works in argument positions that expect a path."
17880 #: ../fish/guestfish.pod:880
17881 msgid "UPLOADING AND DOWNLOADING FILES"
17885 #: ../fish/guestfish.pod:882
17887 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17888 "others which upload from or download to a local file, you can use the "
17889 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17893 #: ../fish/guestfish.pod:886
17901 #: ../fish/guestfish.pod:888
17903 "reads stdin and creates from that a file C</foo> in the disk image, and:"
17907 #: ../fish/guestfish.pod:891
17910 " tar-out /etc - | tar tf -\n"
17915 #: ../fish/guestfish.pod:893
17917 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17918 "command (see L</PIPES>)."
17922 #: ../fish/guestfish.pod:896
17924 "When using C<-> to read from stdin, the input is read up to the end of "
17925 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17926 "some arbitrary end marker:"
17930 #: ../fish/guestfish.pod:900
17933 " upload -<<END /foo\n"
17942 #: ../fish/guestfish.pod:906
17944 "Any string of characters can be used instead of C<END>. The end marker must "
17945 "appear on a line of its own, without any preceeding or following characters "
17946 "(not even spaces)."
17950 #: ../fish/guestfish.pod:910
17952 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17953 "upload local files (so-called \"FileIn\" parameters in the generator)."
17957 #: ../fish/guestfish.pod:913
17958 msgid "EXIT ON ERROR BEHAVIOUR"
17962 #: ../fish/guestfish.pod:915
17964 "By default, guestfish will ignore any errors when in interactive mode (ie. "
17965 "taking commands from a human over a tty), and will exit on the first error "
17966 "in non-interactive mode (scripts, commands given on the command line)."
17970 #: ../fish/guestfish.pod:920
17972 "If you prefix a command with a I<-> character, then that command will not "
17973 "cause guestfish to exit, even if that (one) command returns an error."
17977 #: ../fish/guestfish.pod:924
17978 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
17982 #: ../fish/guestfish.pod:926
17984 "Guestfish can be remote-controlled over a socket. This is useful "
17985 "particularly in shell scripts where you want to make several different "
17986 "changes to a filesystem, but you don't want the overhead of starting up a "
17987 "guestfish process each time."
17991 #: ../fish/guestfish.pod:931
17992 msgid "Start a guestfish server process using:"
17996 #: ../fish/guestfish.pod:933
17999 " eval \"`guestfish --listen`\"\n"
18004 #: ../fish/guestfish.pod:935
18005 msgid "and then send it commands by doing:"
18009 #: ../fish/guestfish.pod:937
18012 " guestfish --remote cmd [...]\n"
18017 #: ../fish/guestfish.pod:939
18018 msgid "To cause the server to exit, send it the exit command:"
18022 #: ../fish/guestfish.pod:943
18024 "Note that the server will normally exit if there is an error in a command. "
18025 "You can change this in the usual way. See section L</EXIT ON ERROR "
18030 #: ../fish/guestfish.pod:947
18031 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18035 #: ../fish/guestfish.pod:949
18037 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18038 "is how the I<--remote> option knows where to send the commands. You can "
18039 "have several guestfish listener processes running using:"
18043 #: ../fish/guestfish.pod:953
18046 " eval \"`guestfish --listen`\"\n"
18047 " pid1=$GUESTFISH_PID\n"
18048 " eval \"`guestfish --listen`\"\n"
18049 " pid2=$GUESTFISH_PID\n"
18051 " guestfish --remote=$pid1 cmd\n"
18052 " guestfish --remote=$pid2 cmd\n"
18057 #: ../fish/guestfish.pod:961
18058 msgid "REMOTE CONTROL AND CSH"
18062 #: ../fish/guestfish.pod:963
18064 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18069 #: ../fish/guestfish.pod:966
18072 " eval \"`guestfish --listen --csh`\"\n"
18077 #: ../fish/guestfish.pod:968
18078 msgid "REMOTE CONTROL DETAILS"
18082 #: ../fish/guestfish.pod:970
18084 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18085 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18086 "and C<$PID> is the process ID of the server."
18090 #: ../fish/guestfish.pod:974
18091 msgid "Guestfish client and server versions must match exactly."
18095 #: ../fish/guestfish.pod:976
18096 msgid "REMOTE CONTROL RUN COMMAND HANGING"
18100 #: ../fish/guestfish.pod:978
18102 "Using the C<run> (or C<launch>) command remotely in a command substitution "
18103 "context hangs, ie. don't do (note the backquotes):"
18107 #: ../fish/guestfish.pod:981
18110 " a=`guestfish --remote run`\n"
18115 #: ../fish/guestfish.pod:983
18117 "Since the C<run> command produces no output on stdout, this is not useful "
18118 "anyway. For further information see L<https://bugzilla.redhat.com/show_bug."
18123 #: ../fish/guestfish.pod:987
18124 msgid "PREPARED DISK IMAGES"
18128 #: ../fish/guestfish.pod:989
18130 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18131 "preformatted disk images that guestfish can make for you to save typing. "
18132 "This is particularly useful for testing purposes. This option is used "
18133 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18134 "can be mixed with I<-a>)."
18138 #: ../fish/guestfish.pod:995
18140 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18141 "the second and so on. Existing files in the current directory are "
18146 #: ../fish/guestfish.pod:999
18148 "The type briefly describes how the disk should be sized, partitioned, how "
18149 "filesystem(s) should be created, and how content should be added. "
18150 "Optionally the type can be followed by extra parameters, separated by C<:> "
18151 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18152 "allocated disk, containing a single partition, with the partition formatted "
18153 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18158 #: ../fish/guestfish.pod:1007
18159 msgid "To list the available types and any extra parameters they take, run:"
18163 #: ../fish/guestfish.pod:1011
18165 "Note that the prepared filesystem is not mounted. You would usually have to "
18166 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18170 #: ../fish/guestfish.pod:1015
18172 "If any I<-N> or I<--new> options are given, the guest is automatically "
18177 #: ../fish/guestfish.pod:1020
18178 msgid "Create a 100MB disk with an ext4-formatted partition:"
18182 #: ../fish/guestfish.pod:1022
18185 " guestfish -N fs:ext4\n"
18190 #: ../fish/guestfish.pod:1024
18191 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18195 #: ../fish/guestfish.pod:1026
18198 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18203 #: ../fish/guestfish.pod:1028
18204 msgid "Create a blank 200MB disk:"
18208 #: ../fish/guestfish.pod:1030
18211 " guestfish -N disk:200M\n"
18216 #: ../fish/guestfish.pod:1032
18217 msgid "PROGRESS BARS"
18221 #: ../fish/guestfish.pod:1034
18223 "Some (not all) long-running commands send progress notification messages as "
18224 "they are running. Guestfish turns these messages into progress bars."
18228 #: ../fish/guestfish.pod:1038
18230 "When a command that supports progress bars takes longer than two seconds to "
18231 "run, and if progress bars are enabled, then you will see one appearing below "
18236 #: ../fish/guestfish.pod:1042
18239 " ><fs> copy-size /large-file /another-file 2048M\n"
18240 " / 10% [#####-----------------------------------------] 00:30\n"
18245 #: ../fish/guestfish.pod:1045
18247 "The spinner on the left hand side moves round once for every progress "
18248 "notification received from the backend. This is a (reasonably) golden "
18249 "assurance that the command is \"doing something\" even if the progress bar "
18250 "is not moving, because the command is able to send the progress "
18251 "notifications. When the bar reaches 100% and the command finishes, the "
18252 "spinner disappears."
18256 #: ../fish/guestfish.pod:1052
18258 "Progress bars are enabled by default when guestfish is used interactively. "
18259 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18260 "and you can disable them completely using I<--no-progress-bars>."
18264 #: ../fish/guestfish.pod:1057
18265 msgid "GUESTFISH COMMANDS"
18269 #: ../fish/guestfish.pod:1059
18271 "The commands in this section are guestfish convenience commands, in other "
18272 "words, they are not part of the L<guestfs(3)> API."
18276 #: ../fish/guestfish.pod:1062
18281 #: ../fish/guestfish.pod:1064
18290 #: ../fish/guestfish.pod:1067
18291 msgid "Without any parameter, this provides general help."
18295 #: ../fish/guestfish.pod:1069
18296 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18300 #: ../fish/guestfish.pod:1071
18301 msgid "quit | exit"
18305 #: ../fish/guestfish.pod:1073
18306 msgid "This exits guestfish. You can also use C<^D> key."
18310 #: ../fish/guestfish.pod:1075
18311 msgid "@FISH_COMMANDS@"
18315 #: ../fish/guestfish.pod:1077
18320 #: ../fish/guestfish.pod:1079 ../src/guestfs.pod:1474
18325 #: ../fish/guestfish.pod:1083
18327 "guestfish returns 0 if the commands completed without error, or 1 if there "
18332 #: ../fish/guestfish.pod:1090
18337 #: ../fish/guestfish.pod:1092
18339 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18344 #: ../fish/guestfish.pod:1095 ../src/guestfs.pod:2969
18345 msgid "FEBOOTSTRAP_KERNEL"
18349 #: ../fish/guestfish.pod:1097 ../src/guestfs.pod:2971
18350 msgid "FEBOOTSTRAP_MODULES"
18354 #: ../fish/guestfish.pod:1099 ../src/guestfs.pod:2973
18356 "These two environment variables allow the kernel that libguestfs uses in the "
18357 "appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
18358 "most recent host kernel is chosen. For more information about kernel "
18359 "selection, see L<febootstrap-supermin-helper(8)>. This feature is only "
18360 "available in febootstrap E<ge> 3.8."
18364 #: ../fish/guestfish.pod:1105
18365 msgid "GUESTFISH_DISPLAY_IMAGE"
18369 #: ../fish/guestfish.pod:1107
18371 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
18372 "If not set, it uses L<display(1)>."
18376 #: ../fish/guestfish.pod:1110
18377 msgid "GUESTFISH_PID"
18381 #: ../fish/guestfish.pod:1112
18383 "Used with the I<--remote> option to specify the remote guestfish process to "
18384 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18388 #: ../fish/guestfish.pod:1116
18393 #: ../fish/guestfish.pod:1118
18395 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18396 "not specified, the external L<hexedit(1)> program is used."
18400 #: ../fish/guestfish.pod:1122
18405 #: ../fish/guestfish.pod:1124
18407 "If compiled with GNU readline support, various files in the home directory "
18408 "can be used. See L</FILES>."
18412 #: ../fish/guestfish.pod:1127 ../src/guestfs.pod:2979
18413 msgid "LIBGUESTFS_APPEND"
18417 #: ../fish/guestfish.pod:1129 ../src/guestfs.pod:2981
18418 msgid "Pass additional options to the guest kernel."
18422 #: ../fish/guestfish.pod:1131 ../src/guestfs.pod:2983
18423 msgid "LIBGUESTFS_DEBUG"
18427 #: ../fish/guestfish.pod:1133
18429 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18430 "effect as using the B<-v> option."
18434 #: ../fish/guestfish.pod:1136 ../src/guestfs.pod:2988
18435 msgid "LIBGUESTFS_MEMSIZE"
18439 #: ../fish/guestfish.pod:1138 ../src/guestfs.pod:2990
18441 "Set the memory allocated to the qemu process, in megabytes. For example:"
18445 #: ../fish/guestfish.pod:1141 ../src/guestfs.pod:2993
18448 " LIBGUESTFS_MEMSIZE=700\n"
18453 #: ../fish/guestfish.pod:1143 ../src/guestfs.pod:2995
18454 msgid "LIBGUESTFS_PATH"
18458 #: ../fish/guestfish.pod:1145
18460 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18461 "the discussion of paths in L<guestfs(3)>."
18465 #: ../fish/guestfish.pod:1148 ../src/guestfs.pod:3000
18466 msgid "LIBGUESTFS_QEMU"
18470 #: ../fish/guestfish.pod:1150 ../src/guestfs.pod:3002
18472 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
18473 "which was found at compile time by the configure script is used."
18477 #: ../fish/guestfish.pod:1154 ../src/guestfs.pod:3008
18478 msgid "LIBGUESTFS_TRACE"
18482 #: ../fish/guestfish.pod:1156
18483 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18487 #: ../fish/guestfish.pod:1158
18492 #: ../fish/guestfish.pod:1160
18494 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18499 #: ../fish/guestfish.pod:1163 ../src/guestfs.pod:3013
18504 #: ../fish/guestfish.pod:1165 ../src/guestfs.pod:3015
18506 "Location of temporary directory, defaults to C</tmp> except for the cached "
18507 "supermin appliance which defaults to C</var/tmp>."
18511 #: ../fish/guestfish.pod:1168 ../src/guestfs.pod:3018
18513 "If libguestfs was compiled to use the supermin appliance then the real "
18514 "appliance is cached in this directory, shared between all handles belonging "
18515 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
18516 "use in case C</var/tmp> is not large enough."
18520 #: ../fish/guestfish.pod:1176 ../fuse/guestmount.pod:288
18521 #: ../rescue/virt-rescue.pod:269
18526 #: ../fish/guestfish.pod:1180 ../fuse/guestmount.pod:292
18527 #: ../rescue/virt-rescue.pod:273
18528 msgid "$HOME/.libguestfs-tools.rc"
18532 #: ../fish/guestfish.pod:1182 ../fuse/guestmount.pod:294
18533 #: ../rescue/virt-rescue.pod:275
18534 msgid "/etc/libguestfs-tools.conf"
18538 #: ../fish/guestfish.pod:1184 ../fuse/guestmount.pod:296
18539 #: ../rescue/virt-rescue.pod:277
18541 "This configuration file controls the default read-only or read-write mode "
18542 "(I<--ro> or I<--rw>)."
18546 #: ../fish/guestfish.pod:1187
18547 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
18551 #: ../fish/guestfish.pod:1189
18552 msgid "$HOME/.guestfish"
18556 #: ../fish/guestfish.pod:1191
18558 "If compiled with GNU readline support, then the command history is saved in "
18563 #: ../fish/guestfish.pod:1194
18564 msgid "$HOME/.inputrc"
18568 #: ../fish/guestfish.pod:1196
18569 msgid "/etc/inputrc"
18573 #: ../fish/guestfish.pod:1198
18575 "If compiled with GNU readline support, then these files can be used to "
18576 "configure readline. For further information, please see L<readline(3)/"
18577 "INITIALIZATION FILE>."
18581 #: ../fish/guestfish.pod:1202
18582 msgid "To write rules which only apply to guestfish, use:"
18586 #: ../fish/guestfish.pod:1204
18596 #: ../fish/guestfish.pod:1208
18598 "Variables that you can set in inputrc that change the behaviour of guestfish "
18599 "in useful ways include:"
18603 #: ../fish/guestfish.pod:1213
18604 msgid "completion-ignore-case (default: on)"
18608 #: ../fish/guestfish.pod:1215
18610 "By default, guestfish will ignore case when tab-completing paths on the "
18615 #: ../fish/guestfish.pod:1218
18618 " set completion-ignore-case off\n"
18623 #: ../fish/guestfish.pod:1220
18624 msgid "to make guestfish case sensitive."
18628 #: ../fish/guestfish.pod:1224
18633 #: ../fish/guestfish.pod:1226
18634 msgid "test2.img (etc)"
18638 #: ../fish/guestfish.pod:1228
18640 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
18641 "will be created in the file C<test1.img> in the current directory. The "
18642 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
18643 "the same name will be overwritten."
18647 #: ../fish/guestfish.pod:1237
18649 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
18650 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
18651 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
18652 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
18653 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
18654 ">, L<display(1)>, L<hexedit(1)>, L<febootstrap-supermin-helper(8)>."
18658 #: ../fish/guestfish.pod:1266 ../src/guestfs.pod:3104
18659 #: ../test-tool/libguestfs-test-tool.pod:99
18660 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
18664 #: ../fish/virt-copy-in.pod:5
18666 "virt-copy-in - Copy files and directories into a virtual machine disk image."
18670 #: ../fish/virt-copy-in.pod:9
18673 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
18678 #: ../fish/virt-copy-in.pod:11
18681 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
18686 #: ../fish/virt-copy-in.pod:15
18688 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
18689 "causing disk corruption. The virtual machine must be shut down before you "
18690 "use this command."
18694 #: ../fish/virt-copy-in.pod:21
18696 "C<virt-copy-in> copies files and directories from the local disk into a "
18697 "virtual machine disk image or named libvirt domain."
18701 #: ../fish/virt-copy-in.pod:24
18703 "You can give one of more filenames and directories on the command line. "
18704 "Directories are copied in recursively. The final parameter must be the "
18705 "destination directory in the disk image which must be an absolute path "
18706 "starting with a C</> character."
18710 #: ../fish/virt-copy-in.pod:33
18713 " virt-copy-in -d MyGuest resolv.conf /etc\n"
18718 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
18719 msgid "Upload a home directory to a guest:"
18723 #: ../fish/virt-copy-in.pod:37
18726 " virt-copy-in -d MyGuest skel /home\n"
18731 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28
18732 #: ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
18733 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
18737 #: ../fish/virt-copy-in.pod:41
18739 "This command is just a simple shell script wrapper around the L<guestfish(1)"
18740 "> C<copy-in> command. For anything more complex than a trivial copy, you "
18741 "are probably better off using guestfish directly."
18745 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36
18746 #: ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
18748 "Since the shell script just passes options straight to guestfish, read "
18749 "L<guestfish(1)> to see the full list of options."
18753 #: ../fish/virt-copy-in.pod:52
18755 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
18756 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18760 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55
18761 #: ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
18762 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
18766 #: ../fish/virt-copy-out.pod:5
18768 "virt-copy-out - Copy files and directories out of a virtual machine disk "
18773 #: ../fish/virt-copy-out.pod:9
18776 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
18781 #: ../fish/virt-copy-out.pod:11
18784 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
18789 #: ../fish/virt-copy-out.pod:15
18791 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
18792 "image or named libvirt domain."
18796 #: ../fish/virt-copy-out.pod:18
18798 "You can give one of more filenames and directories on the command line. "
18799 "Directories are copied out recursively."
18803 #: ../fish/virt-copy-out.pod:23
18804 msgid "Download the home directories from a virtual machine:"
18808 #: ../fish/virt-copy-out.pod:25
18812 " virt-copy-out -d MyGuest /home homes\n"
18817 #: ../fish/virt-copy-out.pod:30
18819 "This command is just a simple shell script wrapper around the L<guestfish(1)"
18820 "> C<copy-out> command. For anything more complex than a trivial copy, you "
18821 "are probably better off using guestfish directly."
18825 #: ../fish/virt-copy-out.pod:41
18827 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, L<virt-"
18828 "tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18832 #: ../fish/virt-tar-in.pod:5
18833 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
18837 #: ../fish/virt-tar-in.pod:9
18840 " virt-tar-in -a disk.img data.tar /destination\n"
18845 #: ../fish/virt-tar-in.pod:11
18848 " virt-tar-in -d domain data.tar /destination\n"
18853 #: ../fish/virt-tar-in.pod:13
18856 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
18861 #: ../fish/virt-tar-in.pod:17
18863 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
18864 "causing disk corruption. The virtual machine must be shut down before you "
18865 "use this command."
18869 #: ../fish/virt-tar-in.pod:23
18871 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
18872 "image or named libvirt domain."
18876 #: ../fish/virt-tar-in.pod:26
18878 "The first parameter is the tar file. Use C<-> to read the tar file from "
18879 "standard input. The second parameter is the absolute target directory to "
18884 #: ../fish/virt-tar-in.pod:34
18887 " virt-tar-in -d MyGuest homes.tar /home\n"
18892 #: ../fish/virt-tar-in.pod:38
18894 "This command is just a simple shell script wrapper around the L<guestfish(1)"
18895 "> C<tar-in> command. For anything more complex than a trivial copy, you are "
18896 "probably better off using guestfish directly."
18900 #: ../fish/virt-tar-in.pod:49
18902 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18903 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, L<http://libguestfs."
18908 #: ../fish/virt-tar-out.pod:5
18910 "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
18914 #: ../fish/virt-tar-out.pod:9
18917 " virt-tar-out -a disk.img /dir files.tar\n"
18922 #: ../fish/virt-tar-out.pod:11
18925 " virt-tar-out -d domain /dir files.tar\n"
18930 #: ../fish/virt-tar-out.pod:13
18933 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
18938 #: ../fish/virt-tar-out.pod:17
18940 "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
18944 #: ../fish/virt-tar-out.pod:20
18946 "The first parameter is the absolute path of the virtual machine directory. "
18947 "The second parameter is the tar file to write. Use C<-> to write to "
18952 #: ../fish/virt-tar-out.pod:26
18953 msgid "Download the home directories from a guest:"
18957 #: ../fish/virt-tar-out.pod:28
18960 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
18965 #: ../fish/virt-tar-out.pod:32
18967 "This command is just a simple shell script wrapper around the L<guestfish(1)"
18968 "> C<tar-out> command. For anything more complex than a trivial copy, you "
18969 "are probably better off using guestfish directly."
18973 #: ../fish/virt-tar-out.pod:43
18975 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18976 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
18980 #: ../fuse/guestmount.pod:5
18982 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
18986 #: ../fuse/guestmount.pod:9
18989 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
18994 #: ../fuse/guestmount.pod:11
18997 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
19002 #: ../fuse/guestmount.pod:13
19005 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
19010 #: ../fuse/guestmount.pod:17
19012 "You must I<not> use C<guestmount> in read-write mode on live virtual "
19013 "machines. If you do this, you risk disk corruption in the VM."
19017 #: ../fuse/guestmount.pod:22
19019 "The guestmount program can be used to mount virtual machine filesystems and "
19020 "other disk images on the host. It uses libguestfs for access to the guest "
19021 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
19022 "a mountable device."
19026 #: ../fuse/guestmount.pod:27
19028 "Along with other options, you have to give at least one device (I<-a> "
19029 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
19030 "option) or use the I<-i> inspection option. How this works is better "
19031 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
19036 #: ../fuse/guestmount.pod:33
19038 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
19039 "by you, and the filesystem will not be visible to any other users unless you "
19040 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
19041 "the filesystem, use the C<fusermount -u> command."
19045 #: ../fuse/guestmount.pod:41
19047 "For a typical Windows guest which has its main filesystem on the first "
19052 #: ../fuse/guestmount.pod:44
19055 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
19060 #: ../fuse/guestmount.pod:46
19062 "For a typical Linux guest which has a /boot filesystem on the first "
19063 "partition, and the root filesystem on a logical volume:"
19067 #: ../fuse/guestmount.pod:49
19070 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
19075 #: ../fuse/guestmount.pod:51
19076 msgid "To get libguestfs to detect guest mountpoints for you:"
19080 #: ../fuse/guestmount.pod:53
19083 " guestmount -a guest.img -i --ro /mnt\n"
19088 #: ../fuse/guestmount.pod:55
19089 msgid "For a libvirt guest called \"Guest\" you could do:"
19093 #: ../fuse/guestmount.pod:57
19096 " guestmount -d Guest -i --ro /mnt\n"
19101 #: ../fuse/guestmount.pod:59
19103 "If you don't know what filesystems are contained in a guest or disk image, "
19104 "use L<virt-filesystems(1)> first:"
19108 #: ../fuse/guestmount.pod:62
19111 " virt-filesystems MyGuest\n"
19116 #: ../fuse/guestmount.pod:64
19118 "If you want to trace the libguestfs calls but without excessive debugging "
19119 "information, we recommend:"
19123 #: ../fuse/guestmount.pod:67
19126 " guestmount [...] --trace /mnt\n"
19131 #: ../fuse/guestmount.pod:69
19132 msgid "If you want to debug the program, we recommend:"
19136 #: ../fuse/guestmount.pod:71
19139 " guestmount [...] --trace --verbose /mnt\n"
19144 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68
19145 #: ../resize/virt-resize.pod:511
19150 #: ../fuse/guestmount.pod:75
19151 msgid "Other users cannot see the filesystem by default"
19155 #: ../fuse/guestmount.pod:77
19157 "If you mount a filesystem as one user (eg. root), then other users will not "
19158 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
19159 "option when mounting:"
19163 #: ../fuse/guestmount.pod:81
19166 " sudo guestmount [...] -o allow_other /mnt\n"
19171 #: ../fuse/guestmount.pod:91
19172 msgid "Add a block device or virtual machine image."
19176 #: ../fuse/guestmount.pod:114
19177 msgid "B<--dir-cache-timeout N>"
19181 #: ../fuse/guestmount.pod:116
19183 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
19184 "seconds. The readdir cache [actually, there are several semi-independent "
19185 "caches] is populated after a readdir(2) call with the stat and extended "
19186 "attributes of the files in the directory, in anticipation that they will be "
19187 "requested soon after."
19191 #: ../fuse/guestmount.pod:122
19193 "There is also a different attribute cache implemented by FUSE (see the FUSE "
19194 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
19195 "requests, only cache existing ones."
19199 #: ../fuse/guestmount.pod:142
19201 "If you have untrusted raw-format guest disk images, you should use this "
19202 "option to specify the disk format. This avoids a possible security problem "
19203 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
19204 "guestfs_add_drive_opts>."
19208 #: ../fuse/guestmount.pod:147
19209 msgid "B<--fuse-help>"
19213 #: ../fuse/guestmount.pod:149
19214 msgid "Display help on special FUSE options (see I<-o> below)."
19218 #: ../fuse/guestmount.pod:153
19219 msgid "Display brief help and exit."
19223 #: ../fuse/guestmount.pod:177
19225 "Mount the named partition or logical volume on the given mountpoint B<in the "
19226 "guest> (this has nothing to do with mountpoints in the host)."
19230 #: ../fuse/guestmount.pod:180
19232 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
19233 "something on C</>."
19237 #: ../fuse/guestmount.pod:197
19239 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
19240 "unmounted. If you specify this option, then we don't attempt to sync the "
19241 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
19245 #: ../fuse/guestmount.pod:202
19246 msgid "B<-o option>"
19250 #: ../fuse/guestmount.pod:204
19251 msgid "B<--option option>"
19255 #: ../fuse/guestmount.pod:206
19256 msgid "Pass extra options to FUSE."
19260 #: ../fuse/guestmount.pod:208
19262 "To get a list of all the extra options supported by FUSE, use the command "
19263 "below. Note that only the FUSE I<-o> options can be passed, and only some "
19264 "of them are a good idea."
19268 #: ../fuse/guestmount.pod:212
19271 " guestmount --fuse-help\n"
19276 #: ../fuse/guestmount.pod:214
19277 msgid "Some potentially useful FUSE options:"
19281 #: ../fuse/guestmount.pod:218
19282 msgid "B<-o allow_other>"
19286 #: ../fuse/guestmount.pod:220
19287 msgid "Allow other users to see the filesystem."
19291 #: ../fuse/guestmount.pod:222
19292 msgid "B<-o attr_timeout=N>"
19296 #: ../fuse/guestmount.pod:224
19297 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
19301 #: ../fuse/guestmount.pod:226
19302 msgid "B<-o kernel_cache>"
19306 #: ../fuse/guestmount.pod:228
19308 "Allow the kernel to cache files (reduces the number of reads that have to go "
19309 "through the L<guestfs(3)> API). This is generally a good idea if you can "
19310 "afford the extra memory usage."
19314 #: ../fuse/guestmount.pod:232
19315 msgid "B<-o uid=N> B<-o gid=N>"
19319 #: ../fuse/guestmount.pod:234
19321 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
19322 "the chosen values."
19326 #: ../fuse/guestmount.pod:243
19328 "Add devices and mount everything read-only. Also disallow writes and make "
19329 "the disk appear read-only to FUSE."
19333 #: ../fuse/guestmount.pod:246
19335 "This is highly recommended if you are not going to edit the guest disk. If "
19336 "the guest is running and this option is I<not> supplied, then there is a "
19337 "strong risk of disk corruption in the guest. We try to prevent this from "
19338 "happening, but it is not always possible."
19342 #: ../fuse/guestmount.pod:251 ../rescue/virt-rescue.pod:171
19343 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19347 #: ../fuse/guestmount.pod:255
19348 msgid "Enable SELinux support for the guest."
19352 #: ../fuse/guestmount.pod:261
19353 msgid "Enable verbose messages from underlying libguestfs."
19357 #: ../fuse/guestmount.pod:267
19358 msgid "Display the program version and exit."
19362 #: ../fuse/guestmount.pod:276 ../fuse/guestmount.pod:299
19363 #: ../rescue/virt-rescue.pod:197 ../rescue/virt-rescue.pod:280
19364 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19368 #: ../fuse/guestmount.pod:280
19373 #: ../fuse/guestmount.pod:282
19374 msgid "Trace libguestfs calls and entry into each FUSE function."
19378 #: ../fuse/guestmount.pod:284
19379 msgid "This also stops the daemon from forking into the background."
19383 #: ../fuse/guestmount.pod:310
19385 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
19386 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
19391 #: ../fuse/guestmount.pod:325
19392 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
19396 #: ../inspector/virt-inspector.pod:5
19398 "virt-inspector - Display operating system version and other information "
19399 "about a virtual machine"
19403 #: ../inspector/virt-inspector.pod:9
19406 " virt-inspector [--options] -d domname\n"
19411 #: ../inspector/virt-inspector.pod:11
19414 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
19419 #: ../inspector/virt-inspector.pod:15
19422 " virt-inspector domname\n"
19427 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
19430 " virt-inspector disk.img [disk.img ...]\n"
19435 #: ../inspector/virt-inspector.pod:21
19437 "B<virt-inspector> examines a virtual machine or disk image and tries to "
19438 "determine the version of the operating system and other information about "
19439 "the virtual machine."
19443 #: ../inspector/virt-inspector.pod:25
19444 msgid "Virt-inspector produces XML output for feeding into other programs."
19448 #: ../inspector/virt-inspector.pod:27
19450 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
19451 "the libvirt domain (see: C<virsh list --all>)."
19455 #: ../inspector/virt-inspector.pod:30
19457 "You can also run virt-inspector directly on disk images from a single "
19458 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
19459 "has several block devices, in which case you should list several I<-a> "
19460 "options one after another, with the first corresponding to the guest's C</"
19461 "dev/sda>, the second to the guest's C</dev/sdb> and so on."
19465 #: ../inspector/virt-inspector.pod:37
19467 "You can also run virt-inspector on install disks, live CDs, bootable USB "
19468 "keys and similar."
19472 #: ../inspector/virt-inspector.pod:40
19474 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
19475 "inspect several virtual machines, you have to run virt-inspector several "
19476 "times (for example, from a shell script for-loop)."
19480 #: ../inspector/virt-inspector.pod:45
19482 "Because virt-inspector needs direct access to guest images, it won't "
19483 "normally work over remote libvirt connections."
19487 #: ../inspector/virt-inspector.pod:48
19489 "All of the information available from virt-inspector is also available "
19490 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
19491 "The same information can also be fetched using guestfish or via libguestfs "
19492 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
19493 "WITH OTHER PROGRAMMING LANGUAGES>)."
19497 #: ../inspector/virt-inspector.pod:81
19499 "Libvirt is only used if you specify a C<domname> on the command line. If "
19500 "you specify guest block devices directly (I<-a>), then libvirt is not used "
19505 #: ../inspector/virt-inspector.pod:94
19507 "When prompting for keys and passphrases, virt-inspector normally turns "
19508 "echoing off so you cannot see what you are typing. If you are not worried "
19509 "about Tempest attacks and there is no one else in the room you can specify "
19510 "this flag to see what you are typing."
19514 #: ../inspector/virt-inspector.pod:103 ../tools/virt-list-filesystems.pl:93
19515 #: ../tools/virt-list-partitions.pl:94 ../tools/virt-tar.pl:143
19516 #: ../tools/virt-win-reg.pl:144
19518 "Specify the format of disk images given on the command line. If this is "
19519 "omitted then the format is autodetected from the content of the disk image."
19523 #: ../inspector/virt-inspector.pod:107 ../tools/virt-list-filesystems.pl:97
19524 #: ../tools/virt-list-partitions.pl:98 ../tools/virt-tar.pl:147
19525 #: ../tools/virt-win-reg.pl:148
19527 "If disk images are requested from libvirt, then this program asks libvirt "
19528 "for this information. In this case, the value of the format parameter is "
19533 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:314
19534 #: ../resize/virt-resize.pod:406 ../tools/virt-list-filesystems.pl:101
19535 #: ../tools/virt-list-partitions.pl:102 ../tools/virt-tar.pl:151
19536 #: ../tools/virt-win-reg.pl:152
19538 "If working with untrusted raw-format guest disk images, you should ensure "
19539 "the format is always specified."
19543 #: ../inspector/virt-inspector.pod:139
19544 msgid "Previous versions of virt-inspector allowed you to write either:"
19548 #: ../inspector/virt-inspector.pod:145
19551 " virt-inspector guestname\n"
19556 #: ../inspector/virt-inspector.pod:153
19561 #: ../inspector/virt-inspector.pod:155
19563 "The virt-inspector XML is described precisely in a RELAX NG schema file "
19564 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
19565 "just an overview."
19569 #: ../inspector/virt-inspector.pod:159
19571 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
19572 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
19573 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
19574 "which is vanishingly rare in real world VMs."
19578 #: ../inspector/virt-inspector.pod:164
19579 msgid "E<lt>operatingsystemE<gt>"
19583 #: ../inspector/virt-inspector.pod:166
19585 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
19586 "describe the operating system, its architecture, the descriptive \"product "
19587 "name\" string, the type of OS and so on, as in this example:"
19591 #: ../inspector/virt-inspector.pod:170
19594 " <operatingsystems>\n"
19595 " <operatingsystem>\n"
19596 " <root>/dev/sda2</root>\n"
19597 " <name>windows</name>\n"
19598 " <arch>i386</arch>\n"
19599 " <distro>windows</distro>\n"
19600 " <product_name>Windows 7 Enterprise</product_name>\n"
19601 " <product_variant>Client</product_variant>\n"
19602 " <major_version>6</major_version>\n"
19603 " <minor_version>1</minor_version>\n"
19604 " <windows_systemroot>/Windows</windows_systemroot>\n"
19605 " <format>installed</format>\n"
19610 #: ../inspector/virt-inspector.pod:183
19612 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
19613 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
19614 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
19615 "architecture. The other fields are fairly self-explanatory, but because "
19616 "these fields are taken directly from the libguestfs inspection API you can "
19617 "find precise information from L<guestfs(3)/INSPECTION>."
19621 #: ../inspector/virt-inspector.pod:191
19623 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
19624 "of view of libguestfs (block devices may have completely different names "
19625 "inside the VM itself)."
19629 #: ../inspector/virt-inspector.pod:195
19630 msgid "E<lt>mountpointsE<gt>"
19634 #: ../inspector/virt-inspector.pod:197
19636 "Un*x-like guests typically have multiple filesystems which are mounted at "
19637 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
19638 "element which looks like this:"
19642 #: ../inspector/virt-inspector.pod:201
19645 " <operatingsystems>\n"
19646 " <operatingsystem>\n"
19649 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
19650 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
19651 " </mountpoints>\n"
19656 #: ../inspector/virt-inspector.pod:209
19658 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
19659 "and may have completely different names inside the guest. Only mountable "
19660 "filesystems appear in this list, not things like swap devices."
19664 #: ../inspector/virt-inspector.pod:214
19665 msgid "E<lt>filesystemsE<gt>"
19669 #: ../inspector/virt-inspector.pod:216
19671 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
19672 "filesystems belonging to the guest, including swap and empty partitions. "
19673 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
19674 "this OS or shared with this OS and other OSes)."
19678 #: ../inspector/virt-inspector.pod:222
19679 msgid "You might see something like this:"
19683 #: ../inspector/virt-inspector.pod:224
19686 " <operatingsystems>\n"
19687 " <operatingsystem>\n"
19690 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19691 " <type>ext4</type>\n"
19692 " <label>Fedora-13-x86_64</label>\n"
19693 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
19699 #: ../inspector/virt-inspector.pod:234
19701 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
19702 "the label, and the UUID."
19706 #: ../inspector/virt-inspector.pod:237
19707 msgid "E<lt>applicationsE<gt>"
19711 #: ../inspector/virt-inspector.pod:239
19713 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
19714 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
19719 #: ../inspector/virt-inspector.pod:243
19721 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
19722 "Typical values would be C<rpm> and C<deb>."
19726 #: ../inspector/virt-inspector.pod:246
19728 "E<lt>package_managementE<gt>, if present, describes the package manager. "
19729 "Typical values include C<yum>, C<up2date> and C<apt>"
19733 #: ../inspector/virt-inspector.pod:249
19734 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
19738 #: ../inspector/virt-inspector.pod:252
19741 " <operatingsystems>\n"
19742 " <operatingsystem>\n"
19744 " <applications>\n"
19746 " <name>coreutils</name>\n"
19747 " <version>8.5</version>\n"
19748 " <release>1</release>\n"
19749 " </application>\n"
19754 #: ../inspector/virt-inspector.pod:262
19756 "The version and release fields may not be available for some types guests. "
19757 "Other fields are possible, see L<guestfs(3)/"
19758 "guestfs_inspect_list_applications>."
19762 #: ../inspector/virt-inspector.pod:266
19763 msgid "E<lt>drive_mappingsE<gt>"
19767 #: ../inspector/virt-inspector.pod:268
19769 "For operating systems like Windows which use drive letters, virt-inspector "
19770 "is able to find out how drive letters map to filesystems."
19774 #: ../inspector/virt-inspector.pod:272
19777 " <operatingsystems>\n"
19778 " <operatingsystem>\n"
19780 " <drive_mappings>\n"
19781 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
19782 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
19783 " </drive_mappings>\n"
19788 #: ../inspector/virt-inspector.pod:280
19790 "In the example above, drive C maps to the filesystem on the second partition "
19791 "on the first disk, and drive E maps to the filesystem on the first partition "
19792 "on the second disk."
19796 #: ../inspector/virt-inspector.pod:284
19798 "Note that this only covers permanent local filesystem mappings, not things "
19799 "like network shares. Furthermore NTFS volume mount points may not be listed "
19804 #: ../inspector/virt-inspector.pod:288
19805 msgid "E<lt>iconE<gt>"
19809 #: ../inspector/virt-inspector.pod:290
19811 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
19812 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
19813 "very large and high quality."
19817 #: ../inspector/virt-inspector.pod:294
19820 " <operatingsystems>\n"
19821 " <operatingsystem>\n"
19824 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
19825 " [... many lines of base64 data ...]\n"
19831 #: ../inspector/virt-inspector.pod:302
19833 "To display the icon, you have to extract it and convert the base64 data back "
19834 "to a binary file. Use an XPath query or simply an editor to extract the "
19835 "data, then use the coreutils L<base64(1)> program to do the conversion back "
19840 #: ../inspector/virt-inspector.pod:307
19843 " base64 -i -d < icon.data > icon.png\n"
19848 #: ../inspector/virt-inspector.pod:309
19849 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
19853 #: ../inspector/virt-inspector.pod:311
19855 "Virt-inspector can detect some operating system installers on install disks, "
19856 "live CDs, bootable USB keys and more."
19860 #: ../inspector/virt-inspector.pod:314
19862 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
19863 "fields may be present to indicate a live CD, network installer, or one part "
19864 "of a multipart CD. For example:"
19868 #: ../inspector/virt-inspector.pod:318
19871 " <operatingsystems>\n"
19872 " <operatingsystem>\n"
19873 " <root>/dev/sda</root>\n"
19874 " <name>linux</name>\n"
19875 " <arch>i386</arch>\n"
19876 " <distro>ubuntu</distro>\n"
19877 " <product_name>Ubuntu 10.10 "Maverick Meerkat"</product_name>\n"
19878 " <major_version>10</major_version>\n"
19879 " <minor_version>10</minor_version>\n"
19880 " <format>installer</format>\n"
19886 #: ../inspector/virt-inspector.pod:330
19887 msgid "USING XPATH"
19891 #: ../inspector/virt-inspector.pod:332
19893 "You can use the XPath query language to select parts of the XML. We "
19894 "recommend using C<xmlstarlet> to perform XPath queries from the command line."
19898 #: ../inspector/virt-inspector.pod:338
19901 " $ virt-inspector -d Guest | xmlstarlet sel -t -c '//filesystems'\n"
19903 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19904 " <type>ext4</type>\n"
19910 #: ../inspector/virt-inspector.pod:344
19913 " $ virt-inspector -d Guest | \\\n"
19914 " xmlstarlet sel -t -c \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
19920 #: ../inspector/virt-inspector.pod:348
19923 " $ virt-inspector -d Guest | \\\n"
19924 " xmlstarlet sel -t -v '//icon' | base64 -i -d | display -\n"
19925 " [displays the guest icon, if there is one]\n"
19930 #: ../inspector/virt-inspector.pod:359
19931 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
19935 #: ../inspector/virt-inspector.pod:361
19937 "Early versions of libguestfs shipped with a different virt-inspector program "
19938 "written in Perl (the current version is written in C). The XML output of "
19939 "the Perl virt-inspector was different and it could also output in other "
19940 "formats like text."
19944 #: ../inspector/virt-inspector.pod:366
19946 "The old virt-inspector is no longer supported or shipped with libguestfs."
19950 #: ../inspector/virt-inspector.pod:369
19952 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
19953 "versions of virt-inspector with different names:"
19957 #: ../inspector/virt-inspector.pod:372
19960 " virt-inspector Old Perl version.\n"
19961 " virt-inspector2 New C version.\n"
19966 #: ../inspector/virt-inspector.pod:382
19968 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, L<base64(1)"
19969 ">, L<xmlstarlet(1)>, L<http://libguestfs.org/>."
19973 #: ../inspector/virt-inspector.pod:399
19974 msgid "Matthew Booth L<mbooth@redhat.com>"
19978 #: ../java/examples/guestfs-java.pod:5
19979 msgid "guestfs-java - How to use libguestfs from Java"
19983 #: ../java/examples/guestfs-java.pod:9
19986 " import com.redhat.et.libguestfs.*;\n"
19991 #: ../java/examples/guestfs-java.pod:11
19994 " GuestFS g = new GuestFS ();\n"
19995 " g.add_drive_opts (\"disk.img\", null);\n"
20001 #: ../java/examples/guestfs-java.pod:17
20003 "This manual page documents how to call libguestfs from the Java programming "
20004 "language. This page just documents the differences from the C API and gives "
20005 "some examples. If you are not familiar with using libguestfs, you also need "
20006 "to read L<guestfs(3)>."
20010 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
20011 msgid "CLOSING THE HANDLE"
20015 #: ../java/examples/guestfs-java.pod:24
20017 "The handle is closed when it is reaped by the garbage collector. Because "
20018 "libguestfs handles include a lot of state, it is also possible to close (and "
20019 "hence free) them explicitly by calling the C<close> method."
20023 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60
20024 #: ../python/examples/guestfs-python.pod:21
20025 #: ../ruby/examples/guestfs-ruby.pod:22
20030 #: ../java/examples/guestfs-java.pod:31
20032 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
20033 "exception. This has a single parameter which is the error message (a "
20038 #: ../java/examples/guestfs-java.pod:35
20039 msgid "Calling any method on a closed handle raises the same exception."
20043 #: ../java/examples/guestfs-java.pod:47
20045 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)"
20046 ">, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
20047 "libguestfs.org/>, L<http://caml.inria.fr/>."
20051 #: ../java/examples/guestfs-java.pod:63 ../perl/examples/guestfs-perl.pod:57
20052 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
20056 #: ../ocaml/examples/guestfs-ocaml.pod:5
20057 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
20061 #: ../ocaml/examples/guestfs-ocaml.pod:9
20062 msgid "Module style:"
20066 #: ../ocaml/examples/guestfs-ocaml.pod:11
20069 " let g = Guestfs.create () in\n"
20070 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
20071 " Guestfs.launch g;\n"
20076 #: ../ocaml/examples/guestfs-ocaml.pod:15
20077 msgid "Object-oriented style:"
20081 #: ../ocaml/examples/guestfs-ocaml.pod:17
20084 " let g = new Guestfs.guestfs () in\n"
20085 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
20091 #: ../ocaml/examples/guestfs-ocaml.pod:21
20094 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
20096 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
20101 #: ../ocaml/examples/guestfs-ocaml.pod:27
20103 "This manual page documents how to call libguestfs from the OCaml programming "
20104 "language. This page just documents the differences from the C API and gives "
20105 "some examples. If you are not familiar with using libguestfs, you also need "
20106 "to read L<guestfs(3)>."
20110 #: ../ocaml/examples/guestfs-ocaml.pod:32
20111 msgid "PROGRAMMING STYLES"
20115 #: ../ocaml/examples/guestfs-ocaml.pod:34
20117 "There are two different programming styles supported by the OCaml bindings. "
20118 "You can use a module style, with each C function mapped to an OCaml function:"
20122 #: ../ocaml/examples/guestfs-ocaml.pod:38
20125 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
20130 #: ../ocaml/examples/guestfs-ocaml.pod:40
20135 #: ../ocaml/examples/guestfs-ocaml.pod:42
20138 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
20143 #: ../ocaml/examples/guestfs-ocaml.pod:44
20145 "Alternately you can use an object-oriented style, calling methods on the "
20146 "class C<Guestfs.guestfs>:"
20150 #: ../ocaml/examples/guestfs-ocaml.pod:47
20153 " method set_verbose : bool -> unit\n"
20158 #: ../ocaml/examples/guestfs-ocaml.pod:49
20160 "The object-oriented style is usually briefer, and the minor performance "
20161 "penalty isn't noticable in the general overhead of performing libguestfs "
20166 #: ../ocaml/examples/guestfs-ocaml.pod:55
20168 "The handle is closed when it is reaped by the garbage collector. Because "
20169 "libguestfs handles include a lot of state, it is also possible to close (and "
20170 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
20175 #: ../ocaml/examples/guestfs-ocaml.pod:62
20177 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
20178 "exception. This has a single parameter which is the error message (a "
20183 #: ../ocaml/examples/guestfs-ocaml.pod:66
20185 "Calling any function/method on a closed handle raises C<Guestfs."
20186 "Handle_closed>. The single parameter is the name of the function that you "
20191 #: ../ocaml/examples/guestfs-ocaml.pod:80
20193 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-perl(3)"
20194 ">, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
20195 "libguestfs.org/>, L<http://caml.inria.fr/>."
20199 #: ../perl/examples/guestfs-perl.pod:5
20200 msgid "guestfs-perl - How to use libguestfs from Perl"
20204 #: ../perl/examples/guestfs-perl.pod:9
20207 " use Sys::Guestfs;\n"
20212 #: ../perl/examples/guestfs-perl.pod:11
20215 " my $h = Sys::Guestfs->new ();\n"
20216 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
20217 " $h->launch ();\n"
20218 " $h->mount_options ('', '/dev/sda1', '/');\n"
20219 " $h->touch ('/hello');\n"
20225 #: ../perl/examples/guestfs-perl.pod:20
20227 "This manual page documents how to call libguestfs from the Perl programming "
20228 "language. This page just documents the differences from the C API and gives "
20229 "some examples. If you are not familiar with using libguestfs, you also need "
20230 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
20234 #: ../perl/examples/guestfs-perl.pod:26
20239 #: ../perl/examples/guestfs-perl.pod:28
20241 "Errors from libguestfs functions turn into calls to C<croak> (see L<Carp(3)"
20246 #: ../perl/examples/guestfs-perl.pod:41
20248 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)"
20249 ">, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
20250 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
20254 #: ../python/examples/guestfs-python.pod:5
20255 msgid "guestfs-python - How to use libguestfs from Python"
20259 #: ../python/examples/guestfs-python.pod:9
20262 " import guestfs\n"
20263 " g = guestfs.GuestFS ()\n"
20264 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
20270 #: ../python/examples/guestfs-python.pod:16
20272 "This manual page documents how to call libguestfs from the Python "
20273 "programming language. This page just documents the differences from the C "
20274 "API and gives some examples. If you are not familiar with using libguestfs, "
20275 "you also need to read L<guestfs(3)>."
20279 #: ../python/examples/guestfs-python.pod:23
20281 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
20282 "single string argument which is the error message."
20286 #: ../python/examples/guestfs-python.pod:26
20287 msgid "MORE DOCUMENTATION"
20291 #: ../python/examples/guestfs-python.pod:28
20296 #: ../python/examples/guestfs-python.pod:30
20300 " >>> import guestfs\n"
20301 " >>> help (guestfs)\n"
20306 #: ../python/examples/guestfs-python.pod:44
20308 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
20309 ">, L<guestfs-perl(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
20310 "libguestfs.org/>."
20314 #: ../rescue/virt-rescue.pod:5
20315 msgid "virt-rescue - Run a rescue shell on a virtual machine"
20319 #: ../rescue/virt-rescue.pod:9
20322 " virt-rescue [--options] -d domname\n"
20327 #: ../rescue/virt-rescue.pod:11
20330 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
20335 #: ../rescue/virt-rescue.pod:15
20338 " virt-rescue [--options] domname\n"
20343 #: ../rescue/virt-rescue.pod:17
20346 " virt-rescue [--options] disk.img [disk.img ...]\n"
20351 #: ../rescue/virt-rescue.pod:21
20353 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
20354 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
20355 "you from doing this, but doesn't catch all cases."
20359 #: ../rescue/virt-rescue.pod:25
20361 "However if you use the I<--ro> (read only) option, then you can attach a "
20362 "shell to a live virtual machine. The results might be strange or "
20363 "inconsistent at times but you won't get disk corruption."
20367 #: ../rescue/virt-rescue.pod:31
20369 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
20370 "need for a CD. virt-rescue gives you a rescue shell and some simple "
20371 "recovery tools which you can use to examine or rescue a virtual machine or "
20376 #: ../rescue/virt-rescue.pod:36
20378 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
20379 "on disk image(s):"
20383 #: ../rescue/virt-rescue.pod:39
20386 " virt-rescue -d GuestName\n"
20391 #: ../rescue/virt-rescue.pod:41
20394 " virt-rescue --ro -a /path/to/disk.img\n"
20399 #: ../rescue/virt-rescue.pod:43
20402 " virt-rescue -a /dev/sdc\n"
20407 #: ../rescue/virt-rescue.pod:45
20408 msgid "For live VMs you I<must> use the --ro option."
20412 #: ../rescue/virt-rescue.pod:47
20414 "When you run virt-rescue on a virtual machine or disk image, you are placed "
20415 "in an interactive bash shell where you can use many ordinary Linux "
20416 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
20417 "appliance. You must mount the virtual machine's filesystems by hand. There "
20418 "is an empty directory called C</sysroot> where you can mount filesystems."
20422 #: ../rescue/virt-rescue.pod:54
20424 "In the example below, we list logical volumes, then choose one to mount "
20425 "under C</sysroot>:"
20429 #: ../rescue/virt-rescue.pod:57
20433 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
20434 " lv_root vg_f11x64 -wi-a- 8.83G\n"
20435 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
20436 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
20437 " ><rescue> ls /sysroot\n"
20442 #: ../rescue/virt-rescue.pod:64
20444 "If you don't know what filesystems are available on the virtual machine then "
20445 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
20449 #: ../rescue/virt-rescue.pod:70
20451 "Virt-rescue can be used on I<any> disk image file or device, not just a "
20452 "virtual machine. For example you can use it on a blank file if you want to "
20453 "partition that file (although we would recommend using L<guestfish(1)> "
20454 "instead as it is more suitable for this purpose). You can even use virt-"
20455 "rescue on things like SD cards."
20459 #: ../rescue/virt-rescue.pod:76
20461 "Virt-rescue does not require root. You only need to run it as root if you "
20462 "need root to open the disk image."
20466 #: ../rescue/virt-rescue.pod:79
20468 "This tool is just designed for quick interactive hacking on a virtual "
20469 "machine. For more structured access to a virtual machine disk image, you "
20470 "should use L<guestfs(3)>. To get a structured shell that you can use to "
20471 "make scripted changes to guests, use L<guestfish(1)>."
20475 #: ../rescue/virt-rescue.pod:103
20476 msgid "B<--append kernelopts>"
20480 #: ../rescue/virt-rescue.pod:105
20481 msgid "Pass additional options to the rescue kernel."
20485 #: ../rescue/virt-rescue.pod:135
20488 " virt-rescue --format=raw -a disk.img\n"
20493 #: ../rescue/virt-rescue.pod:139
20496 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
20501 #: ../rescue/virt-rescue.pod:148
20506 #: ../rescue/virt-rescue.pod:150
20507 msgid "B<--memsize MB>"
20511 #: ../rescue/virt-rescue.pod:152
20513 "Change the amount of memory allocated to the rescue system. The default is "
20514 "set by libguestfs and is small but adequate for running system tools. The "
20515 "occasional program might need more memory. The parameter is specified in "
20520 #: ../rescue/virt-rescue.pod:157
20521 msgid "B<--network>"
20525 #: ../rescue/virt-rescue.pod:159
20526 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
20530 #: ../rescue/virt-rescue.pod:165
20531 msgid "Open the image read-only."
20535 #: ../rescue/virt-rescue.pod:175
20537 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
20538 "SELINUX> before using this option."
20542 #: ../rescue/virt-rescue.pod:194
20544 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
20545 "are done read-write."
20549 #: ../rescue/virt-rescue.pod:207
20550 msgid "Previous versions of virt-rescue allowed you to write either:"
20554 #: ../rescue/virt-rescue.pod:209
20557 " virt-rescue disk.img [disk.img ...]\n"
20562 #: ../rescue/virt-rescue.pod:213
20565 " virt-rescue guestname\n"
20570 #: ../rescue/virt-rescue.pod:221
20575 #: ../rescue/virt-rescue.pod:223
20577 "Adding the I<--network> option enables QEMU user networking in the rescue "
20578 "appliance. There are some differences between user networking and ordinary "
20583 #: ../rescue/virt-rescue.pod:229
20584 msgid "ping does not work"
20588 #: ../rescue/virt-rescue.pod:231
20590 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
20591 "send the ping packets, and because virt-rescue must be able to run as non-"
20592 "root, QEMU user networking is not able to emulate the L<ping(8)> command. "
20593 "The ping command will appear to resolve addresses but will not be able to "
20594 "send or receive any packets. This does not mean that the network is not "
20599 #: ../rescue/virt-rescue.pod:238
20600 msgid "cannot receive connections"
20604 #: ../rescue/virt-rescue.pod:240
20605 msgid "QEMU user networking cannot receive incoming connections."
20609 #: ../rescue/virt-rescue.pod:242
20610 msgid "making TCP connections"
20614 #: ../rescue/virt-rescue.pod:244
20616 "The virt-rescue appliance needs to be small and so does not include many "
20617 "network tools. In particular there is no L<telnet(1)> command. You can "
20618 "make TCP connections from the shell using the magical C</dev/tcp/"
20619 "E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
20623 #: ../rescue/virt-rescue.pod:249
20626 " exec 3<>/dev/tcp/redhat.com/80\n"
20627 " echo \"GET /\" >&3\n"
20633 #: ../rescue/virt-rescue.pod:253
20634 msgid "See L<bash(1)> for more details."
20638 #: ../rescue/virt-rescue.pod:259
20640 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
20641 "ENVIRONMENT VARIABLES> for the complete list."
20645 #: ../rescue/virt-rescue.pod:286
20647 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<http://"
20648 "libguestfs.org/>."
20652 #: ../resize/virt-resize.pod:5
20653 msgid "virt-resize - Resize a virtual machine disk"
20657 #: ../resize/virt-resize.pod:9
20660 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
20661 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
20662 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
20667 #: ../resize/virt-resize.pod:15
20669 "Virt-resize is a tool which can resize a virtual machine disk, making it "
20670 "larger or smaller overall, and resizing or deleting any partitions contained "
20675 #: ../resize/virt-resize.pod:19
20677 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
20678 "not> be used on live virtual machines - for consistent results, shut the "
20679 "virtual machine down before resizing it."
20683 #: ../resize/virt-resize.pod:23
20685 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
20686 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
20690 #: ../resize/virt-resize.pod:31 ../src/guestfs.pod:469 ../src/guestfs.pod:1257
20691 #: ../src/guestfs.pod:1395 ../src/guestfs.pod:2465
20696 #: ../resize/virt-resize.pod:33
20698 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
20699 "fill the extra 5GB of space."
20703 #: ../resize/virt-resize.pod:36
20706 " virt-filesystems --long -h --all -a olddisk\n"
20711 #: ../resize/virt-resize.pod:38
20714 " truncate -r olddisk newdisk\n"
20715 " truncate -s +5G newdisk\n"
20720 #: ../resize/virt-resize.pod:41
20723 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
20724 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
20729 #: ../resize/virt-resize.pod:44 ../src/guestfs.pod:475 ../src/guestfs.pod:1261
20730 #: ../src/guestfs.pod:1399 ../src/guestfs.pod:2490
20735 #: ../resize/virt-resize.pod:46
20737 "As above, but make the /boot partition 200MB bigger, while giving the "
20738 "remaining space to /dev/sda2:"
20742 #: ../resize/virt-resize.pod:49
20745 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20746 " olddisk newdisk\n"
20751 #: ../resize/virt-resize.pod:52 ../src/guestfs.pod:486 ../src/guestfs.pod:1405
20756 #: ../resize/virt-resize.pod:54
20758 "As in the first example, but expand a logical volume as the final step. "
20759 "This is what you would typically use for Linux guests that use LVM:"
20763 #: ../resize/virt-resize.pod:58
20766 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
20767 " olddisk newdisk\n"
20772 #: ../resize/virt-resize.pod:61
20777 #: ../resize/virt-resize.pod:63
20779 "As in the first example, but the output format will be qcow2 instead of a "
20784 #: ../resize/virt-resize.pod:66
20787 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
20788 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
20793 #: ../resize/virt-resize.pod:71
20794 msgid "DETAILED USAGE"
20798 #: ../resize/virt-resize.pod:73
20799 msgid "EXPANDING A VIRTUAL MACHINE DISK"
20803 #: ../resize/virt-resize.pod:77
20804 msgid "1. Shut down the virtual machine"
20808 #: ../resize/virt-resize.pod:79
20809 msgid "2. Locate input disk image"
20813 #: ../resize/virt-resize.pod:81
20815 "Locate the input disk image (ie. the file or device on the host containing "
20816 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
20817 "dumpxml> like this to find the disk image name:"
20821 #: ../resize/virt-resize.pod:85
20824 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
20825 " Found 1 nodes:\n"
20827 " <source dev=\"/dev/vg/lv_guest\" />\n"
20832 #: ../resize/virt-resize.pod:90
20833 msgid "3. Look at current sizing"
20837 #: ../resize/virt-resize.pod:92
20838 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
20842 #: ../resize/virt-resize.pod:95
20845 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
20846 " Name Type Size Parent\n"
20847 " /dev/sda1 partition 101M /dev/sda\n"
20848 " /dev/sda2 partition 7.9G /dev/sda\n"
20849 " /dev/sda device 8.0G -\n"
20854 #: ../resize/virt-resize.pod:101
20856 "(This example is a virtual machine with an 8 GB disk which we would like to "
20857 "expand up to 10 GB)."
20861 #: ../resize/virt-resize.pod:104
20862 msgid "4. Create output disk"
20866 #: ../resize/virt-resize.pod:106
20868 "Virt-resize cannot do in-place disk modifications. You have to have space "
20869 "to store the resized output disk."
20873 #: ../resize/virt-resize.pod:109
20875 "To store the resized disk image in a file, create a file of a suitable size:"
20879 #: ../resize/virt-resize.pod:112
20882 " # rm -f outdisk\n"
20883 " # truncate -s 10G outdisk\n"
20888 #: ../resize/virt-resize.pod:115
20889 msgid "Or use L<lvcreate(1)> to create a logical volume:"
20893 #: ../resize/virt-resize.pod:117
20896 " # lvcreate -L 10G -n lv_name vg_name\n"
20901 #: ../resize/virt-resize.pod:119
20902 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
20906 #: ../resize/virt-resize.pod:121
20909 " # virsh pool-list\n"
20910 " # virsh vol-create-as poolname newvol 10G\n"
20915 #: ../resize/virt-resize.pod:124
20920 #: ../resize/virt-resize.pod:126
20922 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
20923 "file) and the output disk. The output disk is the one created in the "
20928 #: ../resize/virt-resize.pod:130
20931 " # virt-resize indisk outdisk\n"
20936 #: ../resize/virt-resize.pod:132
20938 "This command just copies disk image C<indisk> to disk image C<outdisk> "
20939 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
20940 "larger, then an extra, empty partition is created at the end of the disk "
20941 "covering the extra space. If C<outdisk> is smaller, then it will give an "
20946 #: ../resize/virt-resize.pod:138
20948 "More realistically you'd want to expand existing partitions in the disk "
20949 "image by passing extra options (for the full list see the L</OPTIONS> "
20954 #: ../resize/virt-resize.pod:142
20956 "L</--expand> is the most useful option. It expands the named partition "
20957 "within the disk to fill any extra space:"
20961 #: ../resize/virt-resize.pod:145
20964 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
20969 #: ../resize/virt-resize.pod:147
20971 "(In this case, an extra partition is I<not> created at the end of the disk, "
20972 "because there will be no unused space)."
20976 #: ../resize/virt-resize.pod:150
20978 "L</--resize> is the other commonly used option. The following would "
20979 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
20980 "rest of the available space:"
20984 #: ../resize/virt-resize.pod:154
20987 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20988 " indisk outdisk\n"
20993 #: ../resize/virt-resize.pod:157
20995 "If the expanded partition in the image contains a filesystem or LVM PV, then "
20996 "if virt-resize knows how, it will resize the contents, the equivalent of "
20997 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
20998 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
20999 "filesystems, so you would have to online resize them after booting the guest."
21003 #: ../resize/virt-resize.pod:164
21004 msgid "Other options are covered below."
21008 #: ../resize/virt-resize.pod:166
21013 #: ../resize/virt-resize.pod:168
21014 msgid "Thoroughly test the new disk image I<before> discarding the old one."
21018 #: ../resize/virt-resize.pod:170
21019 msgid "If you are using libvirt, edit the XML to point at the new disk:"
21023 #: ../resize/virt-resize.pod:172
21026 " # virsh edit guestname\n"
21031 #: ../resize/virt-resize.pod:174
21033 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
21034 "html#elementsDisks>"
21038 #: ../resize/virt-resize.pod:177
21039 msgid "Then start up the domain with the new, resized disk:"
21043 #: ../resize/virt-resize.pod:179
21046 " # virsh start guestname\n"
21051 #: ../resize/virt-resize.pod:181
21053 "and check that it still works. See also the L</NOTES> section below for "
21054 "additional information."
21058 #: ../resize/virt-resize.pod:184
21059 msgid "7. Resize LVs etc inside the guest"
21063 #: ../resize/virt-resize.pod:186
21064 msgid "(This can also be done offline using L<guestfish(1)>)"
21068 #: ../resize/virt-resize.pod:188
21070 "Once the guest has booted you should see the new space available, at least "
21071 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
21072 "may need to resize LVs inside PVs, and also resize filesystem types that "
21073 "virt-resize does not know how to expand."
21077 #: ../resize/virt-resize.pod:195
21078 msgid "SHRINKING A VIRTUAL MACHINE DISK"
21082 #: ../resize/virt-resize.pod:197
21084 "Shrinking is somewhat more complex than expanding, and only an overview is "
21089 #: ../resize/virt-resize.pod:200
21091 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
21092 "filesystems). The user has to shrink content before passing the disk image "
21093 "to virt-resize, and virt-resize will check that the content has been shrunk "
21098 #: ../resize/virt-resize.pod:205
21099 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
21103 #: ../resize/virt-resize.pod:207
21105 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
21106 "steps 3 and 4 above to allocate a new disk image."
21110 #: ../resize/virt-resize.pod:210
21112 "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
21116 #: ../resize/virt-resize.pod:213
21117 msgid "IGNORING OR DELETING PARTITIONS"
21121 #: ../resize/virt-resize.pod:215
21123 "virt-resize also gives a convenient way to ignore or delete partitions when "
21124 "copying from the input disk to the output disk. Ignoring a partition speeds "
21125 "up the copy where you don't care about the existing contents of a "
21126 "partition. Deleting a partition removes it completely, but note that it "
21127 "also renumbers any partitions after the one which is deleted, which can "
21128 "leave some guests unbootable."
21132 #: ../resize/virt-resize.pod:222
21133 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
21137 #: ../resize/virt-resize.pod:224
21139 "If the input disk is in qcow2 format, then you may prefer that the output is "
21140 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
21141 "the fly. The output format is simply determined by the format of the empty "
21142 "output container that you provide. Thus to create qcow2 output, use:"
21146 #: ../resize/virt-resize.pod:230
21149 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
21154 #: ../resize/virt-resize.pod:232
21155 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
21159 #: ../resize/virt-resize.pod:234
21160 msgid "Similarly, to get non-sparse raw output use:"
21164 #: ../resize/virt-resize.pod:236
21167 " fallocate -l size outdisk\n"
21172 #: ../resize/virt-resize.pod:238
21174 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
21175 "dev/zero of=outdisk bs=1M count=..>)"
21179 #: ../resize/virt-resize.pod:247
21180 msgid "Display help."
21184 #: ../resize/virt-resize.pod:249
21189 #: ../resize/virt-resize.pod:251 ../tools/virt-make-fs.pl:177
21190 #: ../tools/virt-win-reg.pl:120
21195 #: ../resize/virt-resize.pod:253 ../tools/virt-win-reg.pl:122
21196 msgid "Enable debugging messages."
21200 #: ../resize/virt-resize.pod:255
21201 msgid "B<--delete part>"
21205 #: ../resize/virt-resize.pod:257
21207 "Delete the named partition. It would be more accurate to describe this as "
21208 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
21209 "the original disk image is left intact."
21213 #: ../resize/virt-resize.pod:261
21215 "Note that when you delete a partition, then anything contained in the "
21216 "partition is also deleted. Furthermore, this causes any partitions that "
21217 "come after to be I<renumbered>, which can easily make your guest unbootable."
21221 #: ../resize/virt-resize.pod:266 ../resize/virt-resize.pod:327
21222 #: ../resize/virt-resize.pod:454
21223 msgid "You can give this option multiple times."
21227 #: ../resize/virt-resize.pod:268
21228 msgid "B<--expand part>"
21232 #: ../resize/virt-resize.pod:270
21234 "Expand the named partition so it uses up all extra space (space left over "
21235 "after any other resize changes that you request have been done)."
21239 #: ../resize/virt-resize.pod:273
21241 "If virt-resize knows how, it will expand the direct content of the "
21242 "partition. For example, if the partition is an LVM PV, it will expand the "
21243 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
21244 "content it doesn't know about alone."
21248 #: ../resize/virt-resize.pod:278
21249 msgid "Currently virt-resize can resize:"
21253 #: ../resize/virt-resize.pod:284
21254 msgid "ext2, ext3 and ext4 filesystems."
21258 #: ../resize/virt-resize.pod:288
21259 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
21263 #: ../resize/virt-resize.pod:290
21265 "The filesystem must have been shut down consistently last time it was used. "
21266 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
21267 "consistency check, so at the first boot after resizing Windows will check "
21272 #: ../resize/virt-resize.pod:297
21274 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
21275 "inside the PV, but see the I<--LV-expand> option. The user could also "
21276 "resize LVs as desired after boot."
21280 #: ../resize/virt-resize.pod:303
21281 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
21285 #: ../resize/virt-resize.pod:307 ../resize/virt-resize.pod:482
21286 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
21290 #: ../resize/virt-resize.pod:309 ../tools/virt-list-filesystems.pl:91
21291 #: ../tools/virt-list-partitions.pl:92 ../tools/virt-tar.pl:141
21292 #: ../tools/virt-win-reg.pl:142
21293 msgid "B<--format> raw"
21297 #: ../resize/virt-resize.pod:311
21299 "Specify the format of the input disk image. If this flag is not given then "
21300 "it is auto-detected from the image itself."
21304 #: ../resize/virt-resize.pod:317
21306 "Note that this option I<does not> affect the output format. See L</QCOW2 "
21307 "AND NON-SPARSE RAW FORMATS>."
21311 #: ../resize/virt-resize.pod:320
21312 msgid "B<--ignore part>"
21316 #: ../resize/virt-resize.pod:322
21318 "Ignore the named partition. Effectively this means the partition is "
21319 "allocated on the destination disk, but the content is not copied across from "
21320 "the source disk. The content of the partition will be blank (all zero "
21325 #: ../resize/virt-resize.pod:329
21326 msgid "B<--LV-expand logvol>"
21330 #: ../resize/virt-resize.pod:331
21332 "This takes the logical volume and, as a final step, expands it to fill all "
21333 "the space available in its volume group. A typical usage, assuming a Linux "
21334 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
21335 "lv_root> would be:"
21339 #: ../resize/virt-resize.pod:336
21342 " virt-resize indisk outdisk \\\n"
21343 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
21348 #: ../resize/virt-resize.pod:339
21350 "This would first expand the partition (and PV), and then expand the root "
21351 "device to fill the extra space in the PV."
21355 #: ../resize/virt-resize.pod:342
21357 "The contents of the LV are also resized if virt-resize knows how to do "
21358 "that. You can stop virt-resize from trying to expand the content by using "
21359 "the option I<--no-expand-content>."
21363 #: ../resize/virt-resize.pod:346
21364 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
21368 #: ../resize/virt-resize.pod:348
21370 "You can give this option multiple times, I<but> it doesn't make sense to do "
21371 "this unless the logical volumes you specify are all in different volume "
21376 #: ../resize/virt-resize.pod:352
21377 msgid "B<--machine-readable>"
21381 #: ../resize/virt-resize.pod:354
21383 "This option is used to make the output more machine friendly when being "
21384 "parsed by other programs. See L</MACHINE READABLE OUTPUT> below."
21388 #: ../resize/virt-resize.pod:360
21389 msgid "B<--dryrun>"
21393 #: ../resize/virt-resize.pod:362
21394 msgid "Print a summary of what would be done, but don't do anything."
21398 #: ../resize/virt-resize.pod:364
21399 msgid "B<--no-copy-boot-loader>"
21403 #: ../resize/virt-resize.pod:366
21405 "By default, virt-resize copies over some sectors at the start of the disk "
21406 "(up to the beginning of the first partition). Commonly these sectors "
21407 "contain the Master Boot Record (MBR) and the boot loader, and are required "
21408 "in order for the guest to boot correctly."
21412 #: ../resize/virt-resize.pod:371
21414 "If you specify this flag, then this initial copy is not done. You may need "
21415 "to reinstall the boot loader in this case."
21419 #: ../resize/virt-resize.pod:374
21420 msgid "B<--no-extra-partition>"
21424 #: ../resize/virt-resize.pod:376
21426 "By default, virt-resize creates an extra partition if there is any extra, "
21427 "unused space after all resizing has happened. Use this option to prevent "
21428 "the extra partition from being created. If you do this then the extra space "
21429 "will be inaccessible until you run fdisk, parted, or some other partitioning "
21430 "tool in the guest."
21434 #: ../resize/virt-resize.pod:382
21436 "Note that if the surplus space is smaller than 10 MB, no extra partition "
21441 #: ../resize/virt-resize.pod:385
21442 msgid "B<--no-expand-content>"
21446 #: ../resize/virt-resize.pod:387
21448 "By default, virt-resize will try to expand the direct contents of "
21449 "partitions, if it knows how (see I<--expand> option above)."
21453 #: ../resize/virt-resize.pod:390
21455 "If you give the I<--no-expand-content> option then virt-resize will not "
21460 #: ../resize/virt-resize.pod:393
21461 msgid "B<--ntfsresize-force>"
21465 #: ../resize/virt-resize.pod:395
21467 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
21468 "the NTFS disk is marked as needing a consistency check. You have to use "
21469 "this option if you want to resize a Windows guest multiple times without "
21470 "booting into Windows between each resize."
21474 #: ../resize/virt-resize.pod:401
21475 msgid "B<--output-format> raw"
21479 #: ../resize/virt-resize.pod:403
21481 "Specify the format of the output disk image. If this flag is not given then "
21482 "it is auto-detected from the image itself."
21486 #: ../resize/virt-resize.pod:409
21488 "Note that this option I<does not create> the output format. This option "
21489 "just tells libguestfs what it is so it doesn't try to guess it. You still "
21490 "need to create the output disk with the right format. See L</QCOW2 AND NON-"
21491 "SPARSE RAW FORMATS>."
21495 #: ../resize/virt-resize.pod:414
21500 #: ../resize/virt-resize.pod:416
21505 #: ../resize/virt-resize.pod:418
21506 msgid "Don't print the summary."
21510 #: ../resize/virt-resize.pod:420
21511 msgid "B<--resize part=size>"
21515 #: ../resize/virt-resize.pod:422
21517 "Resize the named partition (expanding or shrinking it) so that it has the "
21522 #: ../resize/virt-resize.pod:425
21524 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
21525 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
21526 "size; or as a relative number or percentage. For example:"
21530 #: ../resize/virt-resize.pod:431
21533 " --resize /dev/sda2=10G\n"
21538 #: ../resize/virt-resize.pod:433
21541 " --resize /dev/sda4=90%\n"
21546 #: ../resize/virt-resize.pod:435
21549 " --resize /dev/sda2=+1G\n"
21554 #: ../resize/virt-resize.pod:437
21557 " --resize /dev/sda2=-200M\n"
21562 #: ../resize/virt-resize.pod:439
21565 " --resize /dev/sda1=+128K\n"
21570 #: ../resize/virt-resize.pod:441
21573 " --resize /dev/sda1=+10%\n"
21578 #: ../resize/virt-resize.pod:443
21581 " --resize /dev/sda1=-10%\n"
21586 #: ../resize/virt-resize.pod:445
21588 "You can increase the size of any partition. Virt-resize will expand the "
21589 "direct content of the partition if it knows how (see I<--expand> below)."
21593 #: ../resize/virt-resize.pod:449
21595 "You can only I<decrease> the size of partitions that contain filesystems or "
21596 "PVs which have already been shrunk. Virt-resize will check this has been "
21597 "done before proceeding, or else will print an error (see also I<--resize-"
21602 #: ../resize/virt-resize.pod:456
21603 msgid "B<--resize-force part=size>"
21607 #: ../resize/virt-resize.pod:458
21609 "This is the same as I<--resize> except that it will let you decrease the "
21610 "size of any partition. Generally this means you will lose any data which "
21611 "was at the end of the partition you shrink, but you may not care about that "
21612 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
21613 "as a swap partition)."
21617 #: ../resize/virt-resize.pod:464
21618 msgid "See also the I<--ignore> option."
21622 #: ../resize/virt-resize.pod:466
21623 msgid "B<--shrink part>"
21627 #: ../resize/virt-resize.pod:468
21629 "Shrink the named partition until the overall disk image fits in the "
21630 "destination. The named partition B<must> contain a filesystem or PV which "
21631 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
21632 "online tools). Virt-resize will check this and give an error if it has not "
21637 #: ../resize/virt-resize.pod:474
21639 "The amount by which the overall disk must be shrunk (after carrying out all "
21640 "other operations requested by the user) is called the \"deficit\". For "
21641 "example, a straight copy (assume no other operations) from a 5GB disk image "
21642 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
21643 "would give an error unless the user specified a partition to shrink and that "
21644 "partition had more than a gigabyte of free space."
21648 #: ../resize/virt-resize.pod:492
21649 msgid "MACHINE READABLE OUTPUT"
21653 #: ../resize/virt-resize.pod:494
21655 "The I<--machine-readable> option can be used to make the output more machine "
21656 "friendly, which is useful when calling virt-resize from other programs, GUIs "
21661 #: ../resize/virt-resize.pod:498
21663 "Use the option on its own to query the capabilities of the virt-resize "
21664 "binary. Typical output looks like this:"
21668 #: ../resize/virt-resize.pod:501
21671 " $ virt-resize --machine-readable\n"
21673 " ntfsresize-force\n"
21681 #: ../resize/virt-resize.pod:508
21683 "A list of features is printed, one per line, and the program exits with "
21688 #: ../resize/virt-resize.pod:513
21689 msgid "\"Partition 1 does not end on cylinder boundary.\""
21693 #: ../resize/virt-resize.pod:515
21695 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
21696 "means the partitions will not be aligned to the ancient CHS geometry. "
21697 "However CHS geometry is meaningless for disks manufactured since the early "
21698 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
21699 "cylinders is not required by any modern operating system."
21703 #: ../resize/virt-resize.pod:522
21704 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
21708 #: ../resize/virt-resize.pod:524
21710 "In Windows Vista and later versions, Microsoft switched to using a separate "
21711 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
21712 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
21713 "the boot partition. Doing so seems to break the guest completely. However "
21714 "expanding the second partition (ie. C: drive) should work."
21718 #: ../resize/virt-resize.pod:531
21720 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
21721 "NTFS partitions have been expanded. This is just a safety check and (unless "
21722 "it find errors) is nothing to worry about."
21726 #: ../resize/virt-resize.pod:535
21727 msgid "GUEST BOOT STUCK AT \"GRUB\""
21731 #: ../resize/virt-resize.pod:537
21733 "If a Linux guest does not boot after resizing, and the boot is stuck after "
21734 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
21735 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
21736 "although we think is to do with partition alignment."
21740 #: ../resize/virt-resize.pod:542
21743 " guestfish -i -a newdisk\n"
21744 " ><fs> cat /boot/grub/device.map\n"
21745 " # check the contents of this file are sensible or\n"
21746 " # edit the file if necessary\n"
21747 " ><fs> grub-install / /dev/vda\n"
21753 #: ../resize/virt-resize.pod:549
21755 "For more flexible guest reconfiguration, including if you need to specify "
21756 "other parameters to grub-install, use L<virt-rescue(1)>."
21760 #: ../resize/virt-resize.pod:552
21761 msgid "ALTERNATIVE TOOLS"
21765 #: ../resize/virt-resize.pod:554
21767 "There are several proprietary tools for resizing partitions. We won't "
21768 "mention any here."
21772 #: ../resize/virt-resize.pod:557
21774 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
21775 "operations on disk images. They can resize and move partitions, but I don't "
21776 "think they can do anything with the contents, and they certainly don't "
21781 #: ../resize/virt-resize.pod:562
21783 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
21784 "but at a much lower level. You will probably end up hand-calculating sector "
21785 "offsets, which is something that virt-resize was designed to avoid. If you "
21786 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
21791 #: ../resize/virt-resize.pod:582
21793 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
21794 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
21795 "L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, "
21796 "L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, L<http://libguestfs.org/>."
21800 #: ../ruby/examples/guestfs-ruby.pod:5
21801 msgid "guestfs-ruby - How to use libguestfs from Ruby"
21805 #: ../ruby/examples/guestfs-ruby.pod:9
21808 " require 'guestfs'\n"
21809 " g = Guestfs::Guestfs.new()\n"
21810 " g.add_drive_opts(\"disk.img\",\n"
21811 " :readonly => 1, :format => \"raw\")\n"
21817 #: ../ruby/examples/guestfs-ruby.pod:17
21819 "This manual page documents how to call libguestfs from the Ruby programming "
21820 "language. This page just documents the differences from the C API and gives "
21821 "some examples. If you are not familiar with using libguestfs, you also need "
21822 "to read L<guestfs(3)>."
21826 #: ../ruby/examples/guestfs-ruby.pod:24
21828 "Errors from libguestfs functions are mapped into the C<Error> exception. "
21829 "This has a single parameter which is the error message (a string)."
21833 #: ../ruby/examples/guestfs-ruby.pod:38
21835 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
21836 ">, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<http://"
21837 "libguestfs.org/>."
21841 #: ../src/guestfs-actions.pod:1
21842 msgid "guestfs_add_cdrom"
21846 #: ../src/guestfs-actions.pod:3
21850 " guestfs_add_cdrom (guestfs_h *g,\n"
21851 " const char *filename);\n"
21856 #: ../src/guestfs-actions.pod:17
21858 "This call checks for the existence of C<filename>. This stops you from "
21859 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21860 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
21865 #: ../src/guestfs-actions.pod:24
21867 "If you just want to add an ISO file (often you use this as an efficient way "
21868 "to transfer large files into the guest), then you should probably use "
21869 "C<guestfs_add_drive_ro> instead."
21873 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
21874 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
21875 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
21876 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
21877 #: ../src/guestfs-actions.pod:427 ../src/guestfs-actions.pod:447
21878 #: ../src/guestfs-actions.pod:461 ../src/guestfs-actions.pod:506
21879 #: ../src/guestfs-actions.pod:534 ../src/guestfs-actions.pod:552
21880 #: ../src/guestfs-actions.pod:619 ../src/guestfs-actions.pod:652
21881 #: ../src/guestfs-actions.pod:666 ../src/guestfs-actions.pod:681
21882 #: ../src/guestfs-actions.pod:780 ../src/guestfs-actions.pod:798
21883 #: ../src/guestfs-actions.pod:812 ../src/guestfs-actions.pod:826
21884 #: ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:1046
21885 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1084
21886 #: ../src/guestfs-actions.pod:1168 ../src/guestfs-actions.pod:1186
21887 #: ../src/guestfs-actions.pod:1205 ../src/guestfs-actions.pod:1219
21888 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1309
21889 #: ../src/guestfs-actions.pod:1340 ../src/guestfs-actions.pod:1365
21890 #: ../src/guestfs-actions.pod:1407 ../src/guestfs-actions.pod:1513
21891 #: ../src/guestfs-actions.pod:1547 ../src/guestfs-actions.pod:1762
21892 #: ../src/guestfs-actions.pod:1784 ../src/guestfs-actions.pod:1871
21893 #: ../src/guestfs-actions.pod:2346 ../src/guestfs-actions.pod:2490
21894 #: ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2586
21895 #: ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3641
21896 #: ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:3855
21897 #: ../src/guestfs-actions.pod:3869 ../src/guestfs-actions.pod:3882
21898 #: ../src/guestfs-actions.pod:3896 ../src/guestfs-actions.pod:3911
21899 #: ../src/guestfs-actions.pod:3947 ../src/guestfs-actions.pod:4019
21900 #: ../src/guestfs-actions.pod:4039 ../src/guestfs-actions.pod:4056
21901 #: ../src/guestfs-actions.pod:4079 ../src/guestfs-actions.pod:4102
21902 #: ../src/guestfs-actions.pod:4137 ../src/guestfs-actions.pod:4156
21903 #: ../src/guestfs-actions.pod:4175 ../src/guestfs-actions.pod:4210
21904 #: ../src/guestfs-actions.pod:4222 ../src/guestfs-actions.pod:4258
21905 #: ../src/guestfs-actions.pod:4274 ../src/guestfs-actions.pod:4287
21906 #: ../src/guestfs-actions.pod:4302 ../src/guestfs-actions.pod:4319
21907 #: ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4432
21908 #: ../src/guestfs-actions.pod:4445 ../src/guestfs-actions.pod:4496
21909 #: ../src/guestfs-actions.pod:4514 ../src/guestfs-actions.pod:4532
21910 #: ../src/guestfs-actions.pod:4548 ../src/guestfs-actions.pod:4562
21911 #: ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4593
21912 #: ../src/guestfs-actions.pod:4608 ../src/guestfs-actions.pod:4628
21913 #: ../src/guestfs-actions.pod:4698 ../src/guestfs-actions.pod:4771
21914 #: ../src/guestfs-actions.pod:4802 ../src/guestfs-actions.pod:4821
21915 #: ../src/guestfs-actions.pod:4840 ../src/guestfs-actions.pod:4852
21916 #: ../src/guestfs-actions.pod:4869 ../src/guestfs-actions.pod:4882
21917 #: ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:4912
21918 #: ../src/guestfs-actions.pod:4947 ../src/guestfs-actions.pod:4980
21919 #: ../src/guestfs-actions.pod:5019 ../src/guestfs-actions.pod:5039
21920 #: ../src/guestfs-actions.pod:5053 ../src/guestfs-actions.pod:5070
21921 #: ../src/guestfs-actions.pod:5119 ../src/guestfs-actions.pod:5165
21922 #: ../src/guestfs-actions.pod:5219 ../src/guestfs-actions.pod:5255
21923 #: ../src/guestfs-actions.pod:5290 ../src/guestfs-actions.pod:5307
21924 #: ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5465
21925 #: ../src/guestfs-actions.pod:5522 ../src/guestfs-actions.pod:5544
21926 #: ../src/guestfs-actions.pod:5562 ../src/guestfs-actions.pod:5594
21927 #: ../src/guestfs-actions.pod:5660 ../src/guestfs-actions.pod:5677
21928 #: ../src/guestfs-actions.pod:5690 ../src/guestfs-actions.pod:5704
21929 #: ../src/guestfs-actions.pod:5993 ../src/guestfs-actions.pod:6012
21930 #: ../src/guestfs-actions.pod:6031 ../src/guestfs-actions.pod:6045
21931 #: ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6071
21932 #: ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6097
21933 #: ../src/guestfs-actions.pod:6113 ../src/guestfs-actions.pod:6134
21934 #: ../src/guestfs-actions.pod:6153 ../src/guestfs-actions.pod:6172
21935 #: ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6220
21936 #: ../src/guestfs-actions.pod:6243 ../src/guestfs-actions.pod:6261
21937 #: ../src/guestfs-actions.pod:6280 ../src/guestfs-actions.pod:6301
21938 #: ../src/guestfs-actions.pod:6320 ../src/guestfs-actions.pod:6337
21939 #: ../src/guestfs-actions.pod:6356 ../src/guestfs-actions.pod:6384
21940 #: ../src/guestfs-actions.pod:6408 ../src/guestfs-actions.pod:6427
21941 #: ../src/guestfs-actions.pod:6451 ../src/guestfs-actions.pod:6470
21942 #: ../src/guestfs-actions.pod:6485 ../src/guestfs-actions.pod:6504
21943 #: ../src/guestfs-actions.pod:6541 ../src/guestfs-actions.pod:6571
21944 #: ../src/guestfs-actions.pod:6604 ../src/guestfs-actions.pod:6726
21945 #: ../src/guestfs-actions.pod:6847 ../src/guestfs-actions.pod:6859
21946 #: ../src/guestfs-actions.pod:6872 ../src/guestfs-actions.pod:6885
21947 #: ../src/guestfs-actions.pod:6907 ../src/guestfs-actions.pod:6920
21948 #: ../src/guestfs-actions.pod:6933 ../src/guestfs-actions.pod:6946
21949 #: ../src/guestfs-actions.pod:6961 ../src/guestfs-actions.pod:7020
21950 #: ../src/guestfs-actions.pod:7037 ../src/guestfs-actions.pod:7053
21951 #: ../src/guestfs-actions.pod:7069 ../src/guestfs-actions.pod:7086
21952 #: ../src/guestfs-actions.pod:7099 ../src/guestfs-actions.pod:7119
21953 #: ../src/guestfs-actions.pod:7155 ../src/guestfs-actions.pod:7169
21954 #: ../src/guestfs-actions.pod:7210 ../src/guestfs-actions.pod:7223
21955 #: ../src/guestfs-actions.pod:7241 ../src/guestfs-actions.pod:7275
21956 #: ../src/guestfs-actions.pod:7311 ../src/guestfs-actions.pod:7427
21957 #: ../src/guestfs-actions.pod:7442 ../src/guestfs-actions.pod:7456
21958 #: ../src/guestfs-actions.pod:7511 ../src/guestfs-actions.pod:7524
21959 #: ../src/guestfs-actions.pod:7569 ../src/guestfs-actions.pod:7602
21960 #: ../src/guestfs-actions.pod:7665 ../src/guestfs-actions.pod:7685
21961 #: ../src/guestfs-actions.pod:7711 ../src/guestfs-actions.pod:7782
21962 #: ../src/guestfs-actions.pod:7805 ../src/guestfs-actions.pod:7834
21963 msgid "This function returns 0 on success or -1 on error."
21967 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
21968 #: ../src/guestfs-actions.pod:275
21970 "This function is deprecated. In new code, use the L</"
21971 "guestfs_add_drive_opts> call instead."
21975 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
21976 #: ../src/guestfs-actions.pod:1170 ../src/guestfs-actions.pod:1985
21977 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2197
21978 #: ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3648
21979 #: ../src/guestfs-actions.pod:4956 ../src/guestfs-actions.pod:6222
21980 #: ../src/guestfs-actions.pod:6339 ../src/guestfs-actions.pod:6472
21981 #: ../src/guestfs-actions.pod:6963 ../src/guestfs-actions.pod:7088
21982 #: ../src/guestfs-actions.pod:7611
21983 msgid "(Added in 0.3)"
21987 #: ../src/guestfs-actions.pod:41
21988 msgid "guestfs_add_domain"
21992 #: ../src/guestfs-actions.pod:43
21996 " guestfs_add_domain (guestfs_h *g,\n"
21997 " const char *dom,\n"
22003 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
22004 #: ../src/guestfs-actions.pod:837 ../src/guestfs-actions.pod:2831
22005 #: ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4966
22006 #: ../src/guestfs-actions.pod:5183
22008 "You may supply a list of optional arguments to this call. Use zero or more "
22009 "of the following pairs of parameters, and terminate the list with C<-1> on "
22010 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
22014 #: ../src/guestfs-actions.pod:53
22017 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
22018 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
22019 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
22020 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
22021 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
22026 #: ../src/guestfs-actions.pod:59
22028 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
22029 "It works by connecting to libvirt, requesting the domain and domain XML from "
22030 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
22035 #: ../src/guestfs-actions.pod:94
22037 "The other optional parameters are passed directly through to "
22038 "C<guestfs_add_drive_opts>."
22042 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
22043 #: ../src/guestfs-actions.pod:520 ../src/guestfs-actions.pod:698
22044 #: ../src/guestfs-actions.pod:729 ../src/guestfs-actions.pod:747
22045 #: ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:1385
22046 #: ../src/guestfs-actions.pod:1741 ../src/guestfs-actions.pod:1944
22047 #: ../src/guestfs-actions.pod:2055 ../src/guestfs-actions.pod:2106
22048 #: ../src/guestfs-actions.pod:2161 ../src/guestfs-actions.pod:2184
22049 #: ../src/guestfs-actions.pod:2477 ../src/guestfs-actions.pod:2949
22050 #: ../src/guestfs-actions.pod:2967 ../src/guestfs-actions.pod:5142
22051 #: ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5774
22052 #: ../src/guestfs-actions.pod:5800 ../src/guestfs-actions.pod:7196
22053 #: ../src/guestfs-actions.pod:7622 ../src/guestfs-actions.pod:7635
22054 #: ../src/guestfs-actions.pod:7648
22055 msgid "On error this function returns -1."
22059 #: ../src/guestfs-actions.pod:99
22060 msgid "(Added in 1.7.4)"
22064 #: ../src/guestfs-actions.pod:101
22065 msgid "guestfs_add_domain_va"
22069 #: ../src/guestfs-actions.pod:103
22073 " guestfs_add_domain_va (guestfs_h *g,\n"
22074 " const char *dom,\n"
22075 " va_list args);\n"
22080 #: ../src/guestfs-actions.pod:108
22081 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
22085 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
22086 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
22087 #: ../src/guestfs-actions.pod:876 ../src/guestfs-actions.pod:887
22088 #: ../src/guestfs-actions.pod:2915 ../src/guestfs-actions.pod:2927
22089 #: ../src/guestfs-actions.pod:4712 ../src/guestfs-actions.pod:4724
22090 #: ../src/guestfs-actions.pod:4994 ../src/guestfs-actions.pod:5006
22091 #: ../src/guestfs-actions.pod:5232 ../src/guestfs-actions.pod:5243
22092 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
22096 #: ../src/guestfs-actions.pod:112
22097 msgid "guestfs_add_domain_argv"
22101 #: ../src/guestfs-actions.pod:114
22105 " guestfs_add_domain_argv (guestfs_h *g,\n"
22106 " const char *dom,\n"
22107 " const struct guestfs_add_domain_argv *optargs);\n"
22112 #: ../src/guestfs-actions.pod:119
22113 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
22117 #: ../src/guestfs-actions.pod:123
22118 msgid "guestfs_add_drive"
22122 #: ../src/guestfs-actions.pod:125
22126 " guestfs_add_drive (guestfs_h *g,\n"
22127 " const char *filename);\n"
22132 #: ../src/guestfs-actions.pod:129
22134 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
22135 "optional parameters, so the disk is added writable, with the format being "
22136 "detected automatically."
22140 #: ../src/guestfs-actions.pod:133
22142 "Automatic detection of the format opens you up to a potential security hole "
22143 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22144 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22145 "you should think about replacing calls to this function with calls to "
22146 "C<guestfs_add_drive_opts>, and specifying the format."
22150 #: ../src/guestfs-actions.pod:144
22151 msgid "guestfs_add_drive_opts"
22155 #: ../src/guestfs-actions.pod:146
22159 " guestfs_add_drive_opts (guestfs_h *g,\n"
22160 " const char *filename,\n"
22166 #: ../src/guestfs-actions.pod:156
22169 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
22170 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
22171 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
22176 #: ../src/guestfs-actions.pod:185
22178 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
22179 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
22180 "Possible formats include C<raw> and C<qcow2>."
22184 #: ../src/guestfs-actions.pod:196
22186 "This rarely-used option lets you emulate the behaviour of the deprecated "
22187 "C<guestfs_add_drive_with_if> call (q.v.)"
22191 #: ../src/guestfs-actions.pod:203
22192 msgid "(Added in 1.5.23)"
22196 #: ../src/guestfs-actions.pod:205
22197 msgid "guestfs_add_drive_opts_va"
22201 #: ../src/guestfs-actions.pod:207
22205 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
22206 " const char *filename,\n"
22207 " va_list args);\n"
22212 #: ../src/guestfs-actions.pod:212
22213 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
22217 #: ../src/guestfs-actions.pod:216
22218 msgid "guestfs_add_drive_opts_argv"
22222 #: ../src/guestfs-actions.pod:218
22226 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
22227 " const char *filename,\n"
22228 " const struct guestfs_add_drive_opts_argv *optargs);\n"
22233 #: ../src/guestfs-actions.pod:223
22234 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
22238 #: ../src/guestfs-actions.pod:227
22239 msgid "guestfs_add_drive_ro"
22243 #: ../src/guestfs-actions.pod:229
22247 " guestfs_add_drive_ro (guestfs_h *g,\n"
22248 " const char *filename);\n"
22253 #: ../src/guestfs-actions.pod:233
22255 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
22256 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
22257 "disk is added read-only, with the format being detected automatically."
22261 #: ../src/guestfs-actions.pod:240
22262 msgid "(Added in 1.0.38)"
22266 #: ../src/guestfs-actions.pod:242
22267 msgid "guestfs_add_drive_ro_with_if"
22271 #: ../src/guestfs-actions.pod:244
22275 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
22276 " const char *filename,\n"
22277 " const char *iface);\n"
22282 #: ../src/guestfs-actions.pod:249
22284 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
22285 "QEMU interface emulation to use at run time."
22289 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
22290 #: ../src/guestfs-actions.pod:2436
22291 msgid "(Added in 1.0.84)"
22295 #: ../src/guestfs-actions.pod:263
22296 msgid "guestfs_add_drive_with_if"
22300 #: ../src/guestfs-actions.pod:265
22304 " guestfs_add_drive_with_if (guestfs_h *g,\n"
22305 " const char *filename,\n"
22306 " const char *iface);\n"
22311 #: ../src/guestfs-actions.pod:270
22313 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
22314 "QEMU interface emulation to use at run time."
22318 #: ../src/guestfs-actions.pod:284
22319 msgid "guestfs_aug_clear"
22323 #: ../src/guestfs-actions.pod:286
22327 " guestfs_aug_clear (guestfs_h *g,\n"
22328 " const char *augpath);\n"
22333 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2186
22334 msgid "(Added in 1.3.4)"
22338 #: ../src/guestfs-actions.pod:297
22339 msgid "guestfs_aug_close"
22343 #: ../src/guestfs-actions.pod:299
22347 " guestfs_aug_close (guestfs_h *g);\n"
22352 #: ../src/guestfs-actions.pod:302
22354 "Close the current Augeas handle and free up any resources used by it. After "
22355 "calling this, you have to call C<guestfs_aug_init> again before you can use "
22356 "any other Augeas functions."
22360 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
22361 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
22362 #: ../src/guestfs-actions.pod:429 ../src/guestfs-actions.pod:449
22363 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:494
22364 #: ../src/guestfs-actions.pod:508 ../src/guestfs-actions.pod:522
22365 #: ../src/guestfs-actions.pod:536 ../src/guestfs-actions.pod:554
22366 #: ../src/guestfs-actions.pod:5851
22367 msgid "(Added in 0.7)"
22371 #: ../src/guestfs-actions.pod:311
22372 msgid "guestfs_aug_defnode"
22376 #: ../src/guestfs-actions.pod:313
22379 " struct guestfs_int_bool *\n"
22380 " guestfs_aug_defnode (guestfs_h *g,\n"
22381 " const char *name,\n"
22382 " const char *expr,\n"
22383 " const char *val);\n"
22388 #: ../src/guestfs-actions.pod:322
22390 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22391 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
22392 "containing that single node."
22396 #: ../src/guestfs-actions.pod:330
22398 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
22399 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
22403 #: ../src/guestfs-actions.pod:336
22404 msgid "guestfs_aug_defvar"
22408 #: ../src/guestfs-actions.pod:338
22412 " guestfs_aug_defvar (guestfs_h *g,\n"
22413 " const char *name,\n"
22414 " const char *expr);\n"
22419 #: ../src/guestfs-actions.pod:354
22420 msgid "guestfs_aug_get"
22424 #: ../src/guestfs-actions.pod:356
22428 " guestfs_aug_get (guestfs_h *g,\n"
22429 " const char *augpath);\n"
22434 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:927
22435 #: ../src/guestfs-actions.pod:945 ../src/guestfs-actions.pod:1005
22436 #: ../src/guestfs-actions.pod:1021 ../src/guestfs-actions.pod:1124
22437 #: ../src/guestfs-actions.pod:1254 ../src/guestfs-actions.pod:1271
22438 #: ../src/guestfs-actions.pod:1290 ../src/guestfs-actions.pod:1424
22439 #: ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1724
22440 #: ../src/guestfs-actions.pod:1887 ../src/guestfs-actions.pod:1904
22441 #: ../src/guestfs-actions.pod:1971 ../src/guestfs-actions.pod:2007
22442 #: ../src/guestfs-actions.pod:2028 ../src/guestfs-actions.pod:2209
22443 #: ../src/guestfs-actions.pod:2401 ../src/guestfs-actions.pod:2605
22444 #: ../src/guestfs-actions.pod:2695 ../src/guestfs-actions.pod:2799
22445 #: ../src/guestfs-actions.pod:2818 ../src/guestfs-actions.pod:3032
22446 #: ../src/guestfs-actions.pod:3060 ../src/guestfs-actions.pod:3081
22447 #: ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3174
22448 #: ../src/guestfs-actions.pod:3194 ../src/guestfs-actions.pod:3214
22449 #: ../src/guestfs-actions.pod:3841 ../src/guestfs-actions.pod:4194
22450 #: ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4474
22451 #: ../src/guestfs-actions.pod:5380 ../src/guestfs-actions.pod:5579
22452 #: ../src/guestfs-actions.pod:5749 ../src/guestfs-actions.pod:5927
22453 #: ../src/guestfs-actions.pod:5976 ../src/guestfs-actions.pod:6632
22454 #: ../src/guestfs-actions.pod:6648 ../src/guestfs-actions.pod:6665
22455 #: ../src/guestfs-actions.pod:6696 ../src/guestfs-actions.pod:7370
22456 #: ../src/guestfs-actions.pod:7389 ../src/guestfs-actions.pod:7407
22457 #: ../src/guestfs-actions.pod:7581 ../src/guestfs-actions.pod:7891
22459 "This function returns a string, or NULL on error. I<The caller must free "
22460 "the returned string after use>."
22464 #: ../src/guestfs-actions.pod:368
22465 msgid "guestfs_aug_init"
22469 #: ../src/guestfs-actions.pod:370
22473 " guestfs_aug_init (guestfs_h *g,\n"
22474 " const char *root,\n"
22480 #: ../src/guestfs-actions.pod:379
22481 msgid "You must call this before using any other C<guestfs_aug_*> commands."
22485 #: ../src/guestfs-actions.pod:404
22487 "This option is only useful when debugging Augeas lenses. Use of this option "
22488 "may require additional memory for the libguestfs appliance. You may need to "
22489 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
22490 "C<guestfs_set_memsize>."
22494 #: ../src/guestfs-actions.pod:419
22495 msgid "Do not load the tree in C<guestfs_aug_init>."
22499 #: ../src/guestfs-actions.pod:423
22500 msgid "To close the handle, you can call C<guestfs_aug_close>."
22504 #: ../src/guestfs-actions.pod:431
22505 msgid "guestfs_aug_insert"
22509 #: ../src/guestfs-actions.pod:433
22513 " guestfs_aug_insert (guestfs_h *g,\n"
22514 " const char *augpath,\n"
22515 " const char *label,\n"
22521 #: ../src/guestfs-actions.pod:451
22522 msgid "guestfs_aug_load"
22526 #: ../src/guestfs-actions.pod:453
22530 " guestfs_aug_load (guestfs_h *g);\n"
22535 #: ../src/guestfs-actions.pod:465
22536 msgid "guestfs_aug_ls"
22540 #: ../src/guestfs-actions.pod:467
22544 " guestfs_aug_ls (guestfs_h *g,\n"
22545 " const char *augpath);\n"
22550 #: ../src/guestfs-actions.pod:471
22552 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
22553 "sorting the resulting nodes into alphabetical order."
22557 #: ../src/guestfs-actions.pod:474 ../src/guestfs-actions.pod:490
22558 #: ../src/guestfs-actions.pod:636 ../src/guestfs-actions.pod:1143
22559 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1458
22560 #: ../src/guestfs-actions.pod:1561 ../src/guestfs-actions.pod:1580
22561 #: ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:2281
22562 #: ../src/guestfs-actions.pod:2297 ../src/guestfs-actions.pod:2316
22563 #: ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2383
22564 #: ../src/guestfs-actions.pod:2454 ../src/guestfs-actions.pod:2503
22565 #: ../src/guestfs-actions.pod:2760 ../src/guestfs-actions.pod:3134
22566 #: ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3724
22567 #: ../src/guestfs-actions.pod:3741 ../src/guestfs-actions.pod:3761
22568 #: ../src/guestfs-actions.pod:3823 ../src/guestfs-actions.pod:3928
22569 #: ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:5103
22570 #: ../src/guestfs-actions.pod:5721 ../src/guestfs-actions.pod:5847
22571 #: ../src/guestfs-actions.pod:5961 ../src/guestfs-actions.pod:6712
22572 #: ../src/guestfs-actions.pod:6773 ../src/guestfs-actions.pod:6828
22573 #: ../src/guestfs-actions.pod:6974 ../src/guestfs-actions.pod:6998
22574 #: ../src/guestfs-actions.pod:7474 ../src/guestfs-actions.pod:7494
22575 #: ../src/guestfs-actions.pod:7541 ../src/guestfs-actions.pod:7735
22576 #: ../src/guestfs-actions.pod:7754 ../src/guestfs-actions.pod:7848
22577 #: ../src/guestfs-actions.pod:7867 ../src/guestfs-actions.pod:7913
22578 #: ../src/guestfs-actions.pod:7932
22580 "This function returns a NULL-terminated array of strings (like L<environ(3)"
22581 ">), or NULL if there was an error. I<The caller must free the strings and "
22582 "the array after use>."
22586 #: ../src/guestfs-actions.pod:478 ../src/guestfs-actions.pod:1068
22587 #: ../src/guestfs-actions.pod:1086 ../src/guestfs-actions.pod:1496
22588 #: ../src/guestfs-actions.pod:3488 ../src/guestfs-actions.pod:3519
22589 #: ../src/guestfs-actions.pod:4177 ../src/guestfs-actions.pod:4227
22590 #: ../src/guestfs-actions.pod:4414 ../src/guestfs-actions.pod:4447
22591 #: ../src/guestfs-actions.pod:4610 ../src/guestfs-actions.pod:5107
22592 #: ../src/guestfs-actions.pod:5662 ../src/guestfs-actions.pod:6059
22593 #: ../src/guestfs-actions.pod:6073 ../src/guestfs-actions.pod:6085
22594 #: ../src/guestfs-actions.pod:6553 ../src/guestfs-actions.pod:7212
22595 #: ../src/guestfs-actions.pod:7225 ../src/guestfs-actions.pod:7458
22596 #: ../src/guestfs-actions.pod:7723
22597 msgid "(Added in 0.8)"
22601 #: ../src/guestfs-actions.pod:480
22602 msgid "guestfs_aug_match"
22606 #: ../src/guestfs-actions.pod:482
22610 " guestfs_aug_match (guestfs_h *g,\n"
22611 " const char *augpath);\n"
22616 #: ../src/guestfs-actions.pod:496
22617 msgid "guestfs_aug_mv"
22621 #: ../src/guestfs-actions.pod:498
22625 " guestfs_aug_mv (guestfs_h *g,\n"
22626 " const char *src,\n"
22627 " const char *dest);\n"
22632 #: ../src/guestfs-actions.pod:510
22633 msgid "guestfs_aug_rm"
22637 #: ../src/guestfs-actions.pod:512
22641 " guestfs_aug_rm (guestfs_h *g,\n"
22642 " const char *augpath);\n"
22647 #: ../src/guestfs-actions.pod:524
22648 msgid "guestfs_aug_save"
22652 #: ../src/guestfs-actions.pod:526
22656 " guestfs_aug_save (guestfs_h *g);\n"
22661 #: ../src/guestfs-actions.pod:531
22663 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
22668 #: ../src/guestfs-actions.pod:538
22669 msgid "guestfs_aug_set"
22673 #: ../src/guestfs-actions.pod:540
22677 " guestfs_aug_set (guestfs_h *g,\n"
22678 " const char *augpath,\n"
22679 " const char *val);\n"
22684 #: ../src/guestfs-actions.pod:547
22686 "In the Augeas API, it is possible to clear a node by setting the value to "
22687 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22688 "this call. Instead you must use the C<guestfs_aug_clear> call."
22692 #: ../src/guestfs-actions.pod:556
22693 msgid "guestfs_available"
22697 #: ../src/guestfs-actions.pod:558
22701 " guestfs_available (guestfs_h *g,\n"
22702 " char *const *groups);\n"
22707 #: ../src/guestfs-actions.pod:566
22709 "The libguestfs groups, and the functions that those groups correspond to, "
22710 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22711 "runtime by calling C<guestfs_available_all_groups>."
22715 #: ../src/guestfs-actions.pod:590
22716 msgid "You must call C<guestfs_launch> before calling this function."
22720 #: ../src/guestfs-actions.pod:612
22722 "This call was added in version C<1.0.80>. In previous versions of "
22723 "libguestfs all you could do would be to speculatively execute a command to "
22724 "find out if the daemon implemented it. See also C<guestfs_version>."
22728 #: ../src/guestfs-actions.pod:621 ../src/guestfs-actions.pod:1241
22729 msgid "(Added in 1.0.80)"
22733 #: ../src/guestfs-actions.pod:623
22734 msgid "guestfs_available_all_groups"
22738 #: ../src/guestfs-actions.pod:625
22742 " guestfs_available_all_groups (guestfs_h *g);\n"
22747 #: ../src/guestfs-actions.pod:628
22749 "This command returns a list of all optional groups that this daemon knows "
22750 "about. Note this returns both supported and unsupported groups. To find "
22751 "out which ones the daemon can actually support you have to call "
22752 "C<guestfs_available> on each member of the returned list."
22756 #: ../src/guestfs-actions.pod:634
22757 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
22761 #: ../src/guestfs-actions.pod:640
22762 msgid "(Added in 1.3.15)"
22766 #: ../src/guestfs-actions.pod:642
22767 msgid "guestfs_base64_in"
22771 #: ../src/guestfs-actions.pod:644
22775 " guestfs_base64_in (guestfs_h *g,\n"
22776 " const char *base64file,\n"
22777 " const char *filename);\n"
22782 #: ../src/guestfs-actions.pod:654 ../src/guestfs-actions.pod:668
22783 msgid "(Added in 1.3.5)"
22787 #: ../src/guestfs-actions.pod:656
22788 msgid "guestfs_base64_out"
22792 #: ../src/guestfs-actions.pod:658
22796 " guestfs_base64_out (guestfs_h *g,\n"
22797 " const char *filename,\n"
22798 " const char *base64file);\n"
22803 #: ../src/guestfs-actions.pod:670
22804 msgid "guestfs_blockdev_flushbufs"
22808 #: ../src/guestfs-actions.pod:672
22812 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
22813 " const char *device);\n"
22818 #: ../src/guestfs-actions.pod:683 ../src/guestfs-actions.pod:700
22819 #: ../src/guestfs-actions.pod:715 ../src/guestfs-actions.pod:731
22820 #: ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:768
22821 #: ../src/guestfs-actions.pod:782 ../src/guestfs-actions.pod:800
22822 #: ../src/guestfs-actions.pod:814 ../src/guestfs-actions.pod:828
22823 msgid "(Added in 0.9.3)"
22827 #: ../src/guestfs-actions.pod:685
22828 msgid "guestfs_blockdev_getbsz"
22832 #: ../src/guestfs-actions.pod:687
22836 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
22837 " const char *device);\n"
22842 #: ../src/guestfs-actions.pod:702
22843 msgid "guestfs_blockdev_getro"
22847 #: ../src/guestfs-actions.pod:704
22851 " guestfs_blockdev_getro (guestfs_h *g,\n"
22852 " const char *device);\n"
22857 #: ../src/guestfs-actions.pod:713 ../src/guestfs-actions.pod:1479
22858 #: ../src/guestfs-actions.pod:1494 ../src/guestfs-actions.pod:1983
22859 #: ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:2066
22860 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2132
22861 #: ../src/guestfs-actions.pod:2147 ../src/guestfs-actions.pod:2172
22862 #: ../src/guestfs-actions.pod:2195 ../src/guestfs-actions.pod:3231
22863 #: ../src/guestfs-actions.pod:3247 ../src/guestfs-actions.pod:3265
22864 #: ../src/guestfs-actions.pod:3427 ../src/guestfs-actions.pod:3441
22865 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:3470
22866 #: ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3501
22867 #: ../src/guestfs-actions.pod:3517 ../src/guestfs-actions.pod:3531
22868 #: ../src/guestfs-actions.pod:3544 ../src/guestfs-actions.pod:3558
22869 #: ../src/guestfs-actions.pod:3573 ../src/guestfs-actions.pod:3588
22870 #: ../src/guestfs-actions.pod:3601 ../src/guestfs-actions.pod:3615
22871 #: ../src/guestfs-actions.pod:5344
22872 msgid "This function returns a C truth value on success or -1 on error."
22876 #: ../src/guestfs-actions.pod:717
22877 msgid "guestfs_blockdev_getsize64"
22881 #: ../src/guestfs-actions.pod:719
22885 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
22886 " const char *device);\n"
22891 #: ../src/guestfs-actions.pod:725
22892 msgid "See also C<guestfs_blockdev_getsz>."
22896 #: ../src/guestfs-actions.pod:733
22897 msgid "guestfs_blockdev_getss"
22901 #: ../src/guestfs-actions.pod:735
22905 " guestfs_blockdev_getss (guestfs_h *g,\n"
22906 " const char *device);\n"
22911 #: ../src/guestfs-actions.pod:742
22913 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
22918 #: ../src/guestfs-actions.pod:751
22919 msgid "guestfs_blockdev_getsz"
22923 #: ../src/guestfs-actions.pod:753
22927 " guestfs_blockdev_getsz (guestfs_h *g,\n"
22928 " const char *device);\n"
22933 #: ../src/guestfs-actions.pod:760
22935 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
22936 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
22940 #: ../src/guestfs-actions.pod:770
22941 msgid "guestfs_blockdev_rereadpt"
22945 #: ../src/guestfs-actions.pod:772
22949 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
22950 " const char *device);\n"
22955 #: ../src/guestfs-actions.pod:784
22956 msgid "guestfs_blockdev_setbsz"
22960 #: ../src/guestfs-actions.pod:786
22964 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
22965 " const char *device,\n"
22966 " int blocksize);\n"
22971 #: ../src/guestfs-actions.pod:802
22972 msgid "guestfs_blockdev_setro"
22976 #: ../src/guestfs-actions.pod:804
22980 " guestfs_blockdev_setro (guestfs_h *g,\n"
22981 " const char *device);\n"
22986 #: ../src/guestfs-actions.pod:816
22987 msgid "guestfs_blockdev_setrw"
22991 #: ../src/guestfs-actions.pod:818
22995 " guestfs_blockdev_setrw (guestfs_h *g,\n"
22996 " const char *device);\n"
23001 #: ../src/guestfs-actions.pod:830
23002 msgid "guestfs_btrfs_filesystem_resize"
23006 #: ../src/guestfs-actions.pod:832
23010 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
23011 " const char *mountpoint,\n"
23017 #: ../src/guestfs-actions.pod:842
23020 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
23025 #: ../src/guestfs-actions.pod:865
23026 msgid "(Added in 1.11.17)"
23030 #: ../src/guestfs-actions.pod:867
23031 msgid "guestfs_btrfs_filesystem_resize_va"
23035 #: ../src/guestfs-actions.pod:869
23039 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
23040 " const char *mountpoint,\n"
23041 " va_list args);\n"
23046 #: ../src/guestfs-actions.pod:874
23047 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
23051 #: ../src/guestfs-actions.pod:878
23052 msgid "guestfs_btrfs_filesystem_resize_argv"
23056 #: ../src/guestfs-actions.pod:880
23060 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
23061 " const char *mountpoint,\n"
23062 " const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
23067 #: ../src/guestfs-actions.pod:885
23068 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
23072 #: ../src/guestfs-actions.pod:889
23073 msgid "guestfs_case_sensitive_path"
23077 #: ../src/guestfs-actions.pod:891
23081 " guestfs_case_sensitive_path (guestfs_h *g,\n"
23082 " const char *path);\n"
23087 #: ../src/guestfs-actions.pod:917
23089 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
23090 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
23091 "how the directories were originally created under Windows)."
23095 #: ../src/guestfs-actions.pod:925
23096 msgid "See also C<guestfs_realpath>."
23100 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:7392
23101 msgid "(Added in 1.0.75)"
23105 #: ../src/guestfs-actions.pod:932
23106 msgid "guestfs_cat"
23110 #: ../src/guestfs-actions.pod:934
23114 " guestfs_cat (guestfs_h *g,\n"
23115 " const char *path);\n"
23120 #: ../src/guestfs-actions.pod:940
23122 "Note that this function cannot correctly handle binary files (specifically, "
23123 "files containing C<\\0> character which is treated as end of string). For "
23124 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
23125 "functions which have a more complex interface."
23129 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:3745
23130 #: ../src/guestfs-actions.pod:3827 ../src/guestfs-actions.pod:3844
23131 #: ../src/guestfs-actions.pod:3932 ../src/guestfs-actions.pod:4340
23132 #: ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:5725
23133 #: ../src/guestfs-actions.pod:5739 ../src/guestfs-actions.pod:7545
23134 #: ../src/guestfs-actions.pod:7559
23135 msgid "(Added in 0.4)"
23139 #: ../src/guestfs-actions.pod:953
23140 msgid "guestfs_checksum"
23144 #: ../src/guestfs-actions.pod:955
23148 " guestfs_checksum (guestfs_h *g,\n"
23149 " const char *csumtype,\n"
23150 " const char *path);\n"
23155 #: ../src/guestfs-actions.pod:1001
23156 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
23160 #: ../src/guestfs-actions.pod:1003
23161 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
23165 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1316
23166 #: ../src/guestfs-actions.pod:2163 ../src/guestfs-actions.pod:3443
23167 #: ../src/guestfs-actions.pod:3472 ../src/guestfs-actions.pod:3533
23168 #: ../src/guestfs-actions.pod:3560 ../src/guestfs-actions.pod:7248
23169 msgid "(Added in 1.0.2)"
23173 #: ../src/guestfs-actions.pod:1010
23174 msgid "guestfs_checksum_device"
23178 #: ../src/guestfs-actions.pod:1012
23182 " guestfs_checksum_device (guestfs_h *g,\n"
23183 " const char *csumtype,\n"
23184 " const char *device);\n"
23189 #: ../src/guestfs-actions.pod:1017
23191 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23192 "device named C<device>. For the types of checksums supported see the "
23193 "C<guestfs_checksum> command."
23197 #: ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:5174
23198 #: ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:5346
23199 #: ../src/guestfs-actions.pod:5364 ../src/guestfs-actions.pod:5546
23200 #: ../src/guestfs-actions.pod:7157 ../src/guestfs-actions.pod:7171
23201 #: ../src/guestfs-actions.pod:7571
23202 msgid "(Added in 1.3.2)"
23206 #: ../src/guestfs-actions.pod:1026
23207 msgid "guestfs_checksums_out"
23211 #: ../src/guestfs-actions.pod:1028
23215 " guestfs_checksums_out (guestfs_h *g,\n"
23216 " const char *csumtype,\n"
23217 " const char *directory,\n"
23218 " const char *sumsfile);\n"
23223 #: ../src/guestfs-actions.pod:1048
23224 msgid "(Added in 1.3.7)"
23228 #: ../src/guestfs-actions.pod:1050
23229 msgid "guestfs_chmod"
23233 #: ../src/guestfs-actions.pod:1052
23237 " guestfs_chmod (guestfs_h *g,\n"
23239 " const char *path);\n"
23244 #: ../src/guestfs-actions.pod:1070
23245 msgid "guestfs_chown"
23249 #: ../src/guestfs-actions.pod:1072
23253 " guestfs_chown (guestfs_h *g,\n"
23256 " const char *path);\n"
23261 #: ../src/guestfs-actions.pod:1088
23262 msgid "guestfs_command"
23266 #: ../src/guestfs-actions.pod:1090
23270 " guestfs_command (guestfs_h *g,\n"
23271 " char *const *arguments);\n"
23276 #: ../src/guestfs-actions.pod:1099
23278 "The single parameter is an argv-style list of arguments. The first element "
23279 "is the name of the program to run. Subsequent elements are parameters. The "
23280 "list must be non-empty (ie. must contain a program name). Note that the "
23281 "command runs directly, and is I<not> invoked via the shell (see "
23286 #: ../src/guestfs-actions.pod:1130 ../src/guestfs-actions.pod:1150
23287 #: ../src/guestfs-actions.pod:1615
23288 msgid "(Added in 0.9.1)"
23292 #: ../src/guestfs-actions.pod:1132
23293 msgid "guestfs_command_lines"
23297 #: ../src/guestfs-actions.pod:1134
23301 " guestfs_command_lines (guestfs_h *g,\n"
23302 " char *const *arguments);\n"
23307 #: ../src/guestfs-actions.pod:1138
23309 "This is the same as C<guestfs_command>, but splits the result into a list of "
23314 #: ../src/guestfs-actions.pod:1141
23315 msgid "See also: C<guestfs_sh_lines>"
23319 #: ../src/guestfs-actions.pod:1152
23320 msgid "guestfs_config"
23324 #: ../src/guestfs-actions.pod:1154
23328 " guestfs_config (guestfs_h *g,\n"
23329 " const char *qemuparam,\n"
23330 " const char *qemuvalue);\n"
23335 #: ../src/guestfs-actions.pod:1172
23336 msgid "guestfs_copy_size"
23340 #: ../src/guestfs-actions.pod:1174
23344 " guestfs_copy_size (guestfs_h *g,\n"
23345 " const char *src,\n"
23346 " const char *dest,\n"
23347 " int64_t size);\n"
23352 #: ../src/guestfs-actions.pod:1188 ../src/guestfs-actions.pod:1311
23353 #: ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:1387
23354 #: ../src/guestfs-actions.pod:1764 ../src/guestfs-actions.pod:1786
23355 #: ../src/guestfs-actions.pod:3643 ../src/guestfs-actions.pod:7243
23356 #: ../src/guestfs-actions.pod:7277 ../src/guestfs-actions.pod:7784
23357 #: ../src/guestfs-actions.pod:7807
23359 "This long-running command can generate progress notification messages so "
23360 "that the caller can display a progress bar or indicator. To receive these "
23361 "messages, the caller must register a progress event callback. See L<guestfs"
23362 "(3)/GUESTFS_EVENT_PROGRESS>."
23366 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:4367
23367 #: ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:7478
23368 #: ../src/guestfs-actions.pod:7498 ../src/guestfs-actions.pod:7584
23369 msgid "(Added in 1.0.87)"
23373 #: ../src/guestfs-actions.pod:1195
23378 #: ../src/guestfs-actions.pod:1197
23382 " guestfs_cp (guestfs_h *g,\n"
23383 " const char *src,\n"
23384 " const char *dest);\n"
23389 #: ../src/guestfs-actions.pod:1207 ../src/guestfs-actions.pod:1221
23390 #: ../src/guestfs-actions.pod:1293 ../src/guestfs-actions.pod:1367
23391 #: ../src/guestfs-actions.pod:1481 ../src/guestfs-actions.pod:5121
23392 #: ../src/guestfs-actions.pod:5596
23393 msgid "(Added in 1.0.18)"
23397 #: ../src/guestfs-actions.pod:1209
23398 msgid "guestfs_cp_a"
23402 #: ../src/guestfs-actions.pod:1211
23406 " guestfs_cp_a (guestfs_h *g,\n"
23407 " const char *src,\n"
23408 " const char *dest);\n"
23413 #: ../src/guestfs-actions.pod:1223
23418 #: ../src/guestfs-actions.pod:1225
23422 " guestfs_dd (guestfs_h *g,\n"
23423 " const char *src,\n"
23424 " const char *dest);\n"
23429 #: ../src/guestfs-actions.pod:1235
23431 "If the destination is a device, it must be as large or larger than the "
23432 "source file or device, otherwise the copy will fail. This command cannot do "
23433 "partial copies (see C<guestfs_copy_size>)."
23437 #: ../src/guestfs-actions.pod:1243
23442 #: ../src/guestfs-actions.pod:1245
23446 " guestfs_df (guestfs_h *g);\n"
23451 #: ../src/guestfs-actions.pod:1250 ../src/guestfs-actions.pod:1267
23453 "This command is mostly useful for interactive sessions. It is I<not> "
23454 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
23459 #: ../src/guestfs-actions.pod:1257 ../src/guestfs-actions.pod:1274
23460 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:2366
23461 #: ../src/guestfs-actions.pod:2390 ../src/guestfs-actions.pod:2458
23462 #: ../src/guestfs-actions.pod:4477 ../src/guestfs-actions.pod:5021
23463 #: ../src/guestfs-actions.pod:6981 ../src/guestfs-actions.pod:7005
23464 #: ../src/guestfs-actions.pod:7624 ../src/guestfs-actions.pod:7637
23465 #: ../src/guestfs-actions.pod:7650
23466 msgid "(Added in 1.0.54)"
23470 #: ../src/guestfs-actions.pod:1259
23471 msgid "guestfs_df_h"
23475 #: ../src/guestfs-actions.pod:1261
23479 " guestfs_df_h (guestfs_h *g);\n"
23484 #: ../src/guestfs-actions.pod:1276
23485 msgid "guestfs_dmesg"
23489 #: ../src/guestfs-actions.pod:1278
23493 " guestfs_dmesg (guestfs_h *g);\n"
23498 #: ../src/guestfs-actions.pod:1285
23500 "Another way to get the same information is to enable verbose messages with "
23501 "C<guestfs_set_verbose> or by setting the environment variable "
23502 "C<LIBGUESTFS_DEBUG=1> before running the program."
23506 #: ../src/guestfs-actions.pod:1295
23507 msgid "guestfs_download"
23511 #: ../src/guestfs-actions.pod:1297
23515 " guestfs_download (guestfs_h *g,\n"
23516 " const char *remotefilename,\n"
23517 " const char *filename);\n"
23522 #: ../src/guestfs-actions.pod:1307
23523 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
23527 #: ../src/guestfs-actions.pod:1318
23528 msgid "guestfs_download_offset"
23532 #: ../src/guestfs-actions.pod:1320
23536 " guestfs_download_offset (guestfs_h *g,\n"
23537 " const char *remotefilename,\n"
23538 " const char *filename,\n"
23539 " int64_t offset,\n"
23540 " int64_t size);\n"
23545 #: ../src/guestfs-actions.pod:1333
23547 "Note that there is no limit on the amount of data that can be downloaded "
23548 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
23549 "full amount unless an error occurs."
23553 #: ../src/guestfs-actions.pod:1338
23554 msgid "See also C<guestfs_download>, C<guestfs_pread>."
23558 #: ../src/guestfs-actions.pod:1347 ../src/guestfs-actions.pod:7282
23559 msgid "(Added in 1.5.17)"
23563 #: ../src/guestfs-actions.pod:1349
23564 msgid "guestfs_drop_caches"
23568 #: ../src/guestfs-actions.pod:1351
23572 " guestfs_drop_caches (guestfs_h *g,\n"
23573 " int whattodrop);\n"
23578 #: ../src/guestfs-actions.pod:1369
23583 #: ../src/guestfs-actions.pod:1371
23587 " guestfs_du (guestfs_h *g,\n"
23588 " const char *path);\n"
23593 #: ../src/guestfs-actions.pod:1394
23594 msgid "guestfs_e2fsck_f"
23598 #: ../src/guestfs-actions.pod:1396
23602 " guestfs_e2fsck_f (guestfs_h *g,\n"
23603 " const char *device);\n"
23608 #: ../src/guestfs-actions.pod:1404
23610 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
23611 "Normally you should use C<guestfs_fsck>."
23615 #: ../src/guestfs-actions.pod:1409
23616 msgid "(Added in 1.0.29)"
23620 #: ../src/guestfs-actions.pod:1411
23621 msgid "guestfs_echo_daemon"
23625 #: ../src/guestfs-actions.pod:1413
23629 " guestfs_echo_daemon (guestfs_h *g,\n"
23630 " char *const *words);\n"
23635 #: ../src/guestfs-actions.pod:1422
23636 msgid "See also C<guestfs_ping_daemon>."
23640 #: ../src/guestfs-actions.pod:1427 ../src/guestfs-actions.pod:2174
23641 #: ../src/guestfs-actions.pod:6453
23642 msgid "(Added in 1.0.69)"
23646 #: ../src/guestfs-actions.pod:1429
23647 msgid "guestfs_egrep"
23651 #: ../src/guestfs-actions.pod:1431
23655 " guestfs_egrep (guestfs_h *g,\n"
23656 " const char *regex,\n"
23657 " const char *path);\n"
23662 #: ../src/guestfs-actions.pod:1446 ../src/guestfs-actions.pod:1465
23663 #: ../src/guestfs-actions.pod:1522 ../src/guestfs-actions.pod:1568
23664 #: ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:2304
23665 #: ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:2479
23666 #: ../src/guestfs-actions.pod:2492 ../src/guestfs-actions.pod:2507
23667 #: ../src/guestfs-actions.pod:2553 ../src/guestfs-actions.pod:2575
23668 #: ../src/guestfs-actions.pod:2588 ../src/guestfs-actions.pod:3857
23669 #: ../src/guestfs-actions.pod:3871 ../src/guestfs-actions.pod:3884
23670 #: ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:4899
23671 #: ../src/guestfs-actions.pod:5930 ../src/guestfs-actions.pod:5979
23672 #: ../src/guestfs-actions.pod:6849 ../src/guestfs-actions.pod:6861
23673 #: ../src/guestfs-actions.pod:6874 ../src/guestfs-actions.pod:6887
23674 #: ../src/guestfs-actions.pod:6909 ../src/guestfs-actions.pod:6922
23675 #: ../src/guestfs-actions.pod:6935 ../src/guestfs-actions.pod:6948
23676 #: ../src/guestfs-actions.pod:7742 ../src/guestfs-actions.pod:7761
23677 #: ../src/guestfs-actions.pod:7855 ../src/guestfs-actions.pod:7874
23678 #: ../src/guestfs-actions.pod:7920 ../src/guestfs-actions.pod:7939
23679 msgid "(Added in 1.0.66)"
23683 #: ../src/guestfs-actions.pod:1448
23684 msgid "guestfs_egrepi"
23688 #: ../src/guestfs-actions.pod:1450
23692 " guestfs_egrepi (guestfs_h *g,\n"
23693 " const char *regex,\n"
23694 " const char *path);\n"
23699 #: ../src/guestfs-actions.pod:1467
23700 msgid "guestfs_equal"
23704 #: ../src/guestfs-actions.pod:1469
23708 " guestfs_equal (guestfs_h *g,\n"
23709 " const char *file1,\n"
23710 " const char *file2);\n"
23715 #: ../src/guestfs-actions.pod:1483
23716 msgid "guestfs_exists"
23720 #: ../src/guestfs-actions.pod:1485
23724 " guestfs_exists (guestfs_h *g,\n"
23725 " const char *path);\n"
23730 #: ../src/guestfs-actions.pod:1492
23731 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
23735 #: ../src/guestfs-actions.pod:1498
23736 msgid "guestfs_fallocate"
23740 #: ../src/guestfs-actions.pod:1500
23744 " guestfs_fallocate (guestfs_h *g,\n"
23745 " const char *path,\n"
23751 #: ../src/guestfs-actions.pod:1515
23753 "This function is deprecated. In new code, use the L</guestfs_fallocate64> "
23758 #: ../src/guestfs-actions.pod:1524
23759 msgid "guestfs_fallocate64"
23763 #: ../src/guestfs-actions.pod:1526
23767 " guestfs_fallocate64 (guestfs_h *g,\n"
23768 " const char *path,\n"
23774 #: ../src/guestfs-actions.pod:1535
23776 "Note that this call allocates disk blocks for the file. To create a sparse "
23777 "file use C<guestfs_truncate_size> instead."
23781 #: ../src/guestfs-actions.pod:1538
23783 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
23784 "oversight it only allowed 30 bit lengths to be specified, effectively "
23785 "limiting the maximum size of files created through that call to 1GB."
23789 #: ../src/guestfs-actions.pod:1549
23790 msgid "(Added in 1.3.17)"
23794 #: ../src/guestfs-actions.pod:1551
23795 msgid "guestfs_fgrep"
23799 #: ../src/guestfs-actions.pod:1553
23803 " guestfs_fgrep (guestfs_h *g,\n"
23804 " const char *pattern,\n"
23805 " const char *path);\n"
23810 #: ../src/guestfs-actions.pod:1570
23811 msgid "guestfs_fgrepi"
23815 #: ../src/guestfs-actions.pod:1572
23819 " guestfs_fgrepi (guestfs_h *g,\n"
23820 " const char *pattern,\n"
23821 " const char *path);\n"
23826 #: ../src/guestfs-actions.pod:1589
23827 msgid "guestfs_file"
23831 #: ../src/guestfs-actions.pod:1591
23835 " guestfs_file (guestfs_h *g,\n"
23836 " const char *path);\n"
23841 #: ../src/guestfs-actions.pod:1609
23843 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
23844 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
23848 #: ../src/guestfs-actions.pod:1617
23849 msgid "guestfs_file_architecture"
23853 #: ../src/guestfs-actions.pod:1619
23857 " guestfs_file_architecture (guestfs_h *g,\n"
23858 " const char *filename);\n"
23863 #: ../src/guestfs-actions.pod:1727 ../src/guestfs-actions.pod:1890
23864 #: ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:2608
23865 #: ../src/guestfs-actions.pod:2698 ../src/guestfs-actions.pod:2764
23866 #: ../src/guestfs-actions.pod:2951 ../src/guestfs-actions.pod:2969
23867 #: ../src/guestfs-actions.pod:3009 ../src/guestfs-actions.pod:3084
23868 #: ../src/guestfs-actions.pod:3177 ../src/guestfs-actions.pod:3414
23869 #: ../src/guestfs-actions.pod:3546
23870 msgid "(Added in 1.5.3)"
23874 #: ../src/guestfs-actions.pod:1729
23875 msgid "guestfs_filesize"
23879 #: ../src/guestfs-actions.pod:1731
23883 " guestfs_filesize (guestfs_h *g,\n"
23884 " const char *file);\n"
23889 #: ../src/guestfs-actions.pod:1737
23891 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
23892 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
23893 "devices, use C<guestfs_blockdev_getsize64>."
23897 #: ../src/guestfs-actions.pod:1743
23898 msgid "(Added in 1.0.82)"
23902 #: ../src/guestfs-actions.pod:1745
23903 msgid "guestfs_fill"
23907 #: ../src/guestfs-actions.pod:1747
23911 " guestfs_fill (guestfs_h *g,\n"
23914 " const char *path);\n"
23919 #: ../src/guestfs-actions.pod:1757
23921 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23922 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
23923 "bytes use C<guestfs_fill_pattern>."
23927 #: ../src/guestfs-actions.pod:1769
23928 msgid "(Added in 1.0.79)"
23932 #: ../src/guestfs-actions.pod:1771
23933 msgid "guestfs_fill_pattern"
23937 #: ../src/guestfs-actions.pod:1773
23941 " guestfs_fill_pattern (guestfs_h *g,\n"
23942 " const char *pattern,\n"
23944 " const char *path);\n"
23949 #: ../src/guestfs-actions.pod:1779
23951 "This function is like C<guestfs_fill> except that it creates a new file of "
23952 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
23953 "pattern is truncated if necessary to ensure the length of the file is "
23954 "exactly C<len> bytes."
23958 #: ../src/guestfs-actions.pod:1791
23959 msgid "(Added in 1.3.12)"
23963 #: ../src/guestfs-actions.pod:1793
23964 msgid "guestfs_find"
23968 #: ../src/guestfs-actions.pod:1795
23972 " guestfs_find (guestfs_h *g,\n"
23973 " const char *directory);\n"
23978 #: ../src/guestfs-actions.pod:1811
23980 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
23984 #: ../src/guestfs-actions.pod:1824
23985 msgid "See also C<guestfs_find0>."
23989 #: ../src/guestfs-actions.pod:1833 ../src/guestfs-actions.pod:4304
23990 #: ../src/guestfs-actions.pod:6014
23991 msgid "(Added in 1.0.27)"
23995 #: ../src/guestfs-actions.pod:1835
23996 msgid "guestfs_find0"
24000 #: ../src/guestfs-actions.pod:1837
24004 " guestfs_find0 (guestfs_h *g,\n"
24005 " const char *directory,\n"
24006 " const char *files);\n"
24011 #: ../src/guestfs-actions.pod:1846
24013 "This command works the same way as C<guestfs_find> with the following "
24018 #: ../src/guestfs-actions.pod:1873
24019 msgid "(Added in 1.0.74)"
24023 #: ../src/guestfs-actions.pod:1875
24024 msgid "guestfs_findfs_label"
24028 #: ../src/guestfs-actions.pod:1877
24032 " guestfs_findfs_label (guestfs_h *g,\n"
24033 " const char *label);\n"
24038 #: ../src/guestfs-actions.pod:1885
24039 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
24043 #: ../src/guestfs-actions.pod:1892
24044 msgid "guestfs_findfs_uuid"
24048 #: ../src/guestfs-actions.pod:1894
24052 " guestfs_findfs_uuid (guestfs_h *g,\n"
24053 " const char *uuid);\n"
24058 #: ../src/guestfs-actions.pod:1902
24059 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
24063 #: ../src/guestfs-actions.pod:1909
24064 msgid "guestfs_fsck"
24068 #: ../src/guestfs-actions.pod:1911
24072 " guestfs_fsck (guestfs_h *g,\n"
24073 " const char *fstype,\n"
24074 " const char *device);\n"
24079 #: ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:7789
24080 msgid "(Added in 1.0.16)"
24084 #: ../src/guestfs-actions.pod:1948
24085 msgid "guestfs_get_append"
24089 #: ../src/guestfs-actions.pod:1950
24093 " guestfs_get_append (guestfs_h *g);\n"
24098 #: ../src/guestfs-actions.pod:1958
24100 "This function returns a string which may be NULL. There is no way to return "
24101 "an error from this function. The string is owned by the guest handle and "
24102 "must I<not> be freed."
24106 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:5692
24107 #: ../src/guestfs-actions.pod:6174 ../src/guestfs-actions.pod:6616
24108 #: ../src/guestfs-actions.pod:6635 ../src/guestfs-actions.pod:6651
24109 #: ../src/guestfs-actions.pod:6675 ../src/guestfs-actions.pod:7429
24110 #: ../src/guestfs-actions.pod:7444 ../src/guestfs-actions.pod:7836
24111 msgid "(Added in 1.0.26)"
24115 #: ../src/guestfs-actions.pod:1964
24116 msgid "guestfs_get_attach_method"
24120 #: ../src/guestfs-actions.pod:1966
24124 " guestfs_get_attach_method (guestfs_h *g);\n"
24129 #: ../src/guestfs-actions.pod:1969
24130 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
24134 #: ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:6204
24135 msgid "(Added in 1.9.8)"
24139 #: ../src/guestfs-actions.pod:1976
24140 msgid "guestfs_get_autosync"
24144 #: ../src/guestfs-actions.pod:1978
24148 " guestfs_get_autosync (guestfs_h *g);\n"
24153 #: ../src/guestfs-actions.pod:1987
24154 msgid "guestfs_get_direct"
24158 #: ../src/guestfs-actions.pod:1989
24162 " guestfs_get_direct (guestfs_h *g);\n"
24167 #: ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:6245
24168 msgid "(Added in 1.0.72)"
24172 #: ../src/guestfs-actions.pod:1998
24173 msgid "guestfs_get_e2label"
24177 #: ../src/guestfs-actions.pod:2000
24181 " guestfs_get_e2label (guestfs_h *g,\n"
24182 " const char *device);\n"
24187 #: ../src/guestfs-actions.pod:2010
24189 "This function is deprecated. In new code, use the L</guestfs_vfs_label> "
24194 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2038
24195 #: ../src/guestfs-actions.pod:6263 ../src/guestfs-actions.pod:6282
24196 msgid "(Added in 1.0.15)"
24200 #: ../src/guestfs-actions.pod:2019
24201 msgid "guestfs_get_e2uuid"
24205 #: ../src/guestfs-actions.pod:2021
24209 " guestfs_get_e2uuid (guestfs_h *g,\n"
24210 " const char *device);\n"
24215 #: ../src/guestfs-actions.pod:2031
24217 "This function is deprecated. In new code, use the L</guestfs_vfs_uuid> call "
24222 #: ../src/guestfs-actions.pod:2040
24223 msgid "guestfs_get_memsize"
24227 #: ../src/guestfs-actions.pod:2042
24231 " guestfs_get_memsize (guestfs_h *g);\n"
24236 #: ../src/guestfs-actions.pod:2048
24238 "If C<guestfs_set_memsize> was not called on this handle, and if "
24239 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
24240 "value for memsize."
24244 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:4595
24245 #: ../src/guestfs-actions.pod:4804 ../src/guestfs-actions.pod:4823
24246 #: ../src/guestfs-actions.pod:4842 ../src/guestfs-actions.pod:4854
24247 #: ../src/guestfs-actions.pod:4871 ../src/guestfs-actions.pod:4884
24248 #: ../src/guestfs-actions.pod:5917 ../src/guestfs-actions.pod:6303
24249 #: ../src/guestfs-actions.pod:6583 ../src/guestfs-actions.pod:7198
24250 msgid "(Added in 1.0.55)"
24254 #: ../src/guestfs-actions.pod:2059
24255 msgid "guestfs_get_network"
24259 #: ../src/guestfs-actions.pod:2061
24263 " guestfs_get_network (guestfs_h *g);\n"
24268 #: ../src/guestfs-actions.pod:2068 ../src/guestfs-actions.pod:6322
24269 msgid "(Added in 1.5.4)"
24273 #: ../src/guestfs-actions.pod:2070
24274 msgid "guestfs_get_path"
24278 #: ../src/guestfs-actions.pod:2072
24282 " guestfs_get_path (guestfs_h *g);\n"
24287 #: ../src/guestfs-actions.pod:2080 ../src/guestfs-actions.pod:2120
24289 "This function returns a string, or NULL on error. The string is owned by "
24290 "the guest handle and must I<not> be freed."
24294 #: ../src/guestfs-actions.pod:2085
24295 msgid "guestfs_get_pgroup"
24299 #: ../src/guestfs-actions.pod:2087
24303 " guestfs_get_pgroup (guestfs_h *g);\n"
24308 #: ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:6358
24309 #: ../src/guestfs-actions.pod:7690
24310 msgid "(Added in 1.11.18)"
24314 #: ../src/guestfs-actions.pod:2096
24315 msgid "guestfs_get_pid"
24319 #: ../src/guestfs-actions.pod:2098
24323 " guestfs_get_pid (guestfs_h *g);\n"
24328 #: ../src/guestfs-actions.pod:2108
24329 msgid "(Added in 1.0.56)"
24333 #: ../src/guestfs-actions.pod:2110
24334 msgid "guestfs_get_qemu"
24338 #: ../src/guestfs-actions.pod:2112
24342 " guestfs_get_qemu (guestfs_h *g);\n"
24347 #: ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:6386
24348 msgid "(Added in 1.0.6)"
24352 #: ../src/guestfs-actions.pod:2125
24353 msgid "guestfs_get_recovery_proc"
24357 #: ../src/guestfs-actions.pod:2127
24361 " guestfs_get_recovery_proc (guestfs_h *g);\n"
24366 #: ../src/guestfs-actions.pod:2134 ../src/guestfs-actions.pod:3668
24367 #: ../src/guestfs-actions.pod:3999 ../src/guestfs-actions.pod:4402
24368 #: ../src/guestfs-actions.pod:4434 ../src/guestfs-actions.pod:5622
24369 #: ../src/guestfs-actions.pod:5965 ../src/guestfs-actions.pod:6410
24370 #: ../src/guestfs-actions.pod:7101 ../src/guestfs-actions.pod:7121
24371 #: ../src/guestfs-actions.pod:7313
24372 msgid "(Added in 1.0.77)"
24376 #: ../src/guestfs-actions.pod:2136
24377 msgid "guestfs_get_selinux"
24381 #: ../src/guestfs-actions.pod:2138
24385 " guestfs_get_selinux (guestfs_h *g);\n"
24390 #: ../src/guestfs-actions.pod:2141
24392 "This returns the current setting of the selinux flag which is passed to the "
24393 "appliance at boot time. See C<guestfs_set_selinux>."
24397 #: ../src/guestfs-actions.pod:2149 ../src/guestfs-actions.pod:2212
24398 #: ../src/guestfs-actions.pod:6429 ../src/guestfs-actions.pod:6487
24399 msgid "(Added in 1.0.67)"
24403 #: ../src/guestfs-actions.pod:2151
24404 msgid "guestfs_get_state"
24408 #: ../src/guestfs-actions.pod:2153
24412 " guestfs_get_state (guestfs_h *g);\n"
24417 #: ../src/guestfs-actions.pod:2165
24418 msgid "guestfs_get_trace"
24422 #: ../src/guestfs-actions.pod:2167
24426 " guestfs_get_trace (guestfs_h *g);\n"
24431 #: ../src/guestfs-actions.pod:2176
24432 msgid "guestfs_get_umask"
24436 #: ../src/guestfs-actions.pod:2178
24440 " guestfs_get_umask (guestfs_h *g);\n"
24445 #: ../src/guestfs-actions.pod:2181
24447 "Return the current umask. By default the umask is C<022> unless it has been "
24448 "set by calling C<guestfs_umask>."
24452 #: ../src/guestfs-actions.pod:2188
24453 msgid "guestfs_get_verbose"
24457 #: ../src/guestfs-actions.pod:2190
24461 " guestfs_get_verbose (guestfs_h *g);\n"
24466 #: ../src/guestfs-actions.pod:2199
24467 msgid "guestfs_getcon"
24471 #: ../src/guestfs-actions.pod:2201
24475 " guestfs_getcon (guestfs_h *g);\n"
24480 #: ../src/guestfs-actions.pod:2206
24482 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
24486 #: ../src/guestfs-actions.pod:2214
24487 msgid "guestfs_getxattr"
24491 #: ../src/guestfs-actions.pod:2216
24495 " guestfs_getxattr (guestfs_h *g,\n"
24496 " const char *path,\n"
24497 " const char *name,\n"
24498 " size_t *size_r);\n"
24503 #: ../src/guestfs-actions.pod:2222
24505 "Get a single extended attribute from file C<path> named C<name>. This call "
24506 "follows symlinks. If you want to lookup an extended attribute for the "
24507 "symlink itself, use C<guestfs_lgetxattr>."
24511 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:3682
24513 "Normally it is better to get all extended attributes from a file in one go "
24514 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
24515 "implementations are buggy and do not provide a way to list out attributes. "
24516 "For these filesystems (notably ntfs-3g) you have to know the names of the "
24517 "extended attributes you want in advance and call this function."
24521 #: ../src/guestfs-actions.pod:2236
24522 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
24526 #: ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2429
24527 #: ../src/guestfs-actions.pod:2899 ../src/guestfs-actions.pod:3694
24528 #: ../src/guestfs-actions.pod:5615 ../src/guestfs-actions.pod:5641
24529 #: ../src/guestfs-actions.pod:5822
24531 "This function returns a buffer, or NULL on error. The size of the returned "
24532 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
24537 #: ../src/guestfs-actions.pod:2242 ../src/guestfs-actions.pod:3698
24538 msgid "(Added in 1.7.24)"
24542 #: ../src/guestfs-actions.pod:2244
24543 msgid "guestfs_getxattrs"
24547 #: ../src/guestfs-actions.pod:2246
24550 " struct guestfs_xattr_list *\n"
24551 " guestfs_getxattrs (guestfs_h *g,\n"
24552 " const char *path);\n"
24557 #: ../src/guestfs-actions.pod:2256
24558 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
24562 #: ../src/guestfs-actions.pod:2258 ../src/guestfs-actions.pod:3710
24563 #: ../src/guestfs-actions.pod:4398
24565 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
24566 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
24570 #: ../src/guestfs-actions.pod:2262 ../src/guestfs-actions.pod:3714
24571 #: ../src/guestfs-actions.pod:3913 ../src/guestfs-actions.pod:3949
24572 #: ../src/guestfs-actions.pod:5995 ../src/guestfs-actions.pod:6506
24573 #: ../src/guestfs-actions.pod:7901
24574 msgid "(Added in 1.0.59)"
24578 #: ../src/guestfs-actions.pod:2264
24579 msgid "guestfs_glob_expand"
24583 #: ../src/guestfs-actions.pod:2266
24587 " guestfs_glob_expand (guestfs_h *g,\n"
24588 " const char *pattern);\n"
24593 #: ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:6699
24594 #: ../src/guestfs-actions.pod:6716
24595 msgid "(Added in 1.0.50)"
24599 #: ../src/guestfs-actions.pod:2287
24600 msgid "guestfs_grep"
24604 #: ../src/guestfs-actions.pod:2289
24608 " guestfs_grep (guestfs_h *g,\n"
24609 " const char *regex,\n"
24610 " const char *path);\n"
24615 #: ../src/guestfs-actions.pod:2306
24616 msgid "guestfs_grepi"
24620 #: ../src/guestfs-actions.pod:2308
24624 " guestfs_grepi (guestfs_h *g,\n"
24625 " const char *regex,\n"
24626 " const char *path);\n"
24631 #: ../src/guestfs-actions.pod:2325
24632 msgid "guestfs_grub_install"
24636 #: ../src/guestfs-actions.pod:2327
24640 " guestfs_grub_install (guestfs_h *g,\n"
24641 " const char *root,\n"
24642 " const char *device);\n"
24647 #: ../src/guestfs-actions.pod:2348
24648 msgid "(Added in 1.0.17)"
24652 #: ../src/guestfs-actions.pod:2350
24653 msgid "guestfs_head"
24657 #: ../src/guestfs-actions.pod:2352
24661 " guestfs_head (guestfs_h *g,\n"
24662 " const char *path);\n"
24667 #: ../src/guestfs-actions.pod:2368
24668 msgid "guestfs_head_n"
24672 #: ../src/guestfs-actions.pod:2370
24676 " guestfs_head_n (guestfs_h *g,\n"
24678 " const char *path);\n"
24683 #: ../src/guestfs-actions.pod:2392
24684 msgid "guestfs_hexdump"
24688 #: ../src/guestfs-actions.pod:2394
24692 " guestfs_hexdump (guestfs_h *g,\n"
24693 " const char *path);\n"
24698 #: ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:6780
24699 #: ../src/guestfs-actions.pod:6835
24700 msgid "(Added in 1.0.22)"
24704 #: ../src/guestfs-actions.pod:2409
24705 msgid "guestfs_initrd_cat"
24709 #: ../src/guestfs-actions.pod:2411
24713 " guestfs_initrd_cat (guestfs_h *g,\n"
24714 " const char *initrdpath,\n"
24715 " const char *filename,\n"
24716 " size_t *size_r);\n"
24721 #: ../src/guestfs-actions.pod:2427
24722 msgid "See also C<guestfs_initrd_list>."
24726 #: ../src/guestfs-actions.pod:2438
24727 msgid "guestfs_initrd_list"
24731 #: ../src/guestfs-actions.pod:2440
24735 " guestfs_initrd_list (guestfs_h *g,\n"
24736 " const char *path);\n"
24741 #: ../src/guestfs-actions.pod:2460
24742 msgid "guestfs_inotify_add_watch"
24746 #: ../src/guestfs-actions.pod:2462
24750 " guestfs_inotify_add_watch (guestfs_h *g,\n"
24751 " const char *path,\n"
24757 #: ../src/guestfs-actions.pod:2481
24758 msgid "guestfs_inotify_close"
24762 #: ../src/guestfs-actions.pod:2483
24766 " guestfs_inotify_close (guestfs_h *g);\n"
24771 #: ../src/guestfs-actions.pod:2494
24772 msgid "guestfs_inotify_files"
24776 #: ../src/guestfs-actions.pod:2496
24780 " guestfs_inotify_files (guestfs_h *g);\n"
24785 #: ../src/guestfs-actions.pod:2499
24787 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
24788 "returns a list of pathnames of objects that were touched. The returned "
24789 "pathnames are sorted and deduplicated."
24793 #: ../src/guestfs-actions.pod:2509
24794 msgid "guestfs_inotify_init"
24798 #: ../src/guestfs-actions.pod:2511
24802 " guestfs_inotify_init (guestfs_h *g,\n"
24803 " int maxevents);\n"
24808 #: ../src/guestfs-actions.pod:2519
24810 "C<maxevents> is the maximum number of events which will be queued up between "
24811 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
24812 "passed as C<0>, then the kernel (or previously set) default is used. For "
24813 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
24814 "throws away events, but records the fact that it threw them away by setting "
24815 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
24816 "C<guestfs_inotify_read>)."
24820 #: ../src/guestfs-actions.pod:2529
24822 "Before any events are generated, you have to add some watches to the "
24823 "internal watch list. See: C<guestfs_inotify_add_watch>, "
24824 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
24828 #: ../src/guestfs-actions.pod:2535
24830 "Queued up events should be read periodically by calling "
24831 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
24832 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
24833 "often enough then you risk the internal queue overflowing."
24837 #: ../src/guestfs-actions.pod:2542
24839 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
24840 "This also removes any watches automatically."
24844 #: ../src/guestfs-actions.pod:2555
24845 msgid "guestfs_inotify_read"
24849 #: ../src/guestfs-actions.pod:2557
24852 " struct guestfs_inotify_event_list *\n"
24853 " guestfs_inotify_read (guestfs_h *g);\n"
24858 #: ../src/guestfs-actions.pod:2571
24860 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
24861 "there was an error. I<The caller must call "
24862 "C<guestfs_free_inotify_event_list> after use>."
24866 #: ../src/guestfs-actions.pod:2577
24867 msgid "guestfs_inotify_rm_watch"
24871 #: ../src/guestfs-actions.pod:2579
24875 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
24881 #: ../src/guestfs-actions.pod:2583
24883 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
24887 #: ../src/guestfs-actions.pod:2590
24888 msgid "guestfs_inspect_get_arch"
24892 #: ../src/guestfs-actions.pod:2592
24896 " guestfs_inspect_get_arch (guestfs_h *g,\n"
24897 " const char *root);\n"
24902 #: ../src/guestfs-actions.pod:2596
24904 "This returns the architecture of the inspected operating system. The "
24905 "possible return values are listed under C<guestfs_file_architecture>."
24909 #: ../src/guestfs-actions.pod:2610
24910 msgid "guestfs_inspect_get_distro"
24914 #: ../src/guestfs-actions.pod:2612
24918 " guestfs_inspect_get_distro (guestfs_h *g,\n"
24919 " const char *root);\n"
24924 #: ../src/guestfs-actions.pod:2700
24925 msgid "guestfs_inspect_get_drive_mappings"
24929 #: ../src/guestfs-actions.pod:2702
24933 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
24934 " const char *root);\n"
24939 #: ../src/guestfs-actions.pod:2731
24941 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24942 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
24946 #: ../src/guestfs-actions.pod:2735 ../src/guestfs-actions.pod:3003
24947 #: ../src/guestfs-actions.pod:3801 ../src/guestfs-actions.pod:5083
24948 #: ../src/guestfs-actions.pod:7137
24950 "This function returns a NULL-terminated array of strings, or NULL if there "
24951 "was an error. The array of strings will always have length C<2n+1>, where "
24952 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
24953 "caller must free the strings and the array after use>."
24957 #: ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:3197
24958 msgid "(Added in 1.9.17)"
24962 #: ../src/guestfs-actions.pod:2743
24963 msgid "guestfs_inspect_get_filesystems"
24967 #: ../src/guestfs-actions.pod:2745
24971 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
24972 " const char *root);\n"
24977 #: ../src/guestfs-actions.pod:2757
24979 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24980 "C<guestfs_inspect_get_mountpoints>."
24984 #: ../src/guestfs-actions.pod:2766
24985 msgid "guestfs_inspect_get_format"
24989 #: ../src/guestfs-actions.pod:2768
24993 " guestfs_inspect_get_format (guestfs_h *g,\n"
24994 " const char *root);\n"
24999 #: ../src/guestfs-actions.pod:2802 ../src/guestfs-actions.pod:3233
25000 #: ../src/guestfs-actions.pod:3249 ../src/guestfs-actions.pod:3267
25001 #: ../src/guestfs-actions.pod:6033
25002 msgid "(Added in 1.9.4)"
25006 #: ../src/guestfs-actions.pod:2804
25007 msgid "guestfs_inspect_get_hostname"
25011 #: ../src/guestfs-actions.pod:2806
25015 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
25016 " const char *root);\n"
25021 #: ../src/guestfs-actions.pod:2821
25022 msgid "(Added in 1.7.9)"
25026 #: ../src/guestfs-actions.pod:2823
25027 msgid "guestfs_inspect_get_icon"
25031 #: ../src/guestfs-actions.pod:2825
25035 " guestfs_inspect_get_icon (guestfs_h *g,\n"
25036 " const char *root,\n"
25037 " size_t *size_r,\n"
25043 #: ../src/guestfs-actions.pod:2836
25046 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
25047 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
25052 #: ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:3728
25053 #: ../src/guestfs-actions.pod:4982
25054 msgid "(Added in 1.11.12)"
25058 #: ../src/guestfs-actions.pod:2905
25059 msgid "guestfs_inspect_get_icon_va"
25063 #: ../src/guestfs-actions.pod:2907
25067 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
25068 " const char *root,\n"
25069 " size_t *size_r,\n"
25070 " va_list args);\n"
25075 #: ../src/guestfs-actions.pod:2913
25076 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
25080 #: ../src/guestfs-actions.pod:2917
25081 msgid "guestfs_inspect_get_icon_argv"
25085 #: ../src/guestfs-actions.pod:2919
25089 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
25090 " const char *root,\n"
25091 " size_t *size_r,\n"
25092 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
25097 #: ../src/guestfs-actions.pod:2925
25098 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
25102 #: ../src/guestfs-actions.pod:2929
25103 msgid "guestfs_inspect_get_major_version"
25107 #: ../src/guestfs-actions.pod:2931
25111 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
25112 " const char *root);\n"
25117 #: ../src/guestfs-actions.pod:2953
25118 msgid "guestfs_inspect_get_minor_version"
25122 #: ../src/guestfs-actions.pod:2955
25126 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
25127 " const char *root);\n"
25132 #: ../src/guestfs-actions.pod:2964
25134 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25135 "C<guestfs_inspect_get_major_version>."
25139 #: ../src/guestfs-actions.pod:2971
25140 msgid "guestfs_inspect_get_mountpoints"
25144 #: ../src/guestfs-actions.pod:2973
25148 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
25149 " const char *root);\n"
25154 #: ../src/guestfs-actions.pod:2994
25156 "For operating systems like Windows which still use drive letters, this call "
25157 "will only return an entry for the first drive \"mounted on\" C</>. For "
25158 "information about the mapping of drive letters to partitions, see "
25159 "C<guestfs_inspect_get_drive_mappings>."
25163 #: ../src/guestfs-actions.pod:3000
25165 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25166 "C<guestfs_inspect_get_filesystems>."
25170 #: ../src/guestfs-actions.pod:3011
25171 msgid "guestfs_inspect_get_package_format"
25175 #: ../src/guestfs-actions.pod:3013
25179 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
25180 " const char *root);\n"
25185 #: ../src/guestfs-actions.pod:3017
25187 "This function and C<guestfs_inspect_get_package_management> return the "
25188 "package format and package management tool used by the inspected operating "
25189 "system. For example for Fedora these functions would return C<rpm> (package "
25190 "format) and C<yum> (package management)."
25194 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3063
25195 msgid "(Added in 1.7.5)"
25199 #: ../src/guestfs-actions.pod:3037
25200 msgid "guestfs_inspect_get_package_management"
25204 #: ../src/guestfs-actions.pod:3039
25208 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
25209 " const char *root);\n"
25214 #: ../src/guestfs-actions.pod:3043
25216 "C<guestfs_inspect_get_package_format> and this function return the package "
25217 "format and package management tool used by the inspected operating system. "
25218 "For example for Fedora these functions would return C<rpm> (package format) "
25219 "and C<yum> (package management)."
25223 #: ../src/guestfs-actions.pod:3065
25224 msgid "guestfs_inspect_get_product_name"
25228 #: ../src/guestfs-actions.pod:3067
25232 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
25233 " const char *root);\n"
25238 #: ../src/guestfs-actions.pod:3086
25239 msgid "guestfs_inspect_get_product_variant"
25243 #: ../src/guestfs-actions.pod:3088
25247 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
25248 " const char *root);\n"
25253 #: ../src/guestfs-actions.pod:3111
25255 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25256 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
25260 #: ../src/guestfs-actions.pod:3118
25261 msgid "(Added in 1.9.13)"
25265 #: ../src/guestfs-actions.pod:3120
25266 msgid "guestfs_inspect_get_roots"
25270 #: ../src/guestfs-actions.pod:3122
25274 " guestfs_inspect_get_roots (guestfs_h *g);\n"
25279 #: ../src/guestfs-actions.pod:3125
25281 "This function is a convenient way to get the list of root devices, as "
25282 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
25283 "the whole inspection process."
25287 #: ../src/guestfs-actions.pod:3129
25289 "This returns an empty list if either no root devices were found or the "
25290 "caller has not called C<guestfs_inspect_os>."
25294 #: ../src/guestfs-actions.pod:3138
25295 msgid "(Added in 1.7.3)"
25299 #: ../src/guestfs-actions.pod:3140
25300 msgid "guestfs_inspect_get_type"
25304 #: ../src/guestfs-actions.pod:3142
25308 " guestfs_inspect_get_type (guestfs_h *g,\n"
25309 " const char *root);\n"
25314 #: ../src/guestfs-actions.pod:3179
25315 msgid "guestfs_inspect_get_windows_current_control_set"
25319 #: ../src/guestfs-actions.pod:3181
25323 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
25324 " const char *root);\n"
25329 #: ../src/guestfs-actions.pod:3199
25330 msgid "guestfs_inspect_get_windows_systemroot"
25334 #: ../src/guestfs-actions.pod:3201
25338 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
25339 " const char *root);\n"
25344 #: ../src/guestfs-actions.pod:3217
25345 msgid "(Added in 1.5.25)"
25349 #: ../src/guestfs-actions.pod:3219
25350 msgid "guestfs_inspect_is_live"
25354 #: ../src/guestfs-actions.pod:3221
25358 " guestfs_inspect_is_live (guestfs_h *g,\n"
25359 " const char *root);\n"
25364 #: ../src/guestfs-actions.pod:3225
25366 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25367 "disk), then this returns true if a live image was detected on the disk."
25371 #: ../src/guestfs-actions.pod:3235
25372 msgid "guestfs_inspect_is_multipart"
25376 #: ../src/guestfs-actions.pod:3237
25380 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
25381 " const char *root);\n"
25386 #: ../src/guestfs-actions.pod:3241
25388 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25389 "disk), then this returns true if the disk is part of a set."
25393 #: ../src/guestfs-actions.pod:3251
25394 msgid "guestfs_inspect_is_netinst"
25398 #: ../src/guestfs-actions.pod:3253
25402 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
25403 " const char *root);\n"
25408 #: ../src/guestfs-actions.pod:3257
25410 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25411 "disk), then this returns true if the disk is a network installer, ie. not a "
25412 "self-contained install CD but one which is likely to require network access "
25413 "to complete the install."
25417 #: ../src/guestfs-actions.pod:3269
25418 msgid "guestfs_inspect_list_applications"
25422 #: ../src/guestfs-actions.pod:3271
25425 " struct guestfs_application_list *\n"
25426 " guestfs_inspect_list_applications (guestfs_h *g,\n"
25427 " const char *root);\n"
25432 #: ../src/guestfs-actions.pod:3277
25434 "I<Note:> This call works differently from other parts of the inspection "
25435 "API. You have to call C<guestfs_inspect_os>, then "
25436 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
25437 "this. Listing applications is a significantly more difficult operation "
25438 "which requires access to the full filesystem. Also note that unlike the "
25439 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
25440 "the libguestfs handle, this call actually reads parts of the mounted "
25441 "filesystems during the call."
25445 #: ../src/guestfs-actions.pod:3367
25447 "This function returns a C<struct guestfs_application_list *>, or NULL if "
25448 "there was an error. I<The caller must call C<guestfs_free_application_list> "
25453 #: ../src/guestfs-actions.pod:3371
25454 msgid "(Added in 1.7.8)"
25458 #: ../src/guestfs-actions.pod:3373
25459 msgid "guestfs_inspect_os"
25463 #: ../src/guestfs-actions.pod:3375
25467 " guestfs_inspect_os (guestfs_h *g);\n"
25472 #: ../src/guestfs-actions.pod:3391
25474 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
25475 "functions in order to query further information about each operating system, "
25476 "such as the name and version."
25480 #: ../src/guestfs-actions.pod:3396
25482 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
25483 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
25484 "the contents. This should be called with no disks currently mounted. The "
25485 "function may also use Augeas, so any existing Augeas handle will be closed."
25489 #: ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3739
25490 #: ../src/guestfs-actions.pod:3821
25491 msgid "See also C<guestfs_list_filesystems>."
25495 #: ../src/guestfs-actions.pod:3416
25496 msgid "guestfs_is_blockdev"
25500 #: ../src/guestfs-actions.pod:3418
25504 " guestfs_is_blockdev (guestfs_h *g,\n"
25505 " const char *path);\n"
25510 #: ../src/guestfs-actions.pod:3425 ../src/guestfs-actions.pod:3454
25511 #: ../src/guestfs-actions.pod:3484 ../src/guestfs-actions.pod:3499
25512 #: ../src/guestfs-actions.pod:3515 ../src/guestfs-actions.pod:3571
25513 #: ../src/guestfs-actions.pod:3586
25514 msgid "See also C<guestfs_stat>."
25518 #: ../src/guestfs-actions.pod:3429 ../src/guestfs-actions.pod:3458
25519 #: ../src/guestfs-actions.pod:3503 ../src/guestfs-actions.pod:3575
25520 #: ../src/guestfs-actions.pod:3590
25521 msgid "(Added in 1.5.10)"
25525 #: ../src/guestfs-actions.pod:3431
25526 msgid "guestfs_is_busy"
25530 #: ../src/guestfs-actions.pod:3433
25534 " guestfs_is_busy (guestfs_h *g);\n"
25539 #: ../src/guestfs-actions.pod:3445
25540 msgid "guestfs_is_chardev"
25544 #: ../src/guestfs-actions.pod:3447
25548 " guestfs_is_chardev (guestfs_h *g,\n"
25549 " const char *path);\n"
25554 #: ../src/guestfs-actions.pod:3460
25555 msgid "guestfs_is_config"
25559 #: ../src/guestfs-actions.pod:3462
25563 " guestfs_is_config (guestfs_h *g);\n"
25568 #: ../src/guestfs-actions.pod:3474
25569 msgid "guestfs_is_dir"
25573 #: ../src/guestfs-actions.pod:3476
25577 " guestfs_is_dir (guestfs_h *g,\n"
25578 " const char *path);\n"
25583 #: ../src/guestfs-actions.pod:3490
25584 msgid "guestfs_is_fifo"
25588 #: ../src/guestfs-actions.pod:3492
25592 " guestfs_is_fifo (guestfs_h *g,\n"
25593 " const char *path);\n"
25598 #: ../src/guestfs-actions.pod:3505
25599 msgid "guestfs_is_file"
25603 #: ../src/guestfs-actions.pod:3507
25607 " guestfs_is_file (guestfs_h *g,\n"
25608 " const char *path);\n"
25613 #: ../src/guestfs-actions.pod:3521
25614 msgid "guestfs_is_launching"
25618 #: ../src/guestfs-actions.pod:3523
25622 " guestfs_is_launching (guestfs_h *g);\n"
25627 #: ../src/guestfs-actions.pod:3535
25628 msgid "guestfs_is_lv"
25632 #: ../src/guestfs-actions.pod:3537
25636 " guestfs_is_lv (guestfs_h *g,\n"
25637 " const char *device);\n"
25642 #: ../src/guestfs-actions.pod:3548
25643 msgid "guestfs_is_ready"
25647 #: ../src/guestfs-actions.pod:3550
25651 " guestfs_is_ready (guestfs_h *g);\n"
25656 #: ../src/guestfs-actions.pod:3562
25657 msgid "guestfs_is_socket"
25661 #: ../src/guestfs-actions.pod:3564
25665 " guestfs_is_socket (guestfs_h *g,\n"
25666 " const char *path);\n"
25671 #: ../src/guestfs-actions.pod:3577
25672 msgid "guestfs_is_symlink"
25676 #: ../src/guestfs-actions.pod:3579
25680 " guestfs_is_symlink (guestfs_h *g,\n"
25681 " const char *path);\n"
25686 #: ../src/guestfs-actions.pod:3592
25687 msgid "guestfs_is_zero"
25691 #: ../src/guestfs-actions.pod:3594
25695 " guestfs_is_zero (guestfs_h *g,\n"
25696 " const char *path);\n"
25701 #: ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:3617
25702 msgid "(Added in 1.11.8)"
25706 #: ../src/guestfs-actions.pod:3605
25707 msgid "guestfs_is_zero_device"
25711 #: ../src/guestfs-actions.pod:3607
25715 " guestfs_is_zero_device (guestfs_h *g,\n"
25716 " const char *device);\n"
25721 #: ../src/guestfs-actions.pod:3619
25722 msgid "guestfs_kill_subprocess"
25726 #: ../src/guestfs-actions.pod:3621
25730 " guestfs_kill_subprocess (guestfs_h *g);\n"
25735 #: ../src/guestfs-actions.pod:3630
25736 msgid "guestfs_launch"
25740 #: ../src/guestfs-actions.pod:3632
25744 " guestfs_launch (guestfs_h *g);\n"
25749 #: ../src/guestfs-actions.pod:3650
25750 msgid "guestfs_lchown"
25754 #: ../src/guestfs-actions.pod:3652
25758 " guestfs_lchown (guestfs_h *g,\n"
25761 " const char *path);\n"
25766 #: ../src/guestfs-actions.pod:3658
25768 "Change the file owner to C<owner> and group to C<group>. This is like "
25769 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
25770 "changed, not the target."
25774 #: ../src/guestfs-actions.pod:3670
25775 msgid "guestfs_lgetxattr"
25779 #: ../src/guestfs-actions.pod:3672
25783 " guestfs_lgetxattr (guestfs_h *g,\n"
25784 " const char *path,\n"
25785 " const char *name,\n"
25786 " size_t *size_r);\n"
25791 #: ../src/guestfs-actions.pod:3692
25792 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
25796 #: ../src/guestfs-actions.pod:3700
25797 msgid "guestfs_lgetxattrs"
25801 #: ../src/guestfs-actions.pod:3702
25804 " struct guestfs_xattr_list *\n"
25805 " guestfs_lgetxattrs (guestfs_h *g,\n"
25806 " const char *path);\n"
25811 #: ../src/guestfs-actions.pod:3706
25813 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
25814 "then it returns the extended attributes of the link itself."
25818 #: ../src/guestfs-actions.pod:3716
25819 msgid "guestfs_list_9p"
25823 #: ../src/guestfs-actions.pod:3718
25827 " guestfs_list_9p (guestfs_h *g);\n"
25832 #: ../src/guestfs-actions.pod:3730
25833 msgid "guestfs_list_devices"
25837 #: ../src/guestfs-actions.pod:3732
25841 " guestfs_list_devices (guestfs_h *g);\n"
25846 #: ../src/guestfs-actions.pod:3747
25847 msgid "guestfs_list_dm_devices"
25851 #: ../src/guestfs-actions.pod:3749
25855 " guestfs_list_dm_devices (guestfs_h *g);\n"
25860 #: ../src/guestfs-actions.pod:3754
25862 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
25863 "previous call to C<guestfs_luks_open>."
25867 #: ../src/guestfs-actions.pod:3757
25869 "Device mapper devices which correspond to logical volumes are I<not> "
25870 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
25875 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:5221
25876 msgid "(Added in 1.11.15)"
25880 #: ../src/guestfs-actions.pod:3767
25881 msgid "guestfs_list_filesystems"
25885 #: ../src/guestfs-actions.pod:3769
25889 " guestfs_list_filesystems (guestfs_h *g);\n"
25894 #: ../src/guestfs-actions.pod:3789
25896 "This command runs other libguestfs commands, which might include "
25897 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
25898 "soon after launch and only when nothing is mounted."
25902 #: ../src/guestfs-actions.pod:3793
25904 "Not all of the filesystems returned will be mountable. In particular, swap "
25905 "partitions are returned in the list. Also this command does not check that "
25906 "each filesystem found is valid and mountable, and some filesystems might be "
25907 "mountable but require special options. Filesystems may not all belong to a "
25908 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
25912 #: ../src/guestfs-actions.pod:3807 ../src/guestfs-actions.pod:5582
25913 msgid "(Added in 1.5.15)"
25917 #: ../src/guestfs-actions.pod:3809
25918 msgid "guestfs_list_partitions"
25922 #: ../src/guestfs-actions.pod:3811
25926 " guestfs_list_partitions (guestfs_h *g);\n"
25931 #: ../src/guestfs-actions.pod:3818
25933 "This does not return logical volumes. For that you will need to call "
25938 #: ../src/guestfs-actions.pod:3829
25943 #: ../src/guestfs-actions.pod:3831
25947 " guestfs_ll (guestfs_h *g,\n"
25948 " const char *directory);\n"
25953 #: ../src/guestfs-actions.pod:3846
25958 #: ../src/guestfs-actions.pod:3848
25962 " guestfs_ln (guestfs_h *g,\n"
25963 " const char *target,\n"
25964 " const char *linkname);\n"
25969 #: ../src/guestfs-actions.pod:3859
25970 msgid "guestfs_ln_f"
25974 #: ../src/guestfs-actions.pod:3861
25978 " guestfs_ln_f (guestfs_h *g,\n"
25979 " const char *target,\n"
25980 " const char *linkname);\n"
25985 #: ../src/guestfs-actions.pod:3873
25986 msgid "guestfs_ln_s"
25990 #: ../src/guestfs-actions.pod:3875
25994 " guestfs_ln_s (guestfs_h *g,\n"
25995 " const char *target,\n"
25996 " const char *linkname);\n"
26001 #: ../src/guestfs-actions.pod:3886
26002 msgid "guestfs_ln_sf"
26006 #: ../src/guestfs-actions.pod:3888
26010 " guestfs_ln_sf (guestfs_h *g,\n"
26011 " const char *target,\n"
26012 " const char *linkname);\n"
26017 #: ../src/guestfs-actions.pod:3900
26018 msgid "guestfs_lremovexattr"
26022 #: ../src/guestfs-actions.pod:3902
26026 " guestfs_lremovexattr (guestfs_h *g,\n"
26027 " const char *xattr,\n"
26028 " const char *path);\n"
26033 #: ../src/guestfs-actions.pod:3907
26035 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
26036 "link, then it removes an extended attribute of the link itself."
26040 #: ../src/guestfs-actions.pod:3915
26045 #: ../src/guestfs-actions.pod:3917
26049 " guestfs_ls (guestfs_h *g,\n"
26050 " const char *directory);\n"
26055 #: ../src/guestfs-actions.pod:3925
26057 "This command is mostly useful for interactive sessions. Programs should "
26058 "probably use C<guestfs_readdir> instead."
26062 #: ../src/guestfs-actions.pod:3934
26063 msgid "guestfs_lsetxattr"
26067 #: ../src/guestfs-actions.pod:3936
26071 " guestfs_lsetxattr (guestfs_h *g,\n"
26072 " const char *xattr,\n"
26073 " const char *val,\n"
26075 " const char *path);\n"
26080 #: ../src/guestfs-actions.pod:3943
26082 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
26083 "then it sets an extended attribute of the link itself."
26087 #: ../src/guestfs-actions.pod:3951
26088 msgid "guestfs_lstat"
26092 #: ../src/guestfs-actions.pod:3953
26095 " struct guestfs_stat *\n"
26096 " guestfs_lstat (guestfs_h *g,\n"
26097 " const char *path);\n"
26102 #: ../src/guestfs-actions.pod:3959
26104 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
26105 "link, then the link is stat-ed, not the file it refers to."
26109 #: ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:6740
26111 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
26112 "error. I<The caller must call C<guestfs_free_stat> after use>."
26116 #: ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:6744
26117 #: ../src/guestfs-actions.pod:6762 ../src/guestfs-actions.pod:7143
26118 msgid "(Added in 0.9.2)"
26122 #: ../src/guestfs-actions.pod:3971
26123 msgid "guestfs_lstatlist"
26127 #: ../src/guestfs-actions.pod:3973
26130 " struct guestfs_stat_list *\n"
26131 " guestfs_lstatlist (guestfs_h *g,\n"
26132 " const char *path,\n"
26133 " char *const *names);\n"
26138 #: ../src/guestfs-actions.pod:3978
26140 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
26141 "files, where all files are in the directory C<path>. C<names> is the list "
26142 "of files from this directory."
26146 #: ../src/guestfs-actions.pod:3987
26148 "This call is intended for programs that want to efficiently list a directory "
26149 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
26150 "for a similarly efficient call for getting extended attributes. Very long "
26151 "directory listings might cause the protocol message size to be exceeded, "
26152 "causing this call to fail. The caller must split up such requests into "
26153 "smaller groups of names."
26157 #: ../src/guestfs-actions.pod:3995
26159 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
26160 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
26164 #: ../src/guestfs-actions.pod:4001
26165 msgid "guestfs_luks_add_key"
26169 #: ../src/guestfs-actions.pod:4003
26173 " guestfs_luks_add_key (guestfs_h *g,\n"
26174 " const char *device,\n"
26175 " const char *key,\n"
26176 " const char *newkey,\n"
26182 #: ../src/guestfs-actions.pod:4015
26184 "Note that if C<keyslot> already contains a key, then this command will "
26185 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
26189 #: ../src/guestfs-actions.pod:4021 ../src/guestfs-actions.pod:4061
26190 #: ../src/guestfs-actions.pod:4084 ../src/guestfs-actions.pod:4104
26191 #: ../src/guestfs-actions.pod:4139 ../src/guestfs-actions.pod:4158
26193 "This function takes a key or passphrase parameter which could contain "
26194 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
26199 #: ../src/guestfs-actions.pod:4025 ../src/guestfs-actions.pod:4065
26200 #: ../src/guestfs-actions.pod:4088 ../src/guestfs-actions.pod:4108
26201 msgid "(Added in 1.5.2)"
26205 #: ../src/guestfs-actions.pod:4027
26206 msgid "guestfs_luks_close"
26210 #: ../src/guestfs-actions.pod:4029
26214 " guestfs_luks_close (guestfs_h *g,\n"
26215 " const char *device);\n"
26220 #: ../src/guestfs-actions.pod:4033
26222 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
26223 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
26224 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
26225 "underlying block device."
26229 #: ../src/guestfs-actions.pod:4041 ../src/guestfs-actions.pod:4143
26230 #: ../src/guestfs-actions.pod:4162 ../src/guestfs-actions.pod:4212
26231 #: ../src/guestfs-actions.pod:4260
26232 msgid "(Added in 1.5.1)"
26236 #: ../src/guestfs-actions.pod:4043
26237 msgid "guestfs_luks_format"
26241 #: ../src/guestfs-actions.pod:4045
26245 " guestfs_luks_format (guestfs_h *g,\n"
26246 " const char *device,\n"
26247 " const char *key,\n"
26253 #: ../src/guestfs-actions.pod:4067
26254 msgid "guestfs_luks_format_cipher"
26258 #: ../src/guestfs-actions.pod:4069
26262 " guestfs_luks_format_cipher (guestfs_h *g,\n"
26263 " const char *device,\n"
26264 " const char *key,\n"
26266 " const char *cipher);\n"
26271 #: ../src/guestfs-actions.pod:4076
26273 "This command is the same as C<guestfs_luks_format> but it also allows you to "
26274 "set the C<cipher> used."
26278 #: ../src/guestfs-actions.pod:4090
26279 msgid "guestfs_luks_kill_slot"
26283 #: ../src/guestfs-actions.pod:4092
26287 " guestfs_luks_kill_slot (guestfs_h *g,\n"
26288 " const char *device,\n"
26289 " const char *key,\n"
26295 #: ../src/guestfs-actions.pod:4110
26296 msgid "guestfs_luks_open"
26300 #: ../src/guestfs-actions.pod:4112
26304 " guestfs_luks_open (guestfs_h *g,\n"
26305 " const char *device,\n"
26306 " const char *key,\n"
26307 " const char *mapname);\n"
26312 #: ../src/guestfs-actions.pod:4130
26314 "If this block device contains LVM volume groups, then calling "
26315 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
26320 #: ../src/guestfs-actions.pod:4134
26321 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
26325 #: ../src/guestfs-actions.pod:4145
26326 msgid "guestfs_luks_open_ro"
26330 #: ../src/guestfs-actions.pod:4147
26334 " guestfs_luks_open_ro (guestfs_h *g,\n"
26335 " const char *device,\n"
26336 " const char *key,\n"
26337 " const char *mapname);\n"
26342 #: ../src/guestfs-actions.pod:4153
26344 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
26349 #: ../src/guestfs-actions.pod:4164
26350 msgid "guestfs_lvcreate"
26354 #: ../src/guestfs-actions.pod:4166
26358 " guestfs_lvcreate (guestfs_h *g,\n"
26359 " const char *logvol,\n"
26360 " const char *volgroup,\n"
26366 #: ../src/guestfs-actions.pod:4179
26367 msgid "guestfs_lvm_canonical_lv_name"
26371 #: ../src/guestfs-actions.pod:4181
26375 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
26376 " const char *lvname);\n"
26381 #: ../src/guestfs-actions.pod:4192
26382 msgid "See also C<guestfs_is_lv>."
26386 #: ../src/guestfs-actions.pod:4197
26387 msgid "(Added in 1.5.24)"
26391 #: ../src/guestfs-actions.pod:4199
26392 msgid "guestfs_lvm_clear_filter"
26396 #: ../src/guestfs-actions.pod:4201
26400 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
26405 #: ../src/guestfs-actions.pod:4204
26407 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
26408 "see every block device."
26412 #: ../src/guestfs-actions.pod:4214
26413 msgid "guestfs_lvm_remove_all"
26417 #: ../src/guestfs-actions.pod:4216
26421 " guestfs_lvm_remove_all (guestfs_h *g);\n"
26426 #: ../src/guestfs-actions.pod:4229
26427 msgid "guestfs_lvm_set_filter"
26431 #: ../src/guestfs-actions.pod:4231
26435 " guestfs_lvm_set_filter (guestfs_h *g,\n"
26436 " char *const *devices);\n"
26441 #: ../src/guestfs-actions.pod:4262
26442 msgid "guestfs_lvremove"
26446 #: ../src/guestfs-actions.pod:4264
26450 " guestfs_lvremove (guestfs_h *g,\n"
26451 " const char *device);\n"
26456 #: ../src/guestfs-actions.pod:4276 ../src/guestfs-actions.pod:5679
26457 #: ../src/guestfs-actions.pod:7513
26458 msgid "(Added in 1.0.13)"
26462 #: ../src/guestfs-actions.pod:4278
26463 msgid "guestfs_lvrename"
26467 #: ../src/guestfs-actions.pod:4280
26471 " guestfs_lvrename (guestfs_h *g,\n"
26472 " const char *logvol,\n"
26473 " const char *newlogvol);\n"
26478 #: ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:7526
26479 msgid "(Added in 1.0.83)"
26483 #: ../src/guestfs-actions.pod:4291
26484 msgid "guestfs_lvresize"
26488 #: ../src/guestfs-actions.pod:4293
26492 " guestfs_lvresize (guestfs_h *g,\n"
26493 " const char *device,\n"
26499 #: ../src/guestfs-actions.pod:4306
26500 msgid "guestfs_lvresize_free"
26504 #: ../src/guestfs-actions.pod:4308
26508 " guestfs_lvresize_free (guestfs_h *g,\n"
26509 " const char *lv,\n"
26515 #: ../src/guestfs-actions.pod:4321
26516 msgid "(Added in 1.3.3)"
26520 #: ../src/guestfs-actions.pod:4323
26521 msgid "guestfs_lvs"
26525 #: ../src/guestfs-actions.pod:4325
26529 " guestfs_lvs (guestfs_h *g);\n"
26534 #: ../src/guestfs-actions.pod:4334
26535 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
26539 #: ../src/guestfs-actions.pod:4342
26540 msgid "guestfs_lvs_full"
26544 #: ../src/guestfs-actions.pod:4344
26547 " struct guestfs_lvm_lv_list *\n"
26548 " guestfs_lvs_full (guestfs_h *g);\n"
26553 #: ../src/guestfs-actions.pod:4350
26555 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
26556 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
26560 #: ../src/guestfs-actions.pod:4356
26561 msgid "guestfs_lvuuid"
26565 #: ../src/guestfs-actions.pod:4358
26569 " guestfs_lvuuid (guestfs_h *g,\n"
26570 " const char *device);\n"
26575 #: ../src/guestfs-actions.pod:4369
26576 msgid "guestfs_lxattrlist"
26580 #: ../src/guestfs-actions.pod:4371
26583 " struct guestfs_xattr_list *\n"
26584 " guestfs_lxattrlist (guestfs_h *g,\n"
26585 " const char *path,\n"
26586 " char *const *names);\n"
26591 #: ../src/guestfs-actions.pod:4390
26593 "This call is intended for programs that want to efficiently list a directory "
26594 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
26595 "a similarly efficient call for getting standard stats. Very long directory "
26596 "listings might cause the protocol message size to be exceeded, causing this "
26597 "call to fail. The caller must split up such requests into smaller groups of "
26602 #: ../src/guestfs-actions.pod:4404
26603 msgid "guestfs_mkdir"
26607 #: ../src/guestfs-actions.pod:4406
26611 " guestfs_mkdir (guestfs_h *g,\n"
26612 " const char *path);\n"
26617 #: ../src/guestfs-actions.pod:4416
26618 msgid "guestfs_mkdir_mode"
26622 #: ../src/guestfs-actions.pod:4418
26626 " guestfs_mkdir_mode (guestfs_h *g,\n"
26627 " const char *path,\n"
26633 #: ../src/guestfs-actions.pod:4430
26634 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
26638 #: ../src/guestfs-actions.pod:4436
26639 msgid "guestfs_mkdir_p"
26643 #: ../src/guestfs-actions.pod:4438
26647 " guestfs_mkdir_p (guestfs_h *g,\n"
26648 " const char *path);\n"
26653 #: ../src/guestfs-actions.pod:4449
26654 msgid "guestfs_mkdtemp"
26658 #: ../src/guestfs-actions.pod:4451
26662 " guestfs_mkdtemp (guestfs_h *g,\n"
26663 " const char *template);\n"
26668 #: ../src/guestfs-actions.pod:4479
26669 msgid "guestfs_mke2fs_J"
26673 #: ../src/guestfs-actions.pod:4481
26677 " guestfs_mke2fs_J (guestfs_h *g,\n"
26678 " const char *fstype,\n"
26679 " int blocksize,\n"
26680 " const char *device,\n"
26681 " const char *journal);\n"
26686 #: ../src/guestfs-actions.pod:4494
26687 msgid "See also C<guestfs_mke2journal>."
26691 #: ../src/guestfs-actions.pod:4498 ../src/guestfs-actions.pod:4516
26692 #: ../src/guestfs-actions.pod:4534 ../src/guestfs-actions.pod:4550
26693 #: ../src/guestfs-actions.pod:4564 ../src/guestfs-actions.pod:4578
26694 #: ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4914
26695 msgid "(Added in 1.0.68)"
26699 #: ../src/guestfs-actions.pod:4500
26700 msgid "guestfs_mke2fs_JL"
26704 #: ../src/guestfs-actions.pod:4502
26708 " guestfs_mke2fs_JL (guestfs_h *g,\n"
26709 " const char *fstype,\n"
26710 " int blocksize,\n"
26711 " const char *device,\n"
26712 " const char *label);\n"
26717 #: ../src/guestfs-actions.pod:4512
26718 msgid "See also C<guestfs_mke2journal_L>."
26722 #: ../src/guestfs-actions.pod:4518
26723 msgid "guestfs_mke2fs_JU"
26727 #: ../src/guestfs-actions.pod:4520
26731 " guestfs_mke2fs_JU (guestfs_h *g,\n"
26732 " const char *fstype,\n"
26733 " int blocksize,\n"
26734 " const char *device,\n"
26735 " const char *uuid);\n"
26740 #: ../src/guestfs-actions.pod:4530
26741 msgid "See also C<guestfs_mke2journal_U>."
26745 #: ../src/guestfs-actions.pod:4536
26746 msgid "guestfs_mke2journal"
26750 #: ../src/guestfs-actions.pod:4538
26754 " guestfs_mke2journal (guestfs_h *g,\n"
26755 " int blocksize,\n"
26756 " const char *device);\n"
26761 #: ../src/guestfs-actions.pod:4552
26762 msgid "guestfs_mke2journal_L"
26766 #: ../src/guestfs-actions.pod:4554
26770 " guestfs_mke2journal_L (guestfs_h *g,\n"
26771 " int blocksize,\n"
26772 " const char *label,\n"
26773 " const char *device);\n"
26778 #: ../src/guestfs-actions.pod:4566
26779 msgid "guestfs_mke2journal_U"
26783 #: ../src/guestfs-actions.pod:4568
26787 " guestfs_mke2journal_U (guestfs_h *g,\n"
26788 " int blocksize,\n"
26789 " const char *uuid,\n"
26790 " const char *device);\n"
26795 #: ../src/guestfs-actions.pod:4580
26796 msgid "guestfs_mkfifo"
26800 #: ../src/guestfs-actions.pod:4582
26804 " guestfs_mkfifo (guestfs_h *g,\n"
26806 " const char *path);\n"
26811 #: ../src/guestfs-actions.pod:4587
26813 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26814 "is just a convenient wrapper around C<guestfs_mknod>."
26818 #: ../src/guestfs-actions.pod:4597
26819 msgid "guestfs_mkfs"
26823 #: ../src/guestfs-actions.pod:4599
26827 " guestfs_mkfs (guestfs_h *g,\n"
26828 " const char *fstype,\n"
26829 " const char *device);\n"
26834 #: ../src/guestfs-actions.pod:4612
26835 msgid "guestfs_mkfs_b"
26839 #: ../src/guestfs-actions.pod:4614
26843 " guestfs_mkfs_b (guestfs_h *g,\n"
26844 " const char *fstype,\n"
26845 " int blocksize,\n"
26846 " const char *device);\n"
26851 #: ../src/guestfs-actions.pod:4620
26853 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
26854 "block size of the resulting filesystem. Supported block sizes depend on the "
26855 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26859 #: ../src/guestfs-actions.pod:4630
26861 "This function is deprecated. In new code, use the L</guestfs_mkfs_opts> "
26866 #: ../src/guestfs-actions.pod:4639
26867 msgid "guestfs_mkfs_opts"
26871 #: ../src/guestfs-actions.pod:4641
26875 " guestfs_mkfs_opts (guestfs_h *g,\n"
26876 " const char *fstype,\n"
26877 " const char *device,\n"
26883 #: ../src/guestfs-actions.pod:4652
26886 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
26887 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
26888 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
26889 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
26894 #: ../src/guestfs-actions.pod:4700
26895 msgid "(Added in 1.7.19)"
26899 #: ../src/guestfs-actions.pod:4702
26900 msgid "guestfs_mkfs_opts_va"
26904 #: ../src/guestfs-actions.pod:4704
26908 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
26909 " const char *fstype,\n"
26910 " const char *device,\n"
26911 " va_list args);\n"
26916 #: ../src/guestfs-actions.pod:4710
26917 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
26921 #: ../src/guestfs-actions.pod:4714
26922 msgid "guestfs_mkfs_opts_argv"
26926 #: ../src/guestfs-actions.pod:4716
26930 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
26931 " const char *fstype,\n"
26932 " const char *device,\n"
26933 " const struct guestfs_mkfs_opts_argv *optargs);\n"
26938 #: ../src/guestfs-actions.pod:4722
26939 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
26943 #: ../src/guestfs-actions.pod:4726
26944 msgid "guestfs_mkmountpoint"
26948 #: ../src/guestfs-actions.pod:4728
26952 " guestfs_mkmountpoint (guestfs_h *g,\n"
26953 " const char *exemptpath);\n"
26958 #: ../src/guestfs-actions.pod:4732
26960 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
26961 "that can be used to create extra mountpoints before mounting the first "
26966 #: ../src/guestfs-actions.pod:4756
26968 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
26969 "may get unexpected errors if you try to mix these calls. It is safest to "
26970 "manually unmount filesystems and remove mountpoints after use."
26974 #: ../src/guestfs-actions.pod:4760
26976 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
26977 "first, so for this to work for manual mountpoints, you must ensure that the "
26978 "innermost mountpoints have the longest pathnames, as in the example code "
26983 #: ../src/guestfs-actions.pod:4767
26985 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
26986 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
26987 "can also trigger these issues."
26991 #: ../src/guestfs-actions.pod:4773 ../src/guestfs-actions.pod:5089
26992 #: ../src/guestfs-actions.pod:6099
26993 msgid "(Added in 1.0.62)"
26997 #: ../src/guestfs-actions.pod:4775
26998 msgid "guestfs_mknod"
27002 #: ../src/guestfs-actions.pod:4777
27006 " guestfs_mknod (guestfs_h *g,\n"
27010 " const char *path);\n"
27015 #: ../src/guestfs-actions.pod:4792
27017 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
27018 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
27019 "regular file). These constants are available in the standard Linux header "
27020 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
27021 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
27022 "the appropriate constant for you."
27026 #: ../src/guestfs-actions.pod:4806
27027 msgid "guestfs_mknod_b"
27031 #: ../src/guestfs-actions.pod:4808
27035 " guestfs_mknod_b (guestfs_h *g,\n"
27039 " const char *path);\n"
27044 #: ../src/guestfs-actions.pod:4815
27046 "This call creates a block device node called C<path> with mode C<mode> and "
27047 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27048 "wrapper around C<guestfs_mknod>."
27052 #: ../src/guestfs-actions.pod:4825
27053 msgid "guestfs_mknod_c"
27057 #: ../src/guestfs-actions.pod:4827
27061 " guestfs_mknod_c (guestfs_h *g,\n"
27065 " const char *path);\n"
27070 #: ../src/guestfs-actions.pod:4834
27072 "This call creates a char device node called C<path> with mode C<mode> and "
27073 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27074 "wrapper around C<guestfs_mknod>."
27078 #: ../src/guestfs-actions.pod:4844
27079 msgid "guestfs_mkswap"
27083 #: ../src/guestfs-actions.pod:4846
27087 " guestfs_mkswap (guestfs_h *g,\n"
27088 " const char *device);\n"
27093 #: ../src/guestfs-actions.pod:4856
27094 msgid "guestfs_mkswap_L"
27098 #: ../src/guestfs-actions.pod:4858
27102 " guestfs_mkswap_L (guestfs_h *g,\n"
27103 " const char *label,\n"
27104 " const char *device);\n"
27109 #: ../src/guestfs-actions.pod:4873
27110 msgid "guestfs_mkswap_U"
27114 #: ../src/guestfs-actions.pod:4875
27118 " guestfs_mkswap_U (guestfs_h *g,\n"
27119 " const char *uuid,\n"
27120 " const char *device);\n"
27125 #: ../src/guestfs-actions.pod:4886
27126 msgid "guestfs_mkswap_file"
27130 #: ../src/guestfs-actions.pod:4888
27134 " guestfs_mkswap_file (guestfs_h *g,\n"
27135 " const char *path);\n"
27140 #: ../src/guestfs-actions.pod:4894
27142 "This command just writes a swap file signature to an existing file. To "
27143 "create the file itself, use something like C<guestfs_fallocate>."
27147 #: ../src/guestfs-actions.pod:4901
27148 msgid "guestfs_modprobe"
27152 #: ../src/guestfs-actions.pod:4903
27156 " guestfs_modprobe (guestfs_h *g,\n"
27157 " const char *modulename);\n"
27162 #: ../src/guestfs-actions.pod:4916
27163 msgid "guestfs_mount"
27167 #: ../src/guestfs-actions.pod:4918
27171 " guestfs_mount (guestfs_h *g,\n"
27172 " const char *device,\n"
27173 " const char *mountpoint);\n"
27178 #: ../src/guestfs-actions.pod:4937
27180 "B<Important note:> When you use this call, the filesystem options C<sync> "
27181 "and C<noatime> are set implicitly. This was originally done because we "
27182 "thought it would improve reliability, but it turns out that I<-o sync> has a "
27183 "very large negative performance impact and negligible effect on "
27184 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
27185 "in any code that needs performance, and instead use C<guestfs_mount_options> "
27186 "(use an empty string for the first parameter if you don't want any options)."
27190 #: ../src/guestfs-actions.pod:4949
27192 "This function is deprecated. In new code, use the L</guestfs_mount_options> "
27197 #: ../src/guestfs-actions.pod:4958
27198 msgid "guestfs_mount_9p"
27202 #: ../src/guestfs-actions.pod:4960
27206 " guestfs_mount_9p (guestfs_h *g,\n"
27207 " const char *mounttag,\n"
27208 " const char *mountpoint,\n"
27214 #: ../src/guestfs-actions.pod:4971
27217 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
27222 #: ../src/guestfs-actions.pod:4984
27223 msgid "guestfs_mount_9p_va"
27227 #: ../src/guestfs-actions.pod:4986
27231 " guestfs_mount_9p_va (guestfs_h *g,\n"
27232 " const char *mounttag,\n"
27233 " const char *mountpoint,\n"
27234 " va_list args);\n"
27239 #: ../src/guestfs-actions.pod:4992
27240 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
27244 #: ../src/guestfs-actions.pod:4996
27245 msgid "guestfs_mount_9p_argv"
27249 #: ../src/guestfs-actions.pod:4998
27253 " guestfs_mount_9p_argv (guestfs_h *g,\n"
27254 " const char *mounttag,\n"
27255 " const char *mountpoint,\n"
27256 " const struct guestfs_mount_9p_argv *optargs);\n"
27261 #: ../src/guestfs-actions.pod:5004
27262 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
27266 #: ../src/guestfs-actions.pod:5008
27267 msgid "guestfs_mount_loop"
27271 #: ../src/guestfs-actions.pod:5010
27275 " guestfs_mount_loop (guestfs_h *g,\n"
27276 " const char *file,\n"
27277 " const char *mountpoint);\n"
27282 #: ../src/guestfs-actions.pod:5023
27283 msgid "guestfs_mount_options"
27287 #: ../src/guestfs-actions.pod:5025
27291 " guestfs_mount_options (guestfs_h *g,\n"
27292 " const char *options,\n"
27293 " const char *device,\n"
27294 " const char *mountpoint);\n"
27299 #: ../src/guestfs-actions.pod:5031
27301 "This is the same as the C<guestfs_mount> command, but it allows you to set "
27302 "the mount options as for the L<mount(8)> I<-o> flag."
27306 #: ../src/guestfs-actions.pod:5041 ../src/guestfs-actions.pod:5055
27307 #: ../src/guestfs-actions.pod:5072
27308 msgid "(Added in 1.0.10)"
27312 #: ../src/guestfs-actions.pod:5043
27313 msgid "guestfs_mount_ro"
27317 #: ../src/guestfs-actions.pod:5045
27321 " guestfs_mount_ro (guestfs_h *g,\n"
27322 " const char *device,\n"
27323 " const char *mountpoint);\n"
27328 #: ../src/guestfs-actions.pod:5050
27330 "This is the same as the C<guestfs_mount> command, but it mounts the "
27331 "filesystem with the read-only (I<-o ro>) flag."
27335 #: ../src/guestfs-actions.pod:5057
27336 msgid "guestfs_mount_vfs"
27340 #: ../src/guestfs-actions.pod:5059
27344 " guestfs_mount_vfs (guestfs_h *g,\n"
27345 " const char *options,\n"
27346 " const char *vfstype,\n"
27347 " const char *device,\n"
27348 " const char *mountpoint);\n"
27353 #: ../src/guestfs-actions.pod:5066
27355 "This is the same as the C<guestfs_mount> command, but it allows you to set "
27356 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
27361 #: ../src/guestfs-actions.pod:5074
27362 msgid "guestfs_mountpoints"
27366 #: ../src/guestfs-actions.pod:5076
27370 " guestfs_mountpoints (guestfs_h *g);\n"
27375 #: ../src/guestfs-actions.pod:5079
27377 "This call is similar to C<guestfs_mounts>. That call returns a list of "
27378 "devices. This one returns a hash table (map) of device name to directory "
27379 "where the device is mounted."
27383 #: ../src/guestfs-actions.pod:5091
27384 msgid "guestfs_mounts"
27388 #: ../src/guestfs-actions.pod:5093
27392 " guestfs_mounts (guestfs_h *g);\n"
27397 #: ../src/guestfs-actions.pod:5101
27398 msgid "See also: C<guestfs_mountpoints>"
27402 #: ../src/guestfs-actions.pod:5109
27407 #: ../src/guestfs-actions.pod:5111
27411 " guestfs_mv (guestfs_h *g,\n"
27412 " const char *src,\n"
27413 " const char *dest);\n"
27418 #: ../src/guestfs-actions.pod:5123
27419 msgid "guestfs_ntfs_3g_probe"
27423 #: ../src/guestfs-actions.pod:5125
27427 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
27429 " const char *device);\n"
27434 #: ../src/guestfs-actions.pod:5144
27435 msgid "(Added in 1.0.43)"
27439 #: ../src/guestfs-actions.pod:5146
27440 msgid "guestfs_ntfsresize"
27444 #: ../src/guestfs-actions.pod:5148
27448 " guestfs_ntfsresize (guestfs_h *g,\n"
27449 " const char *device);\n"
27454 #: ../src/guestfs-actions.pod:5167 ../src/guestfs-actions.pod:5257
27456 "This function is deprecated. In new code, use the L</"
27457 "guestfs_ntfsresize_opts> call instead."
27461 #: ../src/guestfs-actions.pod:5176
27462 msgid "guestfs_ntfsresize_opts"
27466 #: ../src/guestfs-actions.pod:5178
27470 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
27471 " const char *device,\n"
27477 #: ../src/guestfs-actions.pod:5188
27480 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
27481 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
27486 #: ../src/guestfs-actions.pod:5208
27488 "After the resize operation, the filesystem is always marked as requiring a "
27489 "consistency check (for safety). You have to boot into Windows to perform "
27490 "this check and clear this condition. If you I<don't> set the C<force> "
27491 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
27492 "times on a single filesystem without booting into Windows between each "
27497 #: ../src/guestfs-actions.pod:5223
27498 msgid "guestfs_ntfsresize_opts_va"
27502 #: ../src/guestfs-actions.pod:5225
27506 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
27507 " const char *device,\n"
27508 " va_list args);\n"
27513 #: ../src/guestfs-actions.pod:5230
27514 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
27518 #: ../src/guestfs-actions.pod:5234
27519 msgid "guestfs_ntfsresize_opts_argv"
27523 #: ../src/guestfs-actions.pod:5236
27527 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
27528 " const char *device,\n"
27529 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
27534 #: ../src/guestfs-actions.pod:5241
27535 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
27539 #: ../src/guestfs-actions.pod:5245
27540 msgid "guestfs_ntfsresize_size"
27544 #: ../src/guestfs-actions.pod:5247
27548 " guestfs_ntfsresize_size (guestfs_h *g,\n"
27549 " const char *device,\n"
27550 " int64_t size);\n"
27555 #: ../src/guestfs-actions.pod:5252
27557 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
27558 "to specify the new size (in bytes) explicitly."
27562 #: ../src/guestfs-actions.pod:5264 ../src/guestfs-actions.pod:5706
27563 #: ../src/guestfs-actions.pod:5779 ../src/guestfs-actions.pod:6047
27564 #: ../src/guestfs-actions.pod:7670
27565 msgid "(Added in 1.3.14)"
27569 #: ../src/guestfs-actions.pod:5266
27570 msgid "guestfs_part_add"
27574 #: ../src/guestfs-actions.pod:5268
27578 " guestfs_part_add (guestfs_h *g,\n"
27579 " const char *device,\n"
27580 " const char *prlogex,\n"
27581 " int64_t startsect,\n"
27582 " int64_t endsect);\n"
27587 #: ../src/guestfs-actions.pod:5275
27589 "This command adds a partition to C<device>. If there is no partition table "
27590 "on the device, call C<guestfs_part_init> first."
27594 #: ../src/guestfs-actions.pod:5287
27596 "Creating a partition which covers the whole disk is not so easy. Use "
27597 "C<guestfs_part_disk> to do that."
27601 #: ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:5330
27602 #: ../src/guestfs-actions.pod:5383 ../src/guestfs-actions.pod:5467
27603 #: ../src/guestfs-actions.pod:5505 ../src/guestfs-actions.pod:5524
27604 #: ../src/guestfs-actions.pod:5564
27605 msgid "(Added in 1.0.78)"
27609 #: ../src/guestfs-actions.pod:5294
27610 msgid "guestfs_part_del"
27614 #: ../src/guestfs-actions.pod:5296
27618 " guestfs_part_del (guestfs_h *g,\n"
27619 " const char *device,\n"
27625 #: ../src/guestfs-actions.pod:5311
27626 msgid "guestfs_part_disk"
27630 #: ../src/guestfs-actions.pod:5313
27634 " guestfs_part_disk (guestfs_h *g,\n"
27635 " const char *device,\n"
27636 " const char *parttype);\n"
27641 #: ../src/guestfs-actions.pod:5318
27643 "This command is simply a combination of C<guestfs_part_init> followed by "
27644 "C<guestfs_part_add> to create a single primary partition covering the whole "
27649 #: ../src/guestfs-actions.pod:5322
27651 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
27652 "possible values are described in C<guestfs_part_init>."
27656 #: ../src/guestfs-actions.pod:5332
27657 msgid "guestfs_part_get_bootable"
27661 #: ../src/guestfs-actions.pod:5334
27665 " guestfs_part_get_bootable (guestfs_h *g,\n"
27666 " const char *device,\n"
27672 #: ../src/guestfs-actions.pod:5342
27673 msgid "See also C<guestfs_part_set_bootable>."
27677 #: ../src/guestfs-actions.pod:5348
27678 msgid "guestfs_part_get_mbr_id"
27682 #: ../src/guestfs-actions.pod:5350
27686 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
27687 " const char *device,\n"
27693 #: ../src/guestfs-actions.pod:5358 ../src/guestfs-actions.pod:5540
27695 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
27696 "undefined results for other partition table types (see "
27697 "C<guestfs_part_get_parttype>)."
27701 #: ../src/guestfs-actions.pod:5366
27702 msgid "guestfs_part_get_parttype"
27706 #: ../src/guestfs-actions.pod:5368
27710 " guestfs_part_get_parttype (guestfs_h *g,\n"
27711 " const char *device);\n"
27716 #: ../src/guestfs-actions.pod:5375
27718 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
27719 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
27720 "possible, although unusual. See C<guestfs_part_init> for a full list."
27724 #: ../src/guestfs-actions.pod:5385
27725 msgid "guestfs_part_init"
27729 #: ../src/guestfs-actions.pod:5387
27733 " guestfs_part_init (guestfs_h *g,\n"
27734 " const char *device,\n"
27735 " const char *parttype);\n"
27740 #: ../src/guestfs-actions.pod:5396
27742 "Initially there are no partitions. Following this, you should call "
27743 "C<guestfs_part_add> for each partition required."
27747 #: ../src/guestfs-actions.pod:5469
27748 msgid "guestfs_part_list"
27752 #: ../src/guestfs-actions.pod:5471
27755 " struct guestfs_partition_list *\n"
27756 " guestfs_part_list (guestfs_h *g,\n"
27757 " const char *device);\n"
27762 #: ../src/guestfs-actions.pod:5488
27764 "Start of the partition I<in bytes>. To get sectors you have to divide by "
27765 "the device's sector size, see C<guestfs_blockdev_getss>."
27769 #: ../src/guestfs-actions.pod:5501
27771 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
27772 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
27777 #: ../src/guestfs-actions.pod:5507
27778 msgid "guestfs_part_set_bootable"
27782 #: ../src/guestfs-actions.pod:5509
27786 " guestfs_part_set_bootable (guestfs_h *g,\n"
27787 " const char *device,\n"
27789 " int bootable);\n"
27794 #: ../src/guestfs-actions.pod:5526
27795 msgid "guestfs_part_set_mbr_id"
27799 #: ../src/guestfs-actions.pod:5528
27803 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
27804 " const char *device,\n"
27811 #: ../src/guestfs-actions.pod:5548
27812 msgid "guestfs_part_set_name"
27816 #: ../src/guestfs-actions.pod:5550
27820 " guestfs_part_set_name (guestfs_h *g,\n"
27821 " const char *device,\n"
27823 " const char *name);\n"
27828 #: ../src/guestfs-actions.pod:5566
27829 msgid "guestfs_part_to_dev"
27833 #: ../src/guestfs-actions.pod:5568
27837 " guestfs_part_to_dev (guestfs_h *g,\n"
27838 " const char *partition);\n"
27843 #: ../src/guestfs-actions.pod:5576
27845 "The named partition must exist, for example as a string returned from "
27846 "C<guestfs_list_partitions>."
27850 #: ../src/guestfs-actions.pod:5584
27851 msgid "guestfs_ping_daemon"
27855 #: ../src/guestfs-actions.pod:5586
27859 " guestfs_ping_daemon (guestfs_h *g);\n"
27864 #: ../src/guestfs-actions.pod:5598
27865 msgid "guestfs_pread"
27869 #: ../src/guestfs-actions.pod:5600
27873 " guestfs_pread (guestfs_h *g,\n"
27874 " const char *path,\n"
27876 " int64_t offset,\n"
27877 " size_t *size_r);\n"
27882 #: ../src/guestfs-actions.pod:5613
27883 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
27887 #: ../src/guestfs-actions.pod:5624
27888 msgid "guestfs_pread_device"
27892 #: ../src/guestfs-actions.pod:5626
27896 " guestfs_pread_device (guestfs_h *g,\n"
27897 " const char *device,\n"
27899 " int64_t offset,\n"
27900 " size_t *size_r);\n"
27905 #: ../src/guestfs-actions.pod:5639
27906 msgid "See also C<guestfs_pread>."
27910 #: ../src/guestfs-actions.pod:5648
27911 msgid "(Added in 1.5.21)"
27915 #: ../src/guestfs-actions.pod:5650
27916 msgid "guestfs_pvcreate"
27920 #: ../src/guestfs-actions.pod:5652
27924 " guestfs_pvcreate (guestfs_h *g,\n"
27925 " const char *device);\n"
27930 #: ../src/guestfs-actions.pod:5664
27931 msgid "guestfs_pvremove"
27935 #: ../src/guestfs-actions.pod:5666
27939 " guestfs_pvremove (guestfs_h *g,\n"
27940 " const char *device);\n"
27945 #: ../src/guestfs-actions.pod:5681
27946 msgid "guestfs_pvresize"
27950 #: ../src/guestfs-actions.pod:5683
27954 " guestfs_pvresize (guestfs_h *g,\n"
27955 " const char *device);\n"
27960 #: ../src/guestfs-actions.pod:5694
27961 msgid "guestfs_pvresize_size"
27965 #: ../src/guestfs-actions.pod:5696
27969 " guestfs_pvresize_size (guestfs_h *g,\n"
27970 " const char *device,\n"
27971 " int64_t size);\n"
27976 #: ../src/guestfs-actions.pod:5701
27978 "This command is the same as C<guestfs_pvresize> except that it allows you to "
27979 "specify the new size (in bytes) explicitly."
27983 #: ../src/guestfs-actions.pod:5708
27984 msgid "guestfs_pvs"
27988 #: ../src/guestfs-actions.pod:5710
27992 " guestfs_pvs (guestfs_h *g);\n"
27997 #: ../src/guestfs-actions.pod:5719
27998 msgid "See also C<guestfs_pvs_full>."
28002 #: ../src/guestfs-actions.pod:5727
28003 msgid "guestfs_pvs_full"
28007 #: ../src/guestfs-actions.pod:5729
28010 " struct guestfs_lvm_pv_list *\n"
28011 " guestfs_pvs_full (guestfs_h *g);\n"
28016 #: ../src/guestfs-actions.pod:5735
28018 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
28019 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
28023 #: ../src/guestfs-actions.pod:5741
28024 msgid "guestfs_pvuuid"
28028 #: ../src/guestfs-actions.pod:5743
28032 " guestfs_pvuuid (guestfs_h *g,\n"
28033 " const char *device);\n"
28038 #: ../src/guestfs-actions.pod:5754
28039 msgid "guestfs_pwrite"
28043 #: ../src/guestfs-actions.pod:5756
28047 " guestfs_pwrite (guestfs_h *g,\n"
28048 " const char *path,\n"
28049 " const char *content,\n"
28050 " size_t content_size,\n"
28051 " int64_t offset);\n"
28056 #: ../src/guestfs-actions.pod:5772
28057 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
28061 #: ../src/guestfs-actions.pod:5781
28062 msgid "guestfs_pwrite_device"
28066 #: ../src/guestfs-actions.pod:5783
28070 " guestfs_pwrite_device (guestfs_h *g,\n"
28071 " const char *device,\n"
28072 " const char *content,\n"
28073 " size_t content_size,\n"
28074 " int64_t offset);\n"
28079 #: ../src/guestfs-actions.pod:5798
28080 msgid "See also C<guestfs_pwrite>."
28084 #: ../src/guestfs-actions.pod:5805
28085 msgid "(Added in 1.5.20)"
28089 #: ../src/guestfs-actions.pod:5807
28090 msgid "guestfs_read_file"
28094 #: ../src/guestfs-actions.pod:5809
28098 " guestfs_read_file (guestfs_h *g,\n"
28099 " const char *path,\n"
28100 " size_t *size_r);\n"
28105 #: ../src/guestfs-actions.pod:5817
28107 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
28108 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
28109 "function is limited in the total size of file that can be handled."
28113 #: ../src/guestfs-actions.pod:5829
28114 msgid "(Added in 1.0.63)"
28118 #: ../src/guestfs-actions.pod:5831
28119 msgid "guestfs_read_lines"
28123 #: ../src/guestfs-actions.pod:5833
28127 " guestfs_read_lines (guestfs_h *g,\n"
28128 " const char *path);\n"
28133 #: ../src/guestfs-actions.pod:5842
28135 "Note that this function cannot correctly handle binary files (specifically, "
28136 "files containing C<\\0> character which is treated as end of line). For "
28137 "those you need to use the C<guestfs_read_file> function which has a more "
28138 "complex interface."
28142 #: ../src/guestfs-actions.pod:5853
28143 msgid "guestfs_readdir"
28147 #: ../src/guestfs-actions.pod:5855
28150 " struct guestfs_dirent_list *\n"
28151 " guestfs_readdir (guestfs_h *g,\n"
28152 " const char *dir);\n"
28157 #: ../src/guestfs-actions.pod:5909
28159 "This function is primarily intended for use by programs. To get a simple "
28160 "list of names, use C<guestfs_ls>. To get a printable directory for human "
28161 "consumption, use C<guestfs_ll>."
28165 #: ../src/guestfs-actions.pod:5913
28167 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
28168 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
28172 #: ../src/guestfs-actions.pod:5919
28173 msgid "guestfs_readlink"
28177 #: ../src/guestfs-actions.pod:5921
28181 " guestfs_readlink (guestfs_h *g,\n"
28182 " const char *path);\n"
28187 #: ../src/guestfs-actions.pod:5932
28188 msgid "guestfs_readlinklist"
28192 #: ../src/guestfs-actions.pod:5934
28196 " guestfs_readlinklist (guestfs_h *g,\n"
28197 " const char *path,\n"
28198 " char *const *names);\n"
28203 #: ../src/guestfs-actions.pod:5967
28204 msgid "guestfs_realpath"
28208 #: ../src/guestfs-actions.pod:5969
28212 " guestfs_realpath (guestfs_h *g,\n"
28213 " const char *path);\n"
28218 #: ../src/guestfs-actions.pod:5981
28219 msgid "guestfs_removexattr"
28223 #: ../src/guestfs-actions.pod:5983
28227 " guestfs_removexattr (guestfs_h *g,\n"
28228 " const char *xattr,\n"
28229 " const char *path);\n"
28234 #: ../src/guestfs-actions.pod:5991
28235 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
28239 #: ../src/guestfs-actions.pod:5997
28240 msgid "guestfs_resize2fs"
28244 #: ../src/guestfs-actions.pod:5999
28248 " guestfs_resize2fs (guestfs_h *g,\n"
28249 " const char *device);\n"
28254 #: ../src/guestfs-actions.pod:6006
28256 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
28257 "C<device> before calling this command. For unknown reasons C<resize2fs> "
28258 "sometimes gives an error about this and sometimes not. In any case, it is "
28259 "always safe to call C<guestfs_e2fsck_f> before calling this function."
28263 #: ../src/guestfs-actions.pod:6016
28264 msgid "guestfs_resize2fs_M"
28268 #: ../src/guestfs-actions.pod:6018
28272 " guestfs_resize2fs_M (guestfs_h *g,\n"
28273 " const char *device);\n"
28278 #: ../src/guestfs-actions.pod:6022
28280 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
28281 "resized to its minimum size. This works like the I<-M> option to the "
28282 "C<resize2fs> command."
28286 #: ../src/guestfs-actions.pod:6026
28288 "To get the resulting size of the filesystem you should call "
28289 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
28290 "These two numbers, multiplied together, give the resulting size of the "
28291 "minimal filesystem in bytes."
28295 #: ../src/guestfs-actions.pod:6035
28296 msgid "guestfs_resize2fs_size"
28300 #: ../src/guestfs-actions.pod:6037
28304 " guestfs_resize2fs_size (guestfs_h *g,\n"
28305 " const char *device,\n"
28306 " int64_t size);\n"
28311 #: ../src/guestfs-actions.pod:6042
28313 "This command is the same as C<guestfs_resize2fs> except that it allows you "
28314 "to specify the new size (in bytes) explicitly."
28318 #: ../src/guestfs-actions.pod:6049
28323 #: ../src/guestfs-actions.pod:6051
28327 " guestfs_rm (guestfs_h *g,\n"
28328 " const char *path);\n"
28333 #: ../src/guestfs-actions.pod:6061
28334 msgid "guestfs_rm_rf"
28338 #: ../src/guestfs-actions.pod:6063
28342 " guestfs_rm_rf (guestfs_h *g,\n"
28343 " const char *path);\n"
28348 #: ../src/guestfs-actions.pod:6075
28349 msgid "guestfs_rmdir"
28353 #: ../src/guestfs-actions.pod:6077
28357 " guestfs_rmdir (guestfs_h *g,\n"
28358 " const char *path);\n"
28363 #: ../src/guestfs-actions.pod:6087
28364 msgid "guestfs_rmmountpoint"
28368 #: ../src/guestfs-actions.pod:6089
28372 " guestfs_rmmountpoint (guestfs_h *g,\n"
28373 " const char *exemptpath);\n"
28378 #: ../src/guestfs-actions.pod:6093
28380 "This calls removes a mountpoint that was previously created with "
28381 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
28385 #: ../src/guestfs-actions.pod:6101
28386 msgid "guestfs_scrub_device"
28390 #: ../src/guestfs-actions.pod:6103
28394 " guestfs_scrub_device (guestfs_h *g,\n"
28395 " const char *device);\n"
28400 #: ../src/guestfs-actions.pod:6118 ../src/guestfs-actions.pod:6136
28401 #: ../src/guestfs-actions.pod:6155
28402 msgid "(Added in 1.0.52)"
28406 #: ../src/guestfs-actions.pod:6120
28407 msgid "guestfs_scrub_file"
28411 #: ../src/guestfs-actions.pod:6122
28415 " guestfs_scrub_file (guestfs_h *g,\n"
28416 " const char *file);\n"
28421 #: ../src/guestfs-actions.pod:6138
28422 msgid "guestfs_scrub_freespace"
28426 #: ../src/guestfs-actions.pod:6140
28430 " guestfs_scrub_freespace (guestfs_h *g,\n"
28431 " const char *dir);\n"
28436 #: ../src/guestfs-actions.pod:6144
28438 "This command creates the directory C<dir> and then fills it with files until "
28439 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
28440 "and deletes them. The intention is to scrub any free space on the partition "
28441 "containing C<dir>."
28445 #: ../src/guestfs-actions.pod:6157
28446 msgid "guestfs_set_append"
28450 #: ../src/guestfs-actions.pod:6159
28454 " guestfs_set_append (guestfs_h *g,\n"
28455 " const char *append);\n"
28460 #: ../src/guestfs-actions.pod:6176
28461 msgid "guestfs_set_attach_method"
28465 #: ../src/guestfs-actions.pod:6178
28469 " guestfs_set_attach_method (guestfs_h *g,\n"
28470 " const char *attachmethod);\n"
28475 #: ../src/guestfs-actions.pod:6206
28476 msgid "guestfs_set_autosync"
28480 #: ../src/guestfs-actions.pod:6208
28484 " guestfs_set_autosync (guestfs_h *g,\n"
28485 " int autosync);\n"
28490 #: ../src/guestfs-actions.pod:6224
28491 msgid "guestfs_set_direct"
28495 #: ../src/guestfs-actions.pod:6226
28499 " guestfs_set_direct (guestfs_h *g,\n"
28505 #: ../src/guestfs-actions.pod:6234
28507 "One consequence of this is that log messages aren't caught by the library "
28508 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
28513 #: ../src/guestfs-actions.pod:6247
28514 msgid "guestfs_set_e2label"
28518 #: ../src/guestfs-actions.pod:6249
28522 " guestfs_set_e2label (guestfs_h *g,\n"
28523 " const char *device,\n"
28524 " const char *label);\n"
28529 #: ../src/guestfs-actions.pod:6258
28531 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
28532 "the existing label on a filesystem."
28536 #: ../src/guestfs-actions.pod:6265
28537 msgid "guestfs_set_e2uuid"
28541 #: ../src/guestfs-actions.pod:6267
28545 " guestfs_set_e2uuid (guestfs_h *g,\n"
28546 " const char *device,\n"
28547 " const char *uuid);\n"
28552 #: ../src/guestfs-actions.pod:6277
28554 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
28555 "the existing UUID of a filesystem."
28559 #: ../src/guestfs-actions.pod:6284
28560 msgid "guestfs_set_memsize"
28564 #: ../src/guestfs-actions.pod:6286
28568 " guestfs_set_memsize (guestfs_h *g,\n"
28574 #: ../src/guestfs-actions.pod:6290
28576 "This sets the memory size in megabytes allocated to the qemu subprocess. "
28577 "This only has any effect if called before C<guestfs_launch>."
28581 #: ../src/guestfs-actions.pod:6305
28582 msgid "guestfs_set_network"
28586 #: ../src/guestfs-actions.pod:6307
28590 " guestfs_set_network (guestfs_h *g,\n"
28596 #: ../src/guestfs-actions.pod:6317
28598 "You must call this before calling C<guestfs_launch>, otherwise it has no "
28603 #: ../src/guestfs-actions.pod:6324
28604 msgid "guestfs_set_path"
28608 #: ../src/guestfs-actions.pod:6326
28612 " guestfs_set_path (guestfs_h *g,\n"
28613 " const char *searchpath);\n"
28618 #: ../src/guestfs-actions.pod:6341
28619 msgid "guestfs_set_pgroup"
28623 #: ../src/guestfs-actions.pod:6343
28627 " guestfs_set_pgroup (guestfs_h *g,\n"
28633 #: ../src/guestfs-actions.pod:6360
28634 msgid "guestfs_set_qemu"
28638 #: ../src/guestfs-actions.pod:6362
28642 " guestfs_set_qemu (guestfs_h *g,\n"
28643 " const char *qemu);\n"
28648 #: ../src/guestfs-actions.pod:6388
28649 msgid "guestfs_set_recovery_proc"
28653 #: ../src/guestfs-actions.pod:6390
28657 " guestfs_set_recovery_proc (guestfs_h *g,\n"
28658 " int recoveryproc);\n"
28663 #: ../src/guestfs-actions.pod:6394
28665 "If this is called with the parameter C<false> then C<guestfs_launch> does "
28666 "not create a recovery process. The purpose of the recovery process is to "
28667 "stop runaway qemu processes in the case where the main program aborts "
28672 #: ../src/guestfs-actions.pod:6399
28674 "This only has any effect if called before C<guestfs_launch>, and the default "
28679 #: ../src/guestfs-actions.pod:6412
28680 msgid "guestfs_set_selinux"
28684 #: ../src/guestfs-actions.pod:6414
28688 " guestfs_set_selinux (guestfs_h *g,\n"
28694 #: ../src/guestfs-actions.pod:6431
28695 msgid "guestfs_set_trace"
28699 #: ../src/guestfs-actions.pod:6433
28703 " guestfs_set_trace (guestfs_h *g,\n"
28709 #: ../src/guestfs-actions.pod:6447
28711 "Trace messages are normally sent to C<stderr>, unless you register a "
28712 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
28716 #: ../src/guestfs-actions.pod:6455
28717 msgid "guestfs_set_verbose"
28721 #: ../src/guestfs-actions.pod:6457
28725 " guestfs_set_verbose (guestfs_h *g,\n"
28731 #: ../src/guestfs-actions.pod:6466
28733 "Verbose messages are normally sent to C<stderr>, unless you register a "
28734 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
28738 #: ../src/guestfs-actions.pod:6474
28739 msgid "guestfs_setcon"
28743 #: ../src/guestfs-actions.pod:6476
28747 " guestfs_setcon (guestfs_h *g,\n"
28748 " const char *context);\n"
28753 #: ../src/guestfs-actions.pod:6489
28754 msgid "guestfs_setxattr"
28758 #: ../src/guestfs-actions.pod:6491
28762 " guestfs_setxattr (guestfs_h *g,\n"
28763 " const char *xattr,\n"
28764 " const char *val,\n"
28766 " const char *path);\n"
28771 #: ../src/guestfs-actions.pod:6502
28772 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
28776 #: ../src/guestfs-actions.pod:6508
28777 msgid "guestfs_sfdisk"
28781 #: ../src/guestfs-actions.pod:6510
28785 " guestfs_sfdisk (guestfs_h *g,\n"
28786 " const char *device,\n"
28790 " char *const *lines);\n"
28795 #: ../src/guestfs-actions.pod:6538
28797 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
28801 #: ../src/guestfs-actions.pod:6546 ../src/guestfs-actions.pod:6576
28802 #: ../src/guestfs-actions.pod:6609
28804 "This function is deprecated. In new code, use the L</guestfs_part_add> call "
28809 #: ../src/guestfs-actions.pod:6555
28810 msgid "guestfs_sfdiskM"
28814 #: ../src/guestfs-actions.pod:6557
28818 " guestfs_sfdiskM (guestfs_h *g,\n"
28819 " const char *device,\n"
28820 " char *const *lines);\n"
28825 #: ../src/guestfs-actions.pod:6562
28827 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
28828 "partition sizes are specified in megabytes only (rounded to the nearest "
28829 "cylinder) and you don't need to specify the cyls, heads and sectors "
28830 "parameters which were rarely if ever used anyway."
28834 #: ../src/guestfs-actions.pod:6568
28836 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
28837 "C<guestfs_part_disk>"
28841 #: ../src/guestfs-actions.pod:6585
28842 msgid "guestfs_sfdisk_N"
28846 #: ../src/guestfs-actions.pod:6587
28850 " guestfs_sfdisk_N (guestfs_h *g,\n"
28851 " const char *device,\n"
28856 " const char *line);\n"
28861 #: ../src/guestfs-actions.pod:6599
28863 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
28864 "for the cyls/heads/sectors parameters."
28868 #: ../src/guestfs-actions.pod:6602
28869 msgid "See also: C<guestfs_part_add>"
28873 #: ../src/guestfs-actions.pod:6618
28874 msgid "guestfs_sfdisk_disk_geometry"
28878 #: ../src/guestfs-actions.pod:6620
28882 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
28883 " const char *device);\n"
28888 #: ../src/guestfs-actions.pod:6624
28890 "This displays the disk geometry of C<device> read from the partition table. "
28891 "Especially in the case where the underlying block device has been resized, "
28892 "this can be different from the kernel's idea of the geometry (see "
28893 "C<guestfs_sfdisk_kernel_geometry>)."
28897 #: ../src/guestfs-actions.pod:6637
28898 msgid "guestfs_sfdisk_kernel_geometry"
28902 #: ../src/guestfs-actions.pod:6639
28906 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
28907 " const char *device);\n"
28912 #: ../src/guestfs-actions.pod:6653
28913 msgid "guestfs_sfdisk_l"
28917 #: ../src/guestfs-actions.pod:6655
28921 " guestfs_sfdisk_l (guestfs_h *g,\n"
28922 " const char *device);\n"
28927 #: ../src/guestfs-actions.pod:6663
28928 msgid "See also: C<guestfs_part_list>"
28932 #: ../src/guestfs-actions.pod:6668
28934 "This function is deprecated. In new code, use the L</guestfs_part_list> "
28939 #: ../src/guestfs-actions.pod:6677
28944 #: ../src/guestfs-actions.pod:6679
28948 " guestfs_sh (guestfs_h *g,\n"
28949 " const char *command);\n"
28954 #: ../src/guestfs-actions.pod:6686
28955 msgid "This is like C<guestfs_command>, but passes the command to:"
28959 #: ../src/guestfs-actions.pod:6694
28960 msgid "All the provisos about C<guestfs_command> apply to this call."
28964 #: ../src/guestfs-actions.pod:6701
28965 msgid "guestfs_sh_lines"
28969 #: ../src/guestfs-actions.pod:6703
28973 " guestfs_sh_lines (guestfs_h *g,\n"
28974 " const char *command);\n"
28979 #: ../src/guestfs-actions.pod:6707
28981 "This is the same as C<guestfs_sh>, but splits the result into a list of "
28986 #: ../src/guestfs-actions.pod:6710
28987 msgid "See also: C<guestfs_command_lines>"
28991 #: ../src/guestfs-actions.pod:6718
28992 msgid "guestfs_sleep"
28996 #: ../src/guestfs-actions.pod:6720
29000 " guestfs_sleep (guestfs_h *g,\n"
29006 #: ../src/guestfs-actions.pod:6728
29007 msgid "(Added in 1.0.41)"
29011 #: ../src/guestfs-actions.pod:6730 ../src/guestfs-structs.pod:109
29012 msgid "guestfs_stat"
29016 #: ../src/guestfs-actions.pod:6732
29019 " struct guestfs_stat *\n"
29020 " guestfs_stat (guestfs_h *g,\n"
29021 " const char *path);\n"
29026 #: ../src/guestfs-actions.pod:6746 ../src/guestfs-structs.pod:135
29027 msgid "guestfs_statvfs"
29031 #: ../src/guestfs-actions.pod:6748
29034 " struct guestfs_statvfs *\n"
29035 " guestfs_statvfs (guestfs_h *g,\n"
29036 " const char *path);\n"
29041 #: ../src/guestfs-actions.pod:6758
29043 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
29044 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
29048 #: ../src/guestfs-actions.pod:6764
29049 msgid "guestfs_strings"
29053 #: ../src/guestfs-actions.pod:6766
29057 " guestfs_strings (guestfs_h *g,\n"
29058 " const char *path);\n"
29063 #: ../src/guestfs-actions.pod:6782
29064 msgid "guestfs_strings_e"
29068 #: ../src/guestfs-actions.pod:6784
29072 " guestfs_strings_e (guestfs_h *g,\n"
29073 " const char *encoding,\n"
29074 " const char *path);\n"
29079 #: ../src/guestfs-actions.pod:6789
29081 "This is like the C<guestfs_strings> command, but allows you to specify the "
29082 "encoding of strings that are looked for in the source file C<path>."
29086 #: ../src/guestfs-actions.pod:6799
29088 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
29089 "ISO-8859-X (this is what C<guestfs_strings> uses)."
29093 #: ../src/guestfs-actions.pod:6837
29094 msgid "guestfs_swapoff_device"
29098 #: ../src/guestfs-actions.pod:6839
29102 " guestfs_swapoff_device (guestfs_h *g,\n"
29103 " const char *device);\n"
29108 #: ../src/guestfs-actions.pod:6843
29110 "This command disables the libguestfs appliance swap device or partition "
29111 "named C<device>. See C<guestfs_swapon_device>."
29115 #: ../src/guestfs-actions.pod:6851
29116 msgid "guestfs_swapoff_file"
29120 #: ../src/guestfs-actions.pod:6853
29124 " guestfs_swapoff_file (guestfs_h *g,\n"
29125 " const char *file);\n"
29130 #: ../src/guestfs-actions.pod:6863
29131 msgid "guestfs_swapoff_label"
29135 #: ../src/guestfs-actions.pod:6865
29139 " guestfs_swapoff_label (guestfs_h *g,\n"
29140 " const char *label);\n"
29145 #: ../src/guestfs-actions.pod:6876
29146 msgid "guestfs_swapoff_uuid"
29150 #: ../src/guestfs-actions.pod:6878
29154 " guestfs_swapoff_uuid (guestfs_h *g,\n"
29155 " const char *uuid);\n"
29160 #: ../src/guestfs-actions.pod:6889
29161 msgid "guestfs_swapon_device"
29165 #: ../src/guestfs-actions.pod:6891
29169 " guestfs_swapon_device (guestfs_h *g,\n"
29170 " const char *device);\n"
29175 #: ../src/guestfs-actions.pod:6895
29177 "This command enables the libguestfs appliance to use the swap device or "
29178 "partition named C<device>. The increased memory is made available for all "
29179 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
29183 #: ../src/guestfs-actions.pod:6911
29184 msgid "guestfs_swapon_file"
29188 #: ../src/guestfs-actions.pod:6913
29192 " guestfs_swapon_file (guestfs_h *g,\n"
29193 " const char *file);\n"
29198 #: ../src/guestfs-actions.pod:6917
29200 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
29205 #: ../src/guestfs-actions.pod:6924
29206 msgid "guestfs_swapon_label"
29210 #: ../src/guestfs-actions.pod:6926
29214 " guestfs_swapon_label (guestfs_h *g,\n"
29215 " const char *label);\n"
29220 #: ../src/guestfs-actions.pod:6930
29222 "This command enables swap to a labeled swap partition. See "
29223 "C<guestfs_swapon_device> for other notes."
29227 #: ../src/guestfs-actions.pod:6937
29228 msgid "guestfs_swapon_uuid"
29232 #: ../src/guestfs-actions.pod:6939
29236 " guestfs_swapon_uuid (guestfs_h *g,\n"
29237 " const char *uuid);\n"
29242 #: ../src/guestfs-actions.pod:6943
29244 "This command enables swap to a swap partition with the given UUID. See "
29245 "C<guestfs_swapon_device> for other notes."
29249 #: ../src/guestfs-actions.pod:6950
29250 msgid "guestfs_sync"
29254 #: ../src/guestfs-actions.pod:6952
29258 " guestfs_sync (guestfs_h *g);\n"
29263 #: ../src/guestfs-actions.pod:6965
29264 msgid "guestfs_tail"
29268 #: ../src/guestfs-actions.pod:6967
29272 " guestfs_tail (guestfs_h *g,\n"
29273 " const char *path);\n"
29278 #: ../src/guestfs-actions.pod:6983
29279 msgid "guestfs_tail_n"
29283 #: ../src/guestfs-actions.pod:6985
29287 " guestfs_tail_n (guestfs_h *g,\n"
29289 " const char *path);\n"
29294 #: ../src/guestfs-actions.pod:7007
29295 msgid "guestfs_tar_in"
29299 #: ../src/guestfs-actions.pod:7009
29303 " guestfs_tar_in (guestfs_h *g,\n"
29304 " const char *tarfile,\n"
29305 " const char *directory);\n"
29310 #: ../src/guestfs-actions.pod:7017
29312 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
29316 #: ../src/guestfs-actions.pod:7022 ../src/guestfs-actions.pod:7039
29317 #: ../src/guestfs-actions.pod:7055 ../src/guestfs-actions.pod:7071
29318 msgid "(Added in 1.0.3)"
29322 #: ../src/guestfs-actions.pod:7024
29323 msgid "guestfs_tar_out"
29327 #: ../src/guestfs-actions.pod:7026
29331 " guestfs_tar_out (guestfs_h *g,\n"
29332 " const char *directory,\n"
29333 " const char *tarfile);\n"
29338 #: ../src/guestfs-actions.pod:7034
29340 "To download a compressed tarball, use C<guestfs_tgz_out> or "
29341 "C<guestfs_txz_out>."
29345 #: ../src/guestfs-actions.pod:7041
29346 msgid "guestfs_tgz_in"
29350 #: ../src/guestfs-actions.pod:7043
29354 " guestfs_tgz_in (guestfs_h *g,\n"
29355 " const char *tarball,\n"
29356 " const char *directory);\n"
29361 #: ../src/guestfs-actions.pod:7051
29362 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
29366 #: ../src/guestfs-actions.pod:7057
29367 msgid "guestfs_tgz_out"
29371 #: ../src/guestfs-actions.pod:7059
29375 " guestfs_tgz_out (guestfs_h *g,\n"
29376 " const char *directory,\n"
29377 " const char *tarball);\n"
29382 #: ../src/guestfs-actions.pod:7067
29383 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
29387 #: ../src/guestfs-actions.pod:7073
29388 msgid "guestfs_touch"
29392 #: ../src/guestfs-actions.pod:7075
29396 " guestfs_touch (guestfs_h *g,\n"
29397 " const char *path);\n"
29402 #: ../src/guestfs-actions.pod:7090
29403 msgid "guestfs_truncate"
29407 #: ../src/guestfs-actions.pod:7092
29411 " guestfs_truncate (guestfs_h *g,\n"
29412 " const char *path);\n"
29417 #: ../src/guestfs-actions.pod:7103
29418 msgid "guestfs_truncate_size"
29422 #: ../src/guestfs-actions.pod:7105
29426 " guestfs_truncate_size (guestfs_h *g,\n"
29427 " const char *path,\n"
29428 " int64_t size);\n"
29433 #: ../src/guestfs-actions.pod:7113
29435 "If the current file size is less than C<size> then the file is extended to "
29436 "the required size with zero bytes. This creates a sparse file (ie. disk "
29437 "blocks are not allocated for the file until you write to it). To create a "
29438 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
29442 #: ../src/guestfs-actions.pod:7123
29443 msgid "guestfs_tune2fs_l"
29447 #: ../src/guestfs-actions.pod:7125
29451 " guestfs_tune2fs_l (guestfs_h *g,\n"
29452 " const char *device);\n"
29457 #: ../src/guestfs-actions.pod:7145
29458 msgid "guestfs_txz_in"
29462 #: ../src/guestfs-actions.pod:7147
29466 " guestfs_txz_in (guestfs_h *g,\n"
29467 " const char *tarball,\n"
29468 " const char *directory);\n"
29473 #: ../src/guestfs-actions.pod:7159
29474 msgid "guestfs_txz_out"
29478 #: ../src/guestfs-actions.pod:7161
29482 " guestfs_txz_out (guestfs_h *g,\n"
29483 " const char *directory,\n"
29484 " const char *tarball);\n"
29489 #: ../src/guestfs-actions.pod:7173
29490 msgid "guestfs_umask"
29494 #: ../src/guestfs-actions.pod:7175
29498 " guestfs_umask (guestfs_h *g,\n"
29504 #: ../src/guestfs-actions.pod:7191
29506 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
29507 "C<guestfs_mkdir>."
29511 #: ../src/guestfs-actions.pod:7200
29512 msgid "guestfs_umount"
29516 #: ../src/guestfs-actions.pod:7202
29520 " guestfs_umount (guestfs_h *g,\n"
29521 " const char *pathordevice);\n"
29526 #: ../src/guestfs-actions.pod:7214
29527 msgid "guestfs_umount_all"
29531 #: ../src/guestfs-actions.pod:7216
29535 " guestfs_umount_all (guestfs_h *g);\n"
29540 #: ../src/guestfs-actions.pod:7227
29541 msgid "guestfs_upload"
29545 #: ../src/guestfs-actions.pod:7229
29549 " guestfs_upload (guestfs_h *g,\n"
29550 " const char *filename,\n"
29551 " const char *remotefilename);\n"
29556 #: ../src/guestfs-actions.pod:7239
29557 msgid "See also C<guestfs_download>."
29561 #: ../src/guestfs-actions.pod:7250
29562 msgid "guestfs_upload_offset"
29566 #: ../src/guestfs-actions.pod:7252
29570 " guestfs_upload_offset (guestfs_h *g,\n"
29571 " const char *filename,\n"
29572 " const char *remotefilename,\n"
29573 " int64_t offset);\n"
29578 #: ../src/guestfs-actions.pod:7268
29580 "Note that there is no limit on the amount of data that can be uploaded with "
29581 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
29582 "full amount unless an error occurs."
29586 #: ../src/guestfs-actions.pod:7273
29587 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
29591 #: ../src/guestfs-actions.pod:7284
29592 msgid "guestfs_utimens"
29596 #: ../src/guestfs-actions.pod:7286
29600 " guestfs_utimens (guestfs_h *g,\n"
29601 " const char *path,\n"
29602 " int64_t atsecs,\n"
29603 " int64_t atnsecs,\n"
29604 " int64_t mtsecs,\n"
29605 " int64_t mtnsecs);\n"
29610 #: ../src/guestfs-actions.pod:7315 ../src/guestfs-structs.pod:175
29611 msgid "guestfs_version"
29615 #: ../src/guestfs-actions.pod:7317
29618 " struct guestfs_version *\n"
29619 " guestfs_version (guestfs_h *g);\n"
29624 #: ../src/guestfs-actions.pod:7345
29626 "I<Note:> Don't use this call to test for availability of features. In "
29627 "enterprise distributions we backport features from later versions into "
29628 "earlier versions, making this an unreliable way to test for features. Use "
29629 "C<guestfs_available> instead."
29633 #: ../src/guestfs-actions.pod:7351
29635 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
29636 "error. I<The caller must call C<guestfs_free_version> after use>."
29640 #: ../src/guestfs-actions.pod:7355
29641 msgid "(Added in 1.0.58)"
29645 #: ../src/guestfs-actions.pod:7357
29646 msgid "guestfs_vfs_label"
29650 #: ../src/guestfs-actions.pod:7359
29654 " guestfs_vfs_label (guestfs_h *g,\n"
29655 " const char *device);\n"
29660 #: ../src/guestfs-actions.pod:7368
29661 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
29665 #: ../src/guestfs-actions.pod:7373 ../src/guestfs-actions.pod:7410
29666 msgid "(Added in 1.3.18)"
29670 #: ../src/guestfs-actions.pod:7375
29671 msgid "guestfs_vfs_type"
29675 #: ../src/guestfs-actions.pod:7377
29679 " guestfs_vfs_type (guestfs_h *g,\n"
29680 " const char *device);\n"
29685 #: ../src/guestfs-actions.pod:7394
29686 msgid "guestfs_vfs_uuid"
29690 #: ../src/guestfs-actions.pod:7396
29694 " guestfs_vfs_uuid (guestfs_h *g,\n"
29695 " const char *device);\n"
29700 #: ../src/guestfs-actions.pod:7405
29701 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
29705 #: ../src/guestfs-actions.pod:7412
29706 msgid "guestfs_vg_activate"
29710 #: ../src/guestfs-actions.pod:7414
29714 " guestfs_vg_activate (guestfs_h *g,\n"
29716 " char *const *volgroups);\n"
29721 #: ../src/guestfs-actions.pod:7431
29722 msgid "guestfs_vg_activate_all"
29726 #: ../src/guestfs-actions.pod:7433
29730 " guestfs_vg_activate_all (guestfs_h *g,\n"
29731 " int activate);\n"
29736 #: ../src/guestfs-actions.pod:7446
29737 msgid "guestfs_vgcreate"
29741 #: ../src/guestfs-actions.pod:7448
29745 " guestfs_vgcreate (guestfs_h *g,\n"
29746 " const char *volgroup,\n"
29747 " char *const *physvols);\n"
29752 #: ../src/guestfs-actions.pod:7460
29753 msgid "guestfs_vglvuuids"
29757 #: ../src/guestfs-actions.pod:7462
29761 " guestfs_vglvuuids (guestfs_h *g,\n"
29762 " const char *vgname);\n"
29767 #: ../src/guestfs-actions.pod:7469
29769 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
29770 "associate logical volumes and volume groups."
29774 #: ../src/guestfs-actions.pod:7472
29775 msgid "See also C<guestfs_vgpvuuids>."
29779 #: ../src/guestfs-actions.pod:7480
29780 msgid "guestfs_vgpvuuids"
29784 #: ../src/guestfs-actions.pod:7482
29788 " guestfs_vgpvuuids (guestfs_h *g,\n"
29789 " const char *vgname);\n"
29794 #: ../src/guestfs-actions.pod:7489
29796 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
29797 "associate physical volumes and volume groups."
29801 #: ../src/guestfs-actions.pod:7492
29802 msgid "See also C<guestfs_vglvuuids>."
29806 #: ../src/guestfs-actions.pod:7500
29807 msgid "guestfs_vgremove"
29811 #: ../src/guestfs-actions.pod:7502
29815 " guestfs_vgremove (guestfs_h *g,\n"
29816 " const char *vgname);\n"
29821 #: ../src/guestfs-actions.pod:7515
29822 msgid "guestfs_vgrename"
29826 #: ../src/guestfs-actions.pod:7517
29830 " guestfs_vgrename (guestfs_h *g,\n"
29831 " const char *volgroup,\n"
29832 " const char *newvolgroup);\n"
29837 #: ../src/guestfs-actions.pod:7528
29838 msgid "guestfs_vgs"
29842 #: ../src/guestfs-actions.pod:7530
29846 " guestfs_vgs (guestfs_h *g);\n"
29851 #: ../src/guestfs-actions.pod:7539
29852 msgid "See also C<guestfs_vgs_full>."
29856 #: ../src/guestfs-actions.pod:7547
29857 msgid "guestfs_vgs_full"
29861 #: ../src/guestfs-actions.pod:7549
29864 " struct guestfs_lvm_vg_list *\n"
29865 " guestfs_vgs_full (guestfs_h *g);\n"
29870 #: ../src/guestfs-actions.pod:7555
29872 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
29873 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
29877 #: ../src/guestfs-actions.pod:7561
29878 msgid "guestfs_vgscan"
29882 #: ../src/guestfs-actions.pod:7563
29886 " guestfs_vgscan (guestfs_h *g);\n"
29891 #: ../src/guestfs-actions.pod:7573
29892 msgid "guestfs_vguuid"
29896 #: ../src/guestfs-actions.pod:7575
29900 " guestfs_vguuid (guestfs_h *g,\n"
29901 " const char *vgname);\n"
29906 #: ../src/guestfs-actions.pod:7586
29907 msgid "guestfs_wait_ready"
29911 #: ../src/guestfs-actions.pod:7588
29915 " guestfs_wait_ready (guestfs_h *g);\n"
29920 #: ../src/guestfs-actions.pod:7591
29921 msgid "This function is a no op."
29925 #: ../src/guestfs-actions.pod:7593
29927 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
29928 "calling C<guestfs_launch> to wait for the launch to complete. However this "
29929 "is no longer necessary because C<guestfs_launch> now does the waiting."
29933 #: ../src/guestfs-actions.pod:7598
29935 "If you see any calls to this function in code then you can just remove them, "
29936 "unless you want to retain compatibility with older versions of the API."
29940 #: ../src/guestfs-actions.pod:7604
29942 "This function is deprecated. In new code, use the L</guestfs_launch> call "
29947 #: ../src/guestfs-actions.pod:7613
29948 msgid "guestfs_wc_c"
29952 #: ../src/guestfs-actions.pod:7615
29956 " guestfs_wc_c (guestfs_h *g,\n"
29957 " const char *path);\n"
29962 #: ../src/guestfs-actions.pod:7626
29963 msgid "guestfs_wc_l"
29967 #: ../src/guestfs-actions.pod:7628
29971 " guestfs_wc_l (guestfs_h *g,\n"
29972 " const char *path);\n"
29977 #: ../src/guestfs-actions.pod:7639
29978 msgid "guestfs_wc_w"
29982 #: ../src/guestfs-actions.pod:7641
29986 " guestfs_wc_w (guestfs_h *g,\n"
29987 " const char *path);\n"
29992 #: ../src/guestfs-actions.pod:7652
29993 msgid "guestfs_write"
29997 #: ../src/guestfs-actions.pod:7654
30001 " guestfs_write (guestfs_h *g,\n"
30002 " const char *path,\n"
30003 " const char *content,\n"
30004 " size_t content_size);\n"
30009 #: ../src/guestfs-actions.pod:7663
30010 msgid "See also C<guestfs_write_append>."
30014 #: ../src/guestfs-actions.pod:7672
30015 msgid "guestfs_write_append"
30019 #: ../src/guestfs-actions.pod:7674
30023 " guestfs_write_append (guestfs_h *g,\n"
30024 " const char *path,\n"
30025 " const char *content,\n"
30026 " size_t content_size);\n"
30031 #: ../src/guestfs-actions.pod:7683
30032 msgid "See also C<guestfs_write>."
30036 #: ../src/guestfs-actions.pod:7692
30037 msgid "guestfs_write_file"
30041 #: ../src/guestfs-actions.pod:7694
30045 " guestfs_write_file (guestfs_h *g,\n"
30046 " const char *path,\n"
30047 " const char *content,\n"
30053 #: ../src/guestfs-actions.pod:7716
30055 "This function is deprecated. In new code, use the L</guestfs_write> call "
30060 #: ../src/guestfs-actions.pod:7725
30061 msgid "guestfs_zegrep"
30065 #: ../src/guestfs-actions.pod:7727
30069 " guestfs_zegrep (guestfs_h *g,\n"
30070 " const char *regex,\n"
30071 " const char *path);\n"
30076 #: ../src/guestfs-actions.pod:7744
30077 msgid "guestfs_zegrepi"
30081 #: ../src/guestfs-actions.pod:7746
30085 " guestfs_zegrepi (guestfs_h *g,\n"
30086 " const char *regex,\n"
30087 " const char *path);\n"
30092 #: ../src/guestfs-actions.pod:7763
30093 msgid "guestfs_zero"
30097 #: ../src/guestfs-actions.pod:7765
30101 " guestfs_zero (guestfs_h *g,\n"
30102 " const char *device);\n"
30107 #: ../src/guestfs-actions.pod:7779
30109 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
30110 "C<guestfs_is_zero_device>"
30114 #: ../src/guestfs-actions.pod:7791
30115 msgid "guestfs_zero_device"
30119 #: ../src/guestfs-actions.pod:7793
30123 " guestfs_zero_device (guestfs_h *g,\n"
30124 " const char *device);\n"
30129 #: ../src/guestfs-actions.pod:7797
30131 "This command writes zeroes over the entire C<device>. Compare with "
30132 "C<guestfs_zero> which just zeroes the first few blocks of a device."
30136 #: ../src/guestfs-actions.pod:7815
30137 msgid "(Added in 1.3.1)"
30141 #: ../src/guestfs-actions.pod:7817
30142 msgid "guestfs_zerofree"
30146 #: ../src/guestfs-actions.pod:7819
30150 " guestfs_zerofree (guestfs_h *g,\n"
30151 " const char *device);\n"
30156 #: ../src/guestfs-actions.pod:7838
30157 msgid "guestfs_zfgrep"
30161 #: ../src/guestfs-actions.pod:7840
30165 " guestfs_zfgrep (guestfs_h *g,\n"
30166 " const char *pattern,\n"
30167 " const char *path);\n"
30172 #: ../src/guestfs-actions.pod:7857
30173 msgid "guestfs_zfgrepi"
30177 #: ../src/guestfs-actions.pod:7859
30181 " guestfs_zfgrepi (guestfs_h *g,\n"
30182 " const char *pattern,\n"
30183 " const char *path);\n"
30188 #: ../src/guestfs-actions.pod:7876
30189 msgid "guestfs_zfile"
30193 #: ../src/guestfs-actions.pod:7878
30197 " guestfs_zfile (guestfs_h *g,\n"
30198 " const char *meth,\n"
30199 " const char *path);\n"
30204 #: ../src/guestfs-actions.pod:7888
30206 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
30211 #: ../src/guestfs-actions.pod:7894
30213 "This function is deprecated. In new code, use the L</guestfs_file> call "
30218 #: ../src/guestfs-actions.pod:7903
30219 msgid "guestfs_zgrep"
30223 #: ../src/guestfs-actions.pod:7905
30227 " guestfs_zgrep (guestfs_h *g,\n"
30228 " const char *regex,\n"
30229 " const char *path);\n"
30234 #: ../src/guestfs-actions.pod:7922
30235 msgid "guestfs_zgrepi"
30239 #: ../src/guestfs-actions.pod:7924
30243 " guestfs_zgrepi (guestfs_h *g,\n"
30244 " const char *regex,\n"
30245 " const char *path);\n"
30250 #: ../src/guestfs-availability.pod:3
30255 #: ../src/guestfs-availability.pod:5
30257 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
30258 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
30259 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
30260 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
30261 "L</guestfs_aug_save> L</guestfs_aug_set>"
30265 #: ../src/guestfs-availability.pod:21
30270 #: ../src/guestfs-availability.pod:23
30271 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
30275 #: ../src/guestfs-availability.pod:26
30280 #: ../src/guestfs-availability.pod:28
30282 "The following functions: L</guestfs_inotify_add_watch> L</"
30283 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
30284 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
30288 #: ../src/guestfs-availability.pod:36
30289 msgid "B<linuxfsuuid>"
30293 #: ../src/guestfs-availability.pod:38
30295 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
30296 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
30300 #: ../src/guestfs-availability.pod:45
30301 msgid "B<linuxmodules>"
30305 #: ../src/guestfs-availability.pod:47
30306 msgid "The following functions: L</guestfs_modprobe>"
30310 #: ../src/guestfs-availability.pod:50
30311 msgid "B<linuxxattrs>"
30315 #: ../src/guestfs-availability.pod:52
30317 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
30318 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
30319 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
30320 "guestfs_setxattr>"
30324 #: ../src/guestfs-availability.pod:63
30329 #: ../src/guestfs-availability.pod:65
30331 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
30332 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
30333 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
30337 #: ../src/guestfs-availability.pod:74
30342 #: ../src/guestfs-availability.pod:76
30344 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
30345 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
30346 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
30347 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
30348 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
30349 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
30350 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
30354 #: ../src/guestfs-availability.pod:99
30359 #: ../src/guestfs-availability.pod:101
30361 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
30362 "guestfs_mknod_b> L</guestfs_mknod_c>"
30366 #: ../src/guestfs-availability.pod:107
30371 #: ../src/guestfs-availability.pod:109
30372 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
30376 #: ../src/guestfs-availability.pod:112
30377 msgid "B<ntfsprogs>"
30381 #: ../src/guestfs-availability.pod:114
30383 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
30384 "L</guestfs_ntfsresize_size>"
30388 #: ../src/guestfs-availability.pod:119
30389 msgid "B<realpath>"
30393 #: ../src/guestfs-availability.pod:121
30394 msgid "The following functions: L</guestfs_realpath>"
30398 #: ../src/guestfs-availability.pod:124
30403 #: ../src/guestfs-availability.pod:126
30405 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
30406 "guestfs_scrub_freespace>"
30410 #: ../src/guestfs-availability.pod:131
30415 #: ../src/guestfs-availability.pod:133
30416 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
30420 #: ../src/guestfs-availability.pod:137
30425 #: ../src/guestfs-availability.pod:139
30426 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
30430 #: ../src/guestfs-availability.pod:143
30431 msgid "B<zerofree>"
30435 #: ../src/guestfs-availability.pod:145
30436 msgid "The following functions: L</guestfs_zerofree>"
30440 #: ../src/guestfs-structs.pod:1
30441 msgid "guestfs_int_bool"
30445 #: ../src/guestfs-structs.pod:3
30448 " struct guestfs_int_bool {\n"
30456 #: ../src/guestfs-structs.pod:8
30459 " struct guestfs_int_bool_list {\n"
30460 " uint32_t len; /* Number of elements in list. */\n"
30461 " struct guestfs_int_bool *val; /* Elements. */\n"
30467 #: ../src/guestfs-structs.pod:13
30470 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
30471 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
30476 #: ../src/guestfs-structs.pod:16
30477 msgid "guestfs_lvm_pv"
30481 #: ../src/guestfs-structs.pod:18
30484 " struct guestfs_lvm_pv {\n"
30485 " char *pv_name;\n"
30486 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30487 " char pv_uuid[32];\n"
30489 " uint64_t pv_size;\n"
30490 " uint64_t dev_size;\n"
30491 " uint64_t pv_free;\n"
30492 " uint64_t pv_used;\n"
30493 " char *pv_attr;\n"
30494 " int64_t pv_pe_count;\n"
30495 " int64_t pv_pe_alloc_count;\n"
30496 " char *pv_tags;\n"
30497 " uint64_t pe_start;\n"
30498 " int64_t pv_mda_count;\n"
30499 " uint64_t pv_mda_free;\n"
30505 #: ../src/guestfs-structs.pod:36
30508 " struct guestfs_lvm_pv_list {\n"
30509 " uint32_t len; /* Number of elements in list. */\n"
30510 " struct guestfs_lvm_pv *val; /* Elements. */\n"
30516 #: ../src/guestfs-structs.pod:41
30519 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
30520 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
30525 #: ../src/guestfs-structs.pod:44
30526 msgid "guestfs_lvm_vg"
30530 #: ../src/guestfs-structs.pod:46
30533 " struct guestfs_lvm_vg {\n"
30534 " char *vg_name;\n"
30535 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30536 " char vg_uuid[32];\n"
30538 " char *vg_attr;\n"
30539 " uint64_t vg_size;\n"
30540 " uint64_t vg_free;\n"
30541 " char *vg_sysid;\n"
30542 " uint64_t vg_extent_size;\n"
30543 " int64_t vg_extent_count;\n"
30544 " int64_t vg_free_count;\n"
30545 " int64_t max_lv;\n"
30546 " int64_t max_pv;\n"
30547 " int64_t pv_count;\n"
30548 " int64_t lv_count;\n"
30549 " int64_t snap_count;\n"
30550 " int64_t vg_seqno;\n"
30551 " char *vg_tags;\n"
30552 " int64_t vg_mda_count;\n"
30553 " uint64_t vg_mda_free;\n"
30559 #: ../src/guestfs-structs.pod:69
30562 " struct guestfs_lvm_vg_list {\n"
30563 " uint32_t len; /* Number of elements in list. */\n"
30564 " struct guestfs_lvm_vg *val; /* Elements. */\n"
30570 #: ../src/guestfs-structs.pod:74
30573 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
30574 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
30579 #: ../src/guestfs-structs.pod:77
30580 msgid "guestfs_lvm_lv"
30584 #: ../src/guestfs-structs.pod:79
30587 " struct guestfs_lvm_lv {\n"
30588 " char *lv_name;\n"
30589 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30590 " char lv_uuid[32];\n"
30591 " char *lv_attr;\n"
30592 " int64_t lv_major;\n"
30593 " int64_t lv_minor;\n"
30594 " int64_t lv_kernel_major;\n"
30595 " int64_t lv_kernel_minor;\n"
30596 " uint64_t lv_size;\n"
30597 " int64_t seg_count;\n"
30599 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
30600 " float snap_percent;\n"
30601 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
30602 " float copy_percent;\n"
30603 " char *move_pv;\n"
30604 " char *lv_tags;\n"
30605 " char *mirror_log;\n"
30606 " char *modules;\n"
30612 #: ../src/guestfs-structs.pod:101
30615 " struct guestfs_lvm_lv_list {\n"
30616 " uint32_t len; /* Number of elements in list. */\n"
30617 " struct guestfs_lvm_lv *val; /* Elements. */\n"
30623 #: ../src/guestfs-structs.pod:106
30626 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
30627 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
30632 #: ../src/guestfs-structs.pod:111
30635 " struct guestfs_stat {\n"
30639 " int64_t nlink;\n"
30644 " int64_t blksize;\n"
30645 " int64_t blocks;\n"
30646 " int64_t atime;\n"
30647 " int64_t mtime;\n"
30648 " int64_t ctime;\n"
30654 #: ../src/guestfs-structs.pod:127
30657 " struct guestfs_stat_list {\n"
30658 " uint32_t len; /* Number of elements in list. */\n"
30659 " struct guestfs_stat *val; /* Elements. */\n"
30665 #: ../src/guestfs-structs.pod:132
30668 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
30669 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
30674 #: ../src/guestfs-structs.pod:137
30677 " struct guestfs_statvfs {\n"
30678 " int64_t bsize;\n"
30679 " int64_t frsize;\n"
30680 " int64_t blocks;\n"
30681 " int64_t bfree;\n"
30682 " int64_t bavail;\n"
30683 " int64_t files;\n"
30684 " int64_t ffree;\n"
30685 " int64_t favail;\n"
30688 " int64_t namemax;\n"
30694 #: ../src/guestfs-structs.pod:151
30697 " struct guestfs_statvfs_list {\n"
30698 " uint32_t len; /* Number of elements in list. */\n"
30699 " struct guestfs_statvfs *val; /* Elements. */\n"
30705 #: ../src/guestfs-structs.pod:156
30708 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
30709 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
30714 #: ../src/guestfs-structs.pod:159
30715 msgid "guestfs_dirent"
30719 #: ../src/guestfs-structs.pod:161
30722 " struct guestfs_dirent {\n"
30731 #: ../src/guestfs-structs.pod:167
30734 " struct guestfs_dirent_list {\n"
30735 " uint32_t len; /* Number of elements in list. */\n"
30736 " struct guestfs_dirent *val; /* Elements. */\n"
30742 #: ../src/guestfs-structs.pod:172
30745 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
30746 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
30751 #: ../src/guestfs-structs.pod:177
30754 " struct guestfs_version {\n"
30755 " int64_t major;\n"
30756 " int64_t minor;\n"
30757 " int64_t release;\n"
30764 #: ../src/guestfs-structs.pod:184
30767 " struct guestfs_version_list {\n"
30768 " uint32_t len; /* Number of elements in list. */\n"
30769 " struct guestfs_version *val; /* Elements. */\n"
30775 #: ../src/guestfs-structs.pod:189
30778 " void guestfs_free_version (struct guestfs_free_version *);\n"
30779 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
30784 #: ../src/guestfs-structs.pod:192
30785 msgid "guestfs_xattr"
30789 #: ../src/guestfs-structs.pod:194
30792 " struct guestfs_xattr {\n"
30793 " char *attrname;\n"
30794 " /* The next two fields describe a byte array. */\n"
30795 " uint32_t attrval_len;\n"
30796 " char *attrval;\n"
30802 #: ../src/guestfs-structs.pod:201
30805 " struct guestfs_xattr_list {\n"
30806 " uint32_t len; /* Number of elements in list. */\n"
30807 " struct guestfs_xattr *val; /* Elements. */\n"
30813 #: ../src/guestfs-structs.pod:206
30816 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
30817 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
30822 #: ../src/guestfs-structs.pod:209
30823 msgid "guestfs_inotify_event"
30827 #: ../src/guestfs-structs.pod:211
30830 " struct guestfs_inotify_event {\n"
30831 " int64_t in_wd;\n"
30832 " uint32_t in_mask;\n"
30833 " uint32_t in_cookie;\n"
30834 " char *in_name;\n"
30840 #: ../src/guestfs-structs.pod:218
30843 " struct guestfs_inotify_event_list {\n"
30844 " uint32_t len; /* Number of elements in list. */\n"
30845 " struct guestfs_inotify_event *val; /* Elements. */\n"
30851 #: ../src/guestfs-structs.pod:223
30854 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
30855 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
30860 #: ../src/guestfs-structs.pod:226
30861 msgid "guestfs_partition"
30865 #: ../src/guestfs-structs.pod:228
30868 " struct guestfs_partition {\n"
30869 " int32_t part_num;\n"
30870 " uint64_t part_start;\n"
30871 " uint64_t part_end;\n"
30872 " uint64_t part_size;\n"
30878 #: ../src/guestfs-structs.pod:235
30881 " struct guestfs_partition_list {\n"
30882 " uint32_t len; /* Number of elements in list. */\n"
30883 " struct guestfs_partition *val; /* Elements. */\n"
30889 #: ../src/guestfs-structs.pod:240
30892 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
30893 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
30898 #: ../src/guestfs-structs.pod:243
30899 msgid "guestfs_application"
30903 #: ../src/guestfs-structs.pod:245
30906 " struct guestfs_application {\n"
30907 " char *app_name;\n"
30908 " char *app_display_name;\n"
30909 " int32_t app_epoch;\n"
30910 " char *app_version;\n"
30911 " char *app_release;\n"
30912 " char *app_install_path;\n"
30913 " char *app_trans_path;\n"
30914 " char *app_publisher;\n"
30915 " char *app_url;\n"
30916 " char *app_source_package;\n"
30917 " char *app_summary;\n"
30918 " char *app_description;\n"
30924 #: ../src/guestfs-structs.pod:260
30927 " struct guestfs_application_list {\n"
30928 " uint32_t len; /* Number of elements in list. */\n"
30929 " struct guestfs_application *val; /* Elements. */\n"
30935 #: ../src/guestfs-structs.pod:265
30938 " void guestfs_free_application (struct guestfs_free_application *);\n"
30939 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
30944 #: ../src/guestfs.pod:5
30945 msgid "guestfs - Library for accessing and modifying virtual machine images"
30949 #: ../src/guestfs.pod:11
30952 " guestfs_h *g = guestfs_create ();\n"
30953 " guestfs_add_drive (g, \"guest.img\");\n"
30954 " guestfs_launch (g);\n"
30955 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30956 " guestfs_touch (g, \"/hello\");\n"
30957 " guestfs_umount (g, \"/\");\n"
30958 " guestfs_close (g);\n"
30963 #: ../src/guestfs.pod:25
30965 "Libguestfs is a library for accessing and modifying guest disk images. "
30966 "Amongst the things this is good for: making batch configuration changes to "
30967 "guests, getting disk used/free statistics (see also: virt-df), migrating "
30968 "between virtualization systems (see also: virt-p2v), performing partial "
30969 "backups, performing partial guest clones, cloning guests and changing "
30970 "registry/UUID/hostname info, and much else besides."
30974 #: ../src/guestfs.pod:33
30976 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
30977 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
30978 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
30983 #: ../src/guestfs.pod:38
30985 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
30986 "what filesystem is in each LV, etc.). It can also run commands in the "
30987 "context of the guest. Also you can access filesystems over FUSE."
30991 #: ../src/guestfs.pod:43
30993 "Libguestfs is a library that can be linked with C and C++ management "
30994 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
30995 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
31000 #: ../src/guestfs.pod:48
31002 "You don't need to be root to use libguestfs, although obviously you do need "
31003 "enough permissions to access the disk images."
31007 #: ../src/guestfs.pod:51
31009 "Libguestfs is a large API because it can do many things. For a gentle "
31010 "introduction, please read the L</API OVERVIEW> section next."
31014 #: ../src/guestfs.pod:54
31016 "There are also some example programs in the L<guestfs-examples(3)> manual "
31021 #: ../src/guestfs.pod:57
31022 msgid "API OVERVIEW"
31026 #: ../src/guestfs.pod:59
31028 "This section provides a gentler overview of the libguestfs API. We also try "
31029 "to group API calls together, where that may not be obvious from reading "
31030 "about the individual calls in the main section of this manual."
31034 #: ../src/guestfs.pod:64
31039 #: ../src/guestfs.pod:66
31041 "Before you can use libguestfs calls, you have to create a handle. Then you "
31042 "must add at least one disk image to the handle, followed by launching the "
31043 "handle, then performing whatever operations you want, and finally closing "
31044 "the handle. By convention we use the single letter C<g> for the name of the "
31045 "handle variable, although of course you can use any name you want."
31049 #: ../src/guestfs.pod:73
31050 msgid "The general structure of all libguestfs-using programs looks like this:"
31054 #: ../src/guestfs.pod:76
31057 " guestfs_h *g = guestfs_create ();\n"
31062 #: ../src/guestfs.pod:78
31065 " /* Call guestfs_add_drive additional times if there are\n"
31066 " * multiple disk images.\n"
31068 " guestfs_add_drive (g, \"guest.img\");\n"
31073 #: ../src/guestfs.pod:83
31076 " /* Most manipulation calls won't work until you've launched\n"
31077 " * the handle 'g'. You have to do this _after_ adding drives\n"
31078 " * and _before_ other commands.\n"
31080 " guestfs_launch (g);\n"
31085 #: ../src/guestfs.pod:89
31088 " /* Now you can examine what partitions, LVs etc are available.\n"
31090 " char **partitions = guestfs_list_partitions (g);\n"
31091 " char **logvols = guestfs_lvs (g);\n"
31096 #: ../src/guestfs.pod:94
31099 " /* To access a filesystem in the image, you must mount it.\n"
31101 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
31106 #: ../src/guestfs.pod:98
31109 " /* Now you can perform filesystem actions on the guest\n"
31112 " guestfs_touch (g, \"/hello\");\n"
31117 #: ../src/guestfs.pod:103
31120 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
31121 " * it is done automatically when you close the handle. See\n"
31122 " * discussion of autosync in this page.\n"
31124 " guestfs_sync (g);\n"
31129 #: ../src/guestfs.pod:109
31132 " /* Close the handle 'g'. */\n"
31133 " guestfs_close (g);\n"
31138 #: ../src/guestfs.pod:112
31140 "The code above doesn't include any error checking. In real code you should "
31141 "check return values carefully for errors. In general all functions that "
31142 "return integers return C<-1> on error, and all functions that return "
31143 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
31144 "how to handle errors, and consult the documentation for each function call "
31145 "below to see precisely how they return error indications. See L<guestfs-"
31146 "examples(3)> for fully worked examples."
31150 #: ../src/guestfs.pod:121
31151 msgid "DISK IMAGES"
31155 #: ../src/guestfs.pod:123
31157 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
31158 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
31159 "actual block device, or simply an empty file of zeroes that you have created "
31160 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
31165 #: ../src/guestfs.pod:129
31167 "The call you should use in modern code for adding drives is L</"
31168 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
31169 "specifying that the format is raw, do:"
31173 #: ../src/guestfs.pod:133
31176 " guestfs_add_drive_opts (g, filename,\n"
31177 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
31183 #: ../src/guestfs.pod:137
31184 msgid "You can add a disk read-only using:"
31188 #: ../src/guestfs.pod:139
31191 " guestfs_add_drive_opts (g, filename,\n"
31192 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
31193 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
31199 #: ../src/guestfs.pod:144
31201 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
31202 "libguestfs won't modify the file."
31206 #: ../src/guestfs.pod:147
31208 "Be extremely cautious if the disk image is in use, eg. if it is being used "
31209 "by a virtual machine. Adding it read-write will almost certainly cause disk "
31210 "corruption, but adding it read-only is safe."
31214 #: ../src/guestfs.pod:151
31216 "You must add at least one disk image, and you may add multiple disk images. "
31217 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
31218 "first one you added), C</dev/sdb> (for the second one you added), etc."
31222 #: ../src/guestfs.pod:156
31224 "Once L</guestfs_launch> has been called you cannot add any more images. You "
31225 "can call L</guestfs_list_devices> to get a list of the device names, in the "
31226 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
31230 #: ../src/guestfs.pod:161
31235 #: ../src/guestfs.pod:163
31237 "Before you can read or write files, create directories and so on in a disk "
31238 "image that contains filesystems, you have to mount those filesystems using "
31239 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
31240 "a disk image contains (for example) one partition with a filesystem on that "
31241 "partition, then you can mount it directly:"
31245 #: ../src/guestfs.pod:170
31248 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
31253 #: ../src/guestfs.pod:172
31255 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
31256 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
31257 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
31258 "that these are libguestfs virtual devices, and are nothing to do with host "
31263 #: ../src/guestfs.pod:178
31265 "If you are given a disk image and you don't know what it contains then you "
31266 "have to find out. Libguestfs can do that too: use L</"
31267 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
31268 "LVs, and either try mounting each to see what is mountable, or else examine "
31269 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
31270 "filesystems, use L</guestfs_list_filesystems>."
31274 #: ../src/guestfs.pod:186
31276 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
31277 "L</INSPECTION> below). But you might find it easier to look at higher level "
31278 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
31282 #: ../src/guestfs.pod:191
31284 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
31285 "several other variations of the C<guestfs_mount_*> call."
31289 #: ../src/guestfs.pod:194
31290 msgid "FILESYSTEM ACCESS AND MODIFICATION"
31294 #: ../src/guestfs.pod:196
31296 "The majority of the libguestfs API consists of fairly low-level calls for "
31297 "accessing and modifying the files, directories, symlinks etc on mounted "
31298 "filesystems. There are over a hundred such calls which you can find listed "
31299 "in detail below in this man page, and we don't even pretend to cover them "
31300 "all in this overview."
31304 #: ../src/guestfs.pod:202
31306 "Specify filenames as full paths, starting with C<\"/\"> and including the "
31311 #: ../src/guestfs.pod:205
31313 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
31314 "the file called C<\"etc/passwd\"> then you could do:"
31318 #: ../src/guestfs.pod:208
31321 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
31326 #: ../src/guestfs.pod:210
31328 "This would return C<data> as a newly allocated buffer containing the full "
31329 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
31330 "or C<NULL> if there was an error."
31334 #: ../src/guestfs.pod:214
31336 "As another example, to create a top-level directory on that filesystem "
31337 "called C<\"var\"> you would do:"
31341 #: ../src/guestfs.pod:217
31344 " guestfs_mkdir (g, \"/var\");\n"
31349 #: ../src/guestfs.pod:219
31350 msgid "To create a symlink you could do:"
31354 #: ../src/guestfs.pod:221
31357 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
31358 " \"/etc/rc3.d/S30portmap\");\n"
31363 #: ../src/guestfs.pod:224
31365 "Libguestfs will reject attempts to use relative paths and there is no "
31366 "concept of a current working directory."
31370 #: ../src/guestfs.pod:227
31372 "Libguestfs can return errors in many situations: for example if the "
31373 "filesystem isn't writable, or if a file or directory that you requested "
31374 "doesn't exist. If you are using the C API (documented here) you have to "
31375 "check for those error conditions after each call. (Other language bindings "
31376 "turn these errors into exceptions)."
31380 #: ../src/guestfs.pod:233
31382 "File writes are affected by the per-handle umask, set by calling L</"
31383 "guestfs_umask> and defaulting to 022. See L</UMASK>."
31387 #: ../src/guestfs.pod:236
31388 msgid "PARTITIONING"
31392 #: ../src/guestfs.pod:238
31394 "Libguestfs contains API calls to read, create and modify partition tables on "
31399 #: ../src/guestfs.pod:241
31401 "In the common case where you want to create a single partition covering the "
31402 "whole disk, you should use the L</guestfs_part_disk> call:"
31406 #: ../src/guestfs.pod:245
31409 " const char *parttype = \"mbr\";\n"
31410 " if (disk_is_larger_than_2TB)\n"
31411 " parttype = \"gpt\";\n"
31412 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
31417 #: ../src/guestfs.pod:250
31419 "Obviously this effectively wipes anything that was on that disk image before."
31423 #: ../src/guestfs.pod:253
31428 #: ../src/guestfs.pod:255
31430 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
31431 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
31432 "you familiarize yourself with the concepts of physical volumes, volume "
31433 "groups and logical volumes."
31437 #: ../src/guestfs.pod:260
31439 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
31440 "tldp.org/HOWTO/LVM-HOWTO/>."
31444 #: ../src/guestfs.pod:263
31445 msgid "DOWNLOADING"
31449 #: ../src/guestfs.pod:265
31451 "Use L</guestfs_cat> to download small, text only files. This call is "
31452 "limited to files which are less than 2 MB and which cannot contain any ASCII "
31453 "NUL (C<\\0>) characters. However the API is very simple to use."
31457 #: ../src/guestfs.pod:269
31459 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
31460 "bit data, since it returns a (pointer, size) pair. However it is still "
31461 "limited to \"small\" files, less than 2 MB."
31465 #: ../src/guestfs.pod:273
31467 "L</guestfs_download> can be used to download any file, with no limits on "
31468 "content or size (even files larger than 4 GB)."
31472 #: ../src/guestfs.pod:276
31474 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
31478 #: ../src/guestfs.pod:279
31483 #: ../src/guestfs.pod:281
31485 "It's often the case that you want to write a file or files to the disk image."
31489 #: ../src/guestfs.pod:284
31491 "To write a small file with fixed content, use L</guestfs_write>. To create "
31492 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
31493 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
31494 "of other functions for creating test files, for example L</guestfs_fill> and "
31495 "L</guestfs_fill_pattern>."
31499 #: ../src/guestfs.pod:290
31501 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
31502 "file content or size (even files larger than 4 GB)."
31506 #: ../src/guestfs.pod:293
31508 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
31512 #: ../src/guestfs.pod:295
31514 "However the fastest way to upload I<large numbers of arbitrary files> is to "
31515 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
31516 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
31517 "in a predictable way (eg. adding it last after all other drives) then you "
31518 "can get the device name from L</guestfs_list_devices> and mount it directly "
31519 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
31520 "portable between kernel versions, and they don't support labels or UUIDs. "
31521 "If you want to pre-build an image or you need to mount it using a label or "
31522 "UUID, use an ISO image instead."
31526 #: ../src/guestfs.pod:306
31531 #: ../src/guestfs.pod:308
31533 "There are various different commands for copying between files and devices "
31534 "and in and out of the guest filesystem. These are summarised in the table "
31539 #: ../src/guestfs.pod:314
31540 msgid "B<file> to B<file>"
31544 #: ../src/guestfs.pod:316
31546 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
31547 "directories recursively."
31551 #: ../src/guestfs.pod:319
31552 msgid "B<file or device> to B<file or device>"
31556 #: ../src/guestfs.pod:321
31558 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
31559 "devices in the guest."
31563 #: ../src/guestfs.pod:324
31564 msgid "Example: duplicate the contents of an LV:"
31568 #: ../src/guestfs.pod:326
31571 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
31576 #: ../src/guestfs.pod:328
31578 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
31579 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
31580 "guestfs_copy_size>."
31584 #: ../src/guestfs.pod:332
31585 msgid "B<file on the host> to B<file or device>"
31589 #: ../src/guestfs.pod:334
31590 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
31594 #: ../src/guestfs.pod:336
31595 msgid "B<file or device> to B<file on the host>"
31599 #: ../src/guestfs.pod:338
31600 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
31604 #: ../src/guestfs.pod:342
31605 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
31609 #: ../src/guestfs.pod:344
31611 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
31612 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
31613 "appears you can only upload and download to files. However many Un*x-like "
31614 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
31615 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
31616 "and arbitrary file descriptor N."
31620 #: ../src/guestfs.pod:352
31621 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
31625 #: ../src/guestfs.pod:355
31628 " guestfs_download (g, filename, \"/dev/stdout\");\n"
31633 #: ../src/guestfs.pod:357
31634 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
31638 #: ../src/guestfs.pod:359
31641 " char devfd[64];\n"
31642 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
31643 " guestfs_tar_out (g, \"/\", devfd);\n"
31648 #: ../src/guestfs.pod:363
31649 msgid "LISTING FILES"
31653 #: ../src/guestfs.pod:365
31655 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
31656 "L<guestfish(1)>-equivalent command C<ll>)."
31660 #: ../src/guestfs.pod:368
31662 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
31663 "programs, as a flat list of strings."
31667 #: ../src/guestfs.pod:371
31669 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
31670 "directory, plus additional information about each one. It is more "
31671 "equivalent to using the L<readdir(3)> call on a local filesystem."
31675 #: ../src/guestfs.pod:375
31677 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
31681 #: ../src/guestfs.pod:378
31682 msgid "RUNNING COMMANDS"
31686 #: ../src/guestfs.pod:380
31688 "Although libguestfs is primarily an API for manipulating files inside guest "
31689 "images, we also provide some limited facilities for running commands inside "
31694 #: ../src/guestfs.pod:384
31695 msgid "There are many limitations to this:"
31699 #: ../src/guestfs.pod:390
31701 "The kernel version that the command runs under will be different from what "
31706 #: ../src/guestfs.pod:395
31708 "If the command needs to communicate with daemons, then most likely they "
31709 "won't be running."
31713 #: ../src/guestfs.pod:400
31714 msgid "The command will be running in limited memory."
31718 #: ../src/guestfs.pod:404
31720 "The network may not be available unless you enable it (see L</"
31721 "guestfs_set_network>)."
31725 #: ../src/guestfs.pod:409
31726 msgid "Only supports Linux guests (not Windows, BSD, etc)."
31730 #: ../src/guestfs.pod:413
31732 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
31736 #: ../src/guestfs.pod:418
31738 "For SELinux guests, you may need to enable SELinux and load policy first. "
31739 "See L</SELINUX> in this manpage."
31743 #: ../src/guestfs.pod:423
31745 "I<Security:> It is not safe to run commands from untrusted, possibly "
31746 "malicious guests. These commands may attempt to exploit your program by "
31747 "sending unexpected output. They could also try to exploit the Linux kernel "
31748 "or qemu provided by the libguestfs appliance. They could use the network "
31749 "provided by the libguestfs appliance to bypass ordinary network partitions "
31750 "and firewalls. They could use the elevated privileges or different SELinux "
31751 "context of your program to their advantage."
31755 #: ../src/guestfs.pod:432
31757 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
31758 "(a script which runs when the guest next boots normally), and to have this "
31759 "script run the commands you want in the normal context of the running guest, "
31760 "network security and so on. For information about other security issues, "
31761 "see L</SECURITY>."
31765 #: ../src/guestfs.pod:440
31767 "The two main API calls to run commands are L</guestfs_command> and L</"
31768 "guestfs_sh> (there are also variations)."
31772 #: ../src/guestfs.pod:443
31774 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
31775 "shell globs, redirections, etc will work."
31779 #: ../src/guestfs.pod:446
31780 msgid "CONFIGURATION FILES"
31784 #: ../src/guestfs.pod:448
31786 "To read and write configuration files in Linux guest filesystems, we "
31787 "strongly recommend using Augeas. For example, Augeas understands how to "
31788 "read and write, say, a Linux shadow password file or X.org configuration "
31789 "file, and so avoids you having to write that code."
31793 #: ../src/guestfs.pod:453
31795 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
31796 "document Augeas itself here because there is excellent documentation on the "
31797 "L<http://augeas.net/> website."
31801 #: ../src/guestfs.pod:457
31803 "If you don't want to use Augeas (you fool!) then try calling L</"
31804 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
31809 #: ../src/guestfs.pod:461
31814 #: ../src/guestfs.pod:463
31816 "We support SELinux guests. To ensure that labeling happens correctly in "
31817 "SELinux guests, you need to enable SELinux and load the guest's policy:"
31821 #: ../src/guestfs.pod:471
31822 msgid "Before launching, do:"
31826 #: ../src/guestfs.pod:473
31829 " guestfs_set_selinux (g, 1);\n"
31834 #: ../src/guestfs.pod:477
31836 "After mounting the guest's filesystem(s), load the policy. This is best "
31837 "done by running the L<load_policy(8)> command in the guest itself:"
31841 #: ../src/guestfs.pod:481
31844 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
31849 #: ../src/guestfs.pod:483
31851 "(Older versions of C<load_policy> require you to specify the name of the "
31856 #: ../src/guestfs.pod:488
31858 "Optionally, set the security context for the API. The correct security "
31859 "context to use can only be known by inspecting the guest. As an example:"
31863 #: ../src/guestfs.pod:492
31866 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
31871 #: ../src/guestfs.pod:496
31872 msgid "This will work for running commands and editing existing files."
31876 #: ../src/guestfs.pod:498
31878 "When new files are created, you may need to label them explicitly, for "
31879 "example by running the external command C<restorecon pathname>."
31883 #: ../src/guestfs.pod:502
31888 #: ../src/guestfs.pod:504
31890 "Certain calls are affected by the current file mode creation mask (the "
31891 "\"umask\"). In particular ones which create files or directories, such as "
31892 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
31893 "either the default mode that the file is created with or modifies the mode "
31898 #: ../src/guestfs.pod:510
31900 "The default umask is C<022>, so files are created with modes such as C<0644> "
31901 "and directories with C<0755>."
31905 #: ../src/guestfs.pod:513
31907 "There are two ways to avoid being affected by umask. Either set umask to 0 "
31908 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
31909 "guestfs_chmod> after creating each file or directory."
31913 #: ../src/guestfs.pod:517
31914 msgid "For more information about umask, see L<umask(2)>."
31918 #: ../src/guestfs.pod:521
31920 "Libguestfs allows you to access Linux guests which have been encrypted using "
31921 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
31922 "standard. This includes nearly all whole disk encryption systems used by "
31923 "modern Linux guests."
31927 #: ../src/guestfs.pod:527
31929 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
31930 "returns the string C<crypto_LUKS>)."
31934 #: ../src/guestfs.pod:530
31936 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
31937 "will require the passphrase!"
31941 #: ../src/guestfs.pod:533
31943 "Opening a LUKS device creates a new device mapper device called C</dev/"
31944 "mapper/mapname> (where C<mapname> is the string you supply to L</"
31945 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
31946 "from and encrypted to the underlying block device respectively."
31950 #: ../src/guestfs.pod:539
31952 "LVM volume groups on the device can be made visible by calling L</"
31953 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
31954 "(s) can now be mounted in the usual way."
31958 #: ../src/guestfs.pod:543
31960 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
31961 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
31962 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
31963 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
31964 "underlying encrypted block device)."
31968 #: ../src/guestfs.pod:550
31973 #: ../src/guestfs.pod:552
31975 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
31976 "contains operating systems, an install CD or a live CD. (These APIs used to "
31977 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
31978 "version 1.5.3 the most frequently used part of this library has been "
31979 "rewritten in C and moved into the core code)."
31983 #: ../src/guestfs.pod:559
31985 "Add all disks belonging to the unknown virtual machine and call L</"
31986 "guestfs_launch> in the usual way."
31990 #: ../src/guestfs.pod:562
31992 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
31993 "and certain heuristics, and returns a list of operating systems that were "
31994 "found. An empty list means none were found. A single element is the root "
31995 "filesystem of the operating system. For dual- or multi-boot guests, "
31996 "multiple roots can be returned, each one corresponding to a separate "
31997 "operating system. (Multi-boot virtual machines are extremely rare in the "
31998 "world of virtualization, but since this scenario can happen, we have built "
31999 "libguestfs to deal with it.)"
32003 #: ../src/guestfs.pod:571
32005 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
32006 "to get additional details about that operating system. For example, call L</"
32007 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
32008 "Windows and Linux-based operating systems respectively."
32012 #: ../src/guestfs.pod:577
32014 "Un*x-like and Linux-based operating systems usually consist of several "
32015 "filesystems which are mounted at boot time (for example, a separate boot "
32016 "partition mounted on C</boot>). The inspection rules are able to detect how "
32017 "filesystems correspond to mount points. Call "
32018 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
32019 "hash table like this example:"
32023 #: ../src/guestfs.pod:584
32026 " /boot => /dev/sda1\n"
32027 " / => /dev/vg_guest/lv_root\n"
32028 " /usr => /dev/vg_guest/lv_usr\n"
32033 #: ../src/guestfs.pod:588
32035 "The caller can then make calls to L</guestfs_mount_options> to mount the "
32036 "filesystems as suggested."
32040 #: ../src/guestfs.pod:591
32042 "Be careful to mount filesystems in the right order (eg. C</> before C</"
32043 "usr>). Sorting the keys of the hash by length, shortest first, should work."
32047 #: ../src/guestfs.pod:595
32049 "Inspection currently only works for some common operating systems. "
32050 "Contributors are welcome to send patches for other operating systems that we "
32051 "currently cannot detect."
32055 #: ../src/guestfs.pod:599
32057 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
32058 "for more details. The L</guestfs_inspect_os> function just ignores any "
32059 "encrypted devices."
32063 #: ../src/guestfs.pod:603
32065 "A note on the implementation: The call L</guestfs_inspect_os> performs "
32066 "inspection and caches the results in the guest handle. Subsequent calls to "
32067 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
32068 "read the disks. If you change the content of the guest disks, you can redo "
32069 "inspection by calling L</guestfs_inspect_os> again. (L</"
32070 "guestfs_inspect_list_applications> works a little differently from the other "
32071 "calls and does read the disks. See documentation for that function for "
32076 #: ../src/guestfs.pod:612
32077 msgid "INSPECTING INSTALL DISKS"
32081 #: ../src/guestfs.pod:614
32083 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
32088 #: ../src/guestfs.pod:617
32090 "Call L</guestfs_inspect_get_format> to return the format of the operating "
32091 "system, which currently can be C<installed> (a regular operating system) or "
32092 "C<installer> (some sort of install disk)."
32096 #: ../src/guestfs.pod:621
32098 "Further information is available about the operating system that can be "
32099 "installed using the regular inspection APIs like L</"
32100 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
32104 #: ../src/guestfs.pod:626
32106 "Some additional information specific to installer disks is also available "
32107 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
32108 "guestfs_inspect_is_multipart> calls."
32112 #: ../src/guestfs.pod:631
32113 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
32117 #: ../src/guestfs.pod:633
32119 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
32120 "ntfs-3g.org/> driver."
32124 #: ../src/guestfs.pod:636
32125 msgid "DRIVE LETTERS AND PATHS"
32129 #: ../src/guestfs.pod:638
32131 "DOS and Windows still use drive letters, and the filesystems are always "
32132 "treated as case insensitive by Windows itself, and therefore you might find "
32133 "a Windows configuration file referring to a path like C<c:\\windows"
32134 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
32135 "might be referred to as C</WINDOWS/System32>."
32139 #: ../src/guestfs.pod:644
32141 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
32142 "L</guestfs_inspect_get_drive_mappings>)"
32146 #: ../src/guestfs.pod:647
32148 "Dealing with separator characters (backslash vs forward slash) is outside "
32149 "the scope of libguestfs, but usually a simple character replacement will "
32154 #: ../src/guestfs.pod:651
32156 "To resolve the case insensitivity of paths, call L</"
32157 "guestfs_case_sensitive_path>."
32161 #: ../src/guestfs.pod:654
32162 msgid "ACCESSING THE WINDOWS REGISTRY"
32166 #: ../src/guestfs.pod:656
32168 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
32169 "files, through the library C<hivex> which is part of the libguestfs project "
32170 "although ships as a separate tarball. You have to locate and download the "
32171 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
32172 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
32173 "reg(1)> for more help on this issue."
32177 #: ../src/guestfs.pod:664
32178 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
32182 #: ../src/guestfs.pod:666
32184 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
32185 "provide something which looks like a Linux symlink. The way it tries to do "
32186 "the rewriting is described here:"
32190 #: ../src/guestfs.pod:670
32192 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
32197 #: ../src/guestfs.pod:672
32199 "The essential problem is that ntfs-3g simply does not have enough "
32200 "information to do a correct job. NTFS links can contain drive letters and "
32201 "references to external device GUIDs that ntfs-3g has no way of resolving. "
32202 "It is almost certainly the case that libguestfs callers should ignore what "
32203 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
32207 #: ../src/guestfs.pod:679
32209 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
32210 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
32211 "attribute, and read the raw reparse data from that (you can find the format "
32212 "documented in various places around the web)."
32216 #: ../src/guestfs.pod:684
32217 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
32221 #: ../src/guestfs.pod:686
32223 "There are other useful extended attributes that can be read from ntfs-3g "
32224 "filesystems (using L</guestfs_getxattr>). See:"
32228 #: ../src/guestfs.pod:689
32230 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
32234 #: ../src/guestfs.pod:691
32235 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
32239 #: ../src/guestfs.pod:693
32241 "Although we don't want to discourage you from using the C API, we will "
32242 "mention here that the same API is also available in other languages."
32246 #: ../src/guestfs.pod:696
32248 "The API is broadly identical in all supported languages. This means that "
32249 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
32250 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
32251 "OCaml. In other words, a straightforward, predictable isomorphism between "
32256 #: ../src/guestfs.pod:702
32258 "Error messages are automatically transformed into exceptions if the language "
32263 #: ../src/guestfs.pod:705
32265 "We don't try to \"object orientify\" parts of the API in OO languages, "
32266 "although contributors are welcome to write higher level APIs above what we "
32267 "provide in their favourite languages if they wish."
32271 #: ../src/guestfs.pod:711
32276 #: ../src/guestfs.pod:713
32278 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
32279 "identical to the C API. C++ classes and exceptions are not used."
32283 #: ../src/guestfs.pod:717
32288 #: ../src/guestfs.pod:719
32290 "The C# bindings are highly experimental. Please read the warnings at the "
32291 "top of C<csharp/Libguestfs.cs>."
32295 #: ../src/guestfs.pod:722
32300 #: ../src/guestfs.pod:724
32302 "This is the only language binding that is working but incomplete. Only "
32303 "calls which return simple integers have been bound in Haskell, and we are "
32304 "looking for help to complete this binding."
32308 #: ../src/guestfs.pod:728
32313 #: ../src/guestfs.pod:730
32315 "Full documentation is contained in the Javadoc which is distributed with "
32316 "libguestfs. For examples, see L<guestfs-java(3)>."
32320 #: ../src/guestfs.pod:733
32325 #: ../src/guestfs.pod:735
32326 msgid "See L<guestfs-ocaml(3)>."
32330 #: ../src/guestfs.pod:737
32335 #: ../src/guestfs.pod:739
32336 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
32340 #: ../src/guestfs.pod:741
32345 #: ../src/guestfs.pod:743
32347 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
32348 "the php-libguestfs package for your distribution."
32352 #: ../src/guestfs.pod:746
32353 msgid "The PHP binding only works correctly on 64 bit machines."
32357 #: ../src/guestfs.pod:748
32362 #: ../src/guestfs.pod:750
32363 msgid "See L<guestfs-python(3)>."
32367 #: ../src/guestfs.pod:752
32372 #: ../src/guestfs.pod:754
32373 msgid "See L<guestfs-ruby(3)>."
32377 #: ../src/guestfs.pod:756
32378 msgid "B<shell scripts>"
32382 #: ../src/guestfs.pod:758
32383 msgid "See L<guestfish(1)>."
32387 #: ../src/guestfs.pod:762
32388 msgid "LIBGUESTFS GOTCHAS"
32392 #: ../src/guestfs.pod:764
32394 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
32395 "system [...] that works in the way it is documented but is counterintuitive "
32396 "and almost invites mistakes.\""
32400 #: ../src/guestfs.pod:768
32402 "Since we developed libguestfs and the associated tools, there are several "
32403 "things we would have designed differently, but are now stuck with for "
32404 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
32405 "release, you can expect these to change. Beware of them."
32409 #: ../src/guestfs.pod:776
32410 msgid "Autosync / forgetting to sync."
32414 #: ../src/guestfs.pod:778
32416 "I<Update:> Autosync is enabled by default for all API users starting from "
32417 "libguestfs 1.5.24. This section only applies to older versions."
32421 #: ../src/guestfs.pod:781
32423 "When modifying a filesystem from C or another language, you B<must> unmount "
32424 "all filesystems and call L</guestfs_sync> explicitly before you close the "
32425 "libguestfs handle. You can also call:"
32429 #: ../src/guestfs.pod:785
32432 " guestfs_set_autosync (g, 1);\n"
32437 #: ../src/guestfs.pod:787
32439 "to have the unmount/sync done automatically for you when the handle 'g' is "
32440 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
32444 #: ../src/guestfs.pod:791
32446 "If you forget to do this, then it is entirely possible that your changes "
32447 "won't be written out, or will be partially written, or (very rarely) that "
32448 "you'll get disk corruption."
32452 #: ../src/guestfs.pod:795
32454 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
32455 "guestfish scripts that forget to sync will work just fine, which can make "
32456 "this very puzzling if you are trying to debug a problem."
32460 #: ../src/guestfs.pod:799
32461 msgid "Mount option C<-o sync> should not be the default."
32465 #: ../src/guestfs.pod:801
32467 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
32468 "However C<-o sync> does not add any reliability benefit, but does have a "
32469 "very large performance impact."
32473 #: ../src/guestfs.pod:805
32475 "The work around is to use L</guestfs_mount_options> and set the mount "
32476 "options that you actually want to use."
32480 #: ../src/guestfs.pod:808
32481 msgid "Read-only should be the default."
32485 #: ../src/guestfs.pod:810
32487 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
32488 "specify I<--rw> if you want to make changes to the image."
32492 #: ../src/guestfs.pod:813
32493 msgid "This would reduce the potential to corrupt live VM images."
32497 #: ../src/guestfs.pod:815
32499 "Note that many filesystems change the disk when you just mount and unmount, "
32500 "even if you didn't perform any writes. You need to use L</"
32501 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
32505 #: ../src/guestfs.pod:819
32506 msgid "guestfish command line is hard to use."
32510 #: ../src/guestfs.pod:821
32512 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
32513 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
32514 "exist, so it fails. In earlier versions of guestfish the error message was "
32515 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
32516 "we should have used C<guestfish -c command> to run commands."
32520 #: ../src/guestfs.pod:828
32521 msgid "guestfish megabyte modifiers don't work right on all commands"
32525 #: ../src/guestfs.pod:830
32527 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
32528 "other modifiers). What guestfish actually does is to multiply the number "
32529 "part by the modifier part and pass the result to the C API. However this "
32530 "doesn't work for a few APIs which aren't expecting bytes, but are already "
32531 "expecting some other unit (eg. megabytes)."
32535 #: ../src/guestfs.pod:837
32536 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
32540 #: ../src/guestfs.pod:839
32543 " lvcreate LV VG 100M\n"
32548 #: ../src/guestfs.pod:841
32550 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
32551 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
32552 "megabytes * megabytes) logical volume. The error message you get from this "
32553 "is also a little obscure."
32557 #: ../src/guestfs.pod:846
32559 "This could be fixed in the generator by specially marking parameters and "
32560 "return values which take bytes or other units."
32564 #: ../src/guestfs.pod:849
32565 msgid "Ambiguity between devices and paths"
32569 #: ../src/guestfs.pod:851
32571 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
32572 "sdb2>) and a similar pathname. A file might just happen to be called "
32573 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
32577 #: ../src/guestfs.pod:856
32579 "In the current API we usually resolve this ambiguity by having two separate "
32580 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
32581 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
32582 "detecting if the path supplied begins with C</dev/>."
32586 #: ../src/guestfs.pod:862
32588 "To avoid both the ambiguity and the need to duplicate some calls, we could "
32589 "make paths/devices into structured names. One way to do this would be to "
32590 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
32591 "aspect of grub. Another way would be to use a structured type, equivalent "
32592 "to this OCaml type:"
32596 #: ../src/guestfs.pod:868
32599 " type path = Path of string | Device of int | Partition of int * int\n"
32604 #: ../src/guestfs.pod:870
32605 msgid "which would allow you to pass arguments like:"
32609 #: ../src/guestfs.pod:872
32612 " Path \"/foo/bar\"\n"
32613 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
32614 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
32615 " Path \"/dev/sdb2\" (* not a device *)\n"
32620 #: ../src/guestfs.pod:877
32622 "As you can see there are still problems to resolve even with this "
32623 "representation. Also consider how it might work in guestfish."
32627 #: ../src/guestfs.pod:882
32628 msgid "KEYS AND PASSPHRASES"
32632 #: ../src/guestfs.pod:884
32634 "Certain libguestfs calls take a parameter that contains sensitive key "
32635 "material, passed in as a C string."
32639 #: ../src/guestfs.pod:887
32641 "In the future we would hope to change the libguestfs implementation so that "
32642 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
32643 "swap. However this is I<not> done at the moment, because of the complexity "
32644 "of such an implementation."
32648 #: ../src/guestfs.pod:892
32650 "Therefore you should be aware that any key parameter you pass to libguestfs "
32651 "might end up being written out to the swap partition. If this is a concern, "
32652 "scrub the swap partition or don't use libguestfs on encrypted devices."
32656 #: ../src/guestfs.pod:897
32657 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
32661 #: ../src/guestfs.pod:899
32663 "All high-level libguestfs actions are synchronous. If you want to use "
32664 "libguestfs asynchronously then you must create a thread."
32668 #: ../src/guestfs.pod:902
32670 "Only use the handle from a single thread. Either use the handle exclusively "
32671 "from one thread, or provide your own mutex so that two threads cannot issue "
32672 "calls on the same handle at the same time."
32676 #: ../src/guestfs.pod:906
32678 "See the graphical program guestfs-browser for one possible architecture for "
32679 "multithreaded programs using libvirt and libguestfs."
32683 #: ../src/guestfs.pod:909
32688 #: ../src/guestfs.pod:911
32690 "Libguestfs needs a supermin appliance, which it finds by looking along an "
32695 #: ../src/guestfs.pod:914
32697 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
32698 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
32702 #: ../src/guestfs.pod:917
32704 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
32705 "to change the directories that libguestfs will search in. The value is a "
32706 "colon-separated list of paths. The current directory is I<not> searched "
32707 "unless the path contains an empty element or C<.>. For example "
32708 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
32709 "then C</usr/lib/guestfs>."
32713 #: ../src/guestfs.pod:924
32714 msgid "QEMU WRAPPERS"
32718 #: ../src/guestfs.pod:926
32720 "If you want to compile your own qemu, run qemu from a non-standard location, "
32721 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
32726 #: ../src/guestfs.pod:930
32728 "There is one important rule to remember: you I<must C<exec qemu>> as the "
32729 "last command in the shell script (so that qemu replaces the shell and "
32730 "becomes the direct child of the libguestfs-using program). If you don't do "
32731 "this, then the qemu process won't be cleaned up correctly."
32735 #: ../src/guestfs.pod:935
32737 "Here is an example of a wrapper, where I have built my own copy of qemu from "
32742 #: ../src/guestfs.pod:938
32746 " qemudir=/home/rjones/d/qemu\n"
32747 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
32752 #: ../src/guestfs.pod:942
32754 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
32755 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
32760 #: ../src/guestfs.pod:946
32763 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
32768 #: ../src/guestfs.pod:948
32770 "Note that libguestfs also calls qemu with the -help and -version options in "
32771 "order to determine features."
32775 #: ../src/guestfs.pod:951
32776 msgid "ATTACHING TO RUNNING DAEMONS"
32780 #: ../src/guestfs.pod:953
32782 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
32783 "babies. Use with caution."
32787 #: ../src/guestfs.pod:956
32789 "I<Note (2):> This section explains how to attach to a running daemon from a "
32790 "low level perspective. For most users, simply using virt tools such as "
32791 "L<guestfish(1)> with the I<--live> option will \"just work\"."
32795 #: ../src/guestfs.pod:960
32796 msgid "Using guestfs_set_attach_method"
32800 #: ../src/guestfs.pod:962
32802 "By calling L</guestfs_set_attach_method> you can change how the library "
32803 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
32804 "ARCHITECTURE> for some background)."
32808 #: ../src/guestfs.pod:966
32810 "The normal attach method is C<appliance>, where a small appliance is created "
32811 "containing the daemon, and then the library connects to this."
32815 #: ../src/guestfs.pod:969
32817 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
32818 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
32819 "daemon over the Unix domain socket."
32823 #: ../src/guestfs.pod:973
32825 "The normal use for this is to connect to a running virtual machine that "
32826 "contains a C<guestfsd> daemon, and send commands so you can read and write "
32827 "files inside the live virtual machine."
32831 #: ../src/guestfs.pod:977
32832 msgid "Using guestfs_add_domain with live flag"
32836 #: ../src/guestfs.pod:979
32838 "L</guestfs_add_domain> provides some help for getting the correct attach "
32839 "method. If you pass the C<live> option to this function, then (if the "
32840 "virtual machine is running) it will examine the libvirt XML looking for a "
32841 "virtio-serial channel to connect to:"
32845 #: ../src/guestfs.pod:985
32852 " <channel type='unix'>\n"
32853 " <source mode='bind' path='/path/to/socket'/>\n"
32854 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
32863 #: ../src/guestfs.pod:997
32865 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
32866 "method to C<unix:/path/to/socket>."
32870 #: ../src/guestfs.pod:1000
32872 "Some of the libguestfs tools (including guestfish) support a I<--live> "
32873 "option which is passed through to L</guestfs_add_domain> thus allowing you "
32874 "to attach to and modify live virtual machines."
32878 #: ../src/guestfs.pod:1004
32880 "The virtual machine needs to have been set up beforehand so that it has the "
32881 "virtio-serial channel and so that guestfsd is running inside it."
32885 #: ../src/guestfs.pod:1008
32886 msgid "ABI GUARANTEE"
32890 #: ../src/guestfs.pod:1010
32892 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
32893 "actions as outlined in this section. Although we will deprecate some "
32894 "actions, for example if they get replaced by newer calls, we will keep the "
32895 "old actions forever. This allows you the developer to program in confidence "
32896 "against the libguestfs API."
32900 #: ../src/guestfs.pod:1016
32901 msgid "BLOCK DEVICE NAMING"
32905 #: ../src/guestfs.pod:1018
32907 "In the kernel there is now quite a profusion of schemata for naming block "
32908 "devices (in this context, by I<block device> I mean a physical or virtual "
32909 "hard drive). The original Linux IDE driver used names starting with C</dev/"
32910 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
32911 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
32912 "for the old IDE driver (particularly for SATA devices) those devices also "
32913 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
32914 "paravirtualized drivers. This has created several different naming systems, "
32915 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
32919 #: ../src/guestfs.pod:1030
32921 "As discussed above, libguestfs uses a qemu appliance running an embedded "
32922 "Linux kernel to access block devices. We can run a variety of appliances "
32923 "based on a variety of Linux kernels."
32927 #: ../src/guestfs.pod:1034
32929 "This causes a problem for libguestfs because many API calls use device or "
32930 "partition names. Working scripts and the recipe (example) scripts that we "
32931 "make available over the internet could fail if the naming scheme changes."
32935 #: ../src/guestfs.pod:1039
32937 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
32938 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
32939 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
32940 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
32944 #: ../src/guestfs.pod:1045
32946 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
32947 "L</guestfs_list_partitions> and similar calls return the true names of the "
32948 "devices and partitions as known to the appliance."
32952 #: ../src/guestfs.pod:1050
32953 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
32957 #: ../src/guestfs.pod:1052
32959 "Usually this translation is transparent. However in some (very rare) cases "
32960 "you may need to know the exact algorithm. Such cases include where you use "
32961 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
32962 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
32966 #: ../src/guestfs.pod:1058
32968 "The algorithm is applied only to I<parameters> which are known to be either "
32969 "device or partition names. Return values from functions such as L</"
32970 "guestfs_list_devices> are never changed."
32974 #: ../src/guestfs.pod:1066
32975 msgid "Is the string a parameter which is a device or partition name?"
32979 #: ../src/guestfs.pod:1070
32980 msgid "Does the string begin with C</dev/sd>?"
32984 #: ../src/guestfs.pod:1074
32986 "Does the named device exist? If so, we use that device. However if I<not> "
32987 "then we continue with this algorithm."
32991 #: ../src/guestfs.pod:1079
32992 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
32996 #: ../src/guestfs.pod:1081
32997 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
33001 #: ../src/guestfs.pod:1083
33002 msgid "If that named device exists, use it. If not, continue."
33006 #: ../src/guestfs.pod:1087
33007 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
33011 #: ../src/guestfs.pod:1089
33012 msgid "If that named device exists, use it. If not, return an error."
33016 #: ../src/guestfs.pod:1093
33017 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
33021 #: ../src/guestfs.pod:1095
33023 "Although the standard naming scheme and automatic translation is useful for "
33024 "simple programs and guestfish scripts, for larger programs it is best not to "
33025 "rely on this mechanism."
33029 #: ../src/guestfs.pod:1099
33031 "Where possible for maximum future portability programs using libguestfs "
33032 "should use these future-proof techniques:"
33036 #: ../src/guestfs.pod:1106
33038 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
33039 "device names, and then use those names directly."
33043 #: ../src/guestfs.pod:1109
33045 "Since those device names exist by definition, they will never be translated."
33049 #: ../src/guestfs.pod:1114
33051 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
33052 "filesystem labels."
33056 #: ../src/guestfs.pod:1119
33061 #: ../src/guestfs.pod:1121
33063 "This section discusses security implications of using libguestfs, "
33064 "particularly with untrusted or malicious guests or disk images."
33068 #: ../src/guestfs.pod:1124
33069 msgid "GENERAL SECURITY CONSIDERATIONS"
33073 #: ../src/guestfs.pod:1126
33075 "Be careful with any files or data that you download from a guest (by "
33076 "\"download\" we mean not just the L</guestfs_download> command but any "
33077 "command that reads files, filenames, directories or anything else from a "
33078 "disk image). An attacker could manipulate the data to fool your program "
33079 "into doing the wrong thing. Consider cases such as:"
33083 #: ../src/guestfs.pod:1136
33084 msgid "the data (file etc) not being present"
33088 #: ../src/guestfs.pod:1140
33089 msgid "being present but empty"
33093 #: ../src/guestfs.pod:1144
33094 msgid "being much larger than normal"
33098 #: ../src/guestfs.pod:1148
33099 msgid "containing arbitrary 8 bit data"
33103 #: ../src/guestfs.pod:1152
33104 msgid "being in an unexpected character encoding"
33108 #: ../src/guestfs.pod:1156
33109 msgid "containing homoglyphs."
33113 #: ../src/guestfs.pod:1160
33114 msgid "SECURITY OF MOUNTING FILESYSTEMS"
33118 #: ../src/guestfs.pod:1162
33120 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
33121 "(VFS) module can sometimes be escalated into exploits by deliberately "
33122 "creating a malicious, malformed filesystem. These exploits are very severe "
33123 "for two reasons. Firstly there are very many filesystem drivers in the "
33124 "kernel, and many of them are infrequently used and not much developer "
33125 "attention has been paid to the code. Linux userspace helps potential "
33126 "crackers by detecting the filesystem type and automatically choosing the "
33127 "right VFS driver, even if that filesystem type is obscure or unexpected for "
33128 "the administrator. Secondly, a kernel-level exploit is like a local root "
33129 "exploit (worse in some ways), giving immediate and total access to the "
33130 "system right down to the hardware level."
33134 #: ../src/guestfs.pod:1175
33136 "That explains why you should never mount a filesystem from an untrusted "
33137 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
33138 "inside a qemu virtual machine, usually running as a non-root user. The "
33139 "attacker would need to write a filesystem which first exploited the kernel, "
33140 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
33141 "the libguestfs protocol, and finally to be as serious as the host kernel "
33142 "exploit it would need to escalate its privileges to root. This multi-step "
33143 "escalation, performed by a static piece of data, is thought to be extremely "
33144 "hard to do, although we never say 'never' about security issues."
33148 #: ../src/guestfs.pod:1186
33150 "In any case callers can reduce the attack surface by forcing the filesystem "
33151 "type when mounting (use L</guestfs_mount_vfs>)."
33155 #: ../src/guestfs.pod:1189
33156 msgid "PROTOCOL SECURITY"
33160 #: ../src/guestfs.pod:1191
33162 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
33163 "defined upper message size. However a program that uses libguestfs must "
33164 "also take care - for example you can write a program that downloads a binary "
33165 "from a disk image and executes it locally, and no amount of protocol "
33166 "security will save you from the consequences."
33170 #: ../src/guestfs.pod:1197
33171 msgid "INSPECTION SECURITY"
33175 #: ../src/guestfs.pod:1199
33177 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
33178 "directly from the guest, and these could contain any 8 bit data. Callers "
33179 "should be careful to escape these before printing them to a structured file "
33180 "(for example, use HTML escaping if creating a web page)."
33184 #: ../src/guestfs.pod:1205
33186 "Guest configuration may be altered in unusual ways by the administrator of "
33187 "the virtual machine, and may not reflect reality (particularly for untrusted "
33188 "or actively malicious guests). For example we parse the hostname from "
33189 "configuration files like C</etc/sysconfig/network> that we find in the "
33190 "guest, but the guest administrator can easily manipulate these files to "
33191 "provide the wrong hostname."
33195 #: ../src/guestfs.pod:1213
33197 "The inspection API parses guest configuration using two external libraries: "
33198 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
33199 "designed to be robust in the face of malicious data, although denial of "
33200 "service attacks are still possible, for example with oversized configuration "
33205 #: ../src/guestfs.pod:1219
33206 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
33210 #: ../src/guestfs.pod:1221
33212 "Be very cautious about running commands from the guest. By running a "
33213 "command in the guest, you are giving CPU time to a binary that you do not "
33214 "control, under the same user account as the library, albeit wrapped in qemu "
33215 "virtualization. More information and alternatives can be found in the "
33216 "section L</RUNNING COMMANDS>."
33220 #: ../src/guestfs.pod:1227
33221 msgid "CVE-2010-3851"
33225 #: ../src/guestfs.pod:1229
33226 msgid "https://bugzilla.redhat.com/642934"
33230 #: ../src/guestfs.pod:1231
33232 "This security bug concerns the automatic disk format detection that qemu "
33233 "does on disk images."
33237 #: ../src/guestfs.pod:1234
33239 "A raw disk image is just the raw bytes, there is no header. Other disk "
33240 "images like qcow2 contain a special header. Qemu deals with this by looking "
33241 "for one of the known headers, and if none is found then assuming the disk "
33242 "image must be raw."
33246 #: ../src/guestfs.pod:1239
33248 "This allows a guest which has been given a raw disk image to write some "
33249 "other header. At next boot (or when the disk image is accessed by "
33250 "libguestfs) qemu would do autodetection and think the disk image format was, "
33251 "say, qcow2 based on the header written by the guest."
33255 #: ../src/guestfs.pod:1244
33257 "This in itself would not be a problem, but qcow2 offers many features, one "
33258 "of which is to allow a disk image to refer to another image (called the "
33259 "\"backing disk\"). It does this by placing the path to the backing disk "
33260 "into the qcow2 header. This path is not validated and could point to any "
33261 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
33262 "\"holes\" in the qcow2 disk image, which of course is completely under the "
33263 "control of the attacker."
33267 #: ../src/guestfs.pod:1252
33269 "In libguestfs this is rather hard to exploit except under two circumstances:"
33273 #: ../src/guestfs.pod:1259
33274 msgid "You have enabled the network or have opened the disk in write mode."
33278 #: ../src/guestfs.pod:1263
33280 "You are also running untrusted code from the guest (see L</RUNNING "
33285 #: ../src/guestfs.pod:1268
33287 "The way to avoid this is to specify the expected disk format when adding "
33288 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
33289 "should always do this if the disk is raw format, and it's a good idea for "
33294 #: ../src/guestfs.pod:1273
33296 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
33297 "format is fetched from libvirt and passed through."
33301 #: ../src/guestfs.pod:1276
33303 "For libguestfs tools, use the I<--format> command line parameter as "
33308 #: ../src/guestfs.pod:1279
33309 msgid "CONNECTION MANAGEMENT"
33313 #: ../src/guestfs.pod:1281
33314 msgid "guestfs_h *"
33318 #: ../src/guestfs.pod:1283
33320 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
33321 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
33322 "handle and release all resources used."
33326 #: ../src/guestfs.pod:1287
33328 "For information on using multiple handles and threads, see the section L</"
33329 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
33333 #: ../src/guestfs.pod:1290
33334 msgid "guestfs_create"
33338 #: ../src/guestfs.pod:1292
33341 " guestfs_h *guestfs_create (void);\n"
33346 #: ../src/guestfs.pod:1294
33347 msgid "Create a connection handle."
33351 #: ../src/guestfs.pod:1296
33353 "On success this returns a non-NULL pointer to a handle. On error it returns "
33358 #: ../src/guestfs.pod:1299
33360 "You have to \"configure\" the handle after creating it. This includes "
33361 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
33362 "handle at least once."
33366 #: ../src/guestfs.pod:1303
33367 msgid "After configuring the handle, you have to call L</guestfs_launch>."
33371 #: ../src/guestfs.pod:1305
33373 "You may also want to configure error handling for the handle. See the L</"
33374 "ERROR HANDLING> section below."
33378 #: ../src/guestfs.pod:1308
33379 msgid "guestfs_close"
33383 #: ../src/guestfs.pod:1310
33386 " void guestfs_close (guestfs_h *g);\n"
33391 #: ../src/guestfs.pod:1312
33392 msgid "This closes the connection handle and frees up all resources used."
33396 #: ../src/guestfs.pod:1314
33398 "If autosync was set on the handle and the handle was launched, then this "
33399 "implicitly calls various functions to unmount filesystems and sync the "
33400 "disk. See L</guestfs_set_autosync> for more details."
33404 #: ../src/guestfs.pod:1318
33405 msgid "If a close callback was set on the handle, then it is called."
33409 #: ../src/guestfs.pod:1320
33410 msgid "ERROR HANDLING"
33414 #: ../src/guestfs.pod:1322
33416 "API functions can return errors. For example, almost all functions that "
33417 "return C<int> will return C<-1> to indicate an error."
33421 #: ../src/guestfs.pod:1325
33423 "Additional information is available for errors: an error message string and "
33424 "optionally an error number (errno) if the thing that failed was a system "
33429 #: ../src/guestfs.pod:1329
33431 "You can get at the additional information about the last error on the handle "
33432 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
33433 "up an error handler with L</guestfs_set_error_handler>."
33437 #: ../src/guestfs.pod:1334
33439 "When the handle is created, a default error handler is installed which "
33440 "prints the error message string to C<stderr>. For small short-running "
33441 "command line programs it is sufficient to do:"
33445 #: ../src/guestfs.pod:1338
33448 " if (guestfs_launch (g) == -1)\n"
33449 " exit (EXIT_FAILURE);\n"
33454 #: ../src/guestfs.pod:1341
33456 "since the default error handler will ensure that an error message has been "
33457 "printed to C<stderr> before the program exits."
33461 #: ../src/guestfs.pod:1344
33463 "For other programs the caller will almost certainly want to install an "
33464 "alternate error handler or do error handling in-line like this:"
33468 #: ../src/guestfs.pod:1347
33471 " g = guestfs_create ();\n"
33476 #: ../src/guestfs.pod:1349
33479 " /* This disables the default behaviour of printing errors\n"
33481 " guestfs_set_error_handler (g, NULL, NULL);\n"
33486 #: ../src/guestfs.pod:1353
33489 " if (guestfs_launch (g) == -1) {\n"
33490 " /* Examine the error message and print it etc. */\n"
33491 " char *msg = guestfs_last_error (g);\n"
33492 " int errnum = guestfs_last_errno (g);\n"
33493 " fprintf (stderr, \"%s\\n\", msg);\n"
33500 #: ../src/guestfs.pod:1361
33502 "Out of memory errors are handled differently. The default action is to call "
33503 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
33504 "guestfs_set_out_of_memory_handler>."
33508 #: ../src/guestfs.pod:1365
33510 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
33511 "because there is no handle if this happens there is no way to get additional "
33512 "error information. However L</guestfs_create> is supposed to be a "
33513 "lightweight operation which can only fail because of insufficient memory (it "
33514 "returns NULL in this case)."
33518 #: ../src/guestfs.pod:1371
33519 msgid "guestfs_last_error"
33523 #: ../src/guestfs.pod:1373
33526 " const char *guestfs_last_error (guestfs_h *g);\n"
33531 #: ../src/guestfs.pod:1375
33533 "This returns the last error message that happened on C<g>. If there has not "
33534 "been an error since the handle was created, then this returns C<NULL>."
33538 #: ../src/guestfs.pod:1379
33540 "The lifetime of the returned string is until the next error occurs, or L</"
33541 "guestfs_close> is called."
33545 #: ../src/guestfs.pod:1382
33546 msgid "guestfs_last_errno"
33550 #: ../src/guestfs.pod:1384
33553 " int guestfs_last_errno (guestfs_h *g);\n"
33558 #: ../src/guestfs.pod:1386
33559 msgid "This returns the last error number (errno) that happened on C<g>."
33563 #: ../src/guestfs.pod:1388
33564 msgid "If successful, an errno integer not equal to zero is returned."
33568 #: ../src/guestfs.pod:1390
33570 "If no error, this returns 0. This call can return 0 in three situations:"
33574 #: ../src/guestfs.pod:1397
33575 msgid "There has not been any error on the handle."
33579 #: ../src/guestfs.pod:1401
33581 "There has been an error but the errno was meaningless. This corresponds to "
33582 "the case where the error did not come from a failed system call, but for "
33583 "some other reason."
33587 #: ../src/guestfs.pod:1407
33589 "There was an error from a failed system call, but for some reason the errno "
33590 "was not captured and returned. This usually indicates a bug in libguestfs."
33594 #: ../src/guestfs.pod:1413
33596 "Libguestfs tries to convert the errno from inside the applicance into a "
33597 "corresponding errno for the caller (not entirely trivial: the appliance "
33598 "might be running a completely different operating system from the library "
33599 "and error numbers are not standardized across Un*xen). If this could not be "
33600 "done, then the error is translated to C<EINVAL>. In practice this should "
33601 "only happen in very rare circumstances."
33605 #: ../src/guestfs.pod:1421
33606 msgid "guestfs_set_error_handler"
33610 #: ../src/guestfs.pod:1423
33613 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
33615 " const char *msg);\n"
33616 " void guestfs_set_error_handler (guestfs_h *g,\n"
33617 " guestfs_error_handler_cb cb,\n"
33618 " void *opaque);\n"
33623 #: ../src/guestfs.pod:1430
33625 "The callback C<cb> will be called if there is an error. The parameters "
33626 "passed to the callback are an opaque data pointer and the error message "
33631 #: ../src/guestfs.pod:1434
33633 "C<errno> is not passed to the callback. To get that the callback must call "
33634 "L</guestfs_last_errno>."
33638 #: ../src/guestfs.pod:1437
33640 "Note that the message string C<msg> is freed as soon as the callback "
33641 "function returns, so if you want to stash it somewhere you must make your "
33646 #: ../src/guestfs.pod:1441
33647 msgid "The default handler prints messages on C<stderr>."
33651 #: ../src/guestfs.pod:1443
33652 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
33656 #: ../src/guestfs.pod:1445
33657 msgid "guestfs_get_error_handler"
33661 #: ../src/guestfs.pod:1447
33664 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
33665 " void **opaque_rtn);\n"
33670 #: ../src/guestfs.pod:1450
33671 msgid "Returns the current error handler callback."
33675 #: ../src/guestfs.pod:1452
33676 msgid "guestfs_set_out_of_memory_handler"
33680 #: ../src/guestfs.pod:1454
33683 " typedef void (*guestfs_abort_cb) (void);\n"
33684 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
33685 " guestfs_abort_cb);\n"
33690 #: ../src/guestfs.pod:1458
33692 "The callback C<cb> will be called if there is an out of memory situation. "
33693 "I<Note this callback must not return>."
33697 #: ../src/guestfs.pod:1461
33698 msgid "The default is to call L<abort(3)>."
33702 #: ../src/guestfs.pod:1463
33704 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
33708 #: ../src/guestfs.pod:1466
33709 msgid "guestfs_get_out_of_memory_handler"
33713 #: ../src/guestfs.pod:1468
33716 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
33721 #: ../src/guestfs.pod:1470
33722 msgid "This returns the current out of memory handler."
33726 #: ../src/guestfs.pod:1472
33731 #: ../src/guestfs.pod:1476
33736 #: ../src/guestfs.pod:1478
33741 #: ../src/guestfs.pod:1480
33742 msgid "AVAILABILITY"
33746 #: ../src/guestfs.pod:1482
33747 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
33751 #: ../src/guestfs.pod:1484
33753 "Using L</guestfs_available> you can test availability of the following "
33754 "groups of functions. This test queries the appliance to see if the "
33755 "appliance you are currently using supports the functionality."
33759 #: ../src/guestfs.pod:1489
33760 msgid "@AVAILABILITY@"
33764 #: ../src/guestfs.pod:1491
33765 msgid "GUESTFISH supported COMMAND"
33769 #: ../src/guestfs.pod:1493
33771 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
33772 "prints out the available groups and whether they are supported by this build "
33773 "of libguestfs. Note however that you have to do C<run> first."
33777 #: ../src/guestfs.pod:1498
33778 msgid "SINGLE CALLS AT COMPILE TIME"
33782 #: ../src/guestfs.pod:1500
33784 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
33785 "function, such as:"
33789 #: ../src/guestfs.pod:1503
33792 " #define LIBGUESTFS_HAVE_DD 1\n"
33797 #: ../src/guestfs.pod:1505
33798 msgid "if L</guestfs_dd> is available."
33802 #: ../src/guestfs.pod:1507
33804 "Before version 1.5.8, if you needed to test whether a single libguestfs "
33805 "function is available at compile time, we recommended using build tools such "
33806 "as autoconf or cmake. For example in autotools you could use:"
33810 #: ../src/guestfs.pod:1512
33813 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
33814 " AC_CHECK_FUNCS([guestfs_dd])\n"
33819 #: ../src/guestfs.pod:1515
33821 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
33826 #: ../src/guestfs.pod:1518
33827 msgid "SINGLE CALLS AT RUN TIME"
33831 #: ../src/guestfs.pod:1520
33833 "Testing at compile time doesn't guarantee that a function really exists in "
33834 "the library. The reason is that you might be dynamically linked against a "
33835 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
33836 "This situation unfortunately results in a segmentation fault, which is a "
33837 "shortcoming of the C dynamic linking system itself."
33841 #: ../src/guestfs.pod:1527
33843 "You can use L<dlopen(3)> to test if a function is available at run time, as "
33844 "in this example program (note that you still need the compile time check as "
33849 #: ../src/guestfs.pod:1531
33852 " #include <stdio.h>\n"
33853 " #include <stdlib.h>\n"
33854 " #include <unistd.h>\n"
33855 " #include <dlfcn.h>\n"
33856 " #include <guestfs.h>\n"
33861 #: ../src/guestfs.pod:1537
33866 " #ifdef LIBGUESTFS_HAVE_DD\n"
33868 " int has_function;\n"
33873 #: ../src/guestfs.pod:1543
33876 " /* Test if the function guestfs_dd is really available. */\n"
33877 " dl = dlopen (NULL, RTLD_LAZY);\n"
33879 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
33880 " exit (EXIT_FAILURE);\n"
33882 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
33888 #: ../src/guestfs.pod:1552
33891 " if (!has_function)\n"
33892 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
33894 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
33895 " /* Now it's safe to call\n"
33896 " guestfs_dd (g, \"foo\", \"bar\");\n"
33900 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
33907 #: ../src/guestfs.pod:1565
33909 "You may think the above is an awful lot of hassle, and it is. There are "
33910 "other ways outside of the C linking system to ensure that this kind of "
33911 "incompatibility never arises, such as using package versioning:"
33915 #: ../src/guestfs.pod:1570
33918 " Requires: libguestfs >= 1.0.80\n"
33923 #: ../src/guestfs.pod:1572
33924 msgid "CALLS WITH OPTIONAL ARGUMENTS"
33928 #: ../src/guestfs.pod:1574
33930 "A recent feature of the API is the introduction of calls which take optional "
33931 "arguments. In C these are declared 3 ways. The main way is as a call which "
33932 "takes variable arguments (ie. C<...>), as in this example:"
33936 #: ../src/guestfs.pod:1579
33939 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
33944 #: ../src/guestfs.pod:1581
33946 "Call this with a list of optional arguments, terminated by C<-1>. So to "
33947 "call with no optional arguments specified:"
33951 #: ../src/guestfs.pod:1584
33954 " guestfs_add_drive_opts (g, filename, -1);\n"
33959 #: ../src/guestfs.pod:1586
33960 msgid "With a single optional argument:"
33964 #: ../src/guestfs.pod:1588
33967 " guestfs_add_drive_opts (g, filename,\n"
33968 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33974 #: ../src/guestfs.pod:1592
33979 #: ../src/guestfs.pod:1594
33982 " guestfs_add_drive_opts (g, filename,\n"
33983 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33984 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
33990 #: ../src/guestfs.pod:1599
33992 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
33997 #: ../src/guestfs.pod:1602
33998 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
34002 #: ../src/guestfs.pod:1604
34004 "The second variant has the same name with the suffix C<_va>, which works the "
34005 "same way but takes a C<va_list>. See the C manual for details. For the "
34006 "example function, this is declared:"
34010 #: ../src/guestfs.pod:1608
34013 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
34014 " va_list args);\n"
34019 #: ../src/guestfs.pod:1611
34020 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
34024 #: ../src/guestfs.pod:1613
34026 "The third variant is useful where you need to construct these calls. You "
34027 "pass in a structure where you fill in the optional fields. The structure "
34028 "has a bitmask as the first element which you must set to indicate which "
34029 "fields you have filled in. For our example function the structure and call "
34034 #: ../src/guestfs.pod:1619
34037 " struct guestfs_add_drive_opts_argv {\n"
34038 " uint64_t bitmask;\n"
34040 " const char *format;\n"
34043 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
34044 " const struct guestfs_add_drive_opts_argv *optargs);\n"
34049 #: ../src/guestfs.pod:1628
34050 msgid "You could call it like this:"
34054 #: ../src/guestfs.pod:1630
34057 " struct guestfs_add_drive_opts_argv optargs = {\n"
34058 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
34059 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
34060 " .readonly = 1,\n"
34061 " .format = \"qcow2\"\n"
34067 #: ../src/guestfs.pod:1637
34070 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
34075 #: ../src/guestfs.pod:1645
34076 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
34080 #: ../src/guestfs.pod:1650
34081 msgid "You do not need to fill in all fields of the structure."
34085 #: ../src/guestfs.pod:1654
34087 "There must be a one-to-one correspondence between fields of the structure "
34088 "that are filled in, and bits set in the bitmask."
34092 #: ../src/guestfs.pod:1659
34093 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
34097 #: ../src/guestfs.pod:1661
34099 "In other languages, optional arguments are expressed in the way that is "
34100 "natural for that language. We refer you to the language-specific "
34101 "documentation for more details on that."
34105 #: ../src/guestfs.pod:1665
34106 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
34110 #: ../src/guestfs.pod:1667
34111 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
34115 #: ../src/guestfs.pod:1669
34117 "B<Note:> This section documents the generic event mechanism introduced in "
34118 "libguestfs 1.10, which you should use in new code if possible. The old "
34119 "functions C<guestfs_set_log_message_callback>, "
34120 "C<guestfs_set_subprocess_quit_callback>, "
34121 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
34122 "C<guestfs_set_progress_callback> are no longer documented in this manual "
34123 "page. Because of the ABI guarantee, the old functions continue to work."
34127 #: ../src/guestfs.pod:1678
34129 "Handles generate events when certain things happen, such as log messages "
34130 "being generated, progress messages during long-running operations, or the "
34131 "handle being closed. The API calls described below let you register a "
34132 "callback to be called when events happen. You can register multiple "
34133 "callbacks (for the same, different or overlapping sets of events), and "
34134 "individually remove callbacks. If callbacks are not removed, then they "
34135 "remain in force until the handle is closed."
34139 #: ../src/guestfs.pod:1686
34141 "In the current implementation, events are only generated synchronously: that "
34142 "means that events (and hence callbacks) can only happen while you are in the "
34143 "middle of making another libguestfs call. The callback is called in the "
34148 #: ../src/guestfs.pod:1691
34150 "Events may contain a payload, usually nothing (void), an array of 64 bit "
34151 "unsigned integers, or a message buffer. Payloads are discussed later on."
34155 #: ../src/guestfs.pod:1695
34156 msgid "CLASSES OF EVENTS"
34160 #: ../src/guestfs.pod:1699
34161 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
34165 #: ../src/guestfs.pod:1702
34167 "The callback function will be called while the handle is being closed "
34168 "(synchronously from L</guestfs_close>)."
34172 #: ../src/guestfs.pod:1705
34174 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
34175 "handles that are open when the program exits. This means that this callback "
34176 "might be called indirectly from L<exit(3)>, which can cause unexpected "
34177 "problems in higher-level languages (eg. if your HLL interpreter has already "
34178 "been cleaned up by the time this is called, and if your callback then jumps "
34179 "into some HLL function)."
34183 #: ../src/guestfs.pod:1712
34185 "If no callback is registered: the handle is closed without any callback "
34190 #: ../src/guestfs.pod:1715
34191 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
34195 #: ../src/guestfs.pod:1718
34197 "The callback function will be called when the child process quits, either "
34198 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
34199 "corresponds to a transition from any state to the CONFIG state)."
34203 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
34204 msgid "If no callback is registered: the event is ignored."
34208 #: ../src/guestfs.pod:1724
34209 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
34213 #: ../src/guestfs.pod:1727
34215 "The callback function will be called when the child process becomes ready "
34216 "first time after it has been launched. (This corresponds to a transition "
34217 "from LAUNCHING to the READY state)."
34221 #: ../src/guestfs.pod:1733
34222 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
34226 #: ../src/guestfs.pod:1736
34228 "Some long-running operations can generate progress messages. If this "
34229 "callback is registered, then it will be called each time a progress message "
34230 "is generated (usually two seconds after the operation started, and three "
34231 "times per second thereafter until it completes, although the frequency may "
34232 "change in future versions)."
34236 #: ../src/guestfs.pod:1742
34238 "The callback receives in the payload four unsigned 64 bit numbers which are "
34239 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
34243 #: ../src/guestfs.pod:1745
34245 "The units of C<total> are not defined, although for some operations C<total> "
34246 "may relate in some way to the amount of data to be transferred (eg. in bytes "
34247 "or megabytes), and C<position> may be the portion which has been transferred."
34251 #: ../src/guestfs.pod:1750
34252 msgid "The only defined and stable parts of the API are:"
34256 #: ../src/guestfs.pod:1756
34258 "The callback can display to the user some type of progress bar or indicator "
34259 "which shows the ratio of C<position>:C<total>."
34263 #: ../src/guestfs.pod:1761
34264 msgid "0 E<lt>= C<position> E<lt>= C<total>"
34268 #: ../src/guestfs.pod:1765
34270 "If any progress notification is sent during a call, then a final progress "
34271 "notification is always sent when C<position> = C<total> (I<unless> the call "
34272 "fails with an error)."
34276 #: ../src/guestfs.pod:1769
34278 "This is to simplify caller code, so callers can easily set the progress "
34279 "indicator to \"100%\" at the end of the operation, without requiring special "
34280 "code to detect this case."
34284 #: ../src/guestfs.pod:1775
34286 "For some calls we are unable to estimate the progress of the call, but we "
34287 "can still generate progress messages to indicate activity. This is known as "
34288 "\"pulse mode\", and is directly supported by certain progress bar "
34289 "implementations (eg. GtkProgressBar)."
34293 #: ../src/guestfs.pod:1780
34295 "For these calls, zero or more progress messages are generated with "
34296 "C<position = 0> and C<total = 1>, followed by a final message with "
34297 "C<position = total = 1>."
34301 #: ../src/guestfs.pod:1784
34303 "As noted above, if the call fails with an error then the final message may "
34304 "not be generated."
34308 #: ../src/guestfs.pod:1789
34310 "The callback also receives the procedure number (C<proc_nr>) and serial "
34311 "number (C<serial>) of the call. These are only useful for debugging "
34312 "protocol issues, and the callback can normally ignore them. The callback "
34313 "may want to print these numbers in error messages or debugging messages."
34317 #: ../src/guestfs.pod:1795
34318 msgid "If no callback is registered: progress messages are discarded."
34322 #: ../src/guestfs.pod:1797
34323 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
34327 #: ../src/guestfs.pod:1800
34329 "The callback function is called whenever a log message is generated by qemu, "
34330 "the appliance kernel, guestfsd (daemon), or utility programs."
34334 #: ../src/guestfs.pod:1803
34336 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
34337 "guestfs_launch>) then additional debug messages are generated."
34341 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
34343 "If no callback is registered: the messages are discarded unless the verbose "
34344 "flag is set in which case they are sent to stderr. You can override the "
34345 "printing of verbose messages to stderr by setting up a callback."
34349 #: ../src/guestfs.pod:1811
34350 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
34354 #: ../src/guestfs.pod:1814
34356 "The callback function is called whenever a log message is generated by the "
34357 "library part of libguestfs."
34361 #: ../src/guestfs.pod:1817
34363 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
34364 "messages are generated."
34368 #: ../src/guestfs.pod:1825
34369 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
34373 #: ../src/guestfs.pod:1828
34375 "The callback function is called whenever a trace message is generated. This "
34376 "only applies if the trace flag (L</guestfs_set_trace>) is set."
34380 #: ../src/guestfs.pod:1831
34382 "If no callback is registered: the messages are sent to stderr. You can "
34383 "override the printing of trace messages to stderr by setting up a callback."
34387 #: ../src/guestfs.pod:1837
34388 msgid "guestfs_set_event_callback"
34392 #: ../src/guestfs.pod:1839
34395 " int guestfs_set_event_callback (guestfs_h *g,\n"
34396 " guestfs_event_callback cb,\n"
34397 " uint64_t event_bitmask,\n"
34399 " void *opaque);\n"
34404 #: ../src/guestfs.pod:1845
34406 "This function registers a callback (C<cb>) for all event classes in the "
34407 "C<event_bitmask>."
34411 #: ../src/guestfs.pod:1848
34413 "For example, to register for all log message events, you could call this "
34414 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
34415 "To register a single callback for all possible classes of events, use "
34416 "C<GUESTFS_EVENT_ALL>."
34420 #: ../src/guestfs.pod:1854
34421 msgid "C<flags> should always be passed as 0."
34425 #: ../src/guestfs.pod:1856
34427 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
34428 "it for any purpose."
34432 #: ../src/guestfs.pod:1859
34434 "The return value is the event handle (an integer) which you can use to "
34435 "delete the callback (see below)."
34439 #: ../src/guestfs.pod:1862
34441 "If there is an error, this function returns C<-1>, and sets the error in the "
34442 "handle in the usual way (see L</guestfs_last_error> etc.)"
34446 #: ../src/guestfs.pod:1865
34448 "Callbacks remain in effect until they are deleted, or until the handle is "
34453 #: ../src/guestfs.pod:1868
34455 "In the case where multiple callbacks are registered for a particular event "
34456 "class, all of the callbacks are called. The order in which multiple "
34457 "callbacks are called is not defined."
34461 #: ../src/guestfs.pod:1872
34462 msgid "guestfs_delete_event_callback"
34466 #: ../src/guestfs.pod:1874
34469 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
34474 #: ../src/guestfs.pod:1876
34476 "Delete a callback that was previously registered. C<event_handle> should be "
34477 "the integer that was returned by a previous call to "
34478 "C<guestfs_set_event_callback> on the same handle."
34482 #: ../src/guestfs.pod:1880
34483 msgid "guestfs_event_callback"
34487 #: ../src/guestfs.pod:1882
34490 " typedef void (*guestfs_event_callback) (\n"
34493 " uint64_t event,\n"
34494 " int event_handle,\n"
34496 " const char *buf, size_t buf_len,\n"
34497 " const uint64_t *array, size_t array_len);\n"
34502 #: ../src/guestfs.pod:1891
34504 "This is the type of the event callback function that you have to provide."
34508 #: ../src/guestfs.pod:1894
34510 "The basic parameters are: the handle (C<g>), the opaque user pointer "
34511 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
34512 "handle, and C<flags> which in the current API you should ignore."
34516 #: ../src/guestfs.pod:1898
34518 "The remaining parameters contain the event payload (if any). Each event may "
34519 "contain a payload, which usually relates to the event class, but for future "
34520 "proofing your code should be written to handle any payload for any event "
34525 #: ../src/guestfs.pod:1903
34527 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
34528 "there is no message buffer). Note that this message buffer can contain "
34529 "arbitrary 8 bit data, including NUL bytes."
34533 #: ../src/guestfs.pod:1907
34535 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
34536 "moment this is only used for progress messages."
34540 #: ../src/guestfs.pod:1910
34541 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
34545 #: ../src/guestfs.pod:1912
34547 "One motivation for the generic event API was to allow GUI programs to "
34548 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
34549 "unconditionally to C<stderr>."
34553 #: ../src/guestfs.pod:1916
34555 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
34556 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
34557 "messages are not events; you must capture error messages separately)."
34561 #: ../src/guestfs.pod:1921
34563 "Programs have to set up a callback to capture the classes of events of "
34568 #: ../src/guestfs.pod:1924
34572 " guestfs_set_event_callback\n"
34573 " (g, message_callback,\n"
34574 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
34575 " GUESTFS_EVENT_TRACE,\n"
34576 " 0, NULL) == -1)\n"
34577 " if (eh == -1) {\n"
34578 " // handle error in the usual way\n"
34584 #: ../src/guestfs.pod:1934
34586 "The callback can then direct messages to the appropriate place. In this "
34587 "example, messages are directed to syslog:"
34591 #: ../src/guestfs.pod:1937
34595 " message_callback (\n"
34598 " uint64_t event,\n"
34599 " int event_handle,\n"
34601 " const char *buf, size_t buf_len,\n"
34602 " const uint64_t *array, size_t array_len)\n"
34604 " const int priority = LOG_USER|LOG_INFO;\n"
34605 " if (buf_len > 0)\n"
34606 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
34612 #: ../src/guestfs.pod:1952
34613 msgid "CANCELLING LONG TRANSFERS"
34617 #: ../src/guestfs.pod:1954
34619 "Some operations can be cancelled by the caller while they are in progress. "
34620 "Currently only operations that involve uploading or downloading data can be "
34621 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
34622 "parameters in the generator)."
34626 #: ../src/guestfs.pod:1959
34627 msgid "guestfs_user_cancel"
34631 #: ../src/guestfs.pod:1961
34634 " void guestfs_user_cancel (guestfs_h *g);\n"
34639 #: ../src/guestfs.pod:1963
34641 "C<guestfs_user_cancel> cancels the current upload or download operation."
34645 #: ../src/guestfs.pod:1966
34647 "Unlike most other libguestfs calls, this function is signal safe and thread "
34648 "safe. You can call it from a signal handler or from another thread, without "
34649 "needing to do any locking."
34653 #: ../src/guestfs.pod:1970
34655 "The transfer that was in progress (if there is one) will stop shortly "
34656 "afterwards, and will return an error. The errno (see L</"
34657 "guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
34658 "out if the operation was cancelled or failed because of another error."
34662 #: ../src/guestfs.pod:1976
34664 "No cleanup is performed: for example, if a file was being uploaded then "
34665 "after cancellation there may be a partially uploaded file. It is the "
34666 "caller's responsibility to clean up if necessary."
34670 #: ../src/guestfs.pod:1980
34671 msgid "There are two common places that you might call C<guestfs_user_cancel>."
34675 #: ../src/guestfs.pod:1982
34677 "In an interactive text-based program, you might call it from a C<SIGINT> "
34678 "signal handler so that pressing C<^C> cancels the current operation. (You "
34679 "also need to call L</guestfs_set_pgroup> so that child processes don't "
34680 "receive the C<^C> signal)."
34684 #: ../src/guestfs.pod:1987
34686 "In a graphical program, when the main thread is displaying a progress bar "
34687 "with a cancel button, wire up the cancel button to call this function."
34691 #: ../src/guestfs.pod:1991
34692 msgid "PRIVATE DATA AREA"
34696 #: ../src/guestfs.pod:1993
34698 "You can attach named pieces of private data to the libguestfs handle, fetch "
34699 "them by name, and walk over them, for the lifetime of the handle. This is "
34700 "called the private data area and is only available from the C API."
34704 #: ../src/guestfs.pod:1998
34705 msgid "To attach a named piece of data, use the following call:"
34709 #: ../src/guestfs.pod:2000
34712 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
34717 #: ../src/guestfs.pod:2002
34719 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
34720 "pointer (which can be C<NULL>). Any previous item with the same key is "
34725 #: ../src/guestfs.pod:2006
34727 "You can use any C<key> you want, but your key should I<not> start with an "
34728 "underscore character. Keys beginning with an underscore character are "
34729 "reserved for internal libguestfs purposes (eg. for implementing language "
34730 "bindings). It is recommended that you prefix the key with some unique "
34731 "string to avoid collisions with other users."
34735 #: ../src/guestfs.pod:2012
34736 msgid "To retrieve the pointer, use:"
34740 #: ../src/guestfs.pod:2014
34743 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
34748 #: ../src/guestfs.pod:2016
34750 "This function returns C<NULL> if either no data is found associated with "
34751 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
34756 #: ../src/guestfs.pod:2020
34758 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
34759 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
34760 "all. In particular, libguestfs does I<not> try to free the data when the "
34761 "handle is closed. If the data must be freed, then the caller must either "
34762 "free it before calling L</guestfs_close> or must set up a close callback to "
34763 "do it (see L</GUESTFS_EVENT_CLOSE>)."
34767 #: ../src/guestfs.pod:2027
34768 msgid "To walk over all entries, use these two functions:"
34772 #: ../src/guestfs.pod:2029
34775 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
34780 #: ../src/guestfs.pod:2031
34783 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
34788 #: ../src/guestfs.pod:2033
34790 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
34791 "not have any particular meaning -- keys are not returned in any defined "
34792 "order). A pointer to the key is returned in C<*key_rtn> and the "
34793 "corresponding data pointer is returned from the function. C<NULL> is "
34794 "returned if there are no keys stored in the handle."
34798 #: ../src/guestfs.pod:2039
34800 "C<guestfs_next_private> returns the next key, pointer pair. The return "
34801 "value of this function is also C<NULL> is there are no further entries to "
34806 #: ../src/guestfs.pod:2043
34807 msgid "Notes about walking over entries:"
34811 #: ../src/guestfs.pod:2049
34813 "You must not call C<guestfs_set_private> while walking over the entries."
34817 #: ../src/guestfs.pod:2054
34819 "The handle maintains an internal iterator which is reset when you call "
34820 "C<guestfs_first_private>. This internal iterator is invalidated when you "
34821 "call C<guestfs_set_private>."
34825 #: ../src/guestfs.pod:2060
34826 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
34830 #: ../src/guestfs.pod:2062
34833 " guestfs_set_private (g, key, NULL);\n"
34838 #: ../src/guestfs.pod:2064
34839 msgid "then that C<key> is not returned when walking."
34843 #: ../src/guestfs.pod:2068
34845 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
34846 "C<guestfs_next_private> or C<guestfs_set_private>."
34850 #: ../src/guestfs.pod:2074
34852 "The following example code shows how to print all keys and data pointers "
34853 "that are associated with the handle C<g>:"
34857 #: ../src/guestfs.pod:2077
34860 " const char *key;\n"
34861 " void *data = guestfs_first_private (g, &key);\n"
34862 " while (data != NULL)\n"
34864 " printf (\"key = %s, data = %p\\n\", key, data);\n"
34865 " data = guestfs_next_private (g, &key);\n"
34871 #: ../src/guestfs.pod:2085
34873 "More commonly you are only interested in keys that begin with an application-"
34874 "specific prefix C<foo_>. Modify the loop like so:"
34878 #: ../src/guestfs.pod:2088
34881 " const char *key;\n"
34882 " void *data = guestfs_first_private (g, &key);\n"
34883 " while (data != NULL)\n"
34885 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34886 " printf (\"key = %s, data = %p\\n\", key, data);\n"
34887 " data = guestfs_next_private (g, &key);\n"
34893 #: ../src/guestfs.pod:2097
34895 "If you need to modify keys while walking, then you have to jump back to the "
34896 "beginning of the loop. For example, to delete all keys prefixed with "
34901 #: ../src/guestfs.pod:2101
34904 " const char *key;\n"
34907 " data = guestfs_first_private (g, &key);\n"
34908 " while (data != NULL)\n"
34910 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34912 " guestfs_set_private (g, key, NULL);\n"
34913 " /* note that 'key' pointer is now invalid, and so is\n"
34914 " the internal iterator */\n"
34917 " data = guestfs_next_private (g, &key);\n"
34923 #: ../src/guestfs.pod:2117
34925 "Note that the above loop is guaranteed to terminate because the keys are "
34926 "being deleted, but other manipulations of keys within the loop might not "
34927 "terminate unless you also maintain an indication of which keys have been "
34932 #: ../src/guestfs.pod:2122 ../src/guestfs.pod:2127
34937 #: ../src/guestfs.pod:2124
34939 "<!-- old anchor for the next section --> <a name="
34940 "\"state_machine_and_low_level_event_api\"/>"
34944 #: ../src/guestfs.pod:2129
34945 msgid "ARCHITECTURE"
34949 #: ../src/guestfs.pod:2131
34951 "Internally, libguestfs is implemented by running an appliance (a special "
34952 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
34953 "process of the main program."
34957 #: ../src/guestfs.pod:2135
34960 " ___________________\n"
34962 " | main program |\n"
34964 " | | child process / appliance\n"
34965 " | | __________________________\n"
34967 " +-------------------+ RPC | +-----------------+ |\n"
34968 " | libguestfs <--------------------> guestfsd | |\n"
34969 " | | | +-----------------+ |\n"
34970 " \\___________________/ | | Linux kernel | |\n"
34971 " | +--^--------------+ |\n"
34972 " \\_________|________________/\n"
34974 " _______v______\n"
34977 " | disk image |\n"
34978 " \\______________/\n"
34983 #: ../src/guestfs.pod:2155
34985 "The library, linked to the main program, creates the child process and hence "
34986 "the appliance in the L</guestfs_launch> function."
34990 #: ../src/guestfs.pod:2158
34992 "Inside the appliance is a Linux kernel and a complete stack of userspace "
34993 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
34994 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
34995 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
34996 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
34997 "attached to the qemu process which translates device access by the "
34998 "appliance's Linux kernel into accesses to the image."
35002 #: ../src/guestfs.pod:2167
35004 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
35005 "Although the disk image you are attached to might also be used by some "
35006 "virtual machine, libguestfs doesn't know or care about this. (But you will "
35007 "care if both libguestfs's qemu process and your virtual machine are trying "
35008 "to update the disk image at the same time, since these usually results in "
35009 "massive disk corruption)."
35013 #: ../src/guestfs.pod:2174
35014 msgid "STATE MACHINE"
35018 #: ../src/guestfs.pod:2176
35019 msgid "libguestfs uses a state machine to model the child process:"
35023 #: ../src/guestfs.pod:2178
35027 " guestfs_create\n"
35035 " / | \\ \\ guestfs_launch\n"
35036 " / | _\\__V______\n"
35038 " / | | LAUNCHING |\n"
35039 " / | \\___________/\n"
35041 " / | guestfs_launch\n"
35043 " ______ / __|____V\n"
35044 " / \\ ------> / \\\n"
35045 " | BUSY | | READY |\n"
35046 " \\______/ <------ \\________/\n"
35051 #: ../src/guestfs.pod:2200
35053 "The normal transitions are (1) CONFIG (when the handle is created, but there "
35054 "is no child process), (2) LAUNCHING (when the child process is booting up), "
35055 "(3) alternating between READY and BUSY as commands are issued to, and "
35056 "carried out by, the child process."
35060 #: ../src/guestfs.pod:2205
35062 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
35063 "asynchronously at any time (eg. due to some internal error), and that causes "
35064 "the state to transition back to CONFIG."
35068 #: ../src/guestfs.pod:2209
35070 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
35071 "issued when in the CONFIG state."
35075 #: ../src/guestfs.pod:2212
35077 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
35078 "L</guestfs_launch> blocks until the child process is READY to accept "
35079 "commands (or until some failure or timeout). L</guestfs_launch> internally "
35080 "moves the state from CONFIG to LAUNCHING while it is running."
35084 #: ../src/guestfs.pod:2218
35086 "API actions such as L</guestfs_mount> can only be issued when in the READY "
35087 "state. These API calls block waiting for the command to be carried out (ie. "
35088 "the state to transition to BUSY and then back to READY). There are no non-"
35089 "blocking versions, and no way to issue more than one command per handle at "
35094 #: ../src/guestfs.pod:2224
35096 "Finally, the child process sends asynchronous messages back to the main "
35097 "program, such as kernel log messages. You can register a callback to "
35098 "receive these messages."
35102 #: ../src/guestfs.pod:2228
35107 #: ../src/guestfs.pod:2230
35108 msgid "COMMUNICATION PROTOCOL"
35112 #: ../src/guestfs.pod:2232
35114 "Don't rely on using this protocol directly. This section documents how it "
35115 "currently works, but it may change at any time."
35119 #: ../src/guestfs.pod:2235
35121 "The protocol used to talk between the library and the daemon running inside "
35122 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
35123 "1014, RFC 1832, RFC 4506)."
35127 #: ../src/guestfs.pod:2239
35129 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
35130 "this file is automatically generated)."
35134 #: ../src/guestfs.pod:2242
35136 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
35137 "and C<FileOut> parameters, which are handled with very simple request/reply "
35138 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
35139 "parameters, which use the same request and reply messages, but they may also "
35140 "be followed by files sent using a chunked encoding."
35144 #: ../src/guestfs.pod:2249
35145 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
35149 #: ../src/guestfs.pod:2251
35150 msgid "For ordinary functions, the request message is:"
35154 #: ../src/guestfs.pod:2253
35157 " total length (header + arguments,\n"
35158 " but not including the length word itself)\n"
35159 " struct guestfs_message_header (encoded as XDR)\n"
35160 " struct guestfs_<foo>_args (encoded as XDR)\n"
35165 #: ../src/guestfs.pod:2258
35167 "The total length field allows the daemon to allocate a fixed size buffer "
35168 "into which it slurps the rest of the message. As a result, the total length "
35169 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
35170 "effective size of any request is limited to somewhere under this size."
35174 #: ../src/guestfs.pod:2264
35176 "Note also that many functions don't take any arguments, in which case the "
35177 "C<guestfs_I<foo>_args> is completely omitted."
35181 #: ../src/guestfs.pod:2267
35183 "The header contains the procedure number (C<guestfs_proc>) which is how the "
35184 "receiver knows what type of args structure to expect, or none at all."
35188 #: ../src/guestfs.pod:2271
35190 "For functions that take optional arguments, the optional arguments are "
35191 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
35192 "arguments. A bitmask in the header indicates which optional arguments are "
35193 "meaningful. The bitmask is also checked to see if it contains bits set "
35194 "which the daemon does not know about (eg. if more optional arguments were "
35195 "added in a later version of the library), and this causes the call to be "
35200 #: ../src/guestfs.pod:2279
35201 msgid "The reply message for ordinary functions is:"
35205 #: ../src/guestfs.pod:2281
35208 " total length (header + ret,\n"
35209 " but not including the length word itself)\n"
35210 " struct guestfs_message_header (encoded as XDR)\n"
35211 " struct guestfs_<foo>_ret (encoded as XDR)\n"
35216 #: ../src/guestfs.pod:2286
35218 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
35219 "functions that return no formal return values."
35223 #: ../src/guestfs.pod:2289
35225 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
35229 #: ../src/guestfs.pod:2292
35231 "In the case of an error, a flag is set in the header, and the reply message "
35232 "is slightly changed:"
35236 #: ../src/guestfs.pod:2295
35239 " total length (header + error,\n"
35240 " but not including the length word itself)\n"
35241 " struct guestfs_message_header (encoded as XDR)\n"
35242 " struct guestfs_message_error (encoded as XDR)\n"
35247 #: ../src/guestfs.pod:2300
35249 "The C<guestfs_message_error> structure contains the error message as a "
35254 #: ../src/guestfs.pod:2303
35255 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
35259 #: ../src/guestfs.pod:2305
35261 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
35262 "The normal request message is sent (see above). However this is followed by "
35263 "a sequence of file chunks."
35267 #: ../src/guestfs.pod:2309
35270 " total length (header + arguments,\n"
35271 " but not including the length word itself,\n"
35272 " and not including the chunks)\n"
35273 " struct guestfs_message_header (encoded as XDR)\n"
35274 " struct guestfs_<foo>_args (encoded as XDR)\n"
35275 " sequence of chunks for FileIn param #0\n"
35276 " sequence of chunks for FileIn param #1 etc.\n"
35281 #: ../src/guestfs.pod:2317
35282 msgid "The \"sequence of chunks\" is:"
35286 #: ../src/guestfs.pod:2319
35289 " length of chunk (not including length word itself)\n"
35290 " struct guestfs_chunk (encoded as XDR)\n"
35291 " length of chunk\n"
35292 " struct guestfs_chunk (encoded as XDR)\n"
35294 " length of chunk\n"
35295 " struct guestfs_chunk (with data.data_len == 0)\n"
35300 #: ../src/guestfs.pod:2327
35302 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
35303 "is set in the final chunk to indicate either successful completion or early "
35308 #: ../src/guestfs.pod:2331
35310 "At time of writing there are no functions that have more than one FileIn "
35311 "parameter. However this is (theoretically) supported, by sending the "
35312 "sequence of chunks for each FileIn parameter one after another (from left to "
35317 #: ../src/guestfs.pod:2336
35319 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
35320 "transfer. The library does this by sending a chunk with a special flag set "
35321 "to indicate cancellation. When the daemon sees this, it cancels the whole "
35322 "RPC, does I<not> send any reply, and goes back to reading the next request."
35326 #: ../src/guestfs.pod:2342
35328 "The daemon may also cancel. It does this by writing a special word "
35329 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
35330 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
35331 "cancel chunk). The special word is chosen so that even if cancellation "
35332 "happens right at the end of the transfer (after the library has finished "
35333 "writing and has started listening for the reply), the \"spurious\" cancel "
35334 "flag will not be confused with the reply message."
35338 #: ../src/guestfs.pod:2351
35340 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
35341 "limit), and also files where the size is not known in advance (eg. from "
35342 "pipes or sockets). However the chunks are rather small "
35343 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
35344 "to keep much in memory."
35348 #: ../src/guestfs.pod:2357
35349 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
35353 #: ../src/guestfs.pod:2359
35355 "The protocol for FileOut parameters is exactly the same as for FileIn "
35356 "parameters, but with the roles of daemon and library reversed."
35360 #: ../src/guestfs.pod:2362
35363 " total length (header + ret,\n"
35364 " but not including the length word itself,\n"
35365 " and not including the chunks)\n"
35366 " struct guestfs_message_header (encoded as XDR)\n"
35367 " struct guestfs_<foo>_ret (encoded as XDR)\n"
35368 " sequence of chunks for FileOut param #0\n"
35369 " sequence of chunks for FileOut param #1 etc.\n"
35374 #: ../src/guestfs.pod:2370
35375 msgid "INITIAL MESSAGE"
35379 #: ../src/guestfs.pod:2372
35381 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
35382 "which indicates that the guest and daemon is alive. This is what L</"
35383 "guestfs_launch> waits for."
35387 #: ../src/guestfs.pod:2376
35388 msgid "PROGRESS NOTIFICATION MESSAGES"
35392 #: ../src/guestfs.pod:2378
35394 "The daemon may send progress notification messages at any time. These are "
35395 "distinguished by the normal length word being replaced by "
35396 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
35400 #: ../src/guestfs.pod:2382
35402 "The library turns them into progress callbacks (see L</"
35403 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
35408 #: ../src/guestfs.pod:2386
35410 "The daemon self-limits the frequency of progress messages it sends (see "
35411 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
35416 #: ../src/guestfs.pod:2390
35417 msgid "LIBGUESTFS VERSION NUMBERS"
35421 #: ../src/guestfs.pod:2392
35423 "Since April 2010, libguestfs has started to make separate development and "
35424 "stable releases, along with corresponding branches in our git repository. "
35425 "These separate releases can be identified by version number:"
35429 #: ../src/guestfs.pod:2397
35432 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
35433 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
35439 " | `-------- sub-version\n"
35441 " `------ always '1' because we don't change the ABI\n"
35446 #: ../src/guestfs.pod:2408
35447 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
35451 #: ../src/guestfs.pod:2410
35453 "As time passes we cherry pick fixes from the development branch and backport "
35454 "those into the stable branch, the effect being that the stable branch should "
35455 "get more stable and less buggy over time. So the stable releases are ideal "
35456 "for people who don't need new features but would just like the software to "
35461 #: ../src/guestfs.pod:2416
35462 msgid "Our criteria for backporting changes are:"
35466 #: ../src/guestfs.pod:2422
35468 "Documentation changes which don't affect any code are backported unless the "
35469 "documentation refers to a future feature which is not in stable."
35473 #: ../src/guestfs.pod:2428
35475 "Bug fixes which are not controversial, fix obvious problems, and have been "
35476 "well tested are backported."
35480 #: ../src/guestfs.pod:2433
35482 "Simple rearrangements of code which shouldn't affect how it works get "
35483 "backported. This is so that the code in the two branches doesn't get too "
35484 "far out of step, allowing us to backport future fixes more easily."
35488 #: ../src/guestfs.pod:2439
35490 "We I<don't> backport new features, new APIs, new tools etc, except in one "
35491 "exceptional case: the new feature is required in order to implement an "
35492 "important bug fix."
35496 #: ../src/guestfs.pod:2445
35498 "A new stable branch starts when we think the new features in development are "
35499 "substantial and compelling enough over the current stable branch to warrant "
35500 "it. When that happens we create new stable and development versions 1.N.0 "
35501 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
35502 "stable at this point, but by backporting fixes from development, that branch "
35503 "will stabilize over time."
35507 #: ../src/guestfs.pod:2453
35508 msgid "EXTENDING LIBGUESTFS"
35512 #: ../src/guestfs.pod:2455
35513 msgid "ADDING A NEW API ACTION"
35517 #: ../src/guestfs.pod:2457
35519 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
35520 "documentation) are generated, and this makes it easy to extend the "
35525 #: ../src/guestfs.pod:2461
35526 msgid "To add a new API action there are two changes:"
35530 #: ../src/guestfs.pod:2467
35532 "You need to add a description of the call (name, parameters, return type, "
35533 "tests, documentation) to C<generator/generator_actions.ml>."
35537 #: ../src/guestfs.pod:2470
35539 "There are two sorts of API action, depending on whether the call goes "
35540 "through to the daemon in the appliance, or is serviced entirely by the "
35541 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
35542 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
35543 "an example of the latter, since a trace flag is maintained in the handle and "
35544 "all tracing is done on the library side."
35548 #: ../src/guestfs.pod:2478
35550 "Most new actions are of the first type, and get added to the "
35551 "C<daemon_functions> list. Each function has a unique procedure number used "
35552 "in the RPC protocol which is assigned to that action when we publish "
35553 "libguestfs and cannot be reused. Take the latest procedure number and "
35558 #: ../src/guestfs.pod:2484
35560 "For library-only actions of the second type, add to the "
35561 "C<non_daemon_functions> list. Since these functions are serviced by the "
35562 "library and do not travel over the RPC mechanism to the daemon, these "
35563 "functions do not need a procedure number, and so the procedure number is set "
35568 #: ../src/guestfs.pod:2492
35569 msgid "Implement the action (in C):"
35573 #: ../src/guestfs.pod:2494
35575 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
35576 "C<daemon/> directory."
35580 #: ../src/guestfs.pod:2497
35582 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
35583 "(note: double underscore) in the C<src/> directory."
35587 #: ../src/guestfs.pod:2500
35588 msgid "In either case, use another function as an example of what to do."
35592 #: ../src/guestfs.pod:2504
35593 msgid "After making these changes, use C<make> to compile."
35597 #: ../src/guestfs.pod:2506
35599 "Note that you don't need to implement the RPC, language bindings, manual "
35600 "pages or anything else. It's all automatically generated from the OCaml "
35605 #: ../src/guestfs.pod:2510
35606 msgid "ADDING TESTS FOR AN API ACTION"
35610 #: ../src/guestfs.pod:2512
35612 "You can supply zero or as many tests as you want per API call. The tests "
35613 "can either be added as part of the API description (C<generator/"
35614 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
35615 "into C<regressions/>. Note that adding a script to C<regressions/> is "
35616 "slower, so if possible use the first method."
35620 #: ../src/guestfs.pod:2518
35622 "The following describes the test environment used when you add an API test "
35623 "in C<generator_actions.ml>."
35627 #: ../src/guestfs.pod:2521
35628 msgid "The test environment has 4 block devices:"
35632 #: ../src/guestfs.pod:2525
35633 msgid "C</dev/sda> 500MB"
35637 #: ../src/guestfs.pod:2527
35638 msgid "General block device for testing."
35642 #: ../src/guestfs.pod:2529
35643 msgid "C</dev/sdb> 50MB"
35647 #: ../src/guestfs.pod:2531
35649 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
35654 #: ../src/guestfs.pod:2534
35655 msgid "C</dev/sdc> 10MB"
35659 #: ../src/guestfs.pod:2536
35660 msgid "Used in a few tests where two block devices are needed."
35664 #: ../src/guestfs.pod:2538
35665 msgid "C</dev/sdd>"
35669 #: ../src/guestfs.pod:2540
35670 msgid "ISO with fixed content (see C<images/test.iso>)."
35674 #: ../src/guestfs.pod:2544
35676 "To be able to run the tests in a reasonable amount of time, the libguestfs "
35677 "appliance and block devices are reused between tests. So don't try testing "
35678 "L</guestfs_kill_subprocess> :-x"
35682 #: ../src/guestfs.pod:2548
35684 "Each test starts with an initial scenario, selected using one of the "
35685 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
35686 "initialize the disks mentioned above in a particular way as documented in "
35687 "C<generator_types.ml>. You should not assume anything about the previous "
35688 "contents of other disks that are not initialized."
35692 #: ../src/guestfs.pod:2554
35694 "You can add a prerequisite clause to any individual test. This is a run-"
35695 "time check, which, if it fails, causes the test to be skipped. Useful if "
35696 "testing a command which might not work on all variations of libguestfs "
35697 "builds. A test that has prerequisite of C<Always> means to run "
35702 #: ../src/guestfs.pod:2560
35704 "In addition, packagers can skip individual tests by setting environment "
35705 "variables before running C<make check>."
35709 #: ../src/guestfs.pod:2563
35712 " SKIP_TEST_<CMD>_<NUM>=1\n"
35717 #: ../src/guestfs.pod:2565
35718 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
35722 #: ../src/guestfs.pod:2567
35727 #: ../src/guestfs.pod:2569
35730 " SKIP_TEST_<CMD>=1\n"
35735 #: ../src/guestfs.pod:2571
35736 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
35740 #: ../src/guestfs.pod:2573
35741 msgid "Packagers can run only certain tests by setting for example:"
35745 #: ../src/guestfs.pod:2575
35748 " TEST_ONLY=\"vfs_type zerofree\"\n"
35753 #: ../src/guestfs.pod:2577
35755 "See C<capitests/tests.c> for more details of how these environment variables "
35760 #: ../src/guestfs.pod:2580
35761 msgid "DEBUGGING NEW API ACTIONS"
35765 #: ../src/guestfs.pod:2582
35766 msgid "Test new actions work before submitting them."
35770 #: ../src/guestfs.pod:2584
35771 msgid "You can use guestfish to try out new commands."
35775 #: ../src/guestfs.pod:2586
35777 "Debugging the daemon is a problem because it runs inside a minimal "
35778 "environment. However you can fprintf messages in the daemon to stderr, and "
35779 "they will show up if you use C<guestfish -v>."
35783 #: ../src/guestfs.pod:2590
35784 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
35788 #: ../src/guestfs.pod:2592
35790 "Our C source code generally adheres to some basic code-formatting "
35791 "conventions. The existing code base is not totally consistent on this "
35792 "front, but we do prefer that contributed code be formatted similarly. In "
35793 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
35794 "indentation level, and other than that, follow the K&R style."
35798 #: ../src/guestfs.pod:2598
35800 "If you use Emacs, add the following to one of one of your start-up files (e."
35801 "g., ~/.emacs), to help ensure that you get indentation right:"
35805 #: ../src/guestfs.pod:2601
35808 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
35809 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
35810 " (add-hook 'find-file-hook\n"
35811 " '(lambda () (if (and buffer-file-name\n"
35812 " (string-match \"/libguestfs\\\\>\"\n"
35813 " (buffer-file-name))\n"
35814 " (not (string-equal mode-name \"Change Log\"))\n"
35815 " (not (string-equal mode-name \"Makefile\")))\n"
35816 " (setq indent-tabs-mode nil))))\n"
35821 #: ../src/guestfs.pod:2611
35824 " ;;; When editing C sources in libguestfs, use this style.\n"
35825 " (defun libguestfs-c-mode ()\n"
35826 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
35828 " (c-set-style \"K&R\")\n"
35829 " (setq c-indent-level 2)\n"
35830 " (setq c-basic-offset 2))\n"
35831 " (add-hook 'c-mode-hook\n"
35832 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
35833 " (buffer-file-name))\n"
35834 " (libguestfs-c-mode))))\n"
35839 #: ../src/guestfs.pod:2623
35840 msgid "Enable warnings when compiling (and fix any problems this finds):"
35844 #: ../src/guestfs.pod:2626
35847 " ./configure --enable-gcc-warnings\n"
35852 #: ../src/guestfs.pod:2628
35853 msgid "Useful targets are:"
35857 #: ../src/guestfs.pod:2630
35860 " make syntax-check # checks the syntax of the C code\n"
35861 " make check # runs the test suite\n"
35866 #: ../src/guestfs.pod:2633
35867 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
35871 #: ../src/guestfs.pod:2635
35873 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
35874 "which are used to do shell quoting."
35878 #: ../src/guestfs.pod:2640
35883 #: ../src/guestfs.pod:2642
35885 "Simple shell quoted string. Any spaces or other shell characters are "
35890 #: ../src/guestfs.pod:2645
35895 #: ../src/guestfs.pod:2647
35897 "Same as C<%Q> except the string is treated as a path which is prefixed by "
35902 #: ../src/guestfs.pod:2654
35905 " asprintf (&cmd, \"cat %R\", path);\n"
35910 #: ../src/guestfs.pod:2656
35911 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
35915 #: ../src/guestfs.pod:2658
35917 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
35918 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
35919 "they are not passed via the shell (instead, straight to exec). You probably "
35920 "want to use the C<sysroot_path()> function however."
35924 #: ../src/guestfs.pod:2664
35925 msgid "SUBMITTING YOUR NEW API ACTIONS"
35929 #: ../src/guestfs.pod:2666
35931 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
35932 "libguestfs> and CC to L<rjones@redhat.com>."
35936 #: ../src/guestfs.pod:2670
35937 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
35941 #: ../src/guestfs.pod:2672
35942 msgid "We support i18n (gettext anyhow) in the library."
35946 #: ../src/guestfs.pod:2674
35948 "However many messages come from the daemon, and we don't translate those at "
35949 "the moment. One reason is that the appliance generally has all locale files "
35950 "removed from it, because they take up a lot of space. So we'd have to readd "
35951 "some of those, as well as copying our PO files into the appliance."
35955 #: ../src/guestfs.pod:2680
35957 "Debugging messages are never translated, since they are intended for the "
35962 #: ../src/guestfs.pod:2683
35963 msgid "SOURCE CODE SUBDIRECTORIES"
35967 #: ../src/guestfs.pod:2689
35968 msgid "The libguestfs appliance, build scripts and so on."
35972 #: ../src/guestfs.pod:2691
35973 msgid "C<capitests>"
35977 #: ../src/guestfs.pod:2693
35978 msgid "Automated tests of the C API."
35982 #: ../src/guestfs.pod:2695
35987 #: ../src/guestfs.pod:2697
35989 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
35994 #: ../src/guestfs.pod:2700
35999 #: ../src/guestfs.pod:2702
36001 "Safety and liveness tests of components that libguestfs depends upon (not of "
36002 "libguestfs itself). Mainly this is for qemu and the kernel."
36006 #: ../src/guestfs.pod:2705
36011 #: ../src/guestfs.pod:2707
36012 msgid "Outside contributions, experimental parts."
36016 #: ../src/guestfs.pod:2709
36021 #: ../src/guestfs.pod:2711
36023 "The daemon that runs inside the libguestfs appliance and carries out actions."
36027 #: ../src/guestfs.pod:2714
36032 #: ../src/guestfs.pod:2716
36033 msgid "L<virt-df(1)> command and documentation."
36037 #: ../src/guestfs.pod:2718
36042 #: ../src/guestfs.pod:2720
36043 msgid "L<virt-edit(1)> command and documentation."
36047 #: ../src/guestfs.pod:2722
36048 msgid "C<examples>"
36052 #: ../src/guestfs.pod:2724
36053 msgid "C API example code."
36057 #: ../src/guestfs.pod:2726
36062 #: ../src/guestfs.pod:2728
36064 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
36065 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
36066 "L<virt-tar-out(1)>."
36070 #: ../src/guestfs.pod:2732
36075 #: ../src/guestfs.pod:2734
36077 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
36081 #: ../src/guestfs.pod:2736
36082 msgid "C<generator>"
36086 #: ../src/guestfs.pod:2738
36088 "The crucially important generator, used to automatically generate large "
36089 "amounts of boilerplate C code for things like RPC and bindings."
36093 #: ../src/guestfs.pod:2741
36098 #: ../src/guestfs.pod:2743
36099 msgid "Files used by the test suite."
36103 #: ../src/guestfs.pod:2745
36104 msgid "Some \"phony\" guest images which we test against."
36108 #: ../src/guestfs.pod:2747
36109 msgid "C<inspector>"
36113 #: ../src/guestfs.pod:2749
36114 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
36118 #: ../src/guestfs.pod:2751
36123 #: ../src/guestfs.pod:2753
36124 msgid "Logo used on the website. The fish is called Arthur by the way."
36128 #: ../src/guestfs.pod:2755
36133 #: ../src/guestfs.pod:2757
36134 msgid "M4 macros used by autoconf."
36138 #: ../src/guestfs.pod:2759
36143 #: ../src/guestfs.pod:2761
36144 msgid "Translations of simple gettext strings."
36148 #: ../src/guestfs.pod:2763
36153 #: ../src/guestfs.pod:2765
36155 "The build infrastructure and PO files for translations of manpages and POD "
36156 "files. Eventually this will be combined with the C<po> directory, but that "
36157 "is rather complicated."
36161 #: ../src/guestfs.pod:2769
36162 msgid "C<regressions>"
36166 #: ../src/guestfs.pod:2771
36167 msgid "Regression tests."
36171 #: ../src/guestfs.pod:2773
36176 #: ../src/guestfs.pod:2775
36177 msgid "L<virt-rescue(1)> command and documentation."
36181 #: ../src/guestfs.pod:2777
36186 #: ../src/guestfs.pod:2779
36187 msgid "Source code to the C library."
36191 #: ../src/guestfs.pod:2781
36196 #: ../src/guestfs.pod:2783
36197 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
36201 #: ../src/guestfs.pod:2785
36202 msgid "C<test-tool>"
36206 #: ../src/guestfs.pod:2787
36208 "Test tool for end users to test if their qemu/kernel combination will work "
36213 #: ../src/guestfs.pod:2790
36218 #: ../src/guestfs.pod:2792
36223 #: ../src/guestfs.pod:2794
36228 #: ../src/guestfs.pod:2796
36233 #: ../src/guestfs.pod:2798
36238 #: ../src/guestfs.pod:2800
36243 #: ../src/guestfs.pod:2802
36248 #: ../src/guestfs.pod:2804
36253 #: ../src/guestfs.pod:2806
36254 msgid "Language bindings."
36258 #: ../src/guestfs.pod:2810
36259 msgid "MAKING A STABLE RELEASE"
36263 #: ../src/guestfs.pod:2812
36265 "When we make a stable release, there are several steps documented here. See "
36266 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
36271 #: ../src/guestfs.pod:2820
36273 "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
36277 #: ../src/guestfs.pod:2825
36278 msgid "Finalize RELEASE-NOTES."
36282 #: ../src/guestfs.pod:2829
36283 msgid "Update ROADMAP."
36287 #: ../src/guestfs.pod:2833
36288 msgid "Run C<src/api-support/update-from-tarballs.sh>."
36292 #: ../src/guestfs.pod:2837
36293 msgid "Push and pull from Transifex."
36297 #: ../src/guestfs.pod:2839
36302 #: ../src/guestfs.pod:2841
36310 #: ../src/guestfs.pod:2843
36311 msgid "to push the latest POT files to Transifex. Then run:"
36315 #: ../src/guestfs.pod:2845
36323 #: ../src/guestfs.pod:2847
36324 msgid "which is a wrapper to pull the latest translated C<*.po> files."
36328 #: ../src/guestfs.pod:2851
36330 "Create new stable and development directories under L<http://libguestfs.org/"
36335 #: ../src/guestfs.pod:2856
36336 msgid "Create the branch in git:"
36340 #: ../src/guestfs.pod:2858
36343 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
36344 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
36345 " git branch stable-1.XX\n"
36346 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
36351 #: ../src/guestfs.pod:2865
36356 #: ../src/guestfs.pod:2867
36357 msgid "PROTOCOL LIMITS"
36361 #: ../src/guestfs.pod:2869
36363 "Internally libguestfs uses a message-based protocol to pass API calls and "
36364 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
36365 "plenty more detail about this). The maximum message size used by the "
36366 "protocol is slightly less than 4 MB. For some API calls you may need to be "
36367 "aware of this limit. The API calls which may be affected are individually "
36368 "documented, with a link back to this section of the documentation."
36372 #: ../src/guestfs.pod:2877
36374 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
36375 "a simple string. Because this string is at some point internally encoded as "
36376 "a message, the maximum size that it can return is slightly under 4 MB. If "
36377 "the requested file is larger than this then you will get an error."
36381 #: ../src/guestfs.pod:2883
36383 "In order to transfer large files into and out of the guest filesystem, you "
36384 "need to use particular calls that support this. The sections L</UPLOADING> "
36385 "and L</DOWNLOADING> document how to do this."
36389 #: ../src/guestfs.pod:2887
36391 "You might also consider mounting the disk image using our FUSE filesystem "
36392 "support (L<guestmount(1)>)."
36396 #: ../src/guestfs.pod:2890
36397 msgid "MAXIMUM NUMBER OF DISKS"
36401 #: ../src/guestfs.pod:2892
36402 msgid "When using virtio disks (the default) the current limit is B<25> disks."
36406 #: ../src/guestfs.pod:2895
36408 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
36409 "slots. However febootstrap only understands disks with names C</dev/vda> "
36410 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
36415 #: ../src/guestfs.pod:2900
36417 "We are working to substantially raise this limit in future versions but it "
36418 "requires complex changes to qemu."
36422 #: ../src/guestfs.pod:2903
36424 "In future versions of libguestfs it should also be possible to \"hot plug\" "
36425 "disks (add and remove disks after calling L</guestfs_launch>). This also "
36426 "requires changes to qemu."
36430 #: ../src/guestfs.pod:2907
36431 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
36435 #: ../src/guestfs.pod:2909
36436 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
36440 #: ../src/guestfs.pod:2911
36442 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
36443 "vda>, and C</dev/vda1> through C</dev/vda15>)."
36447 #: ../src/guestfs.pod:2914
36449 "If you attach a disk with more than 15 partitions, the extra partitions are "
36450 "ignored by libguestfs."
36454 #: ../src/guestfs.pod:2917
36455 msgid "MAXIMUM SIZE OF A DISK"
36459 #: ../src/guestfs.pod:2919
36460 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
36464 #: ../src/guestfs.pod:2921
36466 "We have tested block devices up to 1 exabyte (2**60 or "
36467 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
36472 #: ../src/guestfs.pod:2925
36474 "Although libguestfs probably does not impose any limit, the underlying host "
36475 "storage will. If you store disk images on a host ext4 filesystem, then the "
36476 "maximum size will be limited by the maximum ext4 file size (currently 16 "
36477 "TB). If you store disk images as host logical volumes then you are limited "
36478 "by the maximum size of an LV."
36482 #: ../src/guestfs.pod:2931
36484 "For the hugest disk image files, we recommend using XFS on the host for "
36489 #: ../src/guestfs.pod:2934
36490 msgid "MAXIMUM SIZE OF A PARTITION"
36494 #: ../src/guestfs.pod:2936
36496 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
36497 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
36498 "address a partition located beyond 2 TB on the disk."
36502 #: ../src/guestfs.pod:2940
36504 "It is recommended that you use GPT partitions on disks which are larger than "
36505 "this size. GPT uses 64 bit sector numbers and so can address partitions "
36506 "which are theoretically larger than the largest disk we could support."
36510 #: ../src/guestfs.pod:2945
36511 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
36515 #: ../src/guestfs.pod:2947
36517 "This depends on the filesystem type. libguestfs itself does not impose any "
36518 "known limit. Consult Wikipedia or the filesystem documentation to find out "
36519 "what these limits are."
36523 #: ../src/guestfs.pod:2951
36524 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
36528 #: ../src/guestfs.pod:2953
36530 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
36531 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
36532 "uploads and downloads."
36536 #: ../src/guestfs.pod:2957
36537 msgid "INSPECTION LIMITS"
36541 #: ../src/guestfs.pod:2959
36543 "The inspection code has several arbitrary limits on things like the size of "
36544 "Windows Registry hive it will read, and the length of product name. These "
36545 "are intended to stop a malicious guest from consuming arbitrary amounts of "
36546 "memory and disk space on the host, and should not be reached in practice. "
36547 "See the source code for more information."
36551 #: ../src/guestfs.pod:2985
36553 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
36554 "effect as calling C<guestfs_set_verbose (g, 1)>."
36558 #: ../src/guestfs.pod:2997
36560 "Set the path that libguestfs uses to search for a supermin appliance. See "
36561 "the discussion of paths in section L</PATH> above."
36565 #: ../src/guestfs.pod:3006
36566 msgid "See also L</QEMU WRAPPERS> above."
36570 #: ../src/guestfs.pod:3010
36572 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
36573 "effect as calling C<guestfs_set_trace (g, 1)>."
36577 #: ../src/guestfs.pod:3028
36579 "L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-"
36580 "perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, L<guestfish(1)>, "
36581 "L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
36582 "L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)"
36583 ">, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
36584 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
36585 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
36586 "L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<http://libguestfs.org/>."
36590 #: ../src/guestfs.pod:3058
36592 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
36593 "(8)>, L<disktype(1)>."
36597 #: ../src/guestfs.pod:3065 ../tools/virt-make-fs.pl:553
36598 #: ../tools/virt-win-reg.pl:761
36603 #: ../src/guestfs.pod:3067
36604 msgid "To get a list of bugs against libguestfs use this link:"
36608 #: ../src/guestfs.pod:3069
36610 "L<https://bugzilla.redhat.com/buglist.cgi?"
36611 "component=libguestfs&product=Virtualization+Tools>"
36615 #: ../src/guestfs.pod:3071
36616 msgid "To report a new bug against libguestfs use this link:"
36620 #: ../src/guestfs.pod:3073
36622 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
36623 "component=libguestfs&product=Virtualization+Tools>"
36627 #: ../src/guestfs.pod:3075
36628 msgid "When reporting a bug, please check:"
36632 #: ../src/guestfs.pod:3081
36633 msgid "That the bug hasn't been reported already."
36637 #: ../src/guestfs.pod:3085
36638 msgid "That you are testing a recent version."
36642 #: ../src/guestfs.pod:3089
36643 msgid "Describe the bug accurately, and give a way to reproduce it."
36647 #: ../src/guestfs.pod:3093
36649 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
36654 #: ../test-tool/libguestfs-test-tool.pod:5
36655 msgid "libguestfs-test-tool - End user tests for libguestfs"
36659 #: ../test-tool/libguestfs-test-tool.pod:9
36662 " libguestfs-test-tool [--options]\n"
36667 #: ../test-tool/libguestfs-test-tool.pod:13
36669 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
36670 "and developers, to allow them to check basic libguestfs functionality is "
36671 "working. This is needed because libguestfs occasionally breaks for reasons "
36672 "beyond our control: usually because of changes in the underlying qemu or "
36673 "kernel packages, or the host environment."
36677 #: ../test-tool/libguestfs-test-tool.pod:20
36678 msgid "If you suspect a problem in libguestfs, then just run:"
36682 #: ../test-tool/libguestfs-test-tool.pod:22
36685 " libguestfs-test-tool\n"
36690 #: ../test-tool/libguestfs-test-tool.pod:24
36691 msgid "It will print lots of diagnostic messages."
36695 #: ../test-tool/libguestfs-test-tool.pod:26
36696 msgid "If it runs to completion successfully, you will see this near the end:"
36700 #: ../test-tool/libguestfs-test-tool.pod:28
36703 " ===== TEST FINISHED OK =====\n"
36708 #: ../test-tool/libguestfs-test-tool.pod:30
36709 msgid "and the test tool will exit with code 0."
36713 #: ../test-tool/libguestfs-test-tool.pod:32
36715 "If it fails (and/or exits with non-zero error code), please paste the "
36716 "B<complete, unedited> output of the test tool into a bug report. More "
36717 "information about reporting bugs can be found on the L<http://libguestfs.org/"
36722 #: ../test-tool/libguestfs-test-tool.pod:41
36727 #: ../test-tool/libguestfs-test-tool.pod:43
36728 msgid "Display short usage information and exit."
36732 #: ../test-tool/libguestfs-test-tool.pod:45
36733 msgid "I<--qemu qemu_binary>"
36737 #: ../test-tool/libguestfs-test-tool.pod:47
36739 "If you have downloaded another qemu binary, point this option at the full "
36740 "path of the binary to try it."
36744 #: ../test-tool/libguestfs-test-tool.pod:50
36745 msgid "I<--qemudir qemu_source_dir>"
36749 #: ../test-tool/libguestfs-test-tool.pod:52
36751 "If you have compiled qemu from source, point this option at the source "
36752 "directory to try it."
36756 #: ../test-tool/libguestfs-test-tool.pod:55
36757 msgid "I<--timeout N>"
36761 #: ../test-tool/libguestfs-test-tool.pod:57
36763 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
36764 "does not usually need to be adjusted unless your machine is very slow."
36768 #: ../test-tool/libguestfs-test-tool.pod:63
36769 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
36773 #: ../test-tool/libguestfs-test-tool.pod:65
36775 "If you have compiled another version of qemu from source and would like to "
36776 "try that, then you can use the I<--qemudir> option to point to the qemu "
36777 "source directory."
36781 #: ../test-tool/libguestfs-test-tool.pod:69
36783 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
36784 "option to point to the binary."
36788 #: ../test-tool/libguestfs-test-tool.pod:72
36790 "When using an alternate qemu with libguestfs, usually you would need to "
36791 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
36792 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
36793 "use either of the I<--qemudir> or I<--qemu> options."
36797 #: ../test-tool/libguestfs-test-tool.pod:79
36799 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
36800 "I<1> if there was an error."
36804 #: ../test-tool/libguestfs-test-tool.pod:84
36806 "For the full list of environment variables which may affect libguestfs, "
36807 "please see the L<guestfs(3)> manual page."
36811 #: ../test-tool/libguestfs-test-tool.pod:89
36812 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
36816 #: ../tools/virt-list-filesystems.pl:32
36818 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
36822 #: ../tools/virt-list-filesystems.pl:36
36825 " virt-list-filesystems [--options] domname\n"
36830 #: ../tools/virt-list-filesystems.pl:38
36833 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
36838 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
36840 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
36845 #: ../tools/virt-list-filesystems.pl:45
36847 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
36848 "are contained in a virtual machine or disk image."
36852 #: ../tools/virt-list-filesystems.pl:49
36854 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
36855 "functionality. For more complex cases you should look at the L<guestfish(1)"
36860 #: ../tools/virt-list-filesystems.pl:112
36862 "With this option, C<virt-list-filesystems> displays the type of each "
36863 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
36867 #: ../tools/virt-list-filesystems.pl:119
36872 #: ../tools/virt-list-filesystems.pl:123
36874 "Normally we only show mountable filesystems. If this option is given then "
36875 "swap devices are shown too."
36879 #: ../tools/virt-list-filesystems.pl:197
36881 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
36882 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
36883 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36887 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
36888 msgid "Copyright (C) 2009 Red Hat Inc."
36892 #: ../tools/virt-list-partitions.pl:32
36894 "virt-list-partitions - List partitions in a virtual machine or disk image"
36898 #: ../tools/virt-list-partitions.pl:36
36901 " virt-list-partitions [--options] domname\n"
36906 #: ../tools/virt-list-partitions.pl:38
36909 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
36914 #: ../tools/virt-list-partitions.pl:45
36916 "C<virt-list-partitions> is a command line tool to list the partitions that "
36917 "are contained in a virtual machine or disk image. It is mainly useful as a "
36918 "first step to using L<virt-resize(1)>."
36922 #: ../tools/virt-list-partitions.pl:50
36924 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
36925 "functionality. For more complex cases you should look at the L<guestfish(1)"
36930 #: ../tools/virt-list-partitions.pl:113
36931 msgid "Show sizes in human-readable form (eg. \"1G\")."
36935 #: ../tools/virt-list-partitions.pl:123
36937 "With this option, C<virt-list-partitions> displays the type and size of each "
36938 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
36942 #: ../tools/virt-list-partitions.pl:130
36947 #: ../tools/virt-list-partitions.pl:132
36952 #: ../tools/virt-list-partitions.pl:134
36954 "Display the total size of each block device (as a separate row or rows)."
36958 #: ../tools/virt-list-partitions.pl:267
36960 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
36961 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
36962 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36966 #: ../tools/virt-list-partitions.pl:283
36967 msgid "Copyright (C) 2009-2010 Red Hat Inc."
36971 #: ../tools/virt-make-fs.pl:37
36972 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
36976 #: ../tools/virt-make-fs.pl:41
36979 " virt-make-fs [--options] input.tar output.img\n"
36984 #: ../tools/virt-make-fs.pl:43
36987 " virt-make-fs [--options] input.tar.gz output.img\n"
36992 #: ../tools/virt-make-fs.pl:45
36995 " virt-make-fs [--options] directory output.img\n"
37000 #: ../tools/virt-make-fs.pl:49
37002 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
37003 "archive or some files in a directory. It is similar to tools like L<mkisofs"
37004 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
37005 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
37006 "you want to attach these filesystems to existing virtual machines (eg. to "
37007 "import large amounts of read-only data to a VM)."
37011 #: ../tools/virt-make-fs.pl:57
37012 msgid "Basic usage is:"
37016 #: ../tools/virt-make-fs.pl:59
37019 " virt-make-fs input output\n"
37024 #: ../tools/virt-make-fs.pl:61
37026 "where C<input> is either a directory containing files that you want to add, "
37027 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
37028 "C<output> is a disk image. The input type is detected automatically. The "
37029 "output disk image defaults to a raw ext2 image unless you specify extra "
37030 "flags (see L</OPTIONS> below)."
37034 #: ../tools/virt-make-fs.pl:67
37035 msgid "EXTRA SPACE"
37039 #: ../tools/virt-make-fs.pl:69
37041 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
37042 "the files that it contains, but might have extra space. Depending on how "
37043 "you are going to use the output, you might think this extra space is wasted "
37044 "and want to minimize it, or you might want to leave space so that more files "
37045 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
37046 "but you can use the I<--size> flag to leave space in the filesystem if you "
37051 #: ../tools/virt-make-fs.pl:77
37053 "An alternative way to leave extra space but not make the output image any "
37054 "bigger is to use an alternative disk image format (instead of the default "
37055 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
37056 "image format (check your hypervisor supports this before using it). This "
37057 "allows you to choose a large I<--size> but the extra space won't actually be "
37058 "allocated in the image until you try to store something in it."
37062 #: ../tools/virt-make-fs.pl:85
37064 "Don't forget that you can also use local commands including L<resize2fs(8)> "
37065 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
37066 "to build another image from scratch."
37070 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
37071 #: ../tools/virt-make-fs.pl:142
37076 #: ../tools/virt-make-fs.pl:91
37079 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
37084 #: ../tools/virt-make-fs.pl:93
37085 msgid "FILESYSTEM TYPE"
37089 #: ../tools/virt-make-fs.pl:95
37091 "The default filesystem type is C<ext2>. Just about any filesystem type that "
37092 "libguestfs supports can be used (but I<not> read-only formats like "
37093 "ISO9660). Here are some of the more common choices:"
37097 #: ../tools/virt-make-fs.pl:101
37102 #: ../tools/virt-make-fs.pl:103
37104 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
37105 "you are not going to use the filesystem in a way that requires the journal, "
37106 "then this is just wasted overhead."
37110 #: ../tools/virt-make-fs.pl:107
37111 msgid "I<ntfs> or I<vfat>"
37115 #: ../tools/virt-make-fs.pl:109
37116 msgid "Useful if exporting data to a Windows guest."
37120 #: ../tools/virt-make-fs.pl:111
37122 "I<Note for vfat>: The tar archive or local directory must only contain files "
37123 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
37124 "program running within libguestfs is unable to change the ownership of non-"
37125 "root files, since vfat itself does not support this."
37129 #: ../tools/virt-make-fs.pl:116
37134 #: ../tools/virt-make-fs.pl:118
37136 "Lower overhead than C<ext2>, but certain limitations on filename length and "
37137 "total filesystem size."
37141 #: ../tools/virt-make-fs.pl:125
37144 " virt-make-fs --type=minix input minixfs.img\n"
37149 #: ../tools/virt-make-fs.pl:127
37150 msgid "TO PARTITION OR NOT TO PARTITION"
37154 #: ../tools/virt-make-fs.pl:129
37155 msgid "Optionally virt-make-fs can add a partition table to the output disk."
37159 #: ../tools/virt-make-fs.pl:131
37161 "Adding a partition can make the disk image more compatible with certain "
37162 "virtualized operating systems which don't expect to see a filesystem "
37163 "directly located on a block device (Linux doesn't care and will happily "
37164 "handle both types)."
37168 #: ../tools/virt-make-fs.pl:136
37170 "On the other hand, if you have a partition table then the output image is no "
37171 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
37172 "directly on a partitioned disk image. (However libguestfs tools such as "
37173 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
37177 #: ../tools/virt-make-fs.pl:144
37178 msgid "Add an MBR partition:"
37182 #: ../tools/virt-make-fs.pl:146
37185 " virt-make-fs --partition -- input disk.img\n"
37190 #: ../tools/virt-make-fs.pl:148
37192 "If the output disk image could be terabyte-sized or larger, it's better to "
37193 "use an EFI/GPT-compatible partition table:"
37197 #: ../tools/virt-make-fs.pl:151
37200 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
37205 #: ../tools/virt-make-fs.pl:179
37206 msgid "Enable debugging information."
37210 #: ../tools/virt-make-fs.pl:185
37211 msgid "B<--size=E<lt>NE<gt>>"
37215 #: ../tools/virt-make-fs.pl:187
37216 msgid "B<--size=+E<lt>NE<gt>>"
37220 #: ../tools/virt-make-fs.pl:189
37221 msgid "B<-s E<lt>NE<gt>>"
37225 #: ../tools/virt-make-fs.pl:191
37226 msgid "B<-s +E<lt>NE<gt>>"
37230 #: ../tools/virt-make-fs.pl:193
37232 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
37236 #: ../tools/virt-make-fs.pl:196
37238 "If this option is I<not> given, then the output image will be just large "
37239 "enough to contain all the files, with not much wasted space."
37243 #: ../tools/virt-make-fs.pl:199
37245 "To choose a fixed size output disk, specify an absolute number followed by b/"
37246 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
37247 "Petabytes or Exabytes. This must be large enough to contain all the input "
37248 "files, else you will get an error."
37252 #: ../tools/virt-make-fs.pl:204
37254 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
37255 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
37256 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
37257 "the input files, and (approximately) an extra 200 MB free space."
37261 #: ../tools/virt-make-fs.pl:210
37263 "Note that virt-make-fs estimates free space, and therefore will not produce "
37264 "filesystems containing precisely the free space requested. (It is much more "
37265 "expensive and time-consuming to produce a filesystem which has precisely the "
37266 "desired free space)."
37270 #: ../tools/virt-make-fs.pl:219
37271 msgid "B<--format=E<lt>fmtE<gt>>"
37275 #: ../tools/virt-make-fs.pl:221
37276 msgid "B<-F E<lt>fmtE<gt>>"
37280 #: ../tools/virt-make-fs.pl:223
37281 msgid "Choose the output disk image format."
37285 #: ../tools/virt-make-fs.pl:225
37286 msgid "The default is C<raw> (raw disk image)."
37290 #: ../tools/virt-make-fs.pl:227
37292 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
37293 "that would really make sense here is C<qcow2>."
37297 #: ../tools/virt-make-fs.pl:234
37298 msgid "B<--type=E<lt>fsE<gt>>"
37302 #: ../tools/virt-make-fs.pl:236
37303 msgid "B<-t E<lt>fsE<gt>>"
37307 #: ../tools/virt-make-fs.pl:238
37308 msgid "Choose the output filesystem type."
37312 #: ../tools/virt-make-fs.pl:240
37313 msgid "The default is C<ext2>."
37317 #: ../tools/virt-make-fs.pl:242
37319 "Any filesystem which is supported read-write by libguestfs can be used here."
37323 #: ../tools/virt-make-fs.pl:249
37324 msgid "B<--partition>"
37328 #: ../tools/virt-make-fs.pl:251
37329 msgid "B<--partition=E<lt>parttypeE<gt>>"
37333 #: ../tools/virt-make-fs.pl:253
37335 "If specified, this flag adds an MBR partition table to the output disk image."
37339 #: ../tools/virt-make-fs.pl:256
37341 "You can change the partition table type, eg. I<--partition=gpt> for large "
37346 #: ../tools/virt-make-fs.pl:259
37348 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
37349 "might consider the next parameter to be the partition type. For example:"
37353 #: ../tools/virt-make-fs.pl:263
37356 " virt-make-fs --partition input.tar ...\n"
37361 #: ../tools/virt-make-fs.pl:265
37363 "would cause virt-make-fs to think you wanted to use a partition type of "
37364 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
37365 "dash) between options and the input file argument:"
37369 #: ../tools/virt-make-fs.pl:269
37372 " virt-make-fs --partition -- input.tar ...\n"
37377 #: ../tools/virt-make-fs.pl:541
37379 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
37380 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
37381 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
37385 #: ../tools/virt-make-fs.pl:555 ../tools/virt-win-reg.pl:763
37387 "When reporting bugs, please enable debugging and capture the I<complete> "
37392 #: ../tools/virt-make-fs.pl:558
37395 " export LIBGUESTFS_DEBUG=1\n"
37396 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
37401 #: ../tools/virt-make-fs.pl:561
37403 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
37408 #: ../tools/virt-tar.pl:33
37409 msgid "virt-tar - Extract or upload files to a virtual machine"
37413 #: ../tools/virt-tar.pl:37
37416 " virt-tar [--options] -x domname directory tarball\n"
37421 #: ../tools/virt-tar.pl:39
37424 " virt-tar [--options] -u domname tarball directory\n"
37429 #: ../tools/virt-tar.pl:41
37432 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
37437 #: ../tools/virt-tar.pl:43
37440 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
37445 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
37450 #: ../tools/virt-tar.pl:47
37452 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
37453 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
37457 #: ../tools/virt-tar.pl:52
37458 msgid "Download C</home> from the VM into a local tarball:"
37462 #: ../tools/virt-tar.pl:54
37465 " virt-tar -x domname /home home.tar\n"
37470 #: ../tools/virt-tar.pl:56
37473 " virt-tar -zx domname /home home.tar.gz\n"
37478 #: ../tools/virt-tar.pl:58
37479 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
37483 #: ../tools/virt-tar.pl:60
37486 " virt-tar -u domname uploadstuff.tar /tmp\n"
37491 #: ../tools/virt-tar.pl:62
37494 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
37499 #: ../tools/virt-tar.pl:66
37501 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
37502 "virtual machines. If you do this, you risk disk corruption in the VM. "
37503 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
37507 #: ../tools/virt-tar.pl:71
37509 "You can use I<-x> (extract) on live virtual machines, but you might get "
37510 "inconsistent results or errors if there is filesystem activity inside the "
37511 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
37512 "work, but the only way to guarantee consistent results is if the virtual "
37513 "machine is shut down."
37517 #: ../tools/virt-tar.pl:79
37519 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
37520 "parts of a guest filesystem. There are many possibilities: making backups, "
37521 "uploading data files, snooping on guest activity, fixing or customizing "
37526 #: ../tools/virt-tar.pl:84
37528 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
37529 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
37530 "should look at the L<guestfish(1)> tool."
37534 #: ../tools/virt-tar.pl:88
37536 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
37537 "its contents (recursively) from the virtual machine into a local tarball. "
37538 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
37539 "virtual machine. You cannot use these two options together."
37543 #: ../tools/virt-tar.pl:94
37545 "In addition, you may need to use the I<-z> (gZip) option to enable "
37546 "compression. When uploading, you have to specify I<-z> if the upload file "
37547 "is compressed because virt-tar won't detect this on its own."
37551 #: ../tools/virt-tar.pl:98
37553 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
37554 "example it cannot do PKZip files or bzip2 compression. If you want that "
37555 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
37556 "the L<libguestfs(3)> API)."
37560 #: ../tools/virt-tar.pl:160
37561 msgid "B<--extract>"
37565 #: ../tools/virt-tar.pl:162
37566 msgid "B<--download>"
37570 #: ../tools/virt-tar.pl:164
37575 #: ../tools/virt-tar.pl:166
37576 msgid "B<--upload>"
37580 #: ../tools/virt-tar.pl:168
37582 "Use I<-x> to extract (download) a directory from a virtual machine to a "
37587 #: ../tools/virt-tar.pl:171
37589 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
37590 "Please read the L</WARNING> section above before using this option."
37594 #: ../tools/virt-tar.pl:175
37595 msgid "You must specify exactly one of these options."
37599 #: ../tools/virt-tar.pl:181
37604 #: ../tools/virt-tar.pl:183
37609 #: ../tools/virt-tar.pl:185
37610 msgid "Specify that the input or output tarball is gzip-compressed."
37614 #: ../tools/virt-tar.pl:298
37616 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
37617 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
37618 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
37623 #: ../tools/virt-win-reg.pl:37
37625 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
37629 #: ../tools/virt-win-reg.pl:41
37632 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
37637 #: ../tools/virt-win-reg.pl:43
37640 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
37645 #: ../tools/virt-win-reg.pl:45
37648 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
37653 #: ../tools/virt-win-reg.pl:47
37656 " virt-win-reg --merge domname [input.reg ...]\n"
37661 #: ../tools/virt-win-reg.pl:49
37664 " virt-win-reg [--options] disk.img ... # instead of domname\n"
37669 #: ../tools/virt-win-reg.pl:53
37671 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
37672 "virtual machines. If you do this, you I<will> get irreversible disk "
37673 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
37674 "but doesn't catch all cases."
37678 #: ../tools/virt-win-reg.pl:58
37680 "Modifying the Windows Registry is an inherently risky operation. The format "
37681 "is deliberately obscure and undocumented, and Registry changes can leave the "
37682 "system unbootable. Therefore when using the I<--merge> option, make sure "
37683 "you have a reliable backup first."
37687 #: ../tools/virt-win-reg.pl:65
37689 "This program can export and merge Windows Registry entries from a Windows "
37694 #: ../tools/virt-win-reg.pl:68
37696 "The first parameter is the libvirt guest name or the raw disk image of a "
37701 #: ../tools/virt-win-reg.pl:71
37703 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
37704 "exported (recursively). For example:"
37708 #: ../tools/virt-win-reg.pl:74
37711 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
37716 #: ../tools/virt-win-reg.pl:76
37718 "You can also display single values from within registry keys, for example:"
37722 #: ../tools/virt-win-reg.pl:79
37725 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
37726 " $ virt-win-reg Windows7 $cvkey ProductName\n"
37727 " Windows 7 Enterprise\n"
37732 #: ../tools/virt-win-reg.pl:83
37734 "With I<--merge>, you can merge a textual regedit file into the Windows "
37739 #: ../tools/virt-win-reg.pl:86
37742 " $ virt-win-reg --merge Windows7 changes.reg\n"
37747 #: ../tools/virt-win-reg.pl:90
37749 "This program is only meant for simple access to the registry. If you want "
37750 "to do complicated things with the registry, we suggest you download the "
37751 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
37752 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
37753 "L<hivexregedit(1)>."
37757 #: ../tools/virt-win-reg.pl:159
37762 #: ../tools/virt-win-reg.pl:161
37764 "In merge mode, this merges a textual regedit file into the Windows Registry "
37765 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
37766 "displays or exports Registry entries instead."
37770 #: ../tools/virt-win-reg.pl:165
37772 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
37773 "result in disk corruption. However exporting (without this flag) is always "
37778 #: ../tools/virt-win-reg.pl:173
37779 msgid "B<--encoding> UTF-16LE|ASCII"
37783 #: ../tools/virt-win-reg.pl:175
37785 "When merging (only), you may need to specify the encoding for strings to be "
37786 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
37787 "(3)/ENCODING STRINGS>."
37791 #: ../tools/virt-win-reg.pl:179
37793 "The default is to use UTF-16LE, which should work with recent versions of "
37798 #: ../tools/virt-win-reg.pl:186
37799 msgid "B<--unsafe-printable-strings>"
37803 #: ../tools/virt-win-reg.pl:188
37805 "When exporting (only), assume strings are UTF-16LE and print them as strings "
37806 "instead of hex sequences. Remove the final zero codepoint from strings if "
37811 #: ../tools/virt-win-reg.pl:192
37813 "This is unsafe and does not preserve the fidelity of strings in the original "
37814 "Registry for various reasons:"
37818 #: ../tools/virt-win-reg.pl:199
37820 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
37821 "other encodings will be corrupted by this transformation."
37825 #: ../tools/virt-win-reg.pl:204
37827 "Assumes that everything which has type 1 or 2 is really a string and that "
37828 "everything else is not a string, but the type field in real Registries is "
37833 #: ../tools/virt-win-reg.pl:210
37835 "Loses information about whether a zero codepoint followed the string in the "
37840 #: ../tools/virt-win-reg.pl:215
37842 "This all happens because the Registry itself contains no information about "
37843 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
37847 #: ../tools/virt-win-reg.pl:219
37849 "You should only use this option for quick hacking and debugging of the "
37850 "Registry contents, and I<never> use it if the output is going to be passed "
37851 "into another program or stored in another Registry."
37855 #: ../tools/virt-win-reg.pl:556
37856 msgid "SUPPORTED SYSTEMS"
37860 #: ../tools/virt-win-reg.pl:558
37862 "The program currently supports Windows NT-derived guests starting with "
37863 "Windows XP through to at least Windows 7."
37867 #: ../tools/virt-win-reg.pl:561
37868 msgid "The following Registry keys are supported:"
37872 #: ../tools/virt-win-reg.pl:565
37873 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
37877 #: ../tools/virt-win-reg.pl:567
37878 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
37882 #: ../tools/virt-win-reg.pl:569
37883 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
37887 #: ../tools/virt-win-reg.pl:571
37888 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
37892 #: ../tools/virt-win-reg.pl:573
37893 msgid "C<HKEY_USERS\\.DEFAULT>"
37897 #: ../tools/virt-win-reg.pl:575
37898 msgid "C<HKEY_USERS\\I<SID>>"
37902 #: ../tools/virt-win-reg.pl:577
37903 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
37907 #: ../tools/virt-win-reg.pl:579
37908 msgid "C<HKEY_USERS\\I<username>>"
37912 #: ../tools/virt-win-reg.pl:581
37914 "where I<username> is a local user name (this is a libguestfs extension)."
37918 #: ../tools/virt-win-reg.pl:585
37920 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
37925 #: ../tools/virt-win-reg.pl:588
37927 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
37928 "supported (there is no \"current user\")."
37932 #: ../tools/virt-win-reg.pl:591
37937 #: ../tools/virt-win-reg.pl:593
37939 "C<virt-win-reg> expects that regedit files have already been reencoded in "
37940 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
37941 "style line endings. Since Windows regedit files are often in UTF-16LE with "
37942 "Windows-style line endings, you may need to reencode the whole file before "
37943 "or after processing."
37947 #: ../tools/virt-win-reg.pl:599
37949 "To reencode a file from Windows format to Linux (before processing it with "
37950 "the I<--merge> option), you would do something like this:"
37954 #: ../tools/virt-win-reg.pl:602
37957 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
37962 #: ../tools/virt-win-reg.pl:604
37964 "To go in the opposite direction, after exporting and before sending the file "
37965 "to a Windows user, do something like this:"
37969 #: ../tools/virt-win-reg.pl:607
37972 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
37977 #: ../tools/virt-win-reg.pl:609
37978 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
37982 #: ../tools/virt-win-reg.pl:611
37984 "If you are unsure about the current encoding, use the L<file(1)> command. "
37985 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
37986 "style (CRLF) line endings, like this:"
37990 #: ../tools/virt-win-reg.pl:615
37993 " $ file software.reg\n"
37994 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
37995 " with CRLF line terminators\n"
38000 #: ../tools/virt-win-reg.pl:619
38001 msgid "This file would need conversion before you could I<--merge> it."
38005 #: ../tools/virt-win-reg.pl:621
38006 msgid "CurrentControlSet etc."
38010 #: ../tools/virt-win-reg.pl:623
38012 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
38013 "Registry at the level of the hive file, and therefore you cannot modify "
38018 #: ../tools/virt-win-reg.pl:627
38020 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
38021 "circumstances it might refer to another control set. The way to find out is "
38022 "to look at the C<HKLM\\SYSTEM\\Select> key:"
38026 #: ../tools/virt-win-reg.pl:631
38029 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
38030 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
38031 " \"Current\"=dword:00000001\n"
38032 " \"Default\"=dword:00000001\n"
38033 " \"Failed\"=dword:00000000\n"
38034 " \"LastKnownGood\"=dword:00000002\n"
38039 #: ../tools/virt-win-reg.pl:638
38040 msgid "\"Current\" is the one which Windows will choose when it boots."
38044 #: ../tools/virt-win-reg.pl:640
38046 "Similarly, other C<Current...> keys in the path may need to be replaced."
38050 #: ../tools/virt-win-reg.pl:643
38051 msgid "WINDOWS TIPS"
38055 #: ../tools/virt-win-reg.pl:645
38057 "Note that some of these tips modify the guest disk image. The guest I<must> "
38058 "be shut off, else you will get disk corruption."
38062 #: ../tools/virt-win-reg.pl:648
38063 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
38067 #: ../tools/virt-win-reg.pl:650
38069 "Prepare a DOS batch script, VBScript or executable. Upload this using "
38070 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
38071 "is uploaded into C<C:\\>:"
38075 #: ../tools/virt-win-reg.pl:654
38078 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
38083 #: ../tools/virt-win-reg.pl:656
38084 msgid "Prepare a regedit file containing the registry change:"
38088 #: ../tools/virt-win-reg.pl:658
38091 " cat > test.reg <<'EOF'\n"
38092 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
38093 " \"Test\"=\"c:\\\\test.bat\"\n"
38099 #: ../tools/virt-win-reg.pl:663
38101 "In this example we use the key C<RunOnce> which means that the script will "
38102 "run precisely once when the first user logs in. If you want it to run every "
38103 "time a user logs in, replace C<RunOnce> with C<Run>."
38107 #: ../tools/virt-win-reg.pl:667
38108 msgid "Now update the registry:"
38112 #: ../tools/virt-win-reg.pl:669
38115 " virt-win-reg --merge WindowsGuest test.reg\n"
38120 #: ../tools/virt-win-reg.pl:671
38121 msgid "INSTALLING A SERVICE"
38125 #: ../tools/virt-win-reg.pl:673
38127 "This section assumes you are familiar with Windows services, and you either "
38128 "have a program which handles the Windows Service Control Protocol directly "
38129 "or you want to run any program using a service wrapper like SrvAny or the "
38134 #: ../tools/virt-win-reg.pl:678
38136 "First upload the program and optionally the service wrapper. In this case "
38137 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
38141 #: ../tools/virt-win-reg.pl:682
38144 " guestfish -i -d WindowsGuest <<EOF\n"
38145 " upload rhsrvany.exe /rhsrvany.exe\n"
38146 " upload test.exe /test.exe\n"
38152 #: ../tools/virt-win-reg.pl:687
38154 "Prepare a regedit file containing the registry changes. In this example, "
38155 "the first registry change is needed for the service itself or the service "
38156 "wrapper (if used). The second registry change is only needed because I am "
38157 "using the RHSrvAny service wrapper."
38161 #: ../tools/virt-win-reg.pl:692
38164 " cat > service.reg <<'EOF'\n"
38165 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
38166 " \"Type\"=dword:00000010\n"
38167 " \"Start\"=dword:00000002\n"
38168 " \"ErrorControl\"=dword:00000001\n"
38169 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
38170 " \"DisplayName\"=\"RHSrvAny\"\n"
38171 " \"ObjectName\"=\"NetworkService\"\n"
38176 #: ../tools/virt-win-reg.pl:701
38179 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
38180 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
38181 " \"PWD\"=\"c:\\\\Temp\"\n"
38187 #: ../tools/virt-win-reg.pl:712
38189 "For use of C<ControlSet001> see the section above in this manual page. You "
38190 "may need to adjust this according to the control set that is in use by the "
38195 #: ../tools/virt-win-reg.pl:718
38197 "C<\"ObjectName\"> controls the privileges that the service will have. An "
38198 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
38199 "privileged account."
38203 #: ../tools/virt-win-reg.pl:724
38205 "For the meaning of the magic numbers, see this Microsoft KB article: "
38206 "L<http://support.microsoft.com/kb/103000>."
38210 #: ../tools/virt-win-reg.pl:729
38211 msgid "Update the registry:"
38215 #: ../tools/virt-win-reg.pl:731
38218 " virt-win-reg --merge WindowsGuest service.reg\n"
38223 #: ../tools/virt-win-reg.pl:735
38225 "Be careful when passing parameters containing C<\\> (backslash) in the "
38226 "shell. Usually you will have to use 'single quotes' or double backslashes "
38227 "(but not both) to protect them from the shell."
38231 #: ../tools/virt-win-reg.pl:739
38232 msgid "Paths and value names are case-insensitive."
38236 #: ../tools/virt-win-reg.pl:748
38238 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
38239 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
38240 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
38244 #: ../tools/virt-win-reg.pl:766
38247 " export LIBGUESTFS_DEBUG=1\n"
38248 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
38253 #: ../tools/virt-win-reg.pl:769
38255 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."