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-07-20 17:31+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:1007 ../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:88 ../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:90 ../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:92 ../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:95 ../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:97 ../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:99 ../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:104 ../edit/virt-edit.pod:141
403 #: ../fish/guestfish.pod:242 ../fish/guestfish.pod:673
404 #: ../inspector/virt-inspector.pod:335 ../rescue/virt-rescue.pod:133
405 #: ../src/guestfs.pod: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:108 ../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:112 ../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:115 ../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:167 ../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:169 ../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:171 ../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:173 ../edit/virt-edit.pod:167
493 #: ../fish/guestfish.pod:397 ../fuse/guestmount.pod:263
494 #: ../inspector/virt-inspector.pod:125 ../rescue/virt-rescue.pod:184
495 #: ../resize/virt-resize.pod:478
500 #: ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269
501 #: ../cat/virt-ls.pod:433 ../df/virt-df.pod:175 ../edit/virt-edit.pod:169
502 #: ../fish/guestfish.pod:399 ../fuse/guestmount.pod:265
503 #: ../inspector/virt-inspector.pod:127 ../rescue/virt-rescue.pod:186
504 #: ../resize/virt-resize.pod:480 ../tools/virt-list-filesystems.pl:69
505 #: ../tools/virt-list-partitions.pl:70 ../tools/virt-make-fs.pl:169
506 #: ../tools/virt-tar.pl:119 ../tools/virt-win-reg.pl:112
511 #: ../cat/virt-cat.pod:144 ../cat/virt-filesystems.pod:271
512 #: ../cat/virt-ls.pod:435 ../df/virt-df.pod:177 ../edit/virt-edit.pod:171
513 #: ../inspector/virt-inspector.pod:129 ../rescue/virt-rescue.pod:188
514 #: ../resize/virt-resize.pod:482 ../tools/virt-list-filesystems.pl:71
515 #: ../tools/virt-list-partitions.pl:72 ../tools/virt-make-fs.pl:171
516 #: ../tools/virt-tar.pl:121 ../tools/virt-win-reg.pl:114
517 msgid "Display version number and exit."
521 #: ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281
522 #: ../cat/virt-ls.pod:437 ../df/virt-df.pod:179 ../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:181 ../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:209 ../edit/virt-edit.pod:342
642 #: ../inspector/virt-inspector.pod:349 ../rescue/virt-rescue.pod:262
643 #: ../resize/virt-resize.pod:543 ../tools/virt-list-filesystems.pl:188
644 #: ../tools/virt-list-partitions.pl:258 ../tools/virt-make-fs.pl:532
645 #: ../tools/virt-tar.pl:289 ../tools/virt-win-reg.pl:733
646 msgid "SHELL QUOTING"
650 #: ../cat/virt-cat.pod:194 ../cat/virt-filesystems.pod:367
651 #: ../cat/virt-ls.pod:485 ../df/virt-df.pod:211 ../edit/virt-edit.pod:344
652 #: ../inspector/virt-inspector.pod:351 ../rescue/virt-rescue.pod:264
653 #: ../resize/virt-resize.pod:545 ../tools/virt-list-filesystems.pl:190
654 #: ../tools/virt-list-partitions.pl:260 ../tools/virt-make-fs.pl:534
655 #: ../tools/virt-tar.pl:291 ../tools/virt-win-reg.pl:741
657 "Libvirt guest names can contain arbitrary characters, some of which have "
658 "meaning to the shell such as C<#> and space. You may need to quote or "
659 "escape these characters on the command line. See the shell manual page L<sh"
664 #: ../cat/virt-cat.pod:199 ../cat/virt-filesystems.pod:372
665 #: ../cat/virt-ls.pod:490 ../df/virt-df.pod:216 ../edit/virt-edit.pod:349
666 #: ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384
667 #: ../fish/guestfish.pod:1214 ../fish/virt-copy-in.pod:50
668 #: ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47
669 #: ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:303
670 #: ../inspector/virt-inspector.pod:372 ../java/examples/guestfs-java.pod:45
671 #: ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39
672 #: ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:284
673 #: ../resize/virt-resize.pod:550 ../ruby/examples/guestfs-ruby.pod:36
674 #: ../src/guestfs.pod:3016 ../test-tool/libguestfs-test-tool.pod:87
675 #: ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265
676 #: ../tools/virt-make-fs.pl:539 ../tools/virt-tar.pl:296
677 #: ../tools/virt-win-reg.pl:746
682 #: ../cat/virt-cat.pod:201
684 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, L<virt-"
685 "tar-out(1)>, L<http://libguestfs.org/>."
689 #: ../cat/virt-cat.pod:208 ../cat/virt-filesystems.pod:383
690 #: ../cat/virt-ls.pod:502 ../df/virt-df.pod:224 ../edit/virt-edit.pod:363
691 #: ../rescue/virt-rescue.pod:292 ../resize/virt-resize.pod:571
692 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277
693 #: ../tools/virt-make-fs.pl:564 ../tools/virt-tar.pl:311
694 #: ../tools/virt-win-reg.pl:772
699 #: ../cat/virt-cat.pod:210 ../cat/virt-filesystems.pod:385
700 #: ../cat/virt-ls.pod:504 ../df/virt-df.pod:226 ../edit/virt-edit.pod:365
701 #: ../inspector/virt-inspector.pod:386 ../rescue/virt-rescue.pod:294
702 #: ../resize/virt-resize.pod:573 ../tools/virt-list-filesystems.pl:210
703 #: ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:566
704 #: ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:774
705 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
709 #: ../cat/virt-cat.pod:212 ../cat/virt-filesystems.pod:387
710 #: ../cat/virt-ls.pod:506 ../df/virt-df.pod:228 ../edit/virt-edit.pod:367
711 #: ../examples/guestfs-examples.pod:48 ../examples/guestfs-recipes.pod:400
712 #: ../fish/guestfish.pod:1242 ../fish/virt-copy-in.pod:64
713 #: ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62
714 #: ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:318
715 #: ../inspector/virt-inspector.pod:394 ../java/examples/guestfs-java.pod:61
716 #: ../ocaml/examples/guestfs-ocaml.pod:94 ../perl/examples/guestfs-perl.pod:55
717 #: ../python/examples/guestfs-python.pod:57 ../rescue/virt-rescue.pod:296
718 #: ../resize/virt-resize.pod:575 ../ruby/examples/guestfs-ruby.pod:51
719 #: ../src/guestfs.pod:3091 ../test-tool/libguestfs-test-tool.pod:97
720 #: ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281
721 #: ../tools/virt-make-fs.pl:568 ../tools/virt-tar.pl:315
722 #: ../tools/virt-win-reg.pl:776
727 #: ../cat/virt-cat.pod:214 ../inspector/virt-inspector.pod:396
728 #: ../resize/virt-resize.pod:577
729 msgid "Copyright (C) 2010-2011 Red Hat Inc."
733 #: ../cat/virt-cat.pod:216 ../cat/virt-filesystems.pod:391
734 #: ../cat/virt-ls.pod:510 ../df/virt-df.pod:232 ../edit/virt-edit.pod:371
735 #: ../fish/guestfish.pod:1247 ../fish/virt-copy-in.pod:69
736 #: ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67
737 #: ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:323
738 #: ../inspector/virt-inspector.pod:398 ../rescue/virt-rescue.pod:300
739 #: ../resize/virt-resize.pod:579 ../test-tool/libguestfs-test-tool.pod:102
740 #: ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285
741 #: ../tools/virt-make-fs.pl:572 ../tools/virt-tar.pl:319
742 #: ../tools/virt-win-reg.pl:780
744 "This program is free software; you can redistribute it and/or modify it "
745 "under the terms of the GNU General Public License as published by the Free "
746 "Software Foundation; either version 2 of the License, or (at your option) "
751 #: ../cat/virt-cat.pod:221 ../cat/virt-filesystems.pod:396
752 #: ../cat/virt-ls.pod:515 ../df/virt-df.pod:237 ../edit/virt-edit.pod:376
753 #: ../fish/guestfish.pod:1252 ../fish/virt-copy-in.pod:74
754 #: ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72
755 #: ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:328
756 #: ../inspector/virt-inspector.pod:403 ../rescue/virt-rescue.pod:305
757 #: ../resize/virt-resize.pod:584 ../test-tool/libguestfs-test-tool.pod:107
758 #: ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290
759 #: ../tools/virt-make-fs.pl:577 ../tools/virt-tar.pl:324
760 #: ../tools/virt-win-reg.pl:785
762 "This program is distributed in the hope that it will be useful, but WITHOUT "
763 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
764 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
769 #: ../cat/virt-cat.pod:226 ../cat/virt-filesystems.pod:401
770 #: ../cat/virt-ls.pod:520 ../df/virt-df.pod:242 ../edit/virt-edit.pod:381
771 #: ../fish/guestfish.pod:1257 ../fish/virt-copy-in.pod:79
772 #: ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77
773 #: ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:333
774 #: ../inspector/virt-inspector.pod:408 ../rescue/virt-rescue.pod:310
775 #: ../resize/virt-resize.pod:589 ../test-tool/libguestfs-test-tool.pod:112
776 #: ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295
777 #: ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:329
778 #: ../tools/virt-win-reg.pl:790
780 "You should have received a copy of the GNU General Public License along with "
781 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
782 "Ave, Cambridge, MA 02139, USA."
786 #: ../cat/virt-filesystems.pod:5
788 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
789 "virtual machine or disk image"
793 #: ../cat/virt-filesystems.pod:9
796 " virt-filesystems [--options] -d domname\n"
801 #: ../cat/virt-filesystems.pod:11
804 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
809 #: ../cat/virt-filesystems.pod:15
811 "This tool allows you to discover filesystems, partitions, logical volumes, "
812 "and their sizes in a disk image or virtual machine. It is a replacement for "
813 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
817 #: ../cat/virt-filesystems.pod:20
819 "One use for this tool is from shell scripts to iterate over all filesystems "
824 #: ../cat/virt-filesystems.pod:23
827 " for fs in $(virt-filesystems -a disk.img); do\n"
834 #: ../cat/virt-filesystems.pod:27
836 "Another use is to list partitions before using another tool to modify those "
837 "partitions (such as L<virt-resize(1)>). If you are curious about what an "
838 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
842 #: ../cat/virt-filesystems.pod:32
844 "Various command line options control what this program displays. You need "
845 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
846 "guest respectively. If you just specify that then the program shows "
847 "filesystems found, one per line, like this:"
851 #: ../cat/virt-filesystems.pod:37
854 " $ virt-filesystems -a disk.img\n"
856 " /dev/vg_guest/lv_root\n"
861 #: ../cat/virt-filesystems.pod:41
863 "If you add I<-l> or I<--long> then the output includes extra information:"
867 #: ../cat/virt-filesystems.pod:44
870 " $ virt-filesystems -a disk.img -l\n"
871 " Name Type VFS Label Size\n"
872 " /dev/sda1 filesystem ext4 boot 524288000\n"
873 " /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
878 #: ../cat/virt-filesystems.pod:49
880 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
885 #: ../cat/virt-filesystems.pod:52
888 " $ virt-filesystems -a disk.img --extra\n"
890 " /dev/vg_guest/lv_root\n"
891 " /dev/vg_guest/lv_swap\n"
892 " /dev/vg_guest/lv_data\n"
897 #: ../cat/virt-filesystems.pod:58
899 "If you add I<--partitions> then partitions are shown instead of filesystems:"
903 #: ../cat/virt-filesystems.pod:60
906 " $ virt-filesystems -a disk.img --partitions\n"
913 #: ../cat/virt-filesystems.pod:64
915 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, I<--physical-"
916 "volumes>, I<--block-devices> to list those items."
920 #: ../cat/virt-filesystems.pod:67
922 "You can use these options in combination as well (if you want a combination "
923 "including filesystems, you have to add I<--filesystems>). Notice that some "
924 "items fall into several categories (eg. C</dev/sda1> might be both a "
925 "partition and a filesystem). These items are listed several times. To get "
926 "a list which includes absolutely everything that virt-filesystems knows "
927 "about, use the I<--all> option."
931 #: ../cat/virt-filesystems.pod:74
933 "UUIDs (because they are quite long) are not shown by default. Add the I<--"
934 "uuid> option to display device and filesystem UUIDs in the long output."
938 #: ../cat/virt-filesystems.pod:78
940 "I<--all --long --uuid> is a useful combination to display all possible "
941 "information about everything."
945 #: ../cat/virt-filesystems.pod:81
948 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
949 " Name Type VFS Label Size Parent UUID\n"
950 " /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
951 " /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
952 " /dev/sda1 partition - - 100M /dev/sda -\n"
953 " /dev/sda2 partition - - 20G /dev/sda -\n"
954 " /dev/sda device - - 20G - -\n"
959 #: ../cat/virt-filesystems.pod:89
961 "For machine-readable output, use I<--csv> to get Comma-Separated Values."
965 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
970 #: ../cat/virt-filesystems.pod:112
972 "Display everything. This is currently the same as specifying these options: "
973 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, I<--"
974 "logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may be "
975 "added to this list in future)."
979 #: ../cat/virt-filesystems.pod:117
980 msgid "See also I<--long>."
984 #: ../cat/virt-filesystems.pod:119
989 #: ../cat/virt-filesystems.pod:121
990 msgid "B<--block-devices>"
994 #: ../cat/virt-filesystems.pod:123
995 msgid "Display block devices."
999 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301
1004 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303
1006 "Write out the results in CSV format (comma-separated values). This format "
1007 "can be imported easily into databases and spreadsheets, but read L</NOTE "
1008 "ABOUT CSV FORMAT> below."
1012 #: ../cat/virt-filesystems.pod:150
1014 "When prompting for keys and passphrases, virt-filesystems normally turns "
1015 "echoing off so you cannot see what you are typing. If you are not worried "
1016 "about Tempest attacks and there is no one else in the room you can specify "
1017 "this flag to see what you are typing."
1021 #: ../cat/virt-filesystems.pod:155
1026 #: ../cat/virt-filesystems.pod:157
1028 "This causes filesystems that are not ordinary, mountable filesystems to be "
1029 "displayed. This category includes swapspace, and filesystems that are empty "
1030 "or contain unknown data."
1034 #: ../cat/virt-filesystems.pod:161
1035 msgid "This option implies I<--filesystems>."
1039 #: ../cat/virt-filesystems.pod:163
1040 msgid "B<--filesystems>"
1044 #: ../cat/virt-filesystems.pod:165
1046 "Display mountable filesystems. If no display option was selected then this "
1047 "option is implied."
1051 #: ../cat/virt-filesystems.pod:168
1052 msgid "With I<--extra>, non-mountable filesystems are shown too."
1056 #: ../cat/virt-filesystems.pod:181
1059 " virt-filesystems --format=raw -a disk.img\n"
1064 #: ../cat/virt-filesystems.pod:185
1067 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
1072 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352
1073 #: ../df/virt-df.pod:119 ../fish/guestfish.pod:156
1074 #: ../tools/virt-list-partitions.pl:109
1079 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354
1080 #: ../df/virt-df.pod:121 ../tools/virt-list-partitions.pl:111
1081 msgid "B<--human-readable>"
1085 #: ../cat/virt-filesystems.pod:198
1086 msgid "In I<--long> mode, display sizes in human-readable format."
1090 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366
1091 #: ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
1096 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368
1097 #: ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
1102 #: ../cat/virt-filesystems.pod:209
1103 msgid "Display extra columns of data (\"long format\")."
1107 #: ../cat/virt-filesystems.pod:211
1108 msgid "A title row is added unless you also specify I<--no-title>."
1112 #: ../cat/virt-filesystems.pod:213
1114 "The extra columns displayed depend on what output you select, and the "
1115 "ordering of columns may change in future versions. Use the title row, I<--"
1116 "csv> output and/or L<csvtool(1)> to match columns to data in external "
1121 #: ../cat/virt-filesystems.pod:218
1123 "Use I<-h> if you want sizes to be displayed in human-readable format. The "
1124 "default is to show raw numbers of I<bytes>."
1128 #: ../cat/virt-filesystems.pod:221
1129 msgid "Use I<--uuid> to display UUIDs too."
1133 #: ../cat/virt-filesystems.pod:223
1138 #: ../cat/virt-filesystems.pod:225
1139 msgid "B<--logvols>"
1143 #: ../cat/virt-filesystems.pod:227
1144 msgid "B<--logical-volumes>"
1148 #: ../cat/virt-filesystems.pod:229
1150 "Display LVM logical volumes. In this mode, these are displayed irrespective "
1151 "of whether the LVs contain filesystems."
1155 #: ../cat/virt-filesystems.pod:232
1156 msgid "B<--no-title>"
1160 #: ../cat/virt-filesystems.pod:234
1161 msgid "In I<--long> mode, don't add a title row."
1165 #: ../cat/virt-filesystems.pod:236
1167 "Note that the order of the columns is not fixed, and may change in future "
1168 "versions of virt-filesystems, so using this option may give you unexpected "
1173 #: ../cat/virt-filesystems.pod:240
1178 #: ../cat/virt-filesystems.pod:242
1179 msgid "B<--partitions>"
1183 #: ../cat/virt-filesystems.pod:244
1185 "Display partitions. In this mode, these are displayed irrespective of "
1186 "whether the partitions contain filesystems."
1190 #: ../cat/virt-filesystems.pod:247
1195 #: ../cat/virt-filesystems.pod:249
1196 msgid "B<--physvols>"
1200 #: ../cat/virt-filesystems.pod:251
1201 msgid "B<--physical-volumes>"
1205 #: ../cat/virt-filesystems.pod:253
1206 msgid "Display LVM physical volumes."
1210 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:157
1215 #: ../cat/virt-filesystems.pod:257
1220 #: ../cat/virt-filesystems.pod:259
1221 msgid "In I<--long> mode, display UUIDs as well."
1225 #: ../cat/virt-filesystems.pod:273
1230 #: ../cat/virt-filesystems.pod:275
1231 msgid "B<--volgroups>"
1235 #: ../cat/virt-filesystems.pod:277
1236 msgid "B<--volume-groups>"
1240 #: ../cat/virt-filesystems.pod:279
1241 msgid "Display LVM volume groups."
1245 #: ../cat/virt-filesystems.pod:287
1250 #: ../cat/virt-filesystems.pod:289
1252 "Note that columns in the output are subject to reordering and change in "
1253 "future versions of this tool."
1257 #: ../cat/virt-filesystems.pod:294
1262 #: ../cat/virt-filesystems.pod:296
1263 msgid "The filesystem, partition, block device or LVM name."
1267 #: ../cat/virt-filesystems.pod:298
1269 "For device and partition names these are displayed as canonical libguestfs "
1270 "names, so that for example C</dev/sda2> is the second partition on the first "
1275 #: ../cat/virt-filesystems.pod:302
1277 "If the I<--long> option is B<not> specified, then only the name column is "
1278 "shown in the output."
1282 #: ../cat/virt-filesystems.pod:305
1287 #: ../cat/virt-filesystems.pod:307
1288 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1292 #: ../cat/virt-filesystems.pod:309
1297 #: ../cat/virt-filesystems.pod:311
1299 "If there is a filesystem, then this column displays the filesystem type if "
1300 "one could be detected, eg. C<ext4>."
1304 #: ../cat/virt-filesystems.pod:314
1309 #: ../cat/virt-filesystems.pod:316
1311 "If the object has a label (used for identifying and mounting filesystems) "
1312 "then this column contains the label."
1316 #: ../cat/virt-filesystems.pod:319
1321 #: ../cat/virt-filesystems.pod:321
1323 "The size of the object in bytes. If the I<--human> option is used then the "
1324 "size is displayed in a human-readable form."
1328 #: ../cat/virt-filesystems.pod:324
1333 #: ../cat/virt-filesystems.pod:326
1335 "The parent column records the parent relationship between objects. For "
1336 "example, if the object is a partition, then this column contains the name of "
1337 "the containing device. If the object is a logical volume, then this column "
1338 "is the name of the volume group."
1342 #: ../cat/virt-filesystems.pod:331
1347 #: ../cat/virt-filesystems.pod:333
1349 "If the object has a UUID (used for identifying and mounting filesystems and "
1350 "block devices) then this column contains the UUID as a string."
1354 #: ../cat/virt-filesystems.pod:337
1355 msgid "The UUID is only displayed if the I<--uuid> option is given."
1359 #: ../cat/virt-filesystems.pod:341 ../cat/virt-ls.pod:459
1360 #: ../df/virt-df.pod:185
1361 msgid "NOTE ABOUT CSV FORMAT"
1365 #: ../cat/virt-filesystems.pod:343 ../cat/virt-ls.pod:461
1366 #: ../df/virt-df.pod:187
1368 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
1369 "should be easy to parse, but it is definitely not easy to parse."
1373 #: ../cat/virt-filesystems.pod:346 ../cat/virt-ls.pod:464
1374 #: ../df/virt-df.pod:190
1376 "Myth: Just split fields at commas. Reality: This does I<not> work "
1377 "reliably. This example has two columns:"
1381 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:467
1382 #: ../df/virt-df.pod:193
1385 " \"foo,bar\",baz\n"
1390 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:469
1391 #: ../df/virt-df.pod:195
1393 "Myth: Read the file one line at a time. Reality: This does I<not> work "
1394 "reliably. This example has one row:"
1398 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472
1399 #: ../df/virt-df.pod:198
1408 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475
1409 #: ../df/virt-df.pod:201
1411 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
1412 "packaged in major Linux distributions)."
1416 #: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478
1417 #: ../df/virt-df.pod:204
1419 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
1420 "or Python's built-in csv library)."
1424 #: ../cat/virt-filesystems.pod:363 ../cat/virt-ls.pod:481
1425 #: ../df/virt-df.pod:207
1426 msgid "Most spreadsheets and databases can import CSV directly."
1430 #: ../cat/virt-filesystems.pod:374
1432 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-list-"
1433 "filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, L<http://"
1438 #: ../cat/virt-filesystems.pod:389 ../tools/virt-make-fs.pl:570
1439 #: ../tools/virt-win-reg.pl:778
1440 msgid "Copyright (C) 2010 Red Hat Inc."
1444 #: ../cat/virt-ls.pod:5
1445 msgid "virt-ls - List files in a virtual machine"
1449 #: ../cat/virt-ls.pod:9
1452 " virt-ls [--options] -d domname directory [directory ...]\n"
1457 #: ../cat/virt-ls.pod:11
1460 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory ...]\n"
1465 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13
1470 #: ../cat/virt-ls.pod:15
1473 " virt-ls [--options] domname directory\n"
1478 #: ../cat/virt-ls.pod:17
1481 " virt-ls [--options] disk.img [disk.img ...] directory\n"
1486 #: ../cat/virt-ls.pod:21
1488 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
1489 "more from a virtual machine or disk image."
1493 #: ../cat/virt-ls.pod:24
1495 "Multiple directory names can be given, in which case the output from each is "
1500 #: ../cat/virt-ls.pod:27
1502 "To list directories from a libvirt guest use the I<-d> option to specify the "
1503 "name of the guest. For a disk image, use the I<-a> option."
1507 #: ../cat/virt-ls.pod:31
1509 "C<virt-ls> can do many simple file listings. For more complicated cases you "
1510 "may need to use L<guestfish(1)>, or write a program directly to the L<guestfs"
1515 #: ../cat/virt-ls.pod:37
1516 msgid "Get a list of all files and directories in a virtual machine:"
1520 #: ../cat/virt-ls.pod:39
1523 " virt-ls -R -d guest /\n"
1528 #: ../cat/virt-ls.pod:41
1529 msgid "List all setuid or setgid programs in a Linux virtual machine:"
1533 #: ../cat/virt-ls.pod:43
1536 " virt-ls -lR -d guest / | grep '^- [42]'\n"
1541 #: ../cat/virt-ls.pod:45
1542 msgid "List all public-writable directories in a Linux virtual machine:"
1546 #: ../cat/virt-ls.pod:47
1549 " virt-ls -lR -d guest / | grep '^d ...7'\n"
1554 #: ../cat/virt-ls.pod:49
1555 msgid "List all Unix domain sockets in a Linux virtual machine:"
1559 #: ../cat/virt-ls.pod:51
1562 " virt-ls -lR -d guest / | grep '^s'\n"
1567 #: ../cat/virt-ls.pod:53
1568 msgid "List all regular files with filenames ending in '.png':"
1572 #: ../cat/virt-ls.pod:55
1575 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
1580 #: ../cat/virt-ls.pod:57
1581 msgid "To display files larger than 10MB in home directories:"
1585 #: ../cat/virt-ls.pod:59
1588 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
1593 #: ../cat/virt-ls.pod:61
1594 msgid "Find everything modified in the last 7 days:"
1598 #: ../cat/virt-ls.pod:63
1601 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
1606 #: ../cat/virt-ls.pod:65
1607 msgid "Find regular files modified in the last 24 hours:"
1611 #: ../cat/virt-ls.pod:67
1614 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
1619 #: ../cat/virt-ls.pod:69
1620 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
1624 #: ../cat/virt-ls.pod:71
1626 "Find the differences between files in a guest and an earlier snapshot of the "
1631 #: ../cat/virt-ls.pod:74
1634 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
1635 " virt-ls -lR -a current.img / --uids --time-t > new\n"
1636 " diff -u old new | less\n"
1641 #: ../cat/virt-ls.pod:78
1643 "The commands above won't find files where the content has changed but the "
1644 "metadata (eg. file size and modification date) is the same. To do that, you "
1645 "need to add the I<--checksum> parameter to both C<virt-ls> commands. I<--"
1646 "checksum> can be quite slow since it has to read and compute a checksum of "
1647 "every regular file in the virtual machine."
1651 #: ../cat/virt-ls.pod:84
1652 msgid "OUTPUT MODES"
1656 #: ../cat/virt-ls.pod:86
1658 "C<virt-ls> has four output modes, controlled by different combinations of "
1659 "the I<-l> and I<-R> options."
1663 #: ../cat/virt-ls.pod:89
1664 msgid "SIMPLE LISTING"
1668 #: ../cat/virt-ls.pod:91
1669 msgid "A simple listing is like the ordinary L<ls(1)> command:"
1673 #: ../cat/virt-ls.pod:93
1676 " $ virt-ls -d guest /\n"
1684 #: ../cat/virt-ls.pod:98
1685 msgid "LONG LISTING"
1689 #: ../cat/virt-ls.pod:100
1691 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
1692 "(more specifically, like the C<guestfs_ll> function)."
1696 #: ../cat/virt-ls.pod:103
1699 " $ virt-ls -l -d guest /\n"
1701 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
1702 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
1708 #: ../cat/virt-ls.pod:109
1710 "Note that while this is useful for displaying a directory, do not try "
1711 "parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
1716 #: ../cat/virt-ls.pod:113
1717 msgid "RECURSIVE LISTING"
1721 #: ../cat/virt-ls.pod:115
1723 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
1724 "and directories recursively:"
1728 #: ../cat/virt-ls.pod:118
1731 " $ virt-ls -R -d guest /tmp\n"
1739 #: ../cat/virt-ls.pod:123
1741 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
1742 "converts C<\\0> characters to C<\\n>."
1746 #: ../cat/virt-ls.pod:126
1747 msgid "RECURSIVE LONG LISTING"
1751 #: ../cat/virt-ls.pod:128
1753 "Using I<-lR> options together changes the output to display directories "
1754 "recursively, with file stats, and optionally other features such as "
1755 "checksums and extended attributes."
1759 #: ../cat/virt-ls.pod:132
1761 "Most of the interesting features of C<virt-ls> are only available when using "
1766 #: ../cat/virt-ls.pod:135
1768 "The fields are normally space-separated. Filenames are B<not> quoted, so "
1769 "you cannot use the output in another program (because filenames can contain "
1770 "spaces and other unsafe characters). If the guest was untrusted and someone "
1771 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
1772 "on you by creating filenames with embedded newline characters. To B<safely> "
1773 "parse the output in another program, use the I<--csv> (Comma-Separated "
1778 #: ../cat/virt-ls.pod:143
1780 "Note that this output format is completely unrelated to the C<ls -lR> "
1785 #: ../cat/virt-ls.pod:146
1788 " $ virt-ls -lR -d guest /bin\n"
1789 " d 0555 4096 /bin\n"
1790 " - 0755 123 /bin/alsaunmute\n"
1791 " - 0755 28328 /bin/arch\n"
1792 " l 0777 4 /bin/awk -> gawk\n"
1793 " - 0755 27216 /bin/basename\n"
1794 " - 0755 943360 /bin/bash\n"
1800 #: ../cat/virt-ls.pod:155
1801 msgid "These basic fields are always shown:"
1805 #: ../cat/virt-ls.pod:159
1810 #: ../cat/virt-ls.pod:161
1812 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
1813 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
1814 "link), C<s> (socket) or C<u> (unknown)."
1818 #: ../cat/virt-ls.pod:171
1823 #: ../cat/virt-ls.pod:173
1824 msgid "The Unix permissions, displayed as a 4 digit octal number."
1828 #: ../cat/virt-ls.pod:175
1833 #: ../cat/virt-ls.pod:177
1835 "The size of the file. This is shown in bytes unless I<-h> or I<--human-"
1836 "readable> option is given, in which case this is shown as a human-readable "
1841 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4183
1846 #: ../cat/virt-ls.pod:183
1847 msgid "The full path of the file or directory."
1851 #: ../cat/virt-ls.pod:185
1856 #: ../cat/virt-ls.pod:187
1857 msgid "For symbolic links only, the link target."
1861 #: ../cat/virt-ls.pod:191
1863 "In I<-lR> mode, additional command line options enable the display of more "
1868 #: ../cat/virt-ls.pod:194
1870 "With the I<--uids> flag, these additional fields are displayed before the "
1875 #: ../cat/virt-ls.pod:199
1880 #: ../cat/virt-ls.pod:201
1885 #: ../cat/virt-ls.pod:203
1887 "The UID and GID of the owner of the file (displayed numerically). Note "
1888 "these only make sense in the context of a Unix-like guest."
1892 #: ../cat/virt-ls.pod:208
1893 msgid "With the I<--times> flag, these additional fields are displayed:"
1897 #: ../cat/virt-ls.pod:212
1902 #: ../cat/virt-ls.pod:214
1903 msgid "The time of last access."
1907 #: ../cat/virt-ls.pod:216
1912 #: ../cat/virt-ls.pod:218
1913 msgid "The time of last modification."
1917 #: ../cat/virt-ls.pod:220
1922 #: ../cat/virt-ls.pod:222
1923 msgid "The time of last status change."
1927 #: ../cat/virt-ls.pod:226
1929 "The time fields are displayed as string dates and times, unless one of the "
1930 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
1934 #: ../cat/virt-ls.pod:229
1935 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
1939 #: ../cat/virt-ls.pod:233
1944 #: ../cat/virt-ls.pod:235
1946 "The device containing the file (displayed as major:minor). This may not "
1947 "match devices as known to the guest."
1951 #: ../cat/virt-ls.pod:238
1956 #: ../cat/virt-ls.pod:240
1957 msgid "The inode number."
1961 #: ../cat/virt-ls.pod:242
1966 #: ../cat/virt-ls.pod:244
1967 msgid "The number of hard links."
1971 #: ../cat/virt-ls.pod:246
1976 #: ../cat/virt-ls.pod:248
1978 "For block and char special files, the device (displayed as major:minor)."
1982 #: ../cat/virt-ls.pod:251
1987 #: ../cat/virt-ls.pod:253
1988 msgid "The number of 512 byte blocks allocated to the file."
1992 #: ../cat/virt-ls.pod:257
1994 "With the I<--checksum> flag, the checksum of the file contents is shown "
1995 "(only for regular files). Computing file checksums can take a considerable "
2000 #: ../cat/virt-ls.pod:280
2001 msgid "B<--checksum>"
2005 #: ../cat/virt-ls.pod:282
2006 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
2010 #: ../cat/virt-ls.pod:284
2012 "Display checksum over file contents for regular files. With no argument, "
2013 "this defaults to using I<md5>. Using an argument, you can select the "
2014 "checksum type to use."
2018 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358
2019 #: ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408
2020 #: ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
2022 "This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
2027 #: ../cat/virt-ls.pod:316
2029 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
2030 "so you cannot see what you are typing. If you are not worried about Tempest "
2031 "attacks and there is no one else in the room you can specify this flag to "
2032 "see what you are typing."
2036 #: ../cat/virt-ls.pod:321
2037 msgid "B<--extra-stats>"
2041 #: ../cat/virt-ls.pod:323
2042 msgid "Display extra stats."
2046 #: ../cat/virt-ls.pod:339
2049 " virt-ls --format=raw -a disk.img /dir\n"
2054 #: ../cat/virt-ls.pod:343
2057 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
2062 #: ../cat/virt-ls.pod:356
2063 msgid "Display file sizes in human-readable format."
2067 #: ../cat/virt-ls.pod:370
2072 #: ../cat/virt-ls.pod:372
2073 msgid "B<--recursive>"
2077 #: ../cat/virt-ls.pod:374
2079 "Select the mode. With neither of these options, C<virt-ls> produces a "
2080 "simple, flat list of the files in the named directory. See L</SIMPLE "
2085 #: ../cat/virt-ls.pod:378
2087 "C<virt-ls -l> produces a \"long listing\", which shows more detail. See L</"
2092 #: ../cat/virt-ls.pod:381
2094 "C<virt-ls -R> produces a recursive list of files starting at the named "
2095 "directory. See L</RECURSIVE LISTING>."
2099 #: ../cat/virt-ls.pod:384
2101 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
2102 "parsed. See L</RECURSIVE LONG LISTING>."
2106 #: ../cat/virt-ls.pod:387
2111 #: ../cat/virt-ls.pod:389
2112 msgid "Display time fields."
2116 #: ../cat/virt-ls.pod:394
2117 msgid "B<--time-days>"
2121 #: ../cat/virt-ls.pod:396
2122 msgid "Display time fields as days before now (negative if in the future)."
2126 #: ../cat/virt-ls.pod:398
2128 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
2129 "of the file is between 0 and 86399 seconds."
2133 #: ../cat/virt-ls.pod:404
2134 msgid "B<--time-relative>"
2138 #: ../cat/virt-ls.pod:406
2139 msgid "Display time fields as seconds before now (negative if in the future)."
2143 #: ../cat/virt-ls.pod:411
2148 #: ../cat/virt-ls.pod:413
2149 msgid "Display time fields as seconds since the Unix epoch."
2153 #: ../cat/virt-ls.pod:418
2158 #: ../cat/virt-ls.pod:420
2159 msgid "Display UID and GID fields."
2163 #: ../cat/virt-ls.pod:445
2164 msgid "Previous versions of virt-ls allowed you to write either:"
2168 #: ../cat/virt-ls.pod:447
2171 " virt-ls disk.img [disk.img ...] /dir\n"
2176 #: ../cat/virt-ls.pod:451
2179 " virt-ls guestname /dir\n"
2184 #: ../cat/virt-ls.pod:492
2186 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-"
2187 "tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
2188 "L<http://libguestfs.org/>."
2192 #: ../cat/virt-ls.pod:508 ../df/virt-df.pod:230 ../edit/virt-edit.pod:369
2193 #: ../rescue/virt-rescue.pod:298
2194 msgid "Copyright (C) 2009-2011 Red Hat Inc."
2198 #: ../df/virt-df.pod:5
2199 msgid "virt-df - Display free space on virtual filesystems"
2203 #: ../df/virt-df.pod:9
2206 " virt-df [--options]\n"
2211 #: ../df/virt-df.pod:11
2214 " virt-df [--options] -d domname\n"
2219 #: ../df/virt-df.pod:13
2222 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
2227 #: ../df/virt-df.pod:17
2230 " virt-df [--options] domname\n"
2235 #: ../df/virt-df.pod:19
2238 " virt-df [--options] disk.img [disk.img ...]\n"
2243 #: ../df/virt-df.pod:23
2245 "C<virt-df> is a command line tool to display free space on virtual machine "
2246 "filesystems. Unlike other tools, it doesn't just display the size of disk "
2247 "allocated to a virtual machine, but can look inside disk images to see how "
2248 "much space is really being used."
2252 #: ../df/virt-df.pod:28
2254 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
2255 "to get a list of all active and inactive guests, and performs a C<df>-type "
2256 "operation on each one in turn, printing out the results."
2260 #: ../df/virt-df.pod:32
2262 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a C<df>-"
2263 "type operation on either the single named libvirt domain, or on the disk "
2264 "image(s) listed on the command line (which must all belong to a single VM). "
2265 "In this mode (with arguments), C<virt-df> will I<only work for a single "
2266 "guest>. If you want to run on multiple guests, then you have to invoke "
2267 "C<virt-df> multiple times."
2271 #: ../df/virt-df.pod:39
2273 "Use the I<--csv> option to get a format which can be easily parsed by other "
2274 "programs. Other options are similar to the standard L<df(1)> command."
2278 #: ../df/virt-df.pod:45
2280 "Show disk usage for a single libvirt guest called C<F14x64>. Make the "
2281 "output human-readable:"
2285 #: ../df/virt-df.pod:48
2288 " # virt-df -d F14x64 -h\n"
2289 " Filesystem Size Used Available Use%\n"
2290 " F14x64:/dev/sda1 484M 66M 393M 14%\n"
2291 " F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
2296 #: ../df/virt-df.pod:53
2297 msgid "Show disk usage for a disk image file called C<test.img>:"
2301 #: ../df/virt-df.pod:55
2304 " $ virt-df -a test1.img\n"
2305 " Filesystem 1K-blocks Used Available Use%\n"
2306 " test1.img:/dev/sda1 99099 1551 92432 2%\n"
2311 #: ../df/virt-df.pod:106
2314 " virt-df --format=raw -a disk.img\n"
2319 #: ../df/virt-df.pod:110
2322 " virt-df --format=raw -a disk.img --format -a another.img\n"
2327 #: ../df/virt-df.pod:123
2328 msgid "Print sizes in human-readable format."
2332 #: ../df/virt-df.pod:125
2333 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
2337 #: ../df/virt-df.pod:127 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155
2342 #: ../df/virt-df.pod:129
2347 #: ../df/virt-df.pod:131
2348 msgid "Print inodes instead of blocks."
2352 #: ../df/virt-df.pod:133
2353 msgid "B<--one-per-guest>"
2357 #: ../df/virt-df.pod:135
2359 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
2360 "disks from several guests to a single libguestfs appliance."
2364 #: ../df/virt-df.pod:138
2365 msgid "You might use this option in the following circumstances:"
2369 #: ../df/virt-df.pod:142 ../df/virt-df.pod:148 ../edit/virt-edit.pod:266
2370 #: ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276
2371 #: ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291
2372 #: ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102
2373 #: ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132
2374 #: ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227
2375 #: ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235
2376 #: ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243
2377 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
2378 #: ../fish/guestfish-actions.pod:385 ../fish/guestfish-actions.pod:393
2379 #: ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407
2380 #: ../fish/guestfish-actions.pod:1099 ../fish/guestfish-actions.pod:1103
2381 #: ../fish/guestfish-actions.pod:1107 ../fish/guestfish-actions.pod:1111
2382 #: ../fish/guestfish-actions.pod:1119 ../fish/guestfish-actions.pod:1123
2383 #: ../fish/guestfish-actions.pod:1127 ../fish/guestfish-actions.pod:1137
2384 #: ../fish/guestfish-actions.pod:1141 ../fish/guestfish-actions.pod:1145
2385 #: ../fish/guestfish-actions.pod:1235 ../fish/guestfish-actions.pod:1239
2386 #: ../fish/guestfish-actions.pod:1244 ../fish/guestfish-actions.pod:1249
2387 #: ../fish/guestfish-actions.pod:1291 ../fish/guestfish-actions.pod:1295
2388 #: ../fish/guestfish-actions.pod:1300 ../fish/guestfish-actions.pod:1933
2389 #: ../fish/guestfish-actions.pod:1939 ../fish/guestfish-actions.pod:1947
2390 #: ../fish/guestfish-actions.pod:1954 ../fish/guestfish-actions.pod:1961
2391 #: ../fish/guestfish.pod:445 ../fish/guestfish.pod:449
2392 #: ../fish/guestfish.pod:453 ../fish/guestfish.pod:457
2393 #: ../inspector/virt-inspector.pod:384 ../inspector/virt-inspector.pod:388
2394 #: ../resize/virt-resize.pod:282 ../resize/virt-resize.pod:286
2395 #: ../resize/virt-resize.pod:295 ../resize/virt-resize.pod:301
2396 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
2397 #: ../src/guestfs-actions.pod:583 ../src/guestfs-actions.pod:591
2398 #: ../src/guestfs-actions.pod:598 ../src/guestfs-actions.pod:605
2399 #: ../src/guestfs-actions.pod:1662 ../src/guestfs-actions.pod:1666
2400 #: ../src/guestfs-actions.pod:1670 ../src/guestfs-actions.pod:1674
2401 #: ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1686
2402 #: ../src/guestfs-actions.pod:1690 ../src/guestfs-actions.pod:1700
2403 #: ../src/guestfs-actions.pod:1704 ../src/guestfs-actions.pod:1708
2404 #: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850
2405 #: ../src/guestfs-actions.pod:1855 ../src/guestfs-actions.pod:1860
2406 #: ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1925
2407 #: ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:2859
2408 #: ../src/guestfs-actions.pod:2865 ../src/guestfs-actions.pod:2873
2409 #: ../src/guestfs-actions.pod:2880 ../src/guestfs-actions.pod:2887
2410 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
2411 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
2412 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
2413 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
2414 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
2415 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
2416 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
2417 #: ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
2418 #: ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763
2419 #: ../src/guestfs.pod:1773 ../src/guestfs.pod:2047 ../src/guestfs.pod:2052
2420 #: ../src/guestfs.pod:2058 ../src/guestfs.pod:2066 ../src/guestfs.pod:2420
2421 #: ../src/guestfs.pod:2426 ../src/guestfs.pod:2431 ../src/guestfs.pod:2437
2422 #: ../src/guestfs.pod:2818 ../src/guestfs.pod:2823 ../src/guestfs.pod:2827
2423 #: ../src/guestfs.pod:2831 ../src/guestfs.pod:2835 ../src/guestfs.pod:2849
2424 #: ../src/guestfs.pod:2854 ../src/guestfs.pod:3068 ../src/guestfs.pod:3072
2425 #: ../src/guestfs.pod:3076 ../src/guestfs.pod:3080
2426 #: ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202
2427 #: ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:710
2428 #: ../tools/virt-win-reg.pl:716 ../tools/virt-win-reg.pl:722
2433 #: ../df/virt-df.pod:144
2435 "If you think an untrusted guest might actively try to exploit the libguestfs "
2436 "appliance kernel, then this prevents one guest from interfering with the "
2437 "stats printed for another guest."
2441 #: ../df/virt-df.pod:150
2443 "If the kernel has a bug which stops it from accessing a filesystem in one "
2444 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
2445 "and report stats for further guests."
2449 #: ../df/virt-df.pod:159
2451 "Print UUIDs instead of names. This is useful for following a guest even "
2452 "when the guest is migrated or renamed, or when two guests happen to have the "
2457 #: ../df/virt-df.pod:163
2459 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
2460 "images, we still print the disk image name even when this option is "
2465 #: ../df/virt-df.pod:218
2467 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<http://"
2472 #: ../edit/virt-edit.pod:5
2473 msgid "virt-edit - Edit a file in a virtual machine"
2477 #: ../edit/virt-edit.pod:9
2480 " virt-edit [--options] -d domname file [file ...]\n"
2485 #: ../edit/virt-edit.pod:11
2488 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
2493 #: ../edit/virt-edit.pod:13
2496 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
2501 #: ../edit/virt-edit.pod:17
2504 " virt-edit domname file\n"
2509 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
2512 " virt-edit disk.img [disk.img ...] file\n"
2517 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23
2518 #: ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15
2519 #: ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:19
2520 #: ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51
2525 #: ../edit/virt-edit.pod:23
2527 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
2528 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
2529 "doing this, but doesn't catch all cases."
2533 #: ../edit/virt-edit.pod:29
2535 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
2536 "exists in the named virtual machine (or disk image)."
2540 #: ../edit/virt-edit.pod:32
2542 "Multiple filenames can be given, in which case they are each edited in "
2543 "turn. Each filename must be a full path, starting at the root directory "
2544 "(starting with '/')."
2548 #: ../edit/virt-edit.pod:36
2549 msgid "If you want to just view a file, use L<virt-cat(1)>."
2553 #: ../edit/virt-edit.pod:38
2555 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
2556 "USING GUESTFISH> below)."
2560 #: ../edit/virt-edit.pod:41
2562 "C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
2563 "that and much more."
2567 #: ../edit/virt-edit.pod:46
2568 msgid "Edit the named files interactively:"
2572 #: ../edit/virt-edit.pod:48
2575 " virt-edit -d mydomain /boot/grub/grub.conf\n"
2580 #: ../edit/virt-edit.pod:50
2583 " virt-edit -d mydomain /etc/passwd\n"
2588 #: ../edit/virt-edit.pod:52
2589 msgid "For Windows guests, some Windows paths are understood:"
2593 #: ../edit/virt-edit.pod:54
2596 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
2601 #: ../edit/virt-edit.pod:56
2603 "If Perl is installed, you can also edit files non-interactively (see L</NON-"
2604 "INTERACTIVE EDITING> below). To change the init default level to 5:"
2608 #: ../edit/virt-edit.pod:60
2611 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
2616 #: ../edit/virt-edit.pod:81
2617 msgid "B<-b> extension"
2621 #: ../edit/virt-edit.pod:83
2622 msgid "B<--backup> extension"
2626 #: ../edit/virt-edit.pod:85
2628 "Create a backup of the original file I<in the guest disk image>. The backup "
2629 "has the original filename with C<extension> added."
2633 #: ../edit/virt-edit.pod:88
2635 "Usually the first character of C<extension> would be a dot C<.> so you would "
2640 #: ../edit/virt-edit.pod:91
2643 " virt-edit -b .orig [etc]\n"
2648 #: ../edit/virt-edit.pod:93
2649 msgid "By default, no backup file is made."
2653 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181
2654 #: ../fuse/guestmount.pod:96 ../inspector/virt-inspector.pod:74
2655 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78
2656 #: ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
2661 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183
2662 #: ../fuse/guestmount.pod:98 ../inspector/virt-inspector.pod:76
2663 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80
2664 #: ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
2665 msgid "B<--connect URI>"
2669 #: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84
2670 #: ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134
2671 #: ../tools/virt-win-reg.pl:135
2673 "If you specify guest block devices directly, then libvirt is not used at all."
2677 #: ../edit/virt-edit.pod:114
2679 "When prompting for keys and passphrases, virt-edit normally turns echoing "
2680 "off so you cannot see what you are typing. If you are not worried about "
2681 "Tempest attacks and there is no one else in the room you can specify this "
2682 "flag to see what you are typing."
2686 #: ../edit/virt-edit.pod:119
2691 #: ../edit/virt-edit.pod:121
2692 msgid "B<--expr> EXPR"
2696 #: ../edit/virt-edit.pod:123
2698 "Instead of launching the external editor, non-interactively apply the Perl "
2699 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
2704 #: ../edit/virt-edit.pod:127
2706 "Be careful to properly quote the expression to prevent it from being altered "
2711 #: ../edit/virt-edit.pod:130
2712 msgid "Note that this option is only available when Perl 5 is installed."
2716 #: ../edit/virt-edit.pod:132
2717 msgid "B<--format> raw|qcow2|..."
2721 #: ../edit/virt-edit.pod:143
2724 " virt-edit --format=raw -a disk.img file\n"
2729 #: ../edit/virt-edit.pod:147
2732 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
2737 #: ../edit/virt-edit.pod:181
2738 msgid "Previous versions of virt-edit allowed you to write either:"
2742 #: ../edit/virt-edit.pod:187
2745 " virt-edit guestname file\n"
2750 #: ../edit/virt-edit.pod:195
2751 msgid "NON-INTERACTIVE EDITING"
2755 #: ../edit/virt-edit.pod:197
2757 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
2758 "administrator can interactively edit the file."
2762 #: ../edit/virt-edit.pod:200
2764 "There are two ways also to use C<virt-edit> from scripts in order to make "
2765 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
2766 "like this, it's less error-prone to write scripts directly using the "
2767 "libguestfs API and Augeas for configuration file editing.)"
2771 #: ../edit/virt-edit.pod:206
2773 "The first method is to temporarily set C<$EDITOR> to any script or program "
2774 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
2775 "update C<tmpfile> in place however it likes."
2779 #: ../edit/virt-edit.pod:210
2781 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
2782 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
2783 "instances of C<foo> with C<bar> in a file:"
2787 #: ../edit/virt-edit.pod:214
2790 " virt-edit -d domname filename -e 's/foo/bar/'\n"
2795 #: ../edit/virt-edit.pod:216
2797 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
2798 "For example to delete root's password you could do:"
2802 #: ../edit/virt-edit.pod:219
2805 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
2810 #: ../edit/virt-edit.pod:221
2812 "What really happens is that the snippet is evaluated as a Perl expression "
2813 "for each line of the file. The line, including the final C<\\n>, is passed "
2814 "in C<$_> and the expression should update C<$_> or leave it unchanged."
2818 #: ../edit/virt-edit.pod:226
2820 "To delete a line, set C<$_> to the empty string. For example, to delete the "
2821 "C<apache> user account from the password file you can do:"
2825 #: ../edit/virt-edit.pod:229
2828 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
2833 #: ../edit/virt-edit.pod:231
2835 "To insert a line, prepend or append it to C<$_>. However appending lines to "
2836 "the end of the file is rather difficult this way since there is no concept "
2837 "of \"last line of the file\" - your expression just doesn't get called "
2838 "again. You might want to use the first method (setting C<$EDITOR>) if you "
2843 #: ../edit/virt-edit.pod:237
2845 "The variable C<$lineno> contains the current line number. As is "
2846 "traditional, the first line in the file is number C<1>."
2850 #: ../edit/virt-edit.pod:240
2852 "The return value from the expression is ignored, but the expression may call "
2853 "C<die> in order to abort the whole program, leaving the original file "
2858 #: ../edit/virt-edit.pod:244
2860 "Remember when matching the end of a line that C<$_> may contain the final C<"
2861 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
2862 "newline then neither of these. Thus to match or substitute some text at the "
2863 "end of a line, use this regular expression:"
2867 #: ../edit/virt-edit.pod:249
2870 " /some text(\\r?\\n)?$/\n"
2875 #: ../edit/virt-edit.pod:251
2877 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
2878 "$_> itself (since that would remove all newlines from the file):"
2882 #: ../edit/virt-edit.pod:255
2885 " my $m = $_; chomp $m; $m =~ /some text$/\n"
2890 #: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
2891 msgid "WINDOWS PATHS"
2895 #: ../edit/virt-edit.pod:259
2897 "C<virt-edit> has a limited ability to understand Windows drive letters and "
2898 "paths (eg. C<E:\\foo\\bar.txt>)."
2902 #: ../edit/virt-edit.pod:262
2903 msgid "If and only if the guest is running Windows then:"
2907 #: ../edit/virt-edit.pod:268
2909 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
2910 "to the correct filesystem."
2914 #: ../edit/virt-edit.pod:273
2916 "Any backslash (C<\\>) characters in the path are replaced with forward "
2917 "slashes so that libguestfs can process it."
2921 #: ../edit/virt-edit.pod:278
2923 "The path is resolved case insensitively to locate the file that should be "
2928 #: ../edit/virt-edit.pod:283
2929 msgid "There are some known shortcomings:"
2933 #: ../edit/virt-edit.pod:289
2934 msgid "Some NTFS symbolic links may not be followed correctly."
2938 #: ../edit/virt-edit.pod:293
2939 msgid "NTFS junction points that cross filesystems are not followed."
2943 #: ../edit/virt-edit.pod:299
2945 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
2946 "C<virt-edit> doesn't work."
2950 #: ../edit/virt-edit.pod:302
2951 msgid "Using C<virt-edit> is approximately equivalent to doing:"
2955 #: ../edit/virt-edit.pod:304
2958 " guestfish --rw -i -d domname edit /file\n"
2963 #: ../edit/virt-edit.pod:306
2965 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
2970 #: ../edit/virt-edit.pod:309
2972 "The command above uses libguestfs's guest inspection feature and so does not "
2973 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
2974 "disk images that don't contain guests. To edit a file on a disk image "
2979 #: ../edit/virt-edit.pod:314
2982 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
2987 #: ../edit/virt-edit.pod:316
2989 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
2990 "the disk image to edit, and C</file> is the full path to the file."
2994 #: ../edit/virt-edit.pod:320
2996 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
2997 "C<write> or C<upload> instead:"
3001 #: ../edit/virt-edit.pod:323
3004 " guestfish --rw -i -d domname touch /newfile\n"
3009 #: ../edit/virt-edit.pod:325
3012 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
3017 #: ../edit/virt-edit.pod:327
3020 " guestfish --rw -i -d domname upload localfile /newfile\n"
3025 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1075
3026 #: ../rescue/virt-rescue.pod:257 ../src/guestfs.pod:2965
3027 #: ../test-tool/libguestfs-test-tool.pod:82
3028 msgid "ENVIRONMENT VARIABLES"
3032 #: ../edit/virt-edit.pod:333
3037 #: ../edit/virt-edit.pod:335
3039 "If set, this string is used as the editor. It may contain arguments, eg. C<"
3044 #: ../edit/virt-edit.pod:338
3045 msgid "If not set, C<vi> is used."
3049 #: ../edit/virt-edit.pod:351
3051 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
3052 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
3053 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
3057 #: ../examples/guestfs-examples.pod:5
3058 msgid "guestfs-examples - Examples of using libguestfs from C"
3062 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
3065 " #include <guestfs.h>\n"
3070 #: ../examples/guestfs-examples.pod:11
3073 " guestfs_h *g = guestfs_create ();\n"
3074 " guestfs_add_drive_ro (g, \"disk.img\");\n"
3075 " guestfs_launch (g);\n"
3080 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
3083 " cc prog.c -o prog -lguestfs\n"
3085 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
3090 #: ../examples/guestfs-examples.pod:21
3092 "This manual page contains examples of calling libguestfs from the C "
3093 "programming language. If you are not familiar with using libguestfs, you "
3094 "also need to read L<guestfs(3)>."
3098 #: ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37
3099 #: ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31
3100 #: ../python/examples/guestfs-python.pod:34
3101 #: ../ruby/examples/guestfs-ruby.pod:28
3102 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
3106 #: ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39
3107 #: ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33
3108 #: ../python/examples/guestfs-python.pod:36
3109 #: ../ruby/examples/guestfs-ruby.pod:30
3114 #: ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41
3115 #: ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35
3116 #: ../python/examples/guestfs-python.pod:38
3117 #: ../ruby/examples/guestfs-ruby.pod:32
3118 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
3122 #: ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43
3123 #: ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37
3124 #: ../python/examples/guestfs-python.pod:40
3125 #: ../ruby/examples/guestfs-ruby.pod:34
3130 #: ../examples/guestfs-examples.pod:35
3132 "L<guestfs(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
3133 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
3138 #: ../examples/guestfs-examples.pod:44 ../examples/guestfs-recipes.pod:396
3139 #: ../fish/guestfish.pod:1238 ../fish/virt-copy-in.pod:60
3140 #: ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58
3141 #: ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:314
3142 #: ../inspector/virt-inspector.pod:380 ../java/examples/guestfs-java.pod:57
3143 #: ../ocaml/examples/guestfs-ocaml.pod:90 ../perl/examples/guestfs-perl.pod:51
3144 #: ../python/examples/guestfs-python.pod:53
3145 #: ../ruby/examples/guestfs-ruby.pod:47 ../src/guestfs.pod:3087
3146 #: ../test-tool/libguestfs-test-tool.pod:93
3151 #: ../examples/guestfs-examples.pod:46 ../examples/guestfs-recipes.pod:398
3152 #: ../fish/guestfish.pod:1240 ../fish/virt-copy-in.pod:62
3153 #: ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60
3154 #: ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:316
3155 #: ../java/examples/guestfs-java.pod:59 ../ocaml/examples/guestfs-ocaml.pod:92
3156 #: ../perl/examples/guestfs-perl.pod:53
3157 #: ../python/examples/guestfs-python.pod:55
3158 #: ../ruby/examples/guestfs-ruby.pod:49 ../src/guestfs.pod:3089
3159 #: ../test-tool/libguestfs-test-tool.pod:95
3160 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3164 #: ../examples/guestfs-examples.pod:50 ../ocaml/examples/guestfs-ocaml.pod:96
3165 #: ../python/examples/guestfs-python.pod:59
3166 #: ../ruby/examples/guestfs-ruby.pod:53
3167 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
3171 #: ../examples/guestfs-examples.pod:52 ../examples/guestfs-recipes.pod:404
3172 #: ../java/examples/guestfs-java.pod:65 ../ocaml/examples/guestfs-ocaml.pod:98
3173 #: ../perl/examples/guestfs-perl.pod:59
3174 #: ../python/examples/guestfs-python.pod:61
3175 #: ../ruby/examples/guestfs-ruby.pod:55
3177 "The examples in this manual page may be freely copied, modified and "
3178 "distributed without any restrictions."
3182 #: ../examples/guestfs-examples.pod:55 ../examples/guestfs-recipes.pod:407
3183 #: ../java/examples/guestfs-java.pod:68
3184 #: ../ocaml/examples/guestfs-ocaml.pod:101
3185 #: ../perl/examples/guestfs-perl.pod:62
3186 #: ../python/examples/guestfs-python.pod:64
3187 #: ../ruby/examples/guestfs-ruby.pod:58 ../src/guestfs.pod:3096
3189 "This library is free software; you can redistribute it and/or modify it "
3190 "under the terms of the GNU Lesser General Public License as published by the "
3191 "Free Software Foundation; either version 2 of the License, or (at your "
3192 "option) any later version."
3196 #: ../examples/guestfs-examples.pod:60 ../examples/guestfs-recipes.pod:412
3197 #: ../java/examples/guestfs-java.pod:73
3198 #: ../ocaml/examples/guestfs-ocaml.pod:106
3199 #: ../perl/examples/guestfs-perl.pod:67
3200 #: ../python/examples/guestfs-python.pod:69
3201 #: ../ruby/examples/guestfs-ruby.pod:63 ../src/guestfs.pod:3101
3203 "This library is distributed in the hope that it will be useful, but WITHOUT "
3204 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3205 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3210 #: ../examples/guestfs-examples.pod:65 ../examples/guestfs-recipes.pod:417
3211 #: ../java/examples/guestfs-java.pod:78
3212 #: ../ocaml/examples/guestfs-ocaml.pod:111
3213 #: ../perl/examples/guestfs-perl.pod:72
3214 #: ../python/examples/guestfs-python.pod:74
3215 #: ../ruby/examples/guestfs-ruby.pod:68 ../src/guestfs.pod:3106
3217 "You should have received a copy of the GNU Lesser General Public License "
3218 "along with this library; if not, write to the Free Software Foundation, "
3219 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3223 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
3228 #: ../examples/guestfs-recipes.pod:5
3230 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
3231 "here. The only way which works for both sorts of output is to just write "
3232 "the URL directly. Do NOT use L<...> for URLs."
3236 #: ../examples/guestfs-recipes.pod:9
3238 "We break with tradition here and don't use ALL CAPS for the section "
3239 "headings, as this makes them much easier to read."
3243 #: ../examples/guestfs-recipes.pod:16
3244 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
3248 #: ../examples/guestfs-recipes.pod:20
3250 "This page contains recipes for and links to things you can do using "
3251 "libguestfs, L<guestfish(1)> and the virt tools."
3255 #: ../examples/guestfs-recipes.pod:23
3256 msgid "Audit a virtual machine for setuid files"
3260 #: ../examples/guestfs-recipes.pod:25
3262 "The link below contains a small program which can be used to audit a Linux "
3263 "virtual machine to see what setuid and setgid files it contains."
3267 #: ../examples/guestfs-recipes.pod:28
3269 "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-"
3274 #: ../examples/guestfs-recipes.pod:30
3275 msgid "Change the background image in a Windows XP VM"
3279 #: ../examples/guestfs-recipes.pod:32
3281 "The links below explain how to use L<guestfish(1)> to change the background "
3282 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
3283 "be substantially different for each version of Windows."
3287 #: ../examples/guestfs-recipes.pod:37
3289 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html https://"
3290 "lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
3294 #: ../examples/guestfs-recipes.pod:40
3295 msgid "Cloning a virtual machine (Linux)"
3299 #: ../examples/guestfs-recipes.pod:42
3301 "The guestfish technique described in the link below works well for most "
3302 "Linux VMs. Depending on the Linux distro you may need to change the paths "
3307 #: ../examples/guestfs-recipes.pod:46
3309 "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-"
3314 #: ../examples/guestfs-recipes.pod:48
3316 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
3321 #: ../examples/guestfs-recipes.pod:51
3322 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
3326 #: ../examples/guestfs-recipes.pod:53
3327 msgid "Cloning a virtual machine (Windows)"
3331 #: ../examples/guestfs-recipes.pod:55
3333 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
3334 "straightforward. Currently there is code in the Aeolus Oz project which "
3335 "does this (using libguestfs). As part of our review of the virt-clone tool, "
3336 "we may add sysprepping ability."
3340 #: ../examples/guestfs-recipes.pod:60
3342 "https://github.com/clalancette/oz https://www.redhat.com/archives/virt-tools-"
3343 "list/2011-May/msg00019.html"
3347 #: ../examples/guestfs-recipes.pod:63
3348 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
3352 #: ../examples/guestfs-recipes.pod:65
3353 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
3357 #: ../examples/guestfs-recipes.pod:67
3360 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
3365 #: ../examples/guestfs-recipes.pod:69
3366 msgid "To export just a subdirectory, eg. C</files>, do:"
3370 #: ../examples/guestfs-recipes.pod:71
3373 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
3378 #: ../examples/guestfs-recipes.pod:73
3379 msgid "Create empty disk images"
3383 #: ../examples/guestfs-recipes.pod:75
3385 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
3386 "The useful guide below explains the options available."
3390 #: ../examples/guestfs-recipes.pod:78
3392 "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/"
3397 #: ../examples/guestfs-recipes.pod:80
3398 msgid "Dump raw filesystem content from inside a disk image or VM"
3402 #: ../examples/guestfs-recipes.pod:82
3404 "You can use the L<guestfish(1)> C<download> command to extract the raw "
3405 "filesystem content from any filesystem in a disk image or a VM (even one "
3406 "which is encrypted or buried inside an LV):"
3410 #: ../examples/guestfs-recipes.pod:86
3413 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
3418 #: ../examples/guestfs-recipes.pod:88
3421 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
3426 #: ../examples/guestfs-recipes.pod:90
3427 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
3431 #: ../examples/guestfs-recipes.pod:92
3432 msgid "Edit grub configuration in a VM"
3436 #: ../examples/guestfs-recipes.pod:94
3437 msgid "You can use this to:"
3441 #: ../examples/guestfs-recipes.pod:100
3442 msgid "Fix a virtual machine that does not boot."
3446 #: ../examples/guestfs-recipes.pod:104
3447 msgid "Change which kernel is used to boot the VM."
3451 #: ../examples/guestfs-recipes.pod:108
3452 msgid "Change kernel command line options."
3456 #: ../examples/guestfs-recipes.pod:112
3457 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
3461 #: ../examples/guestfs-recipes.pod:114
3464 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
3469 #: ../examples/guestfs-recipes.pod:116
3471 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
3476 #: ../examples/guestfs-recipes.pod:119
3479 " virt-rescue -d BrokenGuest\n"
3484 #: ../examples/guestfs-recipes.pod:121
3485 msgid "Export any directory from a VM"
3489 #: ../examples/guestfs-recipes.pod:123
3491 "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
3495 #: ../examples/guestfs-recipes.pod:126
3498 " virt-copy-out -d Guest /home .\n"
3503 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9
3504 #: ../fish/guestfish-actions.pod:1287 ../fish/guestfish-actions.pod:1929
3505 #: ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1917
3506 #: ../src/guestfs-actions.pod:2855 ../src/guestfs.pod:1639
3507 #: ../tools/virt-win-reg.pl:706
3512 #: ../examples/guestfs-recipes.pod:134
3514 "The final dot of the command is not a printing error. It means we want to "
3515 "copy out to the current directory."
3519 #: ../examples/guestfs-recipes.pod:139
3520 msgid "This creates a directory called C<home> under the current directory."
3524 #: ../examples/guestfs-recipes.pod:143
3526 "If the guest is a Windows guest then you can use drive letters and "
3527 "backslashes, but you must prefix the path with C<win:> and quote it to "
3528 "protect it from the shell, like this:"
3532 #: ../examples/guestfs-recipes.pod:147
3535 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
3540 #: ../examples/guestfs-recipes.pod:149
3541 msgid "To get the output as a compressed tarball, do:"
3545 #: ../examples/guestfs-recipes.pod:151
3548 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
3553 #: ../examples/guestfs-recipes.pod:153
3555 "Although it sounds tempting, this is usually not a reliable way to get a "
3556 "backup from a running guest. See the entry in the FAQ: http://libguestfs."
3557 "org/FAQ.html#backup"
3561 #: ../examples/guestfs-recipes.pod:157
3562 msgid "Find out which user is using the most space"
3566 #: ../examples/guestfs-recipes.pod:159
3568 "This simple script examines a Linux guest to find out which user is using "
3569 "the most space in their home directory:"
3573 #: ../examples/guestfs-recipes.pod:162
3581 #: ../examples/guestfs-recipes.pod:164
3589 #: ../examples/guestfs-recipes.pod:166
3598 #: ../examples/guestfs-recipes.pod:169
3601 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
3606 #: ../examples/guestfs-recipes.pod:171
3609 " for d in $(guestfish --remote ls \"$dir\"); do\n"
3610 " echo -n \"$dir/$d\"\n"
3612 " guestfish --remote du \"$dir/$d\";\n"
3613 " done | sort -nr -k 2\n"
3618 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
3621 " guestfish --remote exit\n"
3626 #: ../examples/guestfs-recipes.pod:179
3627 msgid "Get DHCP address from a VM"
3631 #: ../examples/guestfs-recipes.pod:181
3633 "The link below explains the many different possible techniques for getting "
3634 "the last assigned DHCP address of a virtual machine."
3638 #: ../examples/guestfs-recipes.pod:184
3640 "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-"
3641 "a-virtual-machine-disk-image/#content"
3645 #: ../examples/guestfs-recipes.pod:186
3647 "In the libguestfs source examples directory you will find the latest version "
3648 "of the C<virt-dhcp-address.c> program."
3652 #: ../examples/guestfs-recipes.pod:189
3653 msgid "Get the operating system product name string"
3657 #: ../examples/guestfs-recipes.pod:191
3658 msgid "Save the following script into a file called C<product-name.sh>:"
3662 #: ../examples/guestfs-recipes.pod:193
3667 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3668 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3669 " guestfish --remote inspect-get-product-name \"$root\"\n"
3670 " guestfish --remote exit\n"
3675 #: ../examples/guestfs-recipes.pod:200
3676 msgid "Make the script executable and run it on a named guest:"
3680 #: ../examples/guestfs-recipes.pod:202
3683 " # product-name.sh RHEL60x64\n"
3684 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
3689 #: ../examples/guestfs-recipes.pod:205
3691 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
3692 "C<xpath> command line tool or from your favourite programming language:"
3696 #: ../examples/guestfs-recipes.pod:209
3699 " # virt-inspector RHEL60x64 > xml\n"
3700 " # xpath '//product_name' < xml\n"
3703 " <product_name>Red Hat Enterprise Linux Server release 6.0 (Santiago)</product_name>\n"
3708 #: ../examples/guestfs-recipes.pod:215
3709 msgid "Get the default boot kernel for a Linux VM"
3713 #: ../examples/guestfs-recipes.pod:217
3715 "The link below contains a program to print the default boot kernel for a "
3720 #: ../examples/guestfs-recipes.pod:220
3722 "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-"
3723 "kernel-for-a-vm/#content"
3727 #: ../examples/guestfs-recipes.pod:222
3729 "It uses Augeas, and the technique is generally applicable for many different "
3734 #: ../examples/guestfs-recipes.pod:229
3735 msgid "listing the user accounts in the guest"
3739 #: ../examples/guestfs-recipes.pod:233
3740 msgid "what repositories is it configured to use"
3744 #: ../examples/guestfs-recipes.pod:237
3745 msgid "what NTP servers does it connect to"
3749 #: ../examples/guestfs-recipes.pod:241
3750 msgid "what were the boot messages last time it booted"
3754 #: ../examples/guestfs-recipes.pod:245
3755 msgid "listing who was logged in recently"
3759 #: ../examples/guestfs-recipes.pod:249
3760 msgid "http://augeas.net/"
3764 #: ../examples/guestfs-recipes.pod:251
3765 msgid "Install RPMs in a guest"
3769 #: ../examples/guestfs-recipes.pod:253
3771 "The link below contains a method to install RPMs in a guest. In fact the "
3772 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
3773 "installs them next time the guest is booted. You could use this technique "
3774 "to install vital security updates in an offline guest."
3778 #: ../examples/guestfs-recipes.pod:259
3780 "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
3784 #: ../examples/guestfs-recipes.pod:261
3785 msgid "List applications installed in a VM"
3789 #: ../examples/guestfs-recipes.pod:263
3790 msgid "Save the following to a file C<list-apps.sh>:"
3794 #: ../examples/guestfs-recipes.pod:265
3799 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3800 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3801 " guestfish --remote inspect-list-applications \"$root\"\n"
3802 " guestfish --remote exit\n"
3807 #: ../examples/guestfs-recipes.pod:272
3809 "Make the file executable and then you can run it on any named virtual "
3814 #: ../examples/guestfs-recipes.pod:275
3817 " # list-apps.sh WinGuest\n"
3819 " app_name: Mozilla Firefox (3.6.12)\n"
3820 " app_display_name: Mozilla Firefox (3.6.12)\n"
3822 " app_version: 3.6.12 (en-GB)\n"
3824 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
3825 " app_trans_path:\n"
3826 " app_publisher: Mozilla\n"
3827 " app_url: http://www.mozilla.com/en-GB/\n"
3828 " app_source_package:\n"
3830 " app_description: Mozilla Firefox\n"
3833 " app_name: VLC media player\n"
3834 " app_display_name: VLC media player 1.1.5\n"
3836 " app_version: 1.1.5\n"
3838 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
3839 " app_trans_path:\n"
3840 " app_publisher: VideoLAN\n"
3841 " app_url: http://www.videolan.org/\n"
3842 " app_source_package:\n"
3844 " app_description:\n"
3850 #: ../examples/guestfs-recipes.pod:305
3852 "If you want to run the script on disk images (instead of libvirt virtual "
3853 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also L<virt-inspector(1)"
3858 #: ../examples/guestfs-recipes.pod:309
3859 msgid "List files and directories in a VM"
3863 #: ../examples/guestfs-recipes.pod:311
3864 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
3868 #: ../examples/guestfs-recipes.pod:313
3871 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
3876 #: ../examples/guestfs-recipes.pod:315
3877 msgid "List services in a Windows VM"
3881 #: ../examples/guestfs-recipes.pod:317
3883 "The link below contains a script that can be used to list out the services "
3884 "from a Windows VM, and whether those services run at boot time or are loaded "
3889 #: ../examples/guestfs-recipes.pod:321
3891 "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/"
3896 #: ../examples/guestfs-recipes.pod:323
3897 msgid "Make a disk image sparse"
3901 #: ../examples/guestfs-recipes.pod:325
3903 "The link below contains some guides for making a disk image sparse (or "
3904 "reintroducing sparseness)."
3908 #: ../examples/guestfs-recipes.pod:328
3910 "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
3914 #: ../examples/guestfs-recipes.pod:330
3915 msgid "Monitor disk usage over time"
3919 #: ../examples/guestfs-recipes.pod:332
3921 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
3922 "The link below contains a guide."
3926 #: ../examples/guestfs-recipes.pod:335
3927 msgid "http://virt-tools.org/learning/advanced-virt-df/"
3931 #: ../examples/guestfs-recipes.pod:337
3932 msgid "Reading the Windows Event Log from Windows Vista (or later)"
3936 #: ../examples/guestfs-recipes.pod:339
3938 "L<guestfish(1)> plus the tools described in the link below can be used to "
3939 "read out the Windows Event Log from any virtual machine running Windows "
3940 "Vista or a later version."
3944 #: ../examples/guestfs-recipes.pod:343
3946 "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-"
3947 "guestfish/#content"
3951 #: ../examples/guestfs-recipes.pod:345
3952 msgid "Remove root password (Linux)"
3956 #: ../examples/guestfs-recipes.pod:347
3958 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
3959 "files. One use is to remove the root password from a Linux guest:"
3963 #: ../examples/guestfs-recipes.pod:350
3966 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3971 #: ../examples/guestfs-recipes.pod:352
3972 msgid "Remove Administrator password (Windows)"
3976 #: ../examples/guestfs-recipes.pod:354
3978 "The link below contains one technique for removing the Administrator "
3979 "password from a Windows VM, or to be more precise, it gives you a command "
3980 "prompt the next time you log in which you can use to bypass any security:"
3984 #: ../examples/guestfs-recipes.pod:359
3986 "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-"
3987 "administrator-password-with-guestfish/"
3991 #: ../examples/guestfs-recipes.pod:361
3992 msgid "Unpack a live CD"
3996 #: ../examples/guestfs-recipes.pod:363
3998 "Linux live CDs often contain multiple layers of disk images wrapped like a "
3999 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
4000 "layers, as outlined in the guide below."
4004 #: ../examples/guestfs-recipes.pod:367
4006 "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-"
4011 #: ../examples/guestfs-recipes.pod:369
4012 msgid "Uploading and downloading files"
4016 #: ../examples/guestfs-recipes.pod:371
4018 "The link below contains general tips on uploading (copying in) and "
4019 "downloading (copying out) files from VMs."
4023 #: ../examples/guestfs-recipes.pod:374
4025 "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
4029 #: ../examples/guestfs-recipes.pod:376
4030 msgid "Use libguestfs tools on VMware ESX guests"
4034 #: ../examples/guestfs-recipes.pod:378
4036 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
4037 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
4041 #: ../examples/guestfs-recipes.pod:382
4043 "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-"
4048 #: ../examples/guestfs-recipes.pod:386
4050 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
4051 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby"
4052 "(3)>, L<http://libguestfs.org/>."
4056 #: ../examples/guestfs-recipes.pod:402
4057 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
4061 #: ../fish/guestfish-actions.pod:1
4066 #: ../fish/guestfish-actions.pod:3
4069 " add-cdrom filename\n"
4074 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:7
4075 msgid "This function adds a virtual CD-ROM disk image to the guest."
4079 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:9
4080 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
4084 #: ../fish/guestfish-actions.pod:15
4086 "This call checks for the existence of C<filename>. This stops you from "
4087 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4088 "and C<http:> URLs. To specify those, use the general L</config> call "
4093 #: ../fish/guestfish-actions.pod:22
4095 "If you just want to add an ISO file (often you use this as an efficient way "
4096 "to transfer large files into the guest), then you should probably use L</add-"
4097 "drive-ro> instead."
4101 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163
4102 #: ../fish/guestfish-actions.pod:177 ../src/guestfs-actions.pod:32
4103 #: ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:275
4105 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4110 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166
4111 #: ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:986
4112 #: ../fish/guestfish-actions.pod:1346 ../fish/guestfish-actions.pod:1360
4113 #: ../fish/guestfish-actions.pod:3085 ../fish/guestfish-actions.pod:3292
4114 #: ../fish/guestfish-actions.pod:3406 ../fish/guestfish-actions.pod:3454
4115 #: ../fish/guestfish-actions.pod:4355 ../fish/guestfish-actions.pod:4378
4116 #: ../fish/guestfish-actions.pod:4400 ../fish/guestfish-actions.pod:4438
4117 #: ../fish/guestfish-actions.pod:5087 ../fish/guestfish-actions.pod:5185
4118 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
4119 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1513
4120 #: ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2029
4121 #: ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4947
4122 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5255
4123 #: ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6574
4124 #: ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6666
4125 #: ../src/guestfs-actions.pod:7602 ../src/guestfs-actions.pod:7714
4126 #: ../src/guestfs-actions.pod:7884
4128 "Deprecated functions will not be removed from the API, but the fact that "
4129 "they are deprecated indicates that there are problems with correct use of "
4134 #: ../fish/guestfish-actions.pod:35
4139 #: ../fish/guestfish-actions.pod:37
4144 #: ../fish/guestfish-actions.pod:39
4147 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
4152 #: ../fish/guestfish-actions.pod:41
4154 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4155 "It works by connecting to libvirt, requesting the domain and domain XML from "
4156 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
4160 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:64
4162 "The number of disks added is returned. This operation is atomic: if an "
4163 "error is returned, then no disks are added."
4167 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:67
4169 "This function does some minimal checks to make sure the libvirt domain is "
4170 "not running (unless C<readonly> is true). In a future version we will try "
4171 "to acquire the libvirt lock on each disk."
4175 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:71
4177 "Disks must be accessible locally. This often means that adding disks from a "
4178 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4179 "unless those disks are accessible via the same device path locally too."
4183 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:76
4185 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
4186 "libvirt.org/uri.html>). If this is not set then we connect to the default "
4187 "libvirt URI (or one set through an environment variable, see the libvirt "
4188 "documentation for full details)."
4192 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:82
4194 "The optional C<live> flag controls whether this call will try to connect to "
4195 "a running virtual machine C<guestfsd> process if it sees a suitable "
4196 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
4197 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
4198 "DAEMONS> for more information."
4202 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:89
4204 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
4205 "passed instead of the domain name. The C<dom> string is treated as a UUID "
4206 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
4211 #: ../fish/guestfish-actions.pod:76
4213 "The other optional parameters are passed directly through to L</add-drive-"
4218 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
4219 #: ../fish/guestfish-actions.pod:568 ../fish/guestfish-actions.pod:1968
4220 #: ../fish/guestfish-actions.pod:3134 ../fish/guestfish-actions.pod:3307
4221 #: ../fish/guestfish-actions.pod:3442
4223 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
4227 #: ../fish/guestfish-actions.pod:81
4232 #: ../fish/guestfish-actions.pod:83
4235 " add-drive filename\n"
4240 #: ../fish/guestfish-actions.pod:85
4242 "This function is the equivalent of calling L</add-drive-opts> with no "
4243 "optional parameters, so the disk is added writable, with the format being "
4244 "detected automatically."
4248 #: ../fish/guestfish-actions.pod:89
4250 "Automatic detection of the format opens you up to a potential security hole "
4251 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4252 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4253 "you should think about replacing calls to this function with calls to L</add-"
4254 "drive-opts>, and specifying the format."
4258 #: ../fish/guestfish-actions.pod:96
4259 msgid "add-drive-opts"
4263 #: ../fish/guestfish-actions.pod:98
4268 #: ../fish/guestfish-actions.pod:100
4271 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
4276 #: ../fish/guestfish-actions.pod:102 ../src/guestfs-actions.pod:160
4278 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4279 "The first time you call this function, the disk appears as C</dev/sda>, the "
4280 "second time as C</dev/sdb>, and so on."
4284 #: ../fish/guestfish-actions.pod:107 ../src/guestfs-actions.pod:165
4286 "You don't necessarily need to be root when using libguestfs. However you "
4287 "obviously do need sufficient permissions to access the filename for whatever "
4288 "operations you want to perform (ie. read access if you just want to read the "
4289 "image or write access if you want to modify the image)."
4293 #: ../fish/guestfish-actions.pod:113 ../src/guestfs-actions.pod:171
4294 msgid "This call checks that C<filename> exists."
4298 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3096
4299 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4655
4300 msgid "The optional arguments are:"
4304 #: ../fish/guestfish-actions.pod:119 ../src/guestfs-actions.pod:177
4309 #: ../fish/guestfish-actions.pod:121 ../src/guestfs-actions.pod:179
4311 "If true then the image is treated as read-only. Writes are still allowed, "
4312 "but they are stored in a temporary snapshot overlay which is discarded at "
4313 "the end. The disk that you add is not modified."
4317 #: ../fish/guestfish-actions.pod:125 ../src/guestfs-actions.pod:183
4322 #: ../fish/guestfish-actions.pod:127
4324 "This forces the image format. If you omit this (or use L</add-drive> or L</"
4325 "add-drive-ro>) then the format is automatically detected. Possible formats "
4326 "include C<raw> and C<qcow2>."
4330 #: ../fish/guestfish-actions.pod:131 ../src/guestfs-actions.pod:189
4332 "Automatic detection of the format opens you up to a potential security hole "
4333 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4334 "RHBZ#642934. Specifying the format closes this security hole."
4338 #: ../fish/guestfish-actions.pod:136 ../src/guestfs-actions.pod:194
4343 #: ../fish/guestfish-actions.pod:138
4345 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
4346 "add-drive-with-if> call (q.v.)"
4350 #: ../fish/guestfish-actions.pod:145
4351 msgid "add-drive-ro"
4355 #: ../fish/guestfish-actions.pod:147
4360 #: ../fish/guestfish-actions.pod:149
4363 " add-drive-ro filename\n"
4368 #: ../fish/guestfish-actions.pod:151
4370 "This function is the equivalent of calling L</add-drive-opts> with the "
4371 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
4372 "is added read-only, with the format being detected automatically."
4376 #: ../fish/guestfish-actions.pod:156
4377 msgid "add-drive-ro-with-if"
4381 #: ../fish/guestfish-actions.pod:158
4384 " add-drive-ro-with-if filename iface\n"
4389 #: ../fish/guestfish-actions.pod:160
4391 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
4392 "interface emulation to use at run time."
4396 #: ../fish/guestfish-actions.pod:170
4397 msgid "add-drive-with-if"
4401 #: ../fish/guestfish-actions.pod:172
4404 " add-drive-with-if filename iface\n"
4409 #: ../fish/guestfish-actions.pod:174
4411 "This is the same as L</add-drive> but it allows you to specify the QEMU "
4412 "interface emulation to use at run time."
4416 #: ../fish/guestfish-actions.pod:184
4421 #: ../fish/guestfish-actions.pod:186
4424 " aug-clear augpath\n"
4429 #: ../fish/guestfish-actions.pod:188 ../src/guestfs-actions.pod:290
4431 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4432 "L<augtool(1)> C<clear> command."
4436 #: ../fish/guestfish-actions.pod:191
4441 #: ../fish/guestfish-actions.pod:193
4449 #: ../fish/guestfish-actions.pod:195
4451 "Close the current Augeas handle and free up any resources used by it. After "
4452 "calling this, you have to call L</aug-init> again before you can use any "
4453 "other Augeas functions."
4457 #: ../fish/guestfish-actions.pod:200
4462 #: ../fish/guestfish-actions.pod:202
4465 " aug-defnode name expr val\n"
4470 #: ../fish/guestfish-actions.pod:204 ../src/guestfs-actions.pod:319
4472 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4476 #: ../fish/guestfish-actions.pod:207
4478 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4479 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
4480 "containing that single node."
4484 #: ../fish/guestfish-actions.pod:211 ../src/guestfs-actions.pod:326
4486 "On success this returns a pair containing the number of nodes in the "
4487 "nodeset, and a boolean flag if a node was created."
4491 #: ../fish/guestfish-actions.pod:215
4496 #: ../fish/guestfish-actions.pod:217
4499 " aug-defvar name expr\n"
4504 #: ../fish/guestfish-actions.pod:219 ../src/guestfs-actions.pod:343
4506 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4507 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4511 #: ../fish/guestfish-actions.pod:223 ../src/guestfs-actions.pod:347
4513 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4514 "evaluates to something which is not a nodeset."
4518 #: ../fish/guestfish-actions.pod:226
4523 #: ../fish/guestfish-actions.pod:228
4526 " aug-get augpath\n"
4531 #: ../fish/guestfish-actions.pod:230 ../src/guestfs-actions.pod:360
4533 "Look up the value associated with C<path>. If C<path> matches exactly one "
4534 "node, the C<value> is returned."
4538 #: ../fish/guestfish-actions.pod:233
4543 #: ../fish/guestfish-actions.pod:235
4546 " aug-init root flags\n"
4551 #: ../fish/guestfish-actions.pod:237 ../src/guestfs-actions.pod:375
4553 "Create a new Augeas handle for editing configuration files. If there was "
4554 "any previous Augeas handle associated with this guestfs session, then it is "
4559 #: ../fish/guestfish-actions.pod:241
4560 msgid "You must call this before using any other L</aug-*> commands."
4564 #: ../fish/guestfish-actions.pod:244 ../src/guestfs-actions.pod:382
4566 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4570 #: ../fish/guestfish-actions.pod:247 ../src/guestfs-actions.pod:385
4572 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4573 "logical I<or> of the following integers:"
4577 #: ../fish/guestfish-actions.pod:253 ../src/guestfs-actions.pod:391
4578 msgid "C<AUG_SAVE_BACKUP> = 1"
4582 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:393
4583 msgid "Keep the original file with a C<.augsave> extension."
4587 #: ../fish/guestfish-actions.pod:257 ../src/guestfs-actions.pod:395
4588 msgid "C<AUG_SAVE_NEWFILE> = 2"
4592 #: ../fish/guestfish-actions.pod:259 ../src/guestfs-actions.pod:397
4594 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4595 "original. Overrides C<AUG_SAVE_BACKUP>."
4599 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:400
4600 msgid "C<AUG_TYPE_CHECK> = 4"
4604 #: ../fish/guestfish-actions.pod:264 ../src/guestfs-actions.pod:402
4605 msgid "Typecheck lenses (can be expensive)."
4609 #: ../fish/guestfish-actions.pod:266 ../src/guestfs-actions.pod:404
4610 msgid "C<AUG_NO_STDINC> = 8"
4614 #: ../fish/guestfish-actions.pod:268 ../src/guestfs-actions.pod:406
4615 msgid "Do not use standard load path for modules."
4619 #: ../fish/guestfish-actions.pod:270 ../src/guestfs-actions.pod:408
4620 msgid "C<AUG_SAVE_NOOP> = 16"
4624 #: ../fish/guestfish-actions.pod:272 ../src/guestfs-actions.pod:410
4625 msgid "Make save a no-op, just record what would have been changed."
4629 #: ../fish/guestfish-actions.pod:274 ../src/guestfs-actions.pod:412
4630 msgid "C<AUG_NO_LOAD> = 32"
4634 #: ../fish/guestfish-actions.pod:276
4635 msgid "Do not load the tree in L</aug-init>."
4639 #: ../fish/guestfish-actions.pod:280
4640 msgid "To close the handle, you can call L</aug-close>."
4644 #: ../fish/guestfish-actions.pod:282 ../src/guestfs-actions.pod:420
4645 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4649 #: ../fish/guestfish-actions.pod:284
4654 #: ../fish/guestfish-actions.pod:286
4657 " aug-insert augpath label true|false\n"
4662 #: ../fish/guestfish-actions.pod:288 ../src/guestfs-actions.pod:434
4664 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4665 "or after C<path> (depending on the boolean flag C<before>)."
4669 #: ../fish/guestfish-actions.pod:292 ../src/guestfs-actions.pod:438
4671 "C<path> must match exactly one existing node in the tree, and C<label> must "
4672 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4676 #: ../fish/guestfish-actions.pod:296
4681 #: ../fish/guestfish-actions.pod:298
4689 #: ../fish/guestfish-actions.pod:300 ../src/guestfs-actions.pod:451
4690 msgid "Load files into the tree."
4694 #: ../fish/guestfish-actions.pod:302 ../src/guestfs-actions.pod:453
4695 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4699 #: ../fish/guestfish-actions.pod:305
4704 #: ../fish/guestfish-actions.pod:307
4712 #: ../fish/guestfish-actions.pod:309
4714 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
4715 "resulting nodes into alphabetical order."
4719 #: ../fish/guestfish-actions.pod:312
4724 #: ../fish/guestfish-actions.pod:314
4727 " aug-match augpath\n"
4732 #: ../fish/guestfish-actions.pod:316 ../src/guestfs-actions.pod:481
4734 "Returns a list of paths which match the path expression C<path>. The "
4735 "returned paths are sufficiently qualified so that they match exactly one "
4736 "node in the current tree."
4740 #: ../fish/guestfish-actions.pod:320
4745 #: ../fish/guestfish-actions.pod:322
4748 " aug-mv src dest\n"
4753 #: ../fish/guestfish-actions.pod:324 ../src/guestfs-actions.pod:498
4755 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4756 "C<dest> is overwritten if it exists."
4760 #: ../fish/guestfish-actions.pod:327
4765 #: ../fish/guestfish-actions.pod:329
4773 #: ../fish/guestfish-actions.pod:331 ../src/guestfs-actions.pod:511
4774 msgid "Remove C<path> and all of its children."
4778 #: ../fish/guestfish-actions.pod:333 ../src/guestfs-actions.pod:513
4779 msgid "On success this returns the number of entries which were removed."
4783 #: ../fish/guestfish-actions.pod:335
4788 #: ../fish/guestfish-actions.pod:337
4796 #: ../fish/guestfish-actions.pod:339 ../src/guestfs-actions.pod:524
4797 msgid "This writes all pending changes to disk."
4801 #: ../fish/guestfish-actions.pod:341
4803 "The flags which were passed to L</aug-init> affect exactly how files are "
4808 #: ../fish/guestfish-actions.pod:344
4813 #: ../fish/guestfish-actions.pod:346
4816 " aug-set augpath val\n"
4821 #: ../fish/guestfish-actions.pod:348 ../src/guestfs-actions.pod:540
4822 msgid "Set the value associated with C<path> to C<val>."
4826 #: ../fish/guestfish-actions.pod:350
4828 "In the Augeas API, it is possible to clear a node by setting the value to "
4829 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4830 "this call. Instead you must use the L</aug-clear> call."
4834 #: ../fish/guestfish-actions.pod:355
4839 #: ../fish/guestfish-actions.pod:357
4842 " available 'groups ...'\n"
4847 #: ../fish/guestfish-actions.pod:359 ../src/guestfs-actions.pod:557
4849 "This command is used to check the availability of some groups of "
4850 "functionality in the appliance, which not all builds of the libguestfs "
4851 "appliance will be able to provide."
4855 #: ../fish/guestfish-actions.pod:363
4857 "The libguestfs groups, and the functions that those groups correspond to, "
4858 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4859 "runtime by calling L</available-all-groups>."
4863 #: ../fish/guestfish-actions.pod:368 ../src/guestfs-actions.pod:566
4865 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
4866 "\"]> would check for the availability of the Linux inotify functions and "
4867 "Augeas (configuration file editing) functions."
4871 #: ../fish/guestfish-actions.pod:373 ../src/guestfs-actions.pod:571
4872 msgid "The command returns no error if I<all> requested groups are available."
4876 #: ../fish/guestfish-actions.pod:375 ../src/guestfs-actions.pod:573
4878 "It fails with an error if one or more of the requested groups is unavailable "
4883 #: ../fish/guestfish-actions.pod:378 ../src/guestfs-actions.pod:576
4885 "If an unknown group name is included in the list of groups then an error is "
4890 #: ../fish/guestfish-actions.pod:381 ../src/guestfs-actions.pod:579
4895 #: ../fish/guestfish-actions.pod:387
4896 msgid "You must call L</launch> before calling this function."
4900 #: ../fish/guestfish-actions.pod:389 ../src/guestfs-actions.pod:587
4902 "The reason is because we don't know what groups are supported by the "
4903 "appliance/daemon until it is running and can be queried."
4907 #: ../fish/guestfish-actions.pod:395 ../src/guestfs-actions.pod:593
4909 "If a group of functions is available, this does not necessarily mean that "
4910 "they will work. You still have to check for errors when calling individual "
4911 "API functions even if they are available."
4915 #: ../fish/guestfish-actions.pod:402 ../src/guestfs-actions.pod:600
4917 "It is usually the job of distro packagers to build complete functionality "
4918 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4919 "with all requirements satisfied, will support everything."
4923 #: ../fish/guestfish-actions.pod:409
4925 "This call was added in version C<1.0.80>. In previous versions of "
4926 "libguestfs all you could do would be to speculatively execute a command to "
4927 "find out if the daemon implemented it. See also L</version>."
4931 #: ../fish/guestfish-actions.pod:416
4932 msgid "available-all-groups"
4936 #: ../fish/guestfish-actions.pod:418
4939 " available-all-groups\n"
4944 #: ../fish/guestfish-actions.pod:420
4946 "This command returns a list of all optional groups that this daemon knows "
4947 "about. Note this returns both supported and unsupported groups. To find "
4948 "out which ones the daemon can actually support you have to call L</"
4949 "available> on each member of the returned list."
4953 #: ../fish/guestfish-actions.pod:426
4954 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
4958 #: ../fish/guestfish-actions.pod:428
4963 #: ../fish/guestfish-actions.pod:430
4966 " base64-in (base64file|-) filename\n"
4971 #: ../fish/guestfish-actions.pod:432 ../src/guestfs-actions.pod:644
4973 "This command uploads base64-encoded data from C<base64file> to C<filename>."
4977 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
4978 #: ../fish/guestfish-actions.pod:693 ../fish/guestfish-actions.pod:862
4979 #: ../fish/guestfish-actions.pod:881 ../fish/guestfish-actions.pod:1255
4980 #: ../fish/guestfish-actions.pod:4658 ../fish/guestfish-actions.pod:4670
4981 #: ../fish/guestfish-actions.pod:4681 ../fish/guestfish-actions.pod:4692
4982 #: ../fish/guestfish-actions.pod:4744 ../fish/guestfish-actions.pod:4753
4983 #: ../fish/guestfish-actions.pod:4807 ../fish/guestfish-actions.pod:4830
4984 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
4988 #: ../fish/guestfish-actions.pod:437
4993 #: ../fish/guestfish-actions.pod:439
4996 " base64-out filename (base64file|-)\n"
5001 #: ../fish/guestfish-actions.pod:441 ../src/guestfs-actions.pod:658
5003 "This command downloads the contents of C<filename>, writing it out to local "
5004 "file C<base64file> encoded as base64."
5008 #: ../fish/guestfish-actions.pod:446
5009 msgid "blockdev-flushbufs"
5013 #: ../fish/guestfish-actions.pod:448
5016 " blockdev-flushbufs device\n"
5021 #: ../fish/guestfish-actions.pod:450 ../src/guestfs-actions.pod:671
5023 "This tells the kernel to flush internal buffers associated with C<device>."
5027 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
5028 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
5029 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
5030 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
5031 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
5032 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
5033 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
5034 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
5035 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
5036 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
5037 msgid "This uses the L<blockdev(8)> command."
5041 #: ../fish/guestfish-actions.pod:455
5042 msgid "blockdev-getbsz"
5046 #: ../fish/guestfish-actions.pod:457
5049 " blockdev-getbsz device\n"
5054 #: ../fish/guestfish-actions.pod:459 ../src/guestfs-actions.pod:686
5055 msgid "This returns the block size of a device."
5059 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
5060 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
5062 "(Note this is different from both I<size in blocks> and I<filesystem block "
5067 #: ../fish/guestfish-actions.pod:466
5068 msgid "blockdev-getro"
5072 #: ../fish/guestfish-actions.pod:468
5075 " blockdev-getro device\n"
5080 #: ../fish/guestfish-actions.pod:470 ../src/guestfs-actions.pod:703
5082 "Returns a boolean indicating if the block device is read-only (true if read-"
5083 "only, false if not)."
5087 #: ../fish/guestfish-actions.pod:475
5088 msgid "blockdev-getsize64"
5092 #: ../fish/guestfish-actions.pod:477
5095 " blockdev-getsize64 device\n"
5100 #: ../fish/guestfish-actions.pod:479 ../src/guestfs-actions.pod:718
5101 msgid "This returns the size of the device in bytes."
5105 #: ../fish/guestfish-actions.pod:481
5106 msgid "See also L</blockdev-getsz>."
5110 #: ../fish/guestfish-actions.pod:485
5111 msgid "blockdev-getss"
5115 #: ../fish/guestfish-actions.pod:487
5118 " blockdev-getss device\n"
5123 #: ../fish/guestfish-actions.pod:489 ../src/guestfs-actions.pod:734
5125 "This returns the size of sectors on a block device. Usually 512, but can be "
5126 "larger for modern devices."
5130 #: ../fish/guestfish-actions.pod:492
5132 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
5136 #: ../fish/guestfish-actions.pod:497
5137 msgid "blockdev-getsz"
5141 #: ../fish/guestfish-actions.pod:499
5144 " blockdev-getsz device\n"
5149 #: ../fish/guestfish-actions.pod:501 ../src/guestfs-actions.pod:752
5151 "This returns the size of the device in units of 512-byte sectors (even if "
5152 "the sectorsize isn't 512 bytes ... weird)."
5156 #: ../fish/guestfish-actions.pod:504
5158 "See also L</blockdev-getss> for the real sector size of the device, and L</"
5159 "blockdev-getsize64> for the more useful I<size in bytes>."
5163 #: ../fish/guestfish-actions.pod:510
5164 msgid "blockdev-rereadpt"
5168 #: ../fish/guestfish-actions.pod:512
5171 " blockdev-rereadpt device\n"
5176 #: ../fish/guestfish-actions.pod:514 ../src/guestfs-actions.pod:771
5177 msgid "Reread the partition table on C<device>."
5181 #: ../fish/guestfish-actions.pod:518
5182 msgid "blockdev-setbsz"
5186 #: ../fish/guestfish-actions.pod:520
5189 " blockdev-setbsz device blocksize\n"
5194 #: ../fish/guestfish-actions.pod:522 ../src/guestfs-actions.pod:786
5195 msgid "This sets the block size of a device."
5199 #: ../fish/guestfish-actions.pod:529
5200 msgid "blockdev-setro"
5204 #: ../fish/guestfish-actions.pod:531
5207 " blockdev-setro device\n"
5212 #: ../fish/guestfish-actions.pod:533 ../src/guestfs-actions.pod:803
5213 msgid "Sets the block device named C<device> to read-only."
5217 #: ../fish/guestfish-actions.pod:537
5218 msgid "blockdev-setrw"
5222 #: ../fish/guestfish-actions.pod:539
5225 " blockdev-setrw device\n"
5230 #: ../fish/guestfish-actions.pod:541 ../src/guestfs-actions.pod:817
5231 msgid "Sets the block device named C<device> to read-write."
5235 #: ../fish/guestfish-actions.pod:545
5236 msgid "btrfs-filesystem-resize"
5240 #: ../fish/guestfish-actions.pod:547
5243 " btrfs-filesystem-resize mountpoint [size:..]\n"
5248 #: ../fish/guestfish-actions.pod:549 ../src/guestfs-actions.pod:839
5249 msgid "This command resizes a btrfs filesystem."
5253 #: ../fish/guestfish-actions.pod:551 ../src/guestfs-actions.pod:841
5255 "Note that unlike other resize calls, the filesystem has to be mounted and "
5256 "the parameter is the mountpoint not the device (this is a requirement of "
5261 #: ../fish/guestfish-actions.pod:555 ../fish/guestfish-actions.pod:3417
5262 #: ../src/guestfs-actions.pod:845 ../src/guestfs-actions.pod:5189
5263 msgid "The optional parameters are:"
5267 #: ../fish/guestfish-actions.pod:559 ../fish/guestfish-actions.pod:3421
5268 #: ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:5193
5273 #: ../fish/guestfish-actions.pod:561 ../src/guestfs-actions.pod:851
5275 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
5276 "resized to the maximum size."
5280 #: ../fish/guestfish-actions.pod:566 ../src/guestfs-actions.pod:856
5281 msgid "See also L<btrfs(8)>."
5285 #: ../fish/guestfish-actions.pod:570
5286 msgid "case-sensitive-path"
5290 #: ../fish/guestfish-actions.pod:572
5293 " case-sensitive-path path\n"
5298 #: ../fish/guestfish-actions.pod:574 ../src/guestfs-actions.pod:890
5300 "This can be used to resolve case insensitive paths on a filesystem which is "
5301 "case sensitive. The use case is to resolve paths which you have read from "
5302 "Windows configuration files or the Windows Registry, to the true path."
5306 #: ../fish/guestfish-actions.pod:579 ../src/guestfs-actions.pod:895
5308 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5309 "(and probably others), which is that although the underlying filesystem is "
5310 "case-insensitive, the driver exports the filesystem to Linux as case-"
5315 #: ../fish/guestfish-actions.pod:584 ../src/guestfs-actions.pod:900
5317 "One consequence of this is that special directories such as C<c:\\windows> "
5318 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5319 "precise details of how they were created. In Windows itself this would not "
5324 #: ../fish/guestfish-actions.pod:590 ../src/guestfs-actions.pod:906
5326 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5331 #: ../fish/guestfish-actions.pod:593 ../src/guestfs-actions.pod:909
5333 "This function resolves the true case of each element in the path and returns "
5334 "the case-sensitive path."
5338 #: ../fish/guestfish-actions.pod:596
5340 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
5341 "WINDOWS/system32\"> (the exact return value would depend on details of how "
5342 "the directories were originally created under Windows)."
5346 #: ../fish/guestfish-actions.pod:601 ../src/guestfs-actions.pod:917
5347 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5351 #: ../fish/guestfish-actions.pod:604
5352 msgid "See also L</realpath>."
5356 #: ../fish/guestfish-actions.pod:606
5361 #: ../fish/guestfish-actions.pod:608
5369 #: ../fish/guestfish-actions.pod:610 ../fish/guestfish-actions.pod:3837
5370 #: ../src/guestfs-actions.pod:933 ../src/guestfs-actions.pod:5832
5371 msgid "Return the contents of the file named C<path>."
5375 #: ../fish/guestfish-actions.pod:612
5377 "Note that this function cannot correctly handle binary files (specifically, "
5378 "files containing C<\\0> character which is treated as end of string). For "
5379 "those you need to use the L</read-file> or L</download> functions which have "
5380 "a more complex interface."
5384 #: ../fish/guestfish-actions.pod:617 ../fish/guestfish-actions.pod:752
5385 #: ../fish/guestfish-actions.pod:764 ../fish/guestfish-actions.pod:940
5386 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:1017
5387 #: ../fish/guestfish-actions.pod:1027 ../fish/guestfish-actions.pod:1219
5388 #: ../fish/guestfish-actions.pod:1526 ../fish/guestfish-actions.pod:1536
5389 #: ../fish/guestfish-actions.pod:1564 ../fish/guestfish-actions.pod:1579
5390 #: ../fish/guestfish-actions.pod:1589 ../fish/guestfish-actions.pod:1608
5391 #: ../fish/guestfish-actions.pod:3707 ../fish/guestfish-actions.pod:3722
5392 #: ../fish/guestfish-actions.pod:3798 ../fish/guestfish-actions.pod:3815
5393 #: ../fish/guestfish-actions.pod:3830 ../fish/guestfish-actions.pod:4499
5394 #: ../fish/guestfish-actions.pod:4545 ../fish/guestfish-actions.pod:4630
5395 #: ../fish/guestfish-actions.pod:4645 ../fish/guestfish-actions.pod:5051
5396 #: ../fish/guestfish-actions.pod:5063 ../fish/guestfish-actions.pod:5081
5397 #: ../fish/guestfish-actions.pod:5098 ../fish/guestfish-actions.pod:5108
5398 #: ../fish/guestfish-actions.pod:5157 ../fish/guestfish-actions.pod:5167
5399 #: ../fish/guestfish-actions.pod:5196 ../fish/guestfish-actions.pod:5206
5400 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1122
5401 #: ../src/guestfs-actions.pod:1142 ../src/guestfs-actions.pod:1438
5402 #: ../src/guestfs-actions.pod:1457 ../src/guestfs-actions.pod:1560
5403 #: ../src/guestfs-actions.pod:1579 ../src/guestfs-actions.pod:1825
5404 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:2315
5405 #: ../src/guestfs-actions.pod:2358 ../src/guestfs-actions.pod:2382
5406 #: ../src/guestfs-actions.pod:2399 ../src/guestfs-actions.pod:2428
5407 #: ../src/guestfs-actions.pod:5614 ../src/guestfs-actions.pod:5640
5408 #: ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5797
5409 #: ../src/guestfs-actions.pod:5821 ../src/guestfs-actions.pod:6772
5410 #: ../src/guestfs-actions.pod:6827 ../src/guestfs-actions.pod:6973
5411 #: ../src/guestfs-actions.pod:6997 ../src/guestfs-actions.pod:7662
5412 #: ../src/guestfs-actions.pod:7682 ../src/guestfs-actions.pod:7708
5413 #: ../src/guestfs-actions.pod:7734 ../src/guestfs-actions.pod:7753
5414 #: ../src/guestfs-actions.pod:7839 ../src/guestfs-actions.pod:7858
5415 #: ../src/guestfs-actions.pod:7904 ../src/guestfs-actions.pod:7923
5417 "Because of the message protocol, there is a transfer limit of somewhere "
5418 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5422 #: ../fish/guestfish-actions.pod:620
5427 #: ../fish/guestfish-actions.pod:622
5430 " checksum csumtype path\n"
5435 #: ../fish/guestfish-actions.pod:624 ../src/guestfs-actions.pod:955
5437 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5441 #: ../fish/guestfish-actions.pod:627 ../src/guestfs-actions.pod:958
5443 "The type of checksum to compute is given by the C<csumtype> parameter which "
5444 "must have one of the following values:"
5448 #: ../fish/guestfish-actions.pod:632 ../src/guestfs-actions.pod:963
5453 #: ../fish/guestfish-actions.pod:634 ../src/guestfs-actions.pod:965
5455 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5460 #: ../fish/guestfish-actions.pod:637 ../src/guestfs-actions.pod:968
5465 #: ../fish/guestfish-actions.pod:639 ../src/guestfs-actions.pod:970
5466 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5470 #: ../fish/guestfish-actions.pod:641 ../src/guestfs-actions.pod:972
5475 #: ../fish/guestfish-actions.pod:643 ../src/guestfs-actions.pod:974
5476 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5480 #: ../fish/guestfish-actions.pod:645 ../src/guestfs-actions.pod:976
5485 #: ../fish/guestfish-actions.pod:647 ../src/guestfs-actions.pod:978
5486 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5490 #: ../fish/guestfish-actions.pod:649 ../src/guestfs-actions.pod:980
5495 #: ../fish/guestfish-actions.pod:651 ../src/guestfs-actions.pod:982
5496 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5500 #: ../fish/guestfish-actions.pod:653 ../src/guestfs-actions.pod:984
5505 #: ../fish/guestfish-actions.pod:655 ../src/guestfs-actions.pod:986
5506 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5510 #: ../fish/guestfish-actions.pod:657 ../src/guestfs-actions.pod:988
5515 #: ../fish/guestfish-actions.pod:659 ../src/guestfs-actions.pod:990
5516 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5520 #: ../fish/guestfish-actions.pod:663 ../src/guestfs-actions.pod:994
5521 msgid "The checksum is returned as a printable string."
5525 #: ../fish/guestfish-actions.pod:665
5526 msgid "To get the checksum for a device, use L</checksum-device>."
5530 #: ../fish/guestfish-actions.pod:667
5531 msgid "To get the checksums for many files, use L</checksums-out>."
5535 #: ../fish/guestfish-actions.pod:669
5536 msgid "checksum-device"
5540 #: ../fish/guestfish-actions.pod:671
5543 " checksum-device csumtype device\n"
5548 #: ../fish/guestfish-actions.pod:673
5550 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5551 "device named C<device>. For the types of checksums supported see the L</"
5552 "checksum> command."
5556 #: ../fish/guestfish-actions.pod:677
5557 msgid "checksums-out"
5561 #: ../fish/guestfish-actions.pod:679
5564 " checksums-out csumtype directory (sumsfile|-)\n"
5569 #: ../fish/guestfish-actions.pod:681 ../src/guestfs-actions.pod:1029
5571 "This command computes the checksums of all regular files in C<directory> and "
5572 "then emits a list of those checksums to the local output file C<sumsfile>."
5576 #: ../fish/guestfish-actions.pod:685 ../src/guestfs-actions.pod:1033
5578 "This can be used for verifying the integrity of a virtual machine. However "
5579 "to be properly secure you should pay attention to the output of the checksum "
5580 "command (it uses the ones from GNU coreutils). In particular when the "
5581 "filename is not printable, coreutils uses a special backslash syntax. For "
5582 "more information, see the GNU coreutils info file."
5586 #: ../fish/guestfish-actions.pod:695
5591 #: ../fish/guestfish-actions.pod:697
5594 " chmod mode path\n"
5599 #: ../fish/guestfish-actions.pod:699 ../src/guestfs-actions.pod:1052
5601 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5606 #: ../fish/guestfish-actions.pod:702 ../src/guestfs-actions.pod:1055
5608 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5609 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5614 #: ../fish/guestfish-actions.pod:706 ../fish/guestfish-actions.pod:3060
5615 #: ../fish/guestfish-actions.pod:3199 ../fish/guestfish-actions.pod:3209
5616 #: ../fish/guestfish-actions.pod:3219 ../src/guestfs-actions.pod:1059
5617 #: ../src/guestfs-actions.pod:4586 ../src/guestfs-actions.pod:4795
5618 #: ../src/guestfs-actions.pod:4814 ../src/guestfs-actions.pod:4833
5619 msgid "The mode actually set is affected by the umask."
5623 #: ../fish/guestfish-actions.pod:708
5628 #: ../fish/guestfish-actions.pod:710
5631 " chown owner group path\n"
5636 #: ../fish/guestfish-actions.pod:712 ../src/guestfs-actions.pod:1073
5637 msgid "Change the file owner to C<owner> and group to C<group>."
5641 #: ../fish/guestfish-actions.pod:714 ../fish/guestfish-actions.pod:2495
5642 #: ../src/guestfs-actions.pod:1075 ../src/guestfs-actions.pod:3657
5644 "Only numeric uid and gid are supported. If you want to use names, you will "
5645 "need to locate and parse the password file yourself (Augeas support makes "
5646 "this relatively easy)."
5650 #: ../fish/guestfish-actions.pod:718
5655 #: ../fish/guestfish-actions.pod:720
5658 " command 'arguments ...'\n"
5663 #: ../fish/guestfish-actions.pod:722 ../src/guestfs-actions.pod:1089
5665 "This call runs a command from the guest filesystem. The filesystem must be "
5666 "mounted, and must contain a compatible operating system (ie. something "
5667 "Linux, with the same or compatible processor architecture)."
5671 #: ../fish/guestfish-actions.pod:727
5673 "The single parameter is an argv-style list of arguments. The first element "
5674 "is the name of the program to run. Subsequent elements are parameters. The "
5675 "list must be non-empty (ie. must contain a program name). Note that the "
5676 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
5680 #: ../fish/guestfish-actions.pod:734 ../src/guestfs-actions.pod:1101
5681 msgid "The return value is anything printed to I<stdout> by the command."
5685 #: ../fish/guestfish-actions.pod:737 ../src/guestfs-actions.pod:1104
5687 "If the command returns a non-zero exit status, then this function returns an "
5688 "error message. The error message string is the content of I<stderr> from "
5693 #: ../fish/guestfish-actions.pod:741 ../src/guestfs-actions.pod:1108
5695 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
5696 "bin>. If you require a program from another location, you should provide "
5697 "the full path in the first parameter."
5701 #: ../fish/guestfish-actions.pod:746 ../src/guestfs-actions.pod:1113
5703 "Shared libraries and data files required by the program must be available on "
5704 "filesystems which are mounted in the correct places. It is the caller's "
5705 "responsibility to ensure all filesystems that are needed are mounted at the "
5710 #: ../fish/guestfish-actions.pod:755
5711 msgid "command-lines"
5715 #: ../fish/guestfish-actions.pod:757
5718 " command-lines 'arguments ...'\n"
5723 #: ../fish/guestfish-actions.pod:759
5725 "This is the same as L</command>, but splits the result into a list of lines."
5729 #: ../fish/guestfish-actions.pod:762
5730 msgid "See also: L</sh-lines>"
5734 #: ../fish/guestfish-actions.pod:767
5739 #: ../fish/guestfish-actions.pod:769
5742 " config qemuparam qemuvalue\n"
5747 #: ../fish/guestfish-actions.pod:771 ../src/guestfs-actions.pod:1154
5749 "This can be used to add arbitrary qemu command line parameters of the form "
5750 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
5751 "setting some parameters which would interfere with parameters that we use."
5755 #: ../fish/guestfish-actions.pod:776 ../src/guestfs-actions.pod:1159
5756 msgid "The first character of C<param> string must be a C<-> (dash)."
5760 #: ../fish/guestfish-actions.pod:778 ../src/guestfs-actions.pod:1161
5761 msgid "C<value> can be NULL."
5765 #: ../fish/guestfish-actions.pod:780
5770 #: ../fish/guestfish-actions.pod:782
5773 " copy-size src dest size\n"
5778 #: ../fish/guestfish-actions.pod:784 ../src/guestfs-actions.pod:1175
5780 "This command copies exactly C<size> bytes from one source device or file "
5781 "C<src> to another destination device or file C<dest>."
5785 #: ../fish/guestfish-actions.pod:787 ../src/guestfs-actions.pod:1178
5787 "Note this will fail if the source is too short or if the destination is not "
5792 #: ../fish/guestfish-actions.pod:790
5797 #: ../fish/guestfish-actions.pod:792
5805 #: ../fish/guestfish-actions.pod:794 ../src/guestfs-actions.pod:1197
5807 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5808 "destination filename or destination directory."
5812 #: ../fish/guestfish-actions.pod:797
5817 #: ../fish/guestfish-actions.pod:799
5825 #: ../fish/guestfish-actions.pod:801 ../src/guestfs-actions.pod:1211
5827 "This copies a file or directory from C<src> to C<dest> recursively using the "
5832 #: ../fish/guestfish-actions.pod:804
5837 #: ../fish/guestfish-actions.pod:806
5845 #: ../fish/guestfish-actions.pod:808 ../src/guestfs-actions.pod:1225
5847 "This command copies from one source device or file C<src> to another "
5848 "destination device or file C<dest>. Normally you would use this to copy to "
5849 "or from a device or partition, for example to duplicate a filesystem."
5853 #: ../fish/guestfish-actions.pod:813
5855 "If the destination is a device, it must be as large or larger than the "
5856 "source file or device, otherwise the copy will fail. This command cannot do "
5857 "partial copies (see L</copy-size>)."
5861 #: ../fish/guestfish-actions.pod:817
5866 #: ../fish/guestfish-actions.pod:819
5874 #: ../fish/guestfish-actions.pod:821 ../src/guestfs-actions.pod:1243
5875 msgid "This command runs the C<df> command to report disk space used."
5879 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:834
5881 "This command is mostly useful for interactive sessions. It is I<not> "
5882 "intended that you try to parse the output string. Use L</statvfs> from "
5887 #: ../fish/guestfish-actions.pod:827
5892 #: ../fish/guestfish-actions.pod:829
5900 #: ../fish/guestfish-actions.pod:831 ../src/guestfs-actions.pod:1259
5902 "This command runs the C<df -h> command to report disk space used in human-"
5907 #: ../fish/guestfish-actions.pod:838
5912 #: ../fish/guestfish-actions.pod:840
5920 #: ../fish/guestfish-actions.pod:842 ../src/guestfs-actions.pod:1276
5922 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5923 "This is sometimes useful for extended debugging of problems."
5927 #: ../fish/guestfish-actions.pod:846
5929 "Another way to get the same information is to enable verbose messages with "
5930 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
5931 "before running the program."
5935 #: ../fish/guestfish-actions.pod:851
5940 #: ../fish/guestfish-actions.pod:853
5943 " download remotefilename (filename|-)\n"
5948 #: ../fish/guestfish-actions.pod:855 ../fish/guestfish-actions.pod:868
5949 #: ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1322
5951 "Download file C<remotefilename> and save it as C<filename> on the local "
5956 #: ../fish/guestfish-actions.pod:858 ../fish/guestfish-actions.pod:4803
5957 #: ../src/guestfs-actions.pod:1300 ../src/guestfs-actions.pod:7232
5958 msgid "C<filename> can also be a named pipe."
5962 #: ../fish/guestfish-actions.pod:860
5963 msgid "See also L</upload>, L</cat>."
5967 #: ../fish/guestfish-actions.pod:864
5968 msgid "download-offset"
5972 #: ../fish/guestfish-actions.pod:866
5975 " download-offset remotefilename (filename|-) offset size\n"
5980 #: ../fish/guestfish-actions.pod:871 ../src/guestfs-actions.pod:1325
5982 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
5983 "region must be within the file or device)."
5987 #: ../fish/guestfish-actions.pod:874
5989 "Note that there is no limit on the amount of data that can be downloaded "
5990 "with this call, unlike with L</pread>, and this call always reads the full "
5991 "amount unless an error occurs."
5995 #: ../fish/guestfish-actions.pod:879
5996 msgid "See also L</download>, L</pread>."
6000 #: ../fish/guestfish-actions.pod:883
6005 #: ../fish/guestfish-actions.pod:885
6008 " drop-caches whattodrop\n"
6013 #: ../fish/guestfish-actions.pod:887 ../src/guestfs-actions.pod:1350
6015 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6016 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6017 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6021 #: ../fish/guestfish-actions.pod:892 ../src/guestfs-actions.pod:1355
6022 msgid "Setting C<whattodrop> to 3 should drop everything."
6026 #: ../fish/guestfish-actions.pod:894 ../src/guestfs-actions.pod:1357
6028 "This automatically calls L<sync(2)> before the operation, so that the "
6029 "maximum guest memory is freed."
6033 #: ../fish/guestfish-actions.pod:897
6038 #: ../fish/guestfish-actions.pod:899
6046 #: ../fish/guestfish-actions.pod:901 ../src/guestfs-actions.pod:1370
6048 "This command runs the C<du -s> command to estimate file space usage for "
6053 #: ../fish/guestfish-actions.pod:904 ../src/guestfs-actions.pod:1373
6055 "C<path> can be a file or a directory. If C<path> is a directory then the "
6056 "estimate includes the contents of the directory and all subdirectories "
6061 #: ../fish/guestfish-actions.pod:908 ../src/guestfs-actions.pod:1377
6063 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6067 #: ../fish/guestfish-actions.pod:911
6072 #: ../fish/guestfish-actions.pod:913
6075 " e2fsck-f device\n"
6080 #: ../fish/guestfish-actions.pod:915 ../src/guestfs-actions.pod:1395
6082 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6083 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
6088 #: ../fish/guestfish-actions.pod:919
6090 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
6091 "should use L</fsck>."
6095 #: ../fish/guestfish-actions.pod:922
6100 #: ../fish/guestfish-actions.pod:924
6103 " echo-daemon 'words ...'\n"
6108 #: ../fish/guestfish-actions.pod:926 ../src/guestfs-actions.pod:1412
6110 "This command concatenates the list of C<words> passed with single spaces "
6111 "between them and returns the resulting string."
6115 #: ../fish/guestfish-actions.pod:929 ../src/guestfs-actions.pod:1415
6116 msgid "You can use this command to test the connection through to the daemon."
6120 #: ../fish/guestfish-actions.pod:931
6121 msgid "See also L</ping-daemon>."
6125 #: ../fish/guestfish-actions.pod:933
6130 #: ../fish/guestfish-actions.pod:935
6133 " egrep regex path\n"
6138 #: ../fish/guestfish-actions.pod:937 ../src/guestfs-actions.pod:1431
6140 "This calls the external C<egrep> program and returns the matching lines."
6144 #: ../fish/guestfish-actions.pod:943
6149 #: ../fish/guestfish-actions.pod:945
6152 " egrepi regex path\n"
6157 #: ../fish/guestfish-actions.pod:947 ../src/guestfs-actions.pod:1450
6159 "This calls the external C<egrep -i> program and returns the matching lines."
6163 #: ../fish/guestfish-actions.pod:953
6168 #: ../fish/guestfish-actions.pod:955
6171 " equal file1 file2\n"
6176 #: ../fish/guestfish-actions.pod:957 ../src/guestfs-actions.pod:1469
6178 "This compares the two files C<file1> and C<file2> and returns true if their "
6179 "content is exactly equal, or false otherwise."
6183 #: ../fish/guestfish-actions.pod:960 ../src/guestfs-actions.pod:1472
6184 msgid "The external L<cmp(1)> program is used for the comparison."
6188 #: ../fish/guestfish-actions.pod:962
6193 #: ../fish/guestfish-actions.pod:964
6201 #: ../fish/guestfish-actions.pod:966 ../src/guestfs-actions.pod:1484
6203 "This returns C<true> if and only if there is a file, directory (or anything) "
6204 "with the given C<path> name."
6208 #: ../fish/guestfish-actions.pod:969
6209 msgid "See also L</is-file>, L</is-dir>, L</stat>."
6213 #: ../fish/guestfish-actions.pod:971
6218 #: ../fish/guestfish-actions.pod:973
6221 " fallocate path len\n"
6226 #: ../fish/guestfish-actions.pod:975 ../fish/guestfish-actions.pod:994
6227 #: ../src/guestfs-actions.pod:1500 ../src/guestfs-actions.pod:1526
6229 "This command preallocates a file (containing zero bytes) named C<path> of "
6230 "size C<len> bytes. If the file exists already, it is overwritten."
6234 #: ../fish/guestfish-actions.pod:979 ../src/guestfs-actions.pod:1504
6236 "Do not confuse this with the guestfish-specific C<alloc> command which "
6237 "allocates a file in the host and attaches it as a device."
6241 #: ../fish/guestfish-actions.pod:983 ../src/guestfs-actions.pod:1510
6243 "This function is deprecated. In new code, use the C<fallocate64> call "
6248 #: ../fish/guestfish-actions.pod:990
6253 #: ../fish/guestfish-actions.pod:992
6256 " fallocate64 path len\n"
6261 #: ../fish/guestfish-actions.pod:998
6263 "Note that this call allocates disk blocks for the file. To create a sparse "
6264 "file use L</truncate-size> instead."
6268 #: ../fish/guestfish-actions.pod:1001
6270 "The deprecated call L</fallocate> does the same, but owing to an oversight "
6271 "it only allowed 30 bit lengths to be specified, effectively limiting the "
6272 "maximum size of files created through that call to 1GB."
6276 #: ../fish/guestfish-actions.pod:1006 ../src/guestfs-actions.pod:1538
6278 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6279 "commands which create a file in the host and attach it as a device."
6283 #: ../fish/guestfish-actions.pod:1010
6288 #: ../fish/guestfish-actions.pod:1012
6291 " fgrep pattern path\n"
6296 #: ../fish/guestfish-actions.pod:1014 ../src/guestfs-actions.pod:1553
6298 "This calls the external C<fgrep> program and returns the matching lines."
6302 #: ../fish/guestfish-actions.pod:1020
6307 #: ../fish/guestfish-actions.pod:1022
6310 " fgrepi pattern path\n"
6315 #: ../fish/guestfish-actions.pod:1024 ../src/guestfs-actions.pod:1572
6317 "This calls the external C<fgrep -i> program and returns the matching lines."
6321 #: ../fish/guestfish-actions.pod:1030
6326 #: ../fish/guestfish-actions.pod:1032
6334 #: ../fish/guestfish-actions.pod:1034 ../src/guestfs-actions.pod:1590
6336 "This call uses the standard L<file(1)> command to determine the type or "
6337 "contents of the file."
6341 #: ../fish/guestfish-actions.pod:1037 ../src/guestfs-actions.pod:1593
6343 "This call will also transparently look inside various types of compressed "
6348 #: ../fish/guestfish-actions.pod:1040 ../src/guestfs-actions.pod:1596
6350 "The exact command which runs is C<file -zb path>. Note in particular that "
6351 "the filename is not prepended to the output (the I<-b> option)."
6355 #: ../fish/guestfish-actions.pod:1044 ../src/guestfs-actions.pod:1600
6357 "The output depends on the output of the underlying L<file(1)> command and it "
6358 "can change in future in ways beyond our control. In other words, the output "
6359 "is not guaranteed by the ABI."
6363 #: ../fish/guestfish-actions.pod:1048
6365 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
6366 "(etc), L</is-zero>."
6370 #: ../fish/guestfish-actions.pod:1051
6371 msgid "file-architecture"
6375 #: ../fish/guestfish-actions.pod:1053
6378 " file-architecture filename\n"
6383 #: ../fish/guestfish-actions.pod:1055 ../src/guestfs-actions.pod:1618
6385 "This detects the architecture of the binary C<filename>, and returns it if "
6390 #: ../fish/guestfish-actions.pod:1058 ../src/guestfs-actions.pod:1621
6391 msgid "Currently defined architectures are:"
6395 #: ../fish/guestfish-actions.pod:1062 ../src/guestfs-actions.pod:1625
6400 #: ../fish/guestfish-actions.pod:1064 ../src/guestfs-actions.pod:1627
6402 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6403 "irrespective of the precise processor requirements of the binary."
6407 #: ../fish/guestfish-actions.pod:1067 ../src/guestfs-actions.pod:1630
6412 #: ../fish/guestfish-actions.pod:1069 ../src/guestfs-actions.pod:1632
6413 msgid "64 bit x86-64."
6417 #: ../fish/guestfish-actions.pod:1071 ../src/guestfs-actions.pod:1634
6422 #: ../fish/guestfish-actions.pod:1073 ../src/guestfs-actions.pod:1636
6423 msgid "32 bit SPARC."
6427 #: ../fish/guestfish-actions.pod:1075 ../src/guestfs-actions.pod:1638
6432 #: ../fish/guestfish-actions.pod:1077 ../src/guestfs-actions.pod:1640
6433 msgid "64 bit SPARC V9 and above."
6437 #: ../fish/guestfish-actions.pod:1079 ../src/guestfs-actions.pod:1642
6442 #: ../fish/guestfish-actions.pod:1081 ../src/guestfs-actions.pod:1644
6443 msgid "Intel Itanium."
6447 #: ../fish/guestfish-actions.pod:1083 ../src/guestfs-actions.pod:1646
6452 #: ../fish/guestfish-actions.pod:1085 ../src/guestfs-actions.pod:1648
6453 msgid "32 bit Power PC."
6457 #: ../fish/guestfish-actions.pod:1087 ../src/guestfs-actions.pod:1650
6462 #: ../fish/guestfish-actions.pod:1089 ../src/guestfs-actions.pod:1652
6463 msgid "64 bit Power PC."
6467 #: ../fish/guestfish-actions.pod:1093 ../src/guestfs-actions.pod:1656
6468 msgid "Libguestfs may return other architecture strings in future."
6472 #: ../fish/guestfish-actions.pod:1095 ../src/guestfs-actions.pod:1658
6473 msgid "The function works on at least the following types of files:"
6477 #: ../fish/guestfish-actions.pod:1101 ../src/guestfs-actions.pod:1664
6478 msgid "many types of Un*x and Linux binary"
6482 #: ../fish/guestfish-actions.pod:1105 ../src/guestfs-actions.pod:1668
6483 msgid "many types of Un*x and Linux shared library"
6487 #: ../fish/guestfish-actions.pod:1109 ../src/guestfs-actions.pod:1672
6488 msgid "Windows Win32 and Win64 binaries"
6492 #: ../fish/guestfish-actions.pod:1113 ../src/guestfs-actions.pod:1676
6493 msgid "Windows Win32 and Win64 DLLs"
6497 #: ../fish/guestfish-actions.pod:1115 ../src/guestfs-actions.pod:1678
6498 msgid "Win32 binaries and DLLs return C<i386>."
6502 #: ../fish/guestfish-actions.pod:1117 ../src/guestfs-actions.pod:1680
6503 msgid "Win64 binaries and DLLs return C<x86_64>."
6507 #: ../fish/guestfish-actions.pod:1121 ../src/guestfs-actions.pod:1684
6508 msgid "Linux kernel modules"
6512 #: ../fish/guestfish-actions.pod:1125 ../src/guestfs-actions.pod:1688
6513 msgid "Linux new-style initrd images"
6517 #: ../fish/guestfish-actions.pod:1129 ../src/guestfs-actions.pod:1692
6518 msgid "some non-x86 Linux vmlinuz kernels"
6522 #: ../fish/guestfish-actions.pod:1133 ../src/guestfs-actions.pod:1696
6523 msgid "What it can't do currently:"
6527 #: ../fish/guestfish-actions.pod:1139 ../src/guestfs-actions.pod:1702
6528 msgid "static libraries (libfoo.a)"
6532 #: ../fish/guestfish-actions.pod:1143 ../src/guestfs-actions.pod:1706
6533 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6537 #: ../fish/guestfish-actions.pod:1147 ../src/guestfs-actions.pod:1710
6538 msgid "x86 Linux vmlinuz kernels"
6542 #: ../fish/guestfish-actions.pod:1149 ../src/guestfs-actions.pod:1712
6544 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6545 "compressed code, and are horribly hard to unpack. If you want to find the "
6546 "architecture of a kernel, use the architecture of the associated initrd or "
6547 "kernel module(s) instead."
6551 #: ../fish/guestfish-actions.pod:1156
6556 #: ../fish/guestfish-actions.pod:1158
6564 #: ../fish/guestfish-actions.pod:1160 ../src/guestfs-actions.pod:1730
6565 msgid "This command returns the size of C<file> in bytes."
6569 #: ../fish/guestfish-actions.pod:1162
6571 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
6572 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
6576 #: ../fish/guestfish-actions.pod:1166
6581 #: ../fish/guestfish-actions.pod:1168
6584 " fill c len path\n"
6589 #: ../fish/guestfish-actions.pod:1170 ../src/guestfs-actions.pod:1748
6591 "This command creates a new file called C<path>. The initial content of the "
6592 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
6597 #: ../fish/guestfish-actions.pod:1174
6599 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6600 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
6605 #: ../fish/guestfish-actions.pod:1179
6606 msgid "fill-pattern"
6610 #: ../fish/guestfish-actions.pod:1181
6613 " fill-pattern pattern len path\n"
6618 #: ../fish/guestfish-actions.pod:1183
6620 "This function is like L</fill> except that it creates a new file of length "
6621 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
6622 "is truncated if necessary to ensure the length of the file is exactly C<len> "
6627 #: ../fish/guestfish-actions.pod:1188
6632 #: ../fish/guestfish-actions.pod:1190
6640 #: ../fish/guestfish-actions.pod:1192 ../src/guestfs-actions.pod:1794
6642 "This command lists out all files and directories, recursively, starting at "
6643 "C<directory>. It is essentially equivalent to running the shell command "
6644 "C<find directory -print> but some post-processing happens on the output, "
6649 #: ../fish/guestfish-actions.pod:1197 ../src/guestfs-actions.pod:1799
6651 "This returns a list of strings I<without any prefix>. Thus if the directory "
6656 #: ../fish/guestfish-actions.pod:1200 ../src/guestfs-actions.pod:1802
6666 #: ../fish/guestfish-actions.pod:1204
6667 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
6671 #: ../fish/guestfish-actions.pod:1207 ../src/guestfs-actions.pod:1809
6682 #: ../fish/guestfish-actions.pod:1212 ../src/guestfs-actions.pod:1814
6683 msgid "If C<directory> is not a directory, then this command returns an error."
6687 #: ../fish/guestfish-actions.pod:1215 ../src/guestfs-actions.pod:1817
6688 msgid "The returned list is sorted."
6692 #: ../fish/guestfish-actions.pod:1217
6693 msgid "See also L</find0>."
6697 #: ../fish/guestfish-actions.pod:1222
6702 #: ../fish/guestfish-actions.pod:1224
6705 " find0 directory (files|-)\n"
6710 #: ../fish/guestfish-actions.pod:1226 ../src/guestfs-actions.pod:1837
6712 "This command lists out all files and directories, recursively, starting at "
6713 "C<directory>, placing the resulting list in the external file called "
6718 #: ../fish/guestfish-actions.pod:1230
6720 "This command works the same way as L</find> with the following exceptions:"
6724 #: ../fish/guestfish-actions.pod:1237 ../src/guestfs-actions.pod:1848
6725 msgid "The resulting list is written to an external file."
6729 #: ../fish/guestfish-actions.pod:1241 ../src/guestfs-actions.pod:1852
6731 "Items (filenames) in the result are separated by C<\\0> characters. See "
6732 "L<find(1)> option I<-print0>."
6736 #: ../fish/guestfish-actions.pod:1246 ../src/guestfs-actions.pod:1857
6737 msgid "This command is not limited in the number of names that it can return."
6741 #: ../fish/guestfish-actions.pod:1251 ../src/guestfs-actions.pod:1862
6742 msgid "The result list is not sorted."
6746 #: ../fish/guestfish-actions.pod:1257
6747 msgid "findfs-label"
6751 #: ../fish/guestfish-actions.pod:1259
6754 " findfs-label label\n"
6759 #: ../fish/guestfish-actions.pod:1261 ../src/guestfs-actions.pod:1876
6761 "This command searches the filesystems and returns the one which has the "
6762 "given label. An error is returned if no such filesystem can be found."
6766 #: ../fish/guestfish-actions.pod:1265
6767 msgid "To find the label of a filesystem, use L</vfs-label>."
6771 #: ../fish/guestfish-actions.pod:1267
6776 #: ../fish/guestfish-actions.pod:1269
6779 " findfs-uuid uuid\n"
6784 #: ../fish/guestfish-actions.pod:1271 ../src/guestfs-actions.pod:1893
6786 "This command searches the filesystems and returns the one which has the "
6787 "given UUID. An error is returned if no such filesystem can be found."
6791 #: ../fish/guestfish-actions.pod:1275
6792 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
6796 #: ../fish/guestfish-actions.pod:1277
6801 #: ../fish/guestfish-actions.pod:1279
6804 " fsck fstype device\n"
6809 #: ../fish/guestfish-actions.pod:1281 ../src/guestfs-actions.pod:1911
6811 "This runs the filesystem checker (fsck) on C<device> which should have "
6812 "filesystem type C<fstype>."
6816 #: ../fish/guestfish-actions.pod:1284 ../src/guestfs-actions.pod:1914
6818 "The returned integer is the status. See L<fsck(8)> for the list of status "
6819 "codes from C<fsck>."
6823 #: ../fish/guestfish-actions.pod:1293 ../src/guestfs-actions.pod:1923
6824 msgid "Multiple status codes can be summed together."
6828 #: ../fish/guestfish-actions.pod:1297 ../src/guestfs-actions.pod:1927
6830 "A non-zero return code can mean \"success\", for example if errors have been "
6831 "corrected on the filesystem."
6835 #: ../fish/guestfish-actions.pod:1302 ../src/guestfs-actions.pod:1932
6836 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6840 #: ../fish/guestfish-actions.pod:1307 ../src/guestfs-actions.pod:1937
6842 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6846 #: ../fish/guestfish-actions.pod:1309
6851 #: ../fish/guestfish-actions.pod:1311
6859 #: ../fish/guestfish-actions.pod:1313 ../src/guestfs-actions.pod:1948
6861 "Return the additional kernel options which are added to the guest kernel "
6866 #: ../fish/guestfish-actions.pod:1316 ../src/guestfs-actions.pod:1951
6867 msgid "If C<NULL> then no options are added."
6871 #: ../fish/guestfish-actions.pod:1318
6872 msgid "get-attach-method"
6876 #: ../fish/guestfish-actions.pod:1320
6879 " get-attach-method\n"
6884 #: ../fish/guestfish-actions.pod:1322
6885 msgid "Return the current attach method. See L</set-attach-method>."
6889 #: ../fish/guestfish-actions.pod:1324
6890 msgid "get-autosync"
6894 #: ../fish/guestfish-actions.pod:1326
6902 #: ../fish/guestfish-actions.pod:1328 ../src/guestfs-actions.pod:1976
6903 msgid "Get the autosync flag."
6907 #: ../fish/guestfish-actions.pod:1330
6912 #: ../fish/guestfish-actions.pod:1332
6920 #: ../fish/guestfish-actions.pod:1334 ../src/guestfs-actions.pod:1987
6921 msgid "Return the direct appliance mode flag."
6925 #: ../fish/guestfish-actions.pod:1336
6930 #: ../fish/guestfish-actions.pod:1338
6933 " get-e2label device\n"
6938 #: ../fish/guestfish-actions.pod:1340 ../src/guestfs-actions.pod:1999
6940 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6944 #: ../fish/guestfish-actions.pod:1343 ../src/guestfs-actions.pod:2005
6946 "This function is deprecated. In new code, use the C<vfs_label> call instead."
6950 #: ../fish/guestfish-actions.pod:1350
6955 #: ../fish/guestfish-actions.pod:1352
6958 " get-e2uuid device\n"
6963 #: ../fish/guestfish-actions.pod:1354 ../src/guestfs-actions.pod:2020
6965 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6969 #: ../fish/guestfish-actions.pod:1357 ../src/guestfs-actions.pod:2026
6971 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
6975 #: ../fish/guestfish-actions.pod:1364
6980 #: ../fish/guestfish-actions.pod:1366
6988 #: ../fish/guestfish-actions.pod:1368 ../src/guestfs-actions.pod:2040
6990 "This gets the memory size in megabytes allocated to the qemu subprocess."
6994 #: ../fish/guestfish-actions.pod:1371
6996 "If L</set-memsize> was not called on this handle, and if "
6997 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
6998 "value for memsize."
7002 #: ../fish/guestfish-actions.pod:1375 ../fish/guestfish-actions.pod:1432
7003 #: ../fish/guestfish-actions.pod:4163 ../fish/guestfish-actions.pod:4265
7004 #: ../src/guestfs-actions.pod:2047 ../src/guestfs-actions.pod:2139
7005 #: ../src/guestfs-actions.pod:6293 ../src/guestfs-actions.pod:6419
7007 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7011 #: ../fish/guestfish-actions.pod:1378
7016 #: ../fish/guestfish-actions.pod:1380
7024 #: ../fish/guestfish-actions.pod:1382 ../src/guestfs-actions.pod:2059
7025 msgid "This returns the enable network flag."
7029 #: ../fish/guestfish-actions.pod:1384
7034 #: ../fish/guestfish-actions.pod:1386
7042 #: ../fish/guestfish-actions.pod:1388 ../src/guestfs-actions.pod:2070
7043 msgid "Return the current search path."
7047 #: ../fish/guestfish-actions.pod:1390 ../src/guestfs-actions.pod:2072
7049 "This is always non-NULL. If it wasn't set already, then this will return "
7054 #: ../fish/guestfish-actions.pod:1393
7059 #: ../fish/guestfish-actions.pod:1395
7067 #: ../fish/guestfish-actions.pod:1397 ../src/guestfs-actions.pod:2085
7068 msgid "This returns the process group flag."
7072 #: ../fish/guestfish-actions.pod:1399
7077 #: ../fish/guestfish-actions.pod:1401
7082 #: ../fish/guestfish-actions.pod:1403
7090 #: ../fish/guestfish-actions.pod:1405 ../src/guestfs-actions.pod:2096
7092 "Return the process ID of the qemu subprocess. If there is no qemu "
7093 "subprocess, then this will return an error."
7097 #: ../fish/guestfish-actions.pod:1408 ../src/guestfs-actions.pod:2099
7098 msgid "This is an internal call used for debugging and testing."
7102 #: ../fish/guestfish-actions.pod:1410
7107 #: ../fish/guestfish-actions.pod:1412
7115 #: ../fish/guestfish-actions.pod:1414 ../src/guestfs-actions.pod:2110
7116 msgid "Return the current qemu binary."
7120 #: ../fish/guestfish-actions.pod:1416 ../src/guestfs-actions.pod:2112
7122 "This is always non-NULL. If it wasn't set already, then this will return "
7123 "the default qemu binary name."
7127 #: ../fish/guestfish-actions.pod:1419
7128 msgid "get-recovery-proc"
7132 #: ../fish/guestfish-actions.pod:1421
7135 " get-recovery-proc\n"
7140 #: ../fish/guestfish-actions.pod:1423 ../src/guestfs-actions.pod:2125
7141 msgid "Return the recovery process enabled flag."
7145 #: ../fish/guestfish-actions.pod:1425
7150 #: ../fish/guestfish-actions.pod:1427
7158 #: ../fish/guestfish-actions.pod:1429
7160 "This returns the current setting of the selinux flag which is passed to the "
7161 "appliance at boot time. See L</set-selinux>."
7165 #: ../fish/guestfish-actions.pod:1435
7170 #: ../fish/guestfish-actions.pod:1437
7178 #: ../fish/guestfish-actions.pod:1439 ../src/guestfs-actions.pod:2151
7180 "This returns the current state as an opaque integer. This is only useful "
7181 "for printing debug and internal error messages."
7185 #: ../fish/guestfish-actions.pod:1442 ../fish/guestfish-actions.pod:2362
7186 #: ../fish/guestfish-actions.pod:2380 ../fish/guestfish-actions.pod:2418
7187 #: ../fish/guestfish-actions.pod:2434 ../src/guestfs-actions.pod:2154
7188 #: ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:3463
7189 #: ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:3551
7190 msgid "For more information on states, see L<guestfs(3)>."
7194 #: ../fish/guestfish-actions.pod:1444
7199 #: ../fish/guestfish-actions.pod:1446
7207 #: ../fish/guestfish-actions.pod:1448 ../src/guestfs-actions.pod:2165
7208 msgid "Return the command trace flag."
7212 #: ../fish/guestfish-actions.pod:1450
7217 #: ../fish/guestfish-actions.pod:1452
7225 #: ../fish/guestfish-actions.pod:1454
7227 "Return the current umask. By default the umask is C<022> unless it has been "
7228 "set by calling L</umask>."
7232 #: ../fish/guestfish-actions.pod:1457
7237 #: ../fish/guestfish-actions.pod:1459
7245 #: ../fish/guestfish-actions.pod:1461 ../src/guestfs-actions.pod:2188
7246 msgid "This returns the verbose messages flag."
7250 #: ../fish/guestfish-actions.pod:1463
7255 #: ../fish/guestfish-actions.pod:1465
7263 #: ../fish/guestfish-actions.pod:1467 ../src/guestfs-actions.pod:2199
7264 msgid "This gets the SELinux security context of the daemon."
7268 #: ../fish/guestfish-actions.pod:1469
7269 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
7273 #: ../fish/guestfish-actions.pod:1472
7278 #: ../fish/guestfish-actions.pod:1474
7281 " getxattr path name\n"
7286 #: ../fish/guestfish-actions.pod:1476
7288 "Get a single extended attribute from file C<path> named C<name>. This call "
7289 "follows symlinks. If you want to lookup an extended attribute for the "
7290 "symlink itself, use L</lgetxattr>."
7294 #: ../fish/guestfish-actions.pod:1480 ../fish/guestfish-actions.pod:2507
7296 "Normally it is better to get all extended attributes from a file in one go "
7297 "by calling L</getxattrs>. However some Linux filesystem implementations are "
7298 "buggy and do not provide a way to list out attributes. For these "
7299 "filesystems (notably ntfs-3g) you have to know the names of the extended "
7300 "attributes you want in advance and call this function."
7304 #: ../fish/guestfish-actions.pod:1487 ../fish/guestfish-actions.pod:2514
7305 #: ../src/guestfs-actions.pod:2228 ../src/guestfs-actions.pod:3684
7307 "Extended attribute values are blobs of binary data. If there is no extended "
7308 "attribute named C<name>, this returns an error."
7312 #: ../fish/guestfish-actions.pod:1490
7313 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
7317 #: ../fish/guestfish-actions.pod:1492
7322 #: ../fish/guestfish-actions.pod:1494
7330 #: ../fish/guestfish-actions.pod:1496 ../src/guestfs-actions.pod:2245
7332 "This call lists the extended attributes of the file or directory C<path>."
7336 #: ../fish/guestfish-actions.pod:1499 ../src/guestfs-actions.pod:2248
7338 "At the system call level, this is a combination of the L<listxattr(2)> and "
7339 "L<getxattr(2)> calls."
7343 #: ../fish/guestfish-actions.pod:1502
7344 msgid "See also: L</lgetxattrs>, L<attr(5)>."
7348 #: ../fish/guestfish-actions.pod:1504
7353 #: ../fish/guestfish-actions.pod:1506
7356 " glob-expand pattern\n"
7361 #: ../fish/guestfish-actions.pod:1508 ../src/guestfs-actions.pod:2265
7363 "This command searches for all the pathnames matching C<pattern> according to "
7364 "the wildcard expansion rules used by the shell."
7368 #: ../fish/guestfish-actions.pod:1512 ../src/guestfs-actions.pod:2269
7370 "If no paths match, then this returns an empty list (note: not an error)."
7374 #: ../fish/guestfish-actions.pod:1515 ../src/guestfs-actions.pod:2272
7376 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
7377 "GLOB_BRACE>. See that manual page for more details."
7381 #: ../fish/guestfish-actions.pod:1519
7386 #: ../fish/guestfish-actions.pod:1521
7389 " grep regex path\n"
7394 #: ../fish/guestfish-actions.pod:1523 ../src/guestfs-actions.pod:2289
7395 msgid "This calls the external C<grep> program and returns the matching lines."
7399 #: ../fish/guestfish-actions.pod:1529
7404 #: ../fish/guestfish-actions.pod:1531
7407 " grepi regex path\n"
7412 #: ../fish/guestfish-actions.pod:1533 ../src/guestfs-actions.pod:2308
7414 "This calls the external C<grep -i> program and returns the matching lines."
7418 #: ../fish/guestfish-actions.pod:1539
7419 msgid "grub-install"
7423 #: ../fish/guestfish-actions.pod:1541
7426 " grub-install root device\n"
7431 #: ../fish/guestfish-actions.pod:1543 ../src/guestfs-actions.pod:2327
7433 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7434 "the root directory being C<root>."
7438 #: ../fish/guestfish-actions.pod:1546 ../src/guestfs-actions.pod:2330
7440 "Note: If grub-install reports the error \"No suitable drive was found in the "
7441 "generated device map.\" it may be that you need to create a C</boot/grub/"
7442 "device.map> file first that contains the mapping between grub device names "
7443 "and Linux device names. It is usually sufficient to create a file "
7448 #: ../fish/guestfish-actions.pod:1553 ../src/guestfs-actions.pod:2337
7456 #: ../fish/guestfish-actions.pod:1555 ../src/guestfs-actions.pod:2339
7457 msgid "replacing C</dev/vda> with the name of the installation device."
7461 #: ../fish/guestfish-actions.pod:1557
7466 #: ../fish/guestfish-actions.pod:1559
7474 #: ../fish/guestfish-actions.pod:1561 ../src/guestfs-actions.pod:2351
7476 "This command returns up to the first 10 lines of a file as a list of strings."
7480 #: ../fish/guestfish-actions.pod:1567
7485 #: ../fish/guestfish-actions.pod:1569
7488 " head-n nrlines path\n"
7493 #: ../fish/guestfish-actions.pod:1571 ../src/guestfs-actions.pod:2370
7495 "If the parameter C<nrlines> is a positive number, this returns the first "
7496 "C<nrlines> lines of the file C<path>."
7500 #: ../fish/guestfish-actions.pod:1574 ../src/guestfs-actions.pod:2373
7502 "If the parameter C<nrlines> is a negative number, this returns lines from "
7503 "the file C<path>, excluding the last C<nrlines> lines."
7507 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:4643
7508 #: ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:6991
7509 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7513 #: ../fish/guestfish-actions.pod:1582
7518 #: ../fish/guestfish-actions.pod:1584
7526 #: ../fish/guestfish-actions.pod:1586 ../src/guestfs-actions.pod:2393
7528 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
7529 "readable, canonical hex dump of the file."
7533 #: ../fish/guestfish-actions.pod:1592
7538 #: ../fish/guestfish-actions.pod:1594
7541 " initrd-cat initrdpath filename\n"
7546 #: ../fish/guestfish-actions.pod:1596 ../src/guestfs-actions.pod:2412
7548 "This command unpacks the file C<filename> from the initrd file called "
7549 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7554 #: ../fish/guestfish-actions.pod:1600 ../src/guestfs-actions.pod:2416
7556 "For example, in guestfish you could use the following command to examine the "
7557 "boot script (usually called C</init>) contained in a Linux initrd or "
7562 #: ../fish/guestfish-actions.pod:1604 ../src/guestfs-actions.pod:2420
7565 " initrd-cat /boot/initrd-<version>.img init\n"
7570 #: ../fish/guestfish-actions.pod:1606
7571 msgid "See also L</initrd-list>."
7575 #: ../fish/guestfish-actions.pod:1611
7580 #: ../fish/guestfish-actions.pod:1613
7583 " initrd-list path\n"
7588 #: ../fish/guestfish-actions.pod:1615 ../src/guestfs-actions.pod:2439
7589 msgid "This command lists out files contained in an initrd."
7593 #: ../fish/guestfish-actions.pod:1617 ../src/guestfs-actions.pod:2441
7595 "The files are listed without any initial C</> character. The files are "
7596 "listed in the order they appear (not necessarily alphabetical). Directory "
7597 "names are listed as separate items."
7601 #: ../fish/guestfish-actions.pod:1621 ../src/guestfs-actions.pod:2445
7603 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7604 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7609 #: ../fish/guestfish-actions.pod:1625
7610 msgid "inotify-add-watch"
7614 #: ../fish/guestfish-actions.pod:1627
7617 " inotify-add-watch path mask\n"
7622 #: ../fish/guestfish-actions.pod:1629 ../src/guestfs-actions.pod:2462
7623 msgid "Watch C<path> for the events listed in C<mask>."
7627 #: ../fish/guestfish-actions.pod:1631 ../src/guestfs-actions.pod:2464
7629 "Note that if C<path> is a directory then events within that directory are "
7630 "watched, but this does I<not> happen recursively (in subdirectories)."
7634 #: ../fish/guestfish-actions.pod:1635 ../src/guestfs-actions.pod:2468
7636 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7637 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7641 #: ../fish/guestfish-actions.pod:1639
7642 msgid "inotify-close"
7646 #: ../fish/guestfish-actions.pod:1641
7654 #: ../fish/guestfish-actions.pod:1643 ../src/guestfs-actions.pod:2481
7656 "This closes the inotify handle which was previously opened by inotify_init. "
7657 "It removes all watches, throws away any pending events, and deallocates all "
7662 #: ../fish/guestfish-actions.pod:1647
7663 msgid "inotify-files"
7667 #: ../fish/guestfish-actions.pod:1649
7675 #: ../fish/guestfish-actions.pod:1651
7677 "This function is a helpful wrapper around L</inotify-read> which just "
7678 "returns a list of pathnames of objects that were touched. The returned "
7679 "pathnames are sorted and deduplicated."
7683 #: ../fish/guestfish-actions.pod:1655
7684 msgid "inotify-init"
7688 #: ../fish/guestfish-actions.pod:1657
7691 " inotify-init maxevents\n"
7696 #: ../fish/guestfish-actions.pod:1659 ../src/guestfs-actions.pod:2510
7698 "This command creates a new inotify handle. The inotify subsystem can be "
7699 "used to notify events which happen to objects in the guest filesystem."
7703 #: ../fish/guestfish-actions.pod:1663
7705 "C<maxevents> is the maximum number of events which will be queued up between "
7706 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
7707 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
7708 "default was 16384 events. Beyond this limit, the kernel throws away events, "
7709 "but records the fact that it threw them away by setting a flag "
7710 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
7714 #: ../fish/guestfish-actions.pod:1673
7716 "Before any events are generated, you have to add some watches to the "
7717 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
7718 "L</inotify-watch-all>."
7722 #: ../fish/guestfish-actions.pod:1679
7724 "Queued up events should be read periodically by calling L</inotify-read> (or "
7725 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
7726 "If you don't read the events out often enough then you risk the internal "
7727 "queue overflowing."
7731 #: ../fish/guestfish-actions.pod:1686
7733 "The handle should be closed after use by calling L</inotify-close>. This "
7734 "also removes any watches automatically."
7738 #: ../fish/guestfish-actions.pod:1690 ../src/guestfs-actions.pod:2541
7740 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7741 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7742 "that there is one global inotify handle per libguestfs instance."
7746 #: ../fish/guestfish-actions.pod:1695
7747 msgid "inotify-read"
7751 #: ../fish/guestfish-actions.pod:1697
7759 #: ../fish/guestfish-actions.pod:1699 ../src/guestfs-actions.pod:2555
7761 "Return the complete queue of events that have happened since the previous "
7766 #: ../fish/guestfish-actions.pod:1702 ../src/guestfs-actions.pod:2558
7767 msgid "If no events have happened, this returns an empty list."
7771 #: ../fish/guestfish-actions.pod:1704 ../src/guestfs-actions.pod:2560
7773 "I<Note>: In order to make sure that all events have been read, you must call "
7774 "this function repeatedly until it returns an empty list. The reason is that "
7775 "the call will read events up to the maximum appliance-to-host message size "
7776 "and leave remaining events in the queue."
7780 #: ../fish/guestfish-actions.pod:1710
7781 msgid "inotify-rm-watch"
7785 #: ../fish/guestfish-actions.pod:1712
7788 " inotify-rm-watch wd\n"
7793 #: ../fish/guestfish-actions.pod:1714
7794 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
7798 #: ../fish/guestfish-actions.pod:1717
7799 msgid "inspect-get-arch"
7803 #: ../fish/guestfish-actions.pod:1719
7806 " inspect-get-arch root\n"
7811 #: ../fish/guestfish-actions.pod:1721
7813 "This returns the architecture of the inspected operating system. The "
7814 "possible return values are listed under L</file-architecture>."
7818 #: ../fish/guestfish-actions.pod:1725 ../src/guestfs-actions.pod:2595
7820 "If the architecture could not be determined, then the string C<unknown> is "
7825 #: ../fish/guestfish-actions.pod:1728 ../fish/guestfish-actions.pod:1811
7826 #: ../fish/guestfish-actions.pod:1890 ../fish/guestfish-actions.pod:1902
7827 #: ../fish/guestfish-actions.pod:1986 ../fish/guestfish-actions.pod:2047
7828 #: ../fish/guestfish-actions.pod:2068 ../fish/guestfish-actions.pod:2082
7829 #: ../fish/guestfish-actions.pod:2122 ../fish/guestfish-actions.pod:2154
7830 #: ../fish/guestfish-actions.pod:2167 ../fish/guestfish-actions.pod:2180
7831 #: ../fish/guestfish-actions.pod:2190 ../fish/guestfish-actions.pod:2200
7832 #: ../fish/guestfish-actions.pod:2212 ../fish/guestfish-actions.pod:2308
7833 #: ../fish/guestfish-actions.pod:2342 ../src/guestfs-actions.pod:2598
7834 #: ../src/guestfs-actions.pod:2688 ../src/guestfs-actions.pod:2792
7835 #: ../src/guestfs-actions.pod:2811 ../src/guestfs-actions.pod:2942
7836 #: ../src/guestfs-actions.pod:3025 ../src/guestfs-actions.pod:3053
7837 #: ../src/guestfs-actions.pod:3074 ../src/guestfs-actions.pod:3127
7838 #: ../src/guestfs-actions.pod:3167 ../src/guestfs-actions.pod:3187
7839 #: ../src/guestfs-actions.pod:3207 ../src/guestfs-actions.pod:3224
7840 #: ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:3258
7841 #: ../src/guestfs-actions.pod:3360 ../src/guestfs-actions.pod:3401
7842 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7846 #: ../fish/guestfish-actions.pod:1730
7847 msgid "inspect-get-distro"
7851 #: ../fish/guestfish-actions.pod:1732
7854 " inspect-get-distro root\n"
7859 #: ../fish/guestfish-actions.pod:1734 ../src/guestfs-actions.pod:2611
7861 "This returns the distro (distribution) of the inspected operating system."
7865 #: ../fish/guestfish-actions.pod:1737 ../src/guestfs-actions.pod:2614
7866 msgid "Currently defined distros are:"
7870 #: ../fish/guestfish-actions.pod:1741 ../src/guestfs-actions.pod:2618
7871 msgid "\"archlinux\""
7875 #: ../fish/guestfish-actions.pod:1743 ../src/guestfs-actions.pod:2620
7880 #: ../fish/guestfish-actions.pod:1745 ../src/guestfs-actions.pod:2622
7885 #: ../fish/guestfish-actions.pod:1747 ../src/guestfs-actions.pod:2624
7890 #: ../fish/guestfish-actions.pod:1749 ../src/guestfs-actions.pod:2626
7895 #: ../fish/guestfish-actions.pod:1751 ../src/guestfs-actions.pod:2628
7900 #: ../fish/guestfish-actions.pod:1753 ../src/guestfs-actions.pod:2630
7905 #: ../fish/guestfish-actions.pod:1755 ../src/guestfs-actions.pod:2632
7910 #: ../fish/guestfish-actions.pod:1757 ../src/guestfs-actions.pod:2634
7915 #: ../fish/guestfish-actions.pod:1759 ../src/guestfs-actions.pod:2636
7920 #: ../fish/guestfish-actions.pod:1761 ../src/guestfs-actions.pod:2638
7921 msgid "\"linuxmint\""
7925 #: ../fish/guestfish-actions.pod:1763 ../src/guestfs-actions.pod:2640
7930 #: ../fish/guestfish-actions.pod:1765 ../src/guestfs-actions.pod:2642
7931 msgid "\"mandriva\""
7935 #: ../fish/guestfish-actions.pod:1767 ../src/guestfs-actions.pod:2644
7940 #: ../fish/guestfish-actions.pod:1769 ../src/guestfs-actions.pod:2646
7945 #: ../fish/guestfish-actions.pod:1771 ../src/guestfs-actions.pod:2648
7950 #: ../fish/guestfish-actions.pod:1773 ../src/guestfs-actions.pod:2650
7955 #: ../fish/guestfish-actions.pod:1775 ../src/guestfs-actions.pod:2652
7960 #: ../fish/guestfish-actions.pod:1777 ../src/guestfs-actions.pod:2654
7961 msgid "\"redhat-based\""
7965 #: ../fish/guestfish-actions.pod:1779 ../src/guestfs-actions.pod:2656
7966 msgid "Some Red Hat-derived distro."
7970 #: ../fish/guestfish-actions.pod:1781 ../src/guestfs-actions.pod:2658
7975 #: ../fish/guestfish-actions.pod:1783 ../src/guestfs-actions.pod:2660
7976 msgid "Red Hat Enterprise Linux."
7980 #: ../fish/guestfish-actions.pod:1785 ../src/guestfs-actions.pod:2662
7981 msgid "\"scientificlinux\""
7985 #: ../fish/guestfish-actions.pod:1787 ../src/guestfs-actions.pod:2664
7986 msgid "Scientific Linux."
7990 #: ../fish/guestfish-actions.pod:1789 ../src/guestfs-actions.pod:2666
7991 msgid "\"slackware\""
7995 #: ../fish/guestfish-actions.pod:1791 ../src/guestfs-actions.pod:2668
8000 #: ../fish/guestfish-actions.pod:1793 ../src/guestfs-actions.pod:2670
8005 #: ../fish/guestfish-actions.pod:1795 ../src/guestfs-actions.pod:2672
8010 #: ../fish/guestfish-actions.pod:1797 ../fish/guestfish-actions.pod:1881
8011 #: ../fish/guestfish-actions.pod:2145 ../src/guestfs-actions.pod:2674
8012 #: ../src/guestfs-actions.pod:2783 ../src/guestfs-actions.pod:3158
8017 #: ../fish/guestfish-actions.pod:1799 ../src/guestfs-actions.pod:2676
8018 msgid "The distro could not be determined."
8022 #: ../fish/guestfish-actions.pod:1801 ../fish/guestfish-actions.pod:2137
8023 #: ../src/guestfs-actions.pod:2678 ../src/guestfs-actions.pod:3150
8028 #: ../fish/guestfish-actions.pod:1803 ../src/guestfs-actions.pod:2680
8030 "Windows does not have distributions. This string is returned if the OS type "
8035 #: ../fish/guestfish-actions.pod:1808 ../fish/guestfish-actions.pod:1887
8036 #: ../fish/guestfish-actions.pod:2151 ../src/guestfs-actions.pod:2685
8037 #: ../src/guestfs-actions.pod:2789 ../src/guestfs-actions.pod:3164
8039 "Future versions of libguestfs may return other strings here. The caller "
8040 "should be prepared to handle any string."
8044 #: ../fish/guestfish-actions.pod:1813
8045 msgid "inspect-get-drive-mappings"
8049 #: ../fish/guestfish-actions.pod:1815
8052 " inspect-get-drive-mappings root\n"
8057 #: ../fish/guestfish-actions.pod:1817 ../src/guestfs-actions.pod:2701
8059 "This call is useful for Windows which uses a primitive system of assigning "
8060 "drive letters (like \"C:\") to partitions. This inspection API examines the "
8061 "Windows Registry to find out how disks/partitions are mapped to drive "
8062 "letters, and returns a hash table as in the example below:"
8066 #: ../fish/guestfish-actions.pod:1823 ../src/guestfs-actions.pod:2707
8076 #: ../fish/guestfish-actions.pod:1827 ../src/guestfs-actions.pod:2711
8078 "Note that keys are drive letters. For Windows, the key is case insensitive "
8079 "and just contains the drive letter, without the customary colon separator "
8084 #: ../fish/guestfish-actions.pod:1831 ../src/guestfs-actions.pod:2715
8086 "In future we may support other operating systems that also used drive "
8087 "letters, but the keys for those might not be case insensitive and might be "
8088 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
8093 #: ../fish/guestfish-actions.pod:1836 ../src/guestfs-actions.pod:2720
8095 "For Windows guests, currently only hard drive mappings are returned. "
8096 "Removable disks (eg. DVD-ROMs) are ignored."
8100 #: ../fish/guestfish-actions.pod:1839 ../src/guestfs-actions.pod:2723
8102 "For guests that do not use drive mappings, or if the drive mappings could "
8103 "not be determined, this returns an empty hash table."
8107 #: ../fish/guestfish-actions.pod:1842
8109 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8110 "get-mountpoints>, L</inspect-get-filesystems>."
8114 #: ../fish/guestfish-actions.pod:1846
8115 msgid "inspect-get-filesystems"
8119 #: ../fish/guestfish-actions.pod:1848
8122 " inspect-get-filesystems root\n"
8127 #: ../fish/guestfish-actions.pod:1850 ../src/guestfs-actions.pod:2744
8129 "This returns a list of all the filesystems that we think are associated with "
8130 "this operating system. This includes the root filesystem, other ordinary "
8131 "filesystems, and non-mounted devices like swap partitions."
8135 #: ../fish/guestfish-actions.pod:1855 ../src/guestfs-actions.pod:2749
8137 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8138 "to be shared between operating systems."
8142 #: ../fish/guestfish-actions.pod:1858
8144 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8149 #: ../fish/guestfish-actions.pod:1861
8150 msgid "inspect-get-format"
8154 #: ../fish/guestfish-actions.pod:1863
8157 " inspect-get-format root\n"
8162 #: ../fish/guestfish-actions.pod:1865 ../src/guestfs-actions.pod:2767
8164 "This returns the format of the inspected operating system. You can use it "
8165 "to detect install images, live CDs and similar."
8169 #: ../fish/guestfish-actions.pod:1868 ../src/guestfs-actions.pod:2770
8170 msgid "Currently defined formats are:"
8174 #: ../fish/guestfish-actions.pod:1872 ../src/guestfs-actions.pod:2774
8175 msgid "\"installed\""
8179 #: ../fish/guestfish-actions.pod:1874 ../src/guestfs-actions.pod:2776
8180 msgid "This is an installed operating system."
8184 #: ../fish/guestfish-actions.pod:1876 ../src/guestfs-actions.pod:2778
8185 msgid "\"installer\""
8189 #: ../fish/guestfish-actions.pod:1878 ../src/guestfs-actions.pod:2780
8191 "The disk image being inspected is not an installed operating system, but a "
8192 "I<bootable> install disk, live CD, or similar."
8196 #: ../fish/guestfish-actions.pod:1883 ../src/guestfs-actions.pod:2785
8197 msgid "The format of this disk image is not known."
8201 #: ../fish/guestfish-actions.pod:1892
8202 msgid "inspect-get-hostname"
8206 #: ../fish/guestfish-actions.pod:1894
8209 " inspect-get-hostname root\n"
8214 #: ../fish/guestfish-actions.pod:1896 ../src/guestfs-actions.pod:2805
8216 "This function returns the hostname of the operating system as found by "
8217 "inspection of the guest's configuration files."
8221 #: ../fish/guestfish-actions.pod:1899 ../src/guestfs-actions.pod:2808
8223 "If the hostname could not be determined, then the string C<unknown> is "
8228 #: ../fish/guestfish-actions.pod:1904
8229 msgid "inspect-get-icon"
8233 #: ../fish/guestfish-actions.pod:1906
8236 " inspect-get-icon root [favicon:..] [highquality:..]\n"
8241 #: ../fish/guestfish-actions.pod:1908 ../src/guestfs-actions.pod:2834
8243 "This function returns an icon corresponding to the inspected operating "
8244 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
8245 "to PNG if necessary)."
8249 #: ../fish/guestfish-actions.pod:1912 ../src/guestfs-actions.pod:2838
8251 "If it was not possible to get an icon this function returns a zero-length "
8252 "(non-NULL) buffer. I<Callers must check for this case>."
8256 #: ../fish/guestfish-actions.pod:1915 ../src/guestfs-actions.pod:2841
8258 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
8259 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
8260 "this file will be returned. You can disable favicons by passing the "
8261 "optional C<favicon> boolean as false (default is true)."
8265 #: ../fish/guestfish-actions.pod:1921 ../src/guestfs-actions.pod:2847
8267 "If finding the favicon fails, then we look in other places in the guest for "
8272 #: ../fish/guestfish-actions.pod:1924 ../src/guestfs-actions.pod:2850
8274 "If the optional C<highquality> boolean is true then only high quality icons "
8275 "are returned, which means only icons of high resolution with an alpha "
8276 "channel. The default (false) is to return any icon we can, even if it is of "
8277 "substandard quality."
8281 #: ../fish/guestfish-actions.pod:1935 ../src/guestfs-actions.pod:2861
8283 "Unlike most other inspection API calls, the guest's disks must be mounted up "
8284 "before you call this, since it needs to read information from the guest "
8285 "filesystem during the call."
8289 #: ../fish/guestfish-actions.pod:1941 ../src/guestfs-actions.pod:2867
8291 "B<Security:> The icon data comes from the untrusted guest, and should be "
8292 "treated with caution. PNG files have been known to contain exploits. "
8293 "Ensure that libpng (or other relevant libraries) are fully up to date before "
8294 "trying to process or display the icon."
8298 #: ../fish/guestfish-actions.pod:1949 ../src/guestfs-actions.pod:2875
8300 "The PNG image returned can be any size. It might not be square. Libguestfs "
8301 "tries to return the largest, highest quality icon available. The "
8302 "application must scale the icon to the required size."
8306 #: ../fish/guestfish-actions.pod:1956 ../src/guestfs-actions.pod:2882
8308 "Extracting icons from Windows guests requires the external C<wrestool> "
8309 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
8310 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
8311 "installed separately."
8315 #: ../fish/guestfish-actions.pod:1963 ../src/guestfs-actions.pod:2889
8317 "Operating system icons are usually trademarks. Seek legal advice before "
8318 "using trademarks in applications."
8322 #: ../fish/guestfish-actions.pod:1970
8323 msgid "inspect-get-major-version"
8327 #: ../fish/guestfish-actions.pod:1972
8330 " inspect-get-major-version root\n"
8335 #: ../fish/guestfish-actions.pod:1974 ../src/guestfs-actions.pod:2930
8337 "This returns the major version number of the inspected operating system."
8341 #: ../fish/guestfish-actions.pod:1977 ../src/guestfs-actions.pod:2933
8343 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8344 "popular public names used by the operating system. Notably the operating "
8345 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8346 "1). You can find out the real versions corresponding to releases of Windows "
8347 "by consulting Wikipedia or MSDN."
8351 #: ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:1995
8352 #: ../src/guestfs-actions.pod:2940 ../src/guestfs-actions.pod:2957
8353 msgid "If the version could not be determined, then C<0> is returned."
8357 #: ../fish/guestfish-actions.pod:1988
8358 msgid "inspect-get-minor-version"
8362 #: ../fish/guestfish-actions.pod:1990
8365 " inspect-get-minor-version root\n"
8370 #: ../fish/guestfish-actions.pod:1992 ../src/guestfs-actions.pod:2954
8372 "This returns the minor version number of the inspected operating system."
8376 #: ../fish/guestfish-actions.pod:1997
8378 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8379 "get-major-version>."
8383 #: ../fish/guestfish-actions.pod:2000
8384 msgid "inspect-get-mountpoints"
8388 #: ../fish/guestfish-actions.pod:2002
8391 " inspect-get-mountpoints root\n"
8396 #: ../fish/guestfish-actions.pod:2004 ../src/guestfs-actions.pod:2972
8398 "This returns a hash of where we think the filesystems associated with this "
8399 "operating system should be mounted. Callers should note that this is at "
8400 "best an educated guess made by reading configuration files such as C</etc/"
8401 "fstab>. I<In particular note> that this may return filesystems which are "
8402 "non-existent or not mountable and callers should be prepared to handle or "
8403 "ignore failures if they try to mount them."
8407 #: ../fish/guestfish-actions.pod:2013 ../src/guestfs-actions.pod:2981
8409 "Each element in the returned hashtable has a key which is the path of the "
8410 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8411 "mounted there (eg. C</dev/sda1>)."
8415 #: ../fish/guestfish-actions.pod:2018 ../src/guestfs-actions.pod:2986
8417 "Non-mounted devices such as swap devices are I<not> returned in this list."
8421 #: ../fish/guestfish-actions.pod:2021
8423 "For operating systems like Windows which still use drive letters, this call "
8424 "will only return an entry for the first drive \"mounted on\" C</>. For "
8425 "information about the mapping of drive letters to partitions, see L</inspect-"
8426 "get-drive-mappings>."
8430 #: ../fish/guestfish-actions.pod:2027
8432 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8437 #: ../fish/guestfish-actions.pod:2030
8438 msgid "inspect-get-package-format"
8442 #: ../fish/guestfish-actions.pod:2032
8445 " inspect-get-package-format root\n"
8450 #: ../fish/guestfish-actions.pod:2034
8452 "This function and L</inspect-get-package-management> return the package "
8453 "format and package management tool used by the inspected operating system. "
8454 "For example for Fedora these functions would return C<rpm> (package format) "
8455 "and C<yum> (package management)."
8459 #: ../fish/guestfish-actions.pod:2040 ../src/guestfs-actions.pod:3018
8461 "This returns the string C<unknown> if we could not determine the package "
8462 "format I<or> if the operating system does not have a real packaging system "
8467 #: ../fish/guestfish-actions.pod:2044 ../src/guestfs-actions.pod:3022
8469 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
8470 "Future versions of libguestfs may return other strings."
8474 #: ../fish/guestfish-actions.pod:2049
8475 msgid "inspect-get-package-management"
8479 #: ../fish/guestfish-actions.pod:2051
8482 " inspect-get-package-management root\n"
8487 #: ../fish/guestfish-actions.pod:2053
8489 "L</inspect-get-package-format> and this function return the package format "
8490 "and package management tool used by the inspected operating system. For "
8491 "example for Fedora these functions would return C<rpm> (package format) and "
8492 "C<yum> (package management)."
8496 #: ../fish/guestfish-actions.pod:2059 ../src/guestfs-actions.pod:3044
8498 "This returns the string C<unknown> if we could not determine the package "
8499 "management tool I<or> if the operating system does not have a real packaging "
8500 "system (eg. Windows)."
8504 #: ../fish/guestfish-actions.pod:2063 ../src/guestfs-actions.pod:3048
8506 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8507 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
8508 "libguestfs may return other strings."
8512 #: ../fish/guestfish-actions.pod:2070
8513 msgid "inspect-get-product-name"
8517 #: ../fish/guestfish-actions.pod:2072
8520 " inspect-get-product-name root\n"
8525 #: ../fish/guestfish-actions.pod:2074 ../src/guestfs-actions.pod:3066
8527 "This returns the product name of the inspected operating system. The "
8528 "product name is generally some freeform string which can be displayed to the "
8529 "user, but should not be parsed by programs."
8533 #: ../fish/guestfish-actions.pod:2079 ../src/guestfs-actions.pod:3071
8535 "If the product name could not be determined, then the string C<unknown> is "
8540 #: ../fish/guestfish-actions.pod:2084
8541 msgid "inspect-get-product-variant"
8545 #: ../fish/guestfish-actions.pod:2086
8548 " inspect-get-product-variant root\n"
8553 #: ../fish/guestfish-actions.pod:2088 ../src/guestfs-actions.pod:3087
8554 msgid "This returns the product variant of the inspected operating system."
8558 #: ../fish/guestfish-actions.pod:2091 ../src/guestfs-actions.pod:3090
8560 "For Windows guests, this returns the contents of the Registry key C<HKLM"
8561 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
8562 "is usually a string such as C<Client> or C<Server> (other values are "
8563 "possible). This can be used to distinguish consumer and enterprise versions "
8564 "of Windows that have the same version number (for example, Windows 7 and "
8565 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
8566 "the latter is C<Server>)."
8570 #: ../fish/guestfish-actions.pod:2100 ../src/guestfs-actions.pod:3099
8572 "For enterprise Linux guests, in future we intend this to return the product "
8573 "variant such as C<Desktop>, C<Server> and so on. But this is not "
8574 "implemented at present."
8578 #: ../fish/guestfish-actions.pod:2104 ../src/guestfs-actions.pod:3103
8580 "If the product variant could not be determined, then the string C<unknown> "
8585 #: ../fish/guestfish-actions.pod:2107
8587 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8588 "get-product-name>, L</inspect-get-major-version>."
8592 #: ../fish/guestfish-actions.pod:2111
8593 msgid "inspect-get-roots"
8597 #: ../fish/guestfish-actions.pod:2113
8600 " inspect-get-roots\n"
8605 #: ../fish/guestfish-actions.pod:2115
8607 "This function is a convenient way to get the list of root devices, as "
8608 "returned from a previous call to L</inspect-os>, but without redoing the "
8609 "whole inspection process."
8613 #: ../fish/guestfish-actions.pod:2119
8615 "This returns an empty list if either no root devices were found or the "
8616 "caller has not called L</inspect-os>."
8620 #: ../fish/guestfish-actions.pod:2124
8621 msgid "inspect-get-type"
8625 #: ../fish/guestfish-actions.pod:2126
8628 " inspect-get-type root\n"
8633 #: ../fish/guestfish-actions.pod:2128 ../src/guestfs-actions.pod:3141
8635 "This returns the type of the inspected operating system. Currently defined "
8640 #: ../fish/guestfish-actions.pod:2133 ../src/guestfs-actions.pod:3146
8645 #: ../fish/guestfish-actions.pod:2135 ../src/guestfs-actions.pod:3148
8646 msgid "Any Linux-based operating system."
8650 #: ../fish/guestfish-actions.pod:2139 ../src/guestfs-actions.pod:3152
8651 msgid "Any Microsoft Windows operating system."
8655 #: ../fish/guestfish-actions.pod:2141 ../src/guestfs-actions.pod:3154
8660 #: ../fish/guestfish-actions.pod:2143 ../src/guestfs-actions.pod:3156
8665 #: ../fish/guestfish-actions.pod:2147 ../src/guestfs-actions.pod:3160
8666 msgid "The operating system type could not be determined."
8670 #: ../fish/guestfish-actions.pod:2156
8671 msgid "inspect-get-windows-current-control-set"
8675 #: ../fish/guestfish-actions.pod:2158
8678 " inspect-get-windows-current-control-set root\n"
8683 #: ../fish/guestfish-actions.pod:2160 ../src/guestfs-actions.pod:3180
8685 "This returns the Windows CurrentControlSet of the inspected guest. The "
8686 "CurrentControlSet is a registry key name such as C<ControlSet001>."
8690 #: ../fish/guestfish-actions.pod:2163 ../src/guestfs-actions.pod:3183
8692 "This call assumes that the guest is Windows and that the Registry could be "
8693 "examined by inspection. If this is not the case then an error is returned."
8697 #: ../fish/guestfish-actions.pod:2169
8698 msgid "inspect-get-windows-systemroot"
8702 #: ../fish/guestfish-actions.pod:2171
8705 " inspect-get-windows-systemroot root\n"
8710 #: ../fish/guestfish-actions.pod:2173 ../src/guestfs-actions.pod:3200
8712 "This returns the Windows systemroot of the inspected guest. The systemroot "
8713 "is a directory path such as C</WINDOWS>."
8717 #: ../fish/guestfish-actions.pod:2176 ../src/guestfs-actions.pod:3203
8719 "This call assumes that the guest is Windows and that the systemroot could be "
8720 "determined by inspection. If this is not the case then an error is returned."
8724 #: ../fish/guestfish-actions.pod:2182
8725 msgid "inspect-is-live"
8729 #: ../fish/guestfish-actions.pod:2184
8732 " inspect-is-live root\n"
8737 #: ../fish/guestfish-actions.pod:2186
8739 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8740 "then this returns true if a live image was detected on the disk."
8744 #: ../fish/guestfish-actions.pod:2192
8745 msgid "inspect-is-multipart"
8749 #: ../fish/guestfish-actions.pod:2194
8752 " inspect-is-multipart root\n"
8757 #: ../fish/guestfish-actions.pod:2196
8759 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8760 "then this returns true if the disk is part of a set."
8764 #: ../fish/guestfish-actions.pod:2202
8765 msgid "inspect-is-netinst"
8769 #: ../fish/guestfish-actions.pod:2204
8772 " inspect-is-netinst root\n"
8777 #: ../fish/guestfish-actions.pod:2206
8779 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8780 "then this returns true if the disk is a network installer, ie. not a self-"
8781 "contained install CD but one which is likely to require network access to "
8782 "complete the install."
8786 #: ../fish/guestfish-actions.pod:2214
8787 msgid "inspect-list-applications"
8791 #: ../fish/guestfish-actions.pod:2216
8794 " inspect-list-applications root\n"
8799 #: ../fish/guestfish-actions.pod:2218 ../src/guestfs-actions.pod:3270
8800 msgid "Return the list of applications installed in the operating system."
8804 #: ../fish/guestfish-actions.pod:2220
8806 "I<Note:> This call works differently from other parts of the inspection "
8807 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
8808 "then mount up the disks, before calling this. Listing applications is a "
8809 "significantly more difficult operation which requires access to the full "
8810 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
8811 "are just returning data cached in the libguestfs handle, this call actually "
8812 "reads parts of the mounted filesystems during the call."
8816 #: ../fish/guestfish-actions.pod:2230 ../src/guestfs-actions.pod:3282
8818 "This returns an empty list if the inspection code was not able to determine "
8819 "the list of applications."
8823 #: ../fish/guestfish-actions.pod:2233 ../src/guestfs-actions.pod:3285
8824 msgid "The application structure contains the following fields:"
8828 #: ../fish/guestfish-actions.pod:2237 ../src/guestfs-actions.pod:3289
8833 #: ../fish/guestfish-actions.pod:2239 ../src/guestfs-actions.pod:3291
8835 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8836 "guests, this is the package name."
8840 #: ../fish/guestfish-actions.pod:2242 ../src/guestfs-actions.pod:3294
8841 msgid "C<app_display_name>"
8845 #: ../fish/guestfish-actions.pod:2244 ../src/guestfs-actions.pod:3296
8847 "The display name of the application, sometimes localized to the install "
8848 "language of the guest operating system."
8852 #: ../fish/guestfish-actions.pod:2247 ../src/guestfs-actions.pod:3299
8854 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8855 "to display something can use C<app_name> instead."
8859 #: ../fish/guestfish-actions.pod:2250 ../src/guestfs-actions.pod:3302
8860 msgid "C<app_epoch>"
8864 #: ../fish/guestfish-actions.pod:2252 ../src/guestfs-actions.pod:3304
8866 "For package managers which use epochs, this contains the epoch of the "
8867 "package (an integer). If unavailable, this is returned as C<0>."
8871 #: ../fish/guestfish-actions.pod:2255 ../src/guestfs-actions.pod:3307
8872 msgid "C<app_version>"
8876 #: ../fish/guestfish-actions.pod:2257 ../src/guestfs-actions.pod:3309
8878 "The version string of the application or package. If unavailable this is "
8879 "returned as an empty string C<\"\">."
8883 #: ../fish/guestfish-actions.pod:2260 ../src/guestfs-actions.pod:3312
8884 msgid "C<app_release>"
8888 #: ../fish/guestfish-actions.pod:2262 ../src/guestfs-actions.pod:3314
8890 "The release string of the application or package, for package managers that "
8891 "use this. If unavailable this is returned as an empty string C<\"\">."
8895 #: ../fish/guestfish-actions.pod:2266 ../src/guestfs-actions.pod:3318
8896 msgid "C<app_install_path>"
8900 #: ../fish/guestfish-actions.pod:2268 ../src/guestfs-actions.pod:3320
8902 "The installation path of the application (on operating systems such as "
8903 "Windows which use installation paths). This path is in the format used by "
8904 "the guest operating system, it is not a libguestfs path."
8908 #: ../fish/guestfish-actions.pod:2273 ../src/guestfs-actions.pod:3325
8909 msgid "If unavailable this is returned as an empty string C<\"\">."
8913 #: ../fish/guestfish-actions.pod:2275 ../src/guestfs-actions.pod:3327
8914 msgid "C<app_trans_path>"
8918 #: ../fish/guestfish-actions.pod:2277 ../src/guestfs-actions.pod:3329
8920 "The install path translated into a libguestfs path. If unavailable this is "
8921 "returned as an empty string C<\"\">."
8925 #: ../fish/guestfish-actions.pod:2280 ../src/guestfs-actions.pod:3332
8926 msgid "C<app_publisher>"
8930 #: ../fish/guestfish-actions.pod:2282 ../src/guestfs-actions.pod:3334
8932 "The name of the publisher of the application, for package managers that use "
8933 "this. If unavailable this is returned as an empty string C<\"\">."
8937 #: ../fish/guestfish-actions.pod:2286 ../src/guestfs-actions.pod:3338
8942 #: ../fish/guestfish-actions.pod:2288 ../src/guestfs-actions.pod:3340
8944 "The URL (eg. upstream URL) of the application. If unavailable this is "
8945 "returned as an empty string C<\"\">."
8949 #: ../fish/guestfish-actions.pod:2291 ../src/guestfs-actions.pod:3343
8950 msgid "C<app_source_package>"
8954 #: ../fish/guestfish-actions.pod:2293 ../src/guestfs-actions.pod:3345
8956 "For packaging systems which support this, the name of the source package. "
8957 "If unavailable this is returned as an empty string C<\"\">."
8961 #: ../fish/guestfish-actions.pod:2296 ../src/guestfs-actions.pod:3348
8962 msgid "C<app_summary>"
8966 #: ../fish/guestfish-actions.pod:2298 ../src/guestfs-actions.pod:3350
8968 "A short (usually one line) description of the application or package. If "
8969 "unavailable this is returned as an empty string C<\"\">."
8973 #: ../fish/guestfish-actions.pod:2301 ../src/guestfs-actions.pod:3353
8974 msgid "C<app_description>"
8978 #: ../fish/guestfish-actions.pod:2303 ../src/guestfs-actions.pod:3355
8980 "A longer description of the application or package. If unavailable this is "
8981 "returned as an empty string C<\"\">."
8985 #: ../fish/guestfish-actions.pod:2310
8990 #: ../fish/guestfish-actions.pod:2312
8998 #: ../fish/guestfish-actions.pod:2314 ../src/guestfs-actions.pod:3373
9000 "This function uses other libguestfs functions and certain heuristics to "
9001 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9002 "for operating systems."
9006 #: ../fish/guestfish-actions.pod:2318 ../src/guestfs-actions.pod:3377
9007 msgid "The list returned is empty if no operating systems were found."
9011 #: ../fish/guestfish-actions.pod:2320 ../src/guestfs-actions.pod:3379
9013 "If one operating system was found, then this returns a list with a single "
9014 "element, which is the name of the root filesystem of this operating system. "
9015 "It is also possible for this function to return a list containing more than "
9016 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9017 "element being the root filesystem of one of the operating systems."
9021 #: ../fish/guestfish-actions.pod:2327
9023 "You can pass the root string(s) returned to other L</inspect-get-*> "
9024 "functions in order to query further information about each operating system, "
9025 "such as the name and version."
9029 #: ../fish/guestfish-actions.pod:2332
9031 "This function uses other libguestfs features such as L</mount-ro> and L</"
9032 "umount-all> in order to mount and unmount filesystems and look at the "
9033 "contents. This should be called with no disks currently mounted. The "
9034 "function may also use Augeas, so any existing Augeas handle will be closed."
9038 #: ../fish/guestfish-actions.pod:2338 ../src/guestfs-actions.pod:3397
9040 "This function cannot decrypt encrypted disks. The caller must do that first "
9041 "(supplying the necessary keys) if the disk is encrypted."
9045 #: ../fish/guestfish-actions.pod:2344 ../fish/guestfish-actions.pod:2542
9046 #: ../fish/guestfish-actions.pod:2601
9047 msgid "See also L</list-filesystems>."
9051 #: ../fish/guestfish-actions.pod:2346
9056 #: ../fish/guestfish-actions.pod:2348
9059 " is-blockdev path\n"
9064 #: ../fish/guestfish-actions.pod:2350 ../src/guestfs-actions.pod:3417
9066 "This returns C<true> if and only if there is a block device with the given "
9071 #: ../fish/guestfish-actions.pod:2353 ../fish/guestfish-actions.pod:2371
9072 #: ../fish/guestfish-actions.pod:2390 ../fish/guestfish-actions.pod:2399
9073 #: ../fish/guestfish-actions.pod:2409 ../fish/guestfish-actions.pod:2443
9074 #: ../fish/guestfish-actions.pod:2452
9075 msgid "See also L</stat>."
9079 #: ../fish/guestfish-actions.pod:2355
9084 #: ../fish/guestfish-actions.pod:2357
9092 #: ../fish/guestfish-actions.pod:2359 ../src/guestfs-actions.pod:3431
9094 "This returns true iff this handle is busy processing a command (in the "
9099 #: ../fish/guestfish-actions.pod:2364
9104 #: ../fish/guestfish-actions.pod:2366
9107 " is-chardev path\n"
9112 #: ../fish/guestfish-actions.pod:2368 ../src/guestfs-actions.pod:3446
9114 "This returns C<true> if and only if there is a character device with the "
9115 "given C<path> name."
9119 #: ../fish/guestfish-actions.pod:2373
9124 #: ../fish/guestfish-actions.pod:2375
9132 #: ../fish/guestfish-actions.pod:2377 ../src/guestfs-actions.pod:3460
9134 "This returns true iff this handle is being configured (in the C<CONFIG> "
9139 #: ../fish/guestfish-actions.pod:2382
9144 #: ../fish/guestfish-actions.pod:2384
9152 #: ../fish/guestfish-actions.pod:2386 ../src/guestfs-actions.pod:3475
9154 "This returns C<true> if and only if there is a directory with the given "
9155 "C<path> name. Note that it returns false for other objects like files."
9159 #: ../fish/guestfish-actions.pod:2392
9164 #: ../fish/guestfish-actions.pod:2394
9172 #: ../fish/guestfish-actions.pod:2396 ../src/guestfs-actions.pod:3491
9174 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9175 "given C<path> name."
9179 #: ../fish/guestfish-actions.pod:2401
9184 #: ../fish/guestfish-actions.pod:2403
9192 #: ../fish/guestfish-actions.pod:2405 ../src/guestfs-actions.pod:3506
9194 "This returns C<true> if and only if there is a regular file with the given "
9195 "C<path> name. Note that it returns false for other objects like directories."
9199 #: ../fish/guestfish-actions.pod:2411
9200 msgid "is-launching"
9204 #: ../fish/guestfish-actions.pod:2413
9212 #: ../fish/guestfish-actions.pod:2415 ../src/guestfs-actions.pod:3521
9214 "This returns true iff this handle is launching the subprocess (in the "
9215 "C<LAUNCHING> state)."
9219 #: ../fish/guestfish-actions.pod:2420
9224 #: ../fish/guestfish-actions.pod:2422
9232 #: ../fish/guestfish-actions.pod:2424 ../src/guestfs-actions.pod:3536
9234 "This command tests whether C<device> is a logical volume, and returns true "
9235 "iff this is the case."
9239 #: ../fish/guestfish-actions.pod:2427
9244 #: ../fish/guestfish-actions.pod:2429
9252 #: ../fish/guestfish-actions.pod:2431 ../src/guestfs-actions.pod:3548
9254 "This returns true iff this handle is ready to accept commands (in the "
9259 #: ../fish/guestfish-actions.pod:2436
9264 #: ../fish/guestfish-actions.pod:2438
9272 #: ../fish/guestfish-actions.pod:2440 ../src/guestfs-actions.pod:3563
9274 "This returns C<true> if and only if there is a Unix domain socket with the "
9275 "given C<path> name."
9279 #: ../fish/guestfish-actions.pod:2445
9284 #: ../fish/guestfish-actions.pod:2447
9287 " is-symlink path\n"
9292 #: ../fish/guestfish-actions.pod:2449 ../src/guestfs-actions.pod:3578
9294 "This returns C<true> if and only if there is a symbolic link with the given "
9299 #: ../fish/guestfish-actions.pod:2454
9304 #: ../fish/guestfish-actions.pod:2456
9312 #: ../fish/guestfish-actions.pod:2458 ../src/guestfs-actions.pod:3593
9314 "This returns true iff the file exists and the file is empty or it contains "
9319 #: ../fish/guestfish-actions.pod:2461
9320 msgid "is-zero-device"
9324 #: ../fish/guestfish-actions.pod:2463
9327 " is-zero-device device\n"
9332 #: ../fish/guestfish-actions.pod:2465 ../src/guestfs-actions.pod:3606
9333 msgid "This returns true iff the device exists and contains all zero bytes."
9337 #: ../fish/guestfish-actions.pod:2467 ../src/guestfs-actions.pod:3608
9338 msgid "Note that for large devices this can take a long time to run."
9342 #: ../fish/guestfish-actions.pod:2469
9343 msgid "kill-subprocess"
9347 #: ../fish/guestfish-actions.pod:2471
9350 " kill-subprocess\n"
9355 #: ../fish/guestfish-actions.pod:2473 ../src/guestfs-actions.pod:3619
9356 msgid "This kills the qemu subprocess. You should never need to call this."
9360 #: ../fish/guestfish-actions.pod:2475
9365 #: ../fish/guestfish-actions.pod:2477
9370 #: ../fish/guestfish-actions.pod:2479
9378 #: ../fish/guestfish-actions.pod:2481 ../src/guestfs-actions.pod:3630
9380 "Internally libguestfs is implemented by running a virtual machine using "
9385 #: ../fish/guestfish-actions.pod:2484 ../src/guestfs-actions.pod:3633
9387 "You should call this after configuring the handle (eg. adding drives) but "
9388 "before performing any actions."
9392 #: ../fish/guestfish-actions.pod:2487
9397 #: ../fish/guestfish-actions.pod:2489
9400 " lchown owner group path\n"
9405 #: ../fish/guestfish-actions.pod:2491
9407 "Change the file owner to C<owner> and group to C<group>. This is like L</"
9408 "chown> but if C<path> is a symlink then the link itself is changed, not the "
9413 #: ../fish/guestfish-actions.pod:2499
9418 #: ../fish/guestfish-actions.pod:2501
9421 " lgetxattr path name\n"
9426 #: ../fish/guestfish-actions.pod:2503 ../src/guestfs-actions.pod:3673
9428 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
9429 "is a symlink, then this call returns an extended attribute from the symlink."
9433 #: ../fish/guestfish-actions.pod:2517
9434 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
9438 #: ../fish/guestfish-actions.pod:2519
9443 #: ../fish/guestfish-actions.pod:2521
9446 " lgetxattrs path\n"
9451 #: ../fish/guestfish-actions.pod:2523
9453 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
9454 "it returns the extended attributes of the link itself."
9458 #: ../fish/guestfish-actions.pod:2527
9463 #: ../fish/guestfish-actions.pod:2529
9471 #: ../fish/guestfish-actions.pod:2531 ../src/guestfs-actions.pod:3716
9473 "List all 9p filesystems attached to the guest. A list of mount tags is "
9478 #: ../fish/guestfish-actions.pod:2534
9479 msgid "list-devices"
9483 #: ../fish/guestfish-actions.pod:2536
9491 #: ../fish/guestfish-actions.pod:2538 ../src/guestfs-actions.pod:3730
9492 msgid "List all the block devices."
9496 #: ../fish/guestfish-actions.pod:2540 ../src/guestfs-actions.pod:3732
9497 msgid "The full block device names are returned, eg. C</dev/sda>."
9501 #: ../fish/guestfish-actions.pod:2544
9502 msgid "list-dm-devices"
9506 #: ../fish/guestfish-actions.pod:2546
9509 " list-dm-devices\n"
9514 #: ../fish/guestfish-actions.pod:2548 ../src/guestfs-actions.pod:3747
9515 msgid "List all device mapper devices."
9519 #: ../fish/guestfish-actions.pod:2550
9521 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
9522 "previous call to L</luks-open>."
9526 #: ../fish/guestfish-actions.pod:2553
9528 "Device mapper devices which correspond to logical volumes are I<not> "
9529 "returned in this list. Call L</lvs> if you want to list logical volumes."
9533 #: ../fish/guestfish-actions.pod:2557
9534 msgid "list-filesystems"
9538 #: ../fish/guestfish-actions.pod:2559
9541 " list-filesystems\n"
9546 #: ../fish/guestfish-actions.pod:2561 ../src/guestfs-actions.pod:3767
9548 "This inspection command looks for filesystems on partitions, block devices "
9549 "and logical volumes, returning a list of devices containing filesystems and "
9554 #: ../fish/guestfish-actions.pod:2565 ../src/guestfs-actions.pod:3771
9556 "The return value is a hash, where the keys are the devices containing "
9557 "filesystems, and the values are the filesystem types. For example:"
9561 #: ../fish/guestfish-actions.pod:2569 ../src/guestfs-actions.pod:3775
9564 " \"/dev/sda1\" => \"ntfs\"\n"
9565 " \"/dev/sda2\" => \"ext2\"\n"
9566 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9567 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9572 #: ../fish/guestfish-actions.pod:2574 ../src/guestfs-actions.pod:3780
9574 "The value can have the special value \"unknown\", meaning the content of the "
9575 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9579 #: ../fish/guestfish-actions.pod:2578
9581 "This command runs other libguestfs commands, which might include L</mount> "
9582 "and L</umount>, and therefore you should use this soon after launch and only "
9583 "when nothing is mounted."
9587 #: ../fish/guestfish-actions.pod:2582
9589 "Not all of the filesystems returned will be mountable. In particular, swap "
9590 "partitions are returned in the list. Also this command does not check that "
9591 "each filesystem found is valid and mountable, and some filesystems might be "
9592 "mountable but require special options. Filesystems may not all belong to a "
9593 "single logical operating system (use L</inspect-os> to look for OSes)."
9597 #: ../fish/guestfish-actions.pod:2590
9598 msgid "list-partitions"
9602 #: ../fish/guestfish-actions.pod:2592
9605 " list-partitions\n"
9610 #: ../fish/guestfish-actions.pod:2594 ../src/guestfs-actions.pod:3809
9611 msgid "List all the partitions detected on all block devices."
9615 #: ../fish/guestfish-actions.pod:2596 ../src/guestfs-actions.pod:3811
9616 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9620 #: ../fish/guestfish-actions.pod:2598
9622 "This does not return logical volumes. For that you will need to call L</"
9627 #: ../fish/guestfish-actions.pod:2603
9632 #: ../fish/guestfish-actions.pod:2605
9640 #: ../fish/guestfish-actions.pod:2607 ../src/guestfs-actions.pod:3830
9642 "List the files in C<directory> (relative to the root directory, there is no "
9643 "cwd) in the format of 'ls -la'."
9647 #: ../fish/guestfish-actions.pod:2610 ../src/guestfs-actions.pod:3833
9649 "This command is mostly useful for interactive sessions. It is I<not> "
9650 "intended that you try to parse the output string."
9654 #: ../fish/guestfish-actions.pod:2613
9659 #: ../fish/guestfish-actions.pod:2615
9662 " ln target linkname\n"
9667 #: ../fish/guestfish-actions.pod:2617 ../src/guestfs-actions.pod:3848
9668 msgid "This command creates a hard link using the C<ln> command."
9672 #: ../fish/guestfish-actions.pod:2619
9677 #: ../fish/guestfish-actions.pod:2621
9680 " ln-f target linkname\n"
9685 #: ../fish/guestfish-actions.pod:2623 ../src/guestfs-actions.pod:3861
9687 "This command creates a hard link using the C<ln -f> command. The I<-f> "
9688 "option removes the link (C<linkname>) if it exists already."
9692 #: ../fish/guestfish-actions.pod:2626
9697 #: ../fish/guestfish-actions.pod:2628
9700 " ln-s target linkname\n"
9705 #: ../fish/guestfish-actions.pod:2630 ../src/guestfs-actions.pod:3875
9706 msgid "This command creates a symbolic link using the C<ln -s> command."
9710 #: ../fish/guestfish-actions.pod:2632
9715 #: ../fish/guestfish-actions.pod:2634
9718 " ln-sf target linkname\n"
9723 #: ../fish/guestfish-actions.pod:2636 ../src/guestfs-actions.pod:3888
9725 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
9726 "option removes the link (C<linkname>) if it exists already."
9730 #: ../fish/guestfish-actions.pod:2639
9731 msgid "lremovexattr"
9735 #: ../fish/guestfish-actions.pod:2641
9738 " lremovexattr xattr path\n"
9743 #: ../fish/guestfish-actions.pod:2643
9745 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
9746 "it removes an extended attribute of the link itself."
9750 #: ../fish/guestfish-actions.pod:2647
9755 #: ../fish/guestfish-actions.pod:2649
9763 #: ../fish/guestfish-actions.pod:2651 ../src/guestfs-actions.pod:3916
9765 "List the files in C<directory> (relative to the root directory, there is no "
9766 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
9770 #: ../fish/guestfish-actions.pod:2655
9772 "This command is mostly useful for interactive sessions. Programs should "
9773 "probably use L</readdir> instead."
9777 #: ../fish/guestfish-actions.pod:2658
9782 #: ../fish/guestfish-actions.pod:2660
9785 " lsetxattr xattr val vallen path\n"
9790 #: ../fish/guestfish-actions.pod:2662
9792 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
9793 "sets an extended attribute of the link itself."
9797 #: ../fish/guestfish-actions.pod:2666
9802 #: ../fish/guestfish-actions.pod:2668
9810 #: ../fish/guestfish-actions.pod:2670 ../fish/guestfish-actions.pod:4478
9811 #: ../src/guestfs-actions.pod:3952 ../src/guestfs-actions.pod:6731
9812 msgid "Returns file information for the given C<path>."
9816 #: ../fish/guestfish-actions.pod:2672
9818 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
9819 "the link is stat-ed, not the file it refers to."
9823 #: ../fish/guestfish-actions.pod:2676 ../src/guestfs-actions.pod:3958
9824 msgid "This is the same as the C<lstat(2)> system call."
9828 #: ../fish/guestfish-actions.pod:2678
9833 #: ../fish/guestfish-actions.pod:2680
9836 " lstatlist path 'names ...'\n"
9841 #: ../fish/guestfish-actions.pod:2682
9843 "This call allows you to perform the L</lstat> operation on multiple files, "
9844 "where all files are in the directory C<path>. C<names> is the list of files "
9845 "from this directory."
9849 #: ../fish/guestfish-actions.pod:2686 ../src/guestfs-actions.pod:3977
9851 "On return you get a list of stat structs, with a one-to-one correspondence "
9852 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9853 "then the C<ino> field of that structure is set to C<-1>."
9857 #: ../fish/guestfish-actions.pod:2691
9859 "This call is intended for programs that want to efficiently list a directory "
9860 "contents without making many round-trips. See also L</lxattrlist> for a "
9861 "similarly efficient call for getting extended attributes. Very long "
9862 "directory listings might cause the protocol message size to be exceeded, "
9863 "causing this call to fail. The caller must split up such requests into "
9864 "smaller groups of names."
9868 #: ../fish/guestfish-actions.pod:2699
9869 msgid "luks-add-key"
9873 #: ../fish/guestfish-actions.pod:2701
9876 " luks-add-key device keyslot\n"
9881 #: ../fish/guestfish-actions.pod:2703 ../src/guestfs-actions.pod:4005
9883 "This command adds a new key on LUKS device C<device>. C<key> is any "
9884 "existing key, and is used to access the device. C<newkey> is the new key to "
9885 "add. C<keyslot> is the key slot that will be replaced."
9889 #: ../fish/guestfish-actions.pod:2708
9891 "Note that if C<keyslot> already contains a key, then this command will "
9892 "fail. You have to use L</luks-kill-slot> first to remove that key."
9896 #: ../fish/guestfish-actions.pod:2712 ../fish/guestfish-actions.pod:2734
9897 #: ../fish/guestfish-actions.pod:2747 ../fish/guestfish-actions.pod:2761
9898 #: ../fish/guestfish-actions.pod:2787 ../fish/guestfish-actions.pod:2797
9900 "This command has one or more key or passphrase parameters. Guestfish will "
9901 "prompt for these separately."
9905 #: ../fish/guestfish-actions.pod:2715
9910 #: ../fish/guestfish-actions.pod:2717
9913 " luks-close device\n"
9918 #: ../fish/guestfish-actions.pod:2719
9920 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
9921 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
9922 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
9927 #: ../fish/guestfish-actions.pod:2725
9932 #: ../fish/guestfish-actions.pod:2727
9935 " luks-format device keyslot\n"
9940 #: ../fish/guestfish-actions.pod:2729 ../src/guestfs-actions.pod:4046
9942 "This command erases existing data on C<device> and formats the device as a "
9943 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9944 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9948 #: ../fish/guestfish-actions.pod:2737 ../fish/guestfish-actions.pod:2750
9949 #: ../fish/guestfish-actions.pod:2837 ../fish/guestfish-actions.pod:3498
9950 #: ../fish/guestfish-actions.pod:4024 ../fish/guestfish-actions.pod:4349
9951 #: ../fish/guestfish-actions.pod:4372 ../fish/guestfish-actions.pod:4394
9952 #: ../fish/guestfish-actions.pod:5132 ../src/guestfs-actions.pod:4053
9953 #: ../src/guestfs-actions.pod:4076 ../src/guestfs-actions.pod:4219
9954 #: ../src/guestfs-actions.pod:5322 ../src/guestfs-actions.pod:6110
9955 #: ../src/guestfs-actions.pod:6538 ../src/guestfs-actions.pod:6568
9956 #: ../src/guestfs-actions.pod:6601 ../src/guestfs-actions.pod:7799
9958 "B<This command is dangerous. Without careful use you can easily destroy all "
9963 #: ../fish/guestfish-actions.pod:2740
9964 msgid "luks-format-cipher"
9968 #: ../fish/guestfish-actions.pod:2742
9971 " luks-format-cipher device keyslot cipher\n"
9976 #: ../fish/guestfish-actions.pod:2744
9978 "This command is the same as L</luks-format> but it also allows you to set "
9979 "the C<cipher> used."
9983 #: ../fish/guestfish-actions.pod:2753
9984 msgid "luks-kill-slot"
9988 #: ../fish/guestfish-actions.pod:2755
9991 " luks-kill-slot device keyslot\n"
9996 #: ../fish/guestfish-actions.pod:2757 ../src/guestfs-actions.pod:4093
9998 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9999 "device C<device>. C<key> must be one of the I<other> keys."
10003 #: ../fish/guestfish-actions.pod:2764
10008 #: ../fish/guestfish-actions.pod:2766
10011 " luks-open device mapname\n"
10016 #: ../fish/guestfish-actions.pod:2768 ../src/guestfs-actions.pod:4113
10018 "This command opens a block device which has been encrypted according to the "
10019 "Linux Unified Key Setup (LUKS) standard."
10023 #: ../fish/guestfish-actions.pod:2771 ../src/guestfs-actions.pod:4116
10024 msgid "C<device> is the encrypted block device or partition."
10028 #: ../fish/guestfish-actions.pod:2773 ../src/guestfs-actions.pod:4118
10030 "The caller must supply one of the keys associated with the LUKS block "
10031 "device, in the C<key> parameter."
10035 #: ../fish/guestfish-actions.pod:2776 ../src/guestfs-actions.pod:4121
10037 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10038 "writes to this block device are decrypted from and encrypted to the "
10039 "underlying C<device> respectively."
10043 #: ../fish/guestfish-actions.pod:2780
10045 "If this block device contains LVM volume groups, then calling L</vgscan> "
10046 "followed by L</vg-activate-all> will make them visible."
10050 #: ../fish/guestfish-actions.pod:2784
10051 msgid "Use L</list-dm-devices> to list all device mapper devices."
10055 #: ../fish/guestfish-actions.pod:2790
10056 msgid "luks-open-ro"
10060 #: ../fish/guestfish-actions.pod:2792
10063 " luks-open-ro device mapname\n"
10068 #: ../fish/guestfish-actions.pod:2794
10070 "This is the same as L</luks-open> except that a read-only mapping is created."
10074 #: ../fish/guestfish-actions.pod:2800
10079 #: ../fish/guestfish-actions.pod:2802
10082 " lvcreate logvol volgroup mbytes\n"
10087 #: ../fish/guestfish-actions.pod:2804 ../src/guestfs-actions.pod:4167
10089 "This creates an LVM logical volume called C<logvol> on the volume group "
10090 "C<volgroup>, with C<size> megabytes."
10094 #: ../fish/guestfish-actions.pod:2807
10095 msgid "lvm-canonical-lv-name"
10099 #: ../fish/guestfish-actions.pod:2809
10102 " lvm-canonical-lv-name lvname\n"
10107 #: ../fish/guestfish-actions.pod:2811 ../src/guestfs-actions.pod:4180
10109 "This converts alternative naming schemes for LVs that you might find to the "
10110 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10115 #: ../fish/guestfish-actions.pod:2815 ../src/guestfs-actions.pod:4184
10117 "This command returns an error if the C<lvname> parameter does not refer to a "
10122 #: ../fish/guestfish-actions.pod:2818
10123 msgid "See also L</is-lv>."
10127 #: ../fish/guestfish-actions.pod:2820
10128 msgid "lvm-clear-filter"
10132 #: ../fish/guestfish-actions.pod:2822
10135 " lvm-clear-filter\n"
10140 #: ../fish/guestfish-actions.pod:2824
10142 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
10147 #: ../fish/guestfish-actions.pod:2827 ../fish/guestfish-actions.pod:2858
10148 #: ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4244
10150 "This command also clears the LVM cache and performs a volume group scan."
10154 #: ../fish/guestfish-actions.pod:2830
10155 msgid "lvm-remove-all"
10159 #: ../fish/guestfish-actions.pod:2832
10162 " lvm-remove-all\n"
10167 #: ../fish/guestfish-actions.pod:2834 ../src/guestfs-actions.pod:4214
10169 "This command removes all LVM logical volumes, volume groups and physical "
10174 #: ../fish/guestfish-actions.pod:2840
10175 msgid "lvm-set-filter"
10179 #: ../fish/guestfish-actions.pod:2842
10182 " lvm-set-filter 'devices ...'\n"
10187 #: ../fish/guestfish-actions.pod:2844 ../src/guestfs-actions.pod:4230
10189 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10190 "block devices in the list C<devices>, and will ignore all other attached "
10195 #: ../fish/guestfish-actions.pod:2848 ../src/guestfs-actions.pod:4234
10197 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10198 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10199 "there are two types of duplication possible: either cloned PVs/VGs which "
10200 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10201 "same name. In normal operation you cannot create this situation, but you "
10202 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10203 "inside the LVM metadata."
10207 #: ../fish/guestfish-actions.pod:2861 ../src/guestfs-actions.pod:4247
10208 msgid "You can filter whole block devices or individual partitions."
10212 #: ../fish/guestfish-actions.pod:2863 ../src/guestfs-actions.pod:4249
10214 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10215 "filesystem), even if you are not filtering out that VG."
10219 #: ../fish/guestfish-actions.pod:2867
10224 #: ../fish/guestfish-actions.pod:2869
10227 " lvremove device\n"
10232 #: ../fish/guestfish-actions.pod:2871 ../src/guestfs-actions.pod:4263
10234 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10235 "LV, such as C</dev/VG/LV>."
10239 #: ../fish/guestfish-actions.pod:2874 ../src/guestfs-actions.pod:4266
10241 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10246 #: ../fish/guestfish-actions.pod:2877
10251 #: ../fish/guestfish-actions.pod:2879
10254 " lvrename logvol newlogvol\n"
10259 #: ../fish/guestfish-actions.pod:2881 ../src/guestfs-actions.pod:4280
10260 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10264 #: ../fish/guestfish-actions.pod:2883
10269 #: ../fish/guestfish-actions.pod:2885
10272 " lvresize device mbytes\n"
10277 #: ../fish/guestfish-actions.pod:2887 ../src/guestfs-actions.pod:4293
10279 "This resizes (expands or shrinks) an existing LVM logical volume to "
10280 "C<mbytes>. When reducing, data in the reduced part is lost."
10284 #: ../fish/guestfish-actions.pod:2891
10285 msgid "lvresize-free"
10289 #: ../fish/guestfish-actions.pod:2893
10292 " lvresize-free lv percent\n"
10297 #: ../fish/guestfish-actions.pod:2895 ../src/guestfs-actions.pod:4308
10299 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10300 "remaining free space in the volume group. Commonly you would call this with "
10301 "pc = 100 which expands the logical volume as much as possible, using all "
10302 "remaining free space in the volume group."
10306 #: ../fish/guestfish-actions.pod:2901
10311 #: ../fish/guestfish-actions.pod:2903
10319 #: ../fish/guestfish-actions.pod:2905 ../src/guestfs-actions.pod:4323
10321 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10326 #: ../fish/guestfish-actions.pod:2908 ../src/guestfs-actions.pod:4326
10328 "This returns a list of the logical volume device names (eg. C</dev/"
10329 "VolGroup00/LogVol00>)."
10333 #: ../fish/guestfish-actions.pod:2911
10334 msgid "See also L</lvs-full>, L</list-filesystems>."
10338 #: ../fish/guestfish-actions.pod:2913
10343 #: ../fish/guestfish-actions.pod:2915
10351 #: ../fish/guestfish-actions.pod:2917 ../src/guestfs-actions.pod:4342
10353 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10354 "(8)> command. The \"full\" version includes all fields."
10358 #: ../fish/guestfish-actions.pod:2920
10363 #: ../fish/guestfish-actions.pod:2922
10371 #: ../fish/guestfish-actions.pod:2924 ../src/guestfs-actions.pod:4357
10372 msgid "This command returns the UUID of the LVM LV C<device>."
10376 #: ../fish/guestfish-actions.pod:2926
10381 #: ../fish/guestfish-actions.pod:2928
10384 " lxattrlist path 'names ...'\n"
10389 #: ../fish/guestfish-actions.pod:2930 ../src/guestfs-actions.pod:4371
10391 "This call allows you to get the extended attributes of multiple files, where "
10392 "all files are in the directory C<path>. C<names> is the list of files from "
10397 #: ../fish/guestfish-actions.pod:2934 ../src/guestfs-actions.pod:4375
10399 "On return you get a flat list of xattr structs which must be interpreted "
10400 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10401 "C<attrval> in this struct is zero-length to indicate there was an error "
10402 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10403 "number (the number of following attributes for this file, which could be C<"
10404 "\"0\">). Then after the first xattr struct are the zero or more attributes "
10405 "for the first named file. This repeats for the second and subsequent files."
10409 #: ../fish/guestfish-actions.pod:2944
10411 "This call is intended for programs that want to efficiently list a directory "
10412 "contents without making many round-trips. See also L</lstatlist> for a "
10413 "similarly efficient call for getting standard stats. Very long directory "
10414 "listings might cause the protocol message size to be exceeded, causing this "
10415 "call to fail. The caller must split up such requests into smaller groups of "
10420 #: ../fish/guestfish-actions.pod:2952
10425 #: ../fish/guestfish-actions.pod:2954
10433 #: ../fish/guestfish-actions.pod:2956 ../src/guestfs-actions.pod:4405
10434 msgid "Create a directory named C<path>."
10438 #: ../fish/guestfish-actions.pod:2958
10443 #: ../fish/guestfish-actions.pod:2960
10446 " mkdir-mode path mode\n"
10451 #: ../fish/guestfish-actions.pod:2962 ../src/guestfs-actions.pod:4418
10453 "This command creates a directory, setting the initial permissions of the "
10454 "directory to C<mode>."
10458 #: ../fish/guestfish-actions.pod:2965 ../src/guestfs-actions.pod:4421
10460 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10461 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10466 #: ../fish/guestfish-actions.pod:2969
10467 msgid "See also L</mkdir>, L</umask>"
10471 #: ../fish/guestfish-actions.pod:2971
10476 #: ../fish/guestfish-actions.pod:2973
10484 #: ../fish/guestfish-actions.pod:2975 ../src/guestfs-actions.pod:4437
10486 "Create a directory named C<path>, creating any parent directories as "
10487 "necessary. This is like the C<mkdir -p> shell command."
10491 #: ../fish/guestfish-actions.pod:2978
10496 #: ../fish/guestfish-actions.pod:2980
10499 " mkdtemp template\n"
10504 #: ../fish/guestfish-actions.pod:2982 ../src/guestfs-actions.pod:4450
10506 "This command creates a temporary directory. The C<template> parameter "
10507 "should be a full pathname for the temporary directory name with the final "
10508 "six characters being \"XXXXXX\"."
10512 #: ../fish/guestfish-actions.pod:2987 ../src/guestfs-actions.pod:4455
10514 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10515 "being suitable for Windows filesystems."
10519 #: ../fish/guestfish-actions.pod:2990 ../src/guestfs-actions.pod:4458
10520 msgid "The name of the temporary directory that was created is returned."
10524 #: ../fish/guestfish-actions.pod:2993 ../src/guestfs-actions.pod:4461
10525 msgid "The temporary directory is created with mode 0700 and is owned by root."
10529 #: ../fish/guestfish-actions.pod:2996 ../src/guestfs-actions.pod:4464
10531 "The caller is responsible for deleting the temporary directory and its "
10532 "contents after use."
10536 #: ../fish/guestfish-actions.pod:2999 ../src/guestfs-actions.pod:4467
10537 msgid "See also: L<mkdtemp(3)>"
10541 #: ../fish/guestfish-actions.pod:3001
10546 #: ../fish/guestfish-actions.pod:3003
10549 " mke2fs-J fstype blocksize device journal\n"
10554 #: ../fish/guestfish-actions.pod:3005 ../src/guestfs-actions.pod:4483
10556 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10557 "C<journal>. It is equivalent to the command:"
10561 #: ../fish/guestfish-actions.pod:3009 ../src/guestfs-actions.pod:4487
10564 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10569 #: ../fish/guestfish-actions.pod:3011
10570 msgid "See also L</mke2journal>."
10574 #: ../fish/guestfish-actions.pod:3013
10579 #: ../fish/guestfish-actions.pod:3015
10582 " mke2fs-JL fstype blocksize device label\n"
10587 #: ../fish/guestfish-actions.pod:3017 ../src/guestfs-actions.pod:4504
10589 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10590 "the journal labeled C<label>."
10594 #: ../fish/guestfish-actions.pod:3020
10595 msgid "See also L</mke2journal-L>."
10599 #: ../fish/guestfish-actions.pod:3022
10604 #: ../fish/guestfish-actions.pod:3024
10607 " mke2fs-JU fstype blocksize device uuid\n"
10612 #: ../fish/guestfish-actions.pod:3026 ../src/guestfs-actions.pod:4522
10614 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10615 "the journal with UUID C<uuid>."
10619 #: ../fish/guestfish-actions.pod:3029
10620 msgid "See also L</mke2journal-U>."
10624 #: ../fish/guestfish-actions.pod:3031
10625 msgid "mke2journal"
10629 #: ../fish/guestfish-actions.pod:3033
10632 " mke2journal blocksize device\n"
10637 #: ../fish/guestfish-actions.pod:3035 ../src/guestfs-actions.pod:4538
10639 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10644 #: ../fish/guestfish-actions.pod:3038 ../src/guestfs-actions.pod:4541
10647 " mke2fs -O journal_dev -b blocksize device\n"
10652 #: ../fish/guestfish-actions.pod:3040
10653 msgid "mke2journal-L"
10657 #: ../fish/guestfish-actions.pod:3042
10660 " mke2journal-L blocksize label device\n"
10665 #: ../fish/guestfish-actions.pod:3044 ../src/guestfs-actions.pod:4555
10666 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10670 #: ../fish/guestfish-actions.pod:3046
10671 msgid "mke2journal-U"
10675 #: ../fish/guestfish-actions.pod:3048
10678 " mke2journal-U blocksize uuid device\n"
10683 #: ../fish/guestfish-actions.pod:3050 ../src/guestfs-actions.pod:4569
10684 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10688 #: ../fish/guestfish-actions.pod:3052
10693 #: ../fish/guestfish-actions.pod:3054
10696 " mkfifo mode path\n"
10701 #: ../fish/guestfish-actions.pod:3056
10703 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10704 "is just a convenient wrapper around L</mknod>."
10708 #: ../fish/guestfish-actions.pod:3062
10713 #: ../fish/guestfish-actions.pod:3064
10716 " mkfs fstype device\n"
10721 #: ../fish/guestfish-actions.pod:3066 ../src/guestfs-actions.pod:4599
10723 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10724 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10728 #: ../fish/guestfish-actions.pod:3070
10733 #: ../fish/guestfish-actions.pod:3072
10736 " mkfs-b fstype blocksize device\n"
10741 #: ../fish/guestfish-actions.pod:3074
10743 "This call is similar to L</mkfs>, but it allows you to control the block "
10744 "size of the resulting filesystem. Supported block sizes depend on the "
10745 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10749 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3106
10750 #: ../src/guestfs-actions.pod:4620 ../src/guestfs-actions.pod:4665
10752 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10757 #: ../fish/guestfish-actions.pod:3082 ../src/guestfs-actions.pod:4625
10759 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
10763 #: ../fish/guestfish-actions.pod:3089
10768 #: ../fish/guestfish-actions.pod:3091
10771 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
10776 #: ../fish/guestfish-actions.pod:3093 ../src/guestfs-actions.pod:4652
10778 "This function creates a filesystem on C<device>. The filesystem type is "
10779 "C<fstype>, for example C<ext3>."
10783 #: ../fish/guestfish-actions.pod:3100 ../src/guestfs-actions.pod:4659
10784 msgid "C<blocksize>"
10788 #: ../fish/guestfish-actions.pod:3102 ../src/guestfs-actions.pod:4661
10790 "The filesystem block size. Supported block sizes depend on the filesystem "
10791 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
10796 #: ../fish/guestfish-actions.pod:3109 ../src/guestfs-actions.pod:4668
10797 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
10801 #: ../fish/guestfish-actions.pod:3111 ../src/guestfs-actions.pod:4670
10802 msgid "C<features>"
10806 #: ../fish/guestfish-actions.pod:3113 ../src/guestfs-actions.pod:4672
10807 msgid "This passes the I<-O> parameter to the external mkfs program."
10811 #: ../fish/guestfish-actions.pod:3115 ../src/guestfs-actions.pod:4674
10813 "For certain filesystem types, this allows extra filesystem features to be "
10814 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
10818 #: ../fish/guestfish-actions.pod:3119 ../src/guestfs-actions.pod:4678
10820 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
10825 #: ../fish/guestfish-actions.pod:3122 ../src/guestfs-actions.pod:4681
10830 #: ../fish/guestfish-actions.pod:3124 ../src/guestfs-actions.pod:4683
10832 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
10833 "sets the inode size (only for ext2/3/4 filesystems at present)."
10837 #: ../fish/guestfish-actions.pod:3127 ../src/guestfs-actions.pod:4686
10838 msgid "C<sectorsize>"
10842 #: ../fish/guestfish-actions.pod:3129 ../src/guestfs-actions.pod:4688
10844 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
10845 "sets sector size for ufs filesystem."
10849 #: ../fish/guestfish-actions.pod:3136
10850 msgid "mkmountpoint"
10854 #: ../fish/guestfish-actions.pod:3138
10857 " mkmountpoint exemptpath\n"
10862 #: ../fish/guestfish-actions.pod:3140
10864 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
10865 "to create extra mountpoints before mounting the first filesystem."
10869 #: ../fish/guestfish-actions.pod:3144 ../src/guestfs-actions.pod:4731
10871 "These calls are I<only> necessary in some very limited circumstances, mainly "
10872 "the case where you want to mount a mix of unrelated and/or read-only "
10873 "filesystems together."
10877 #: ../fish/guestfish-actions.pod:3148 ../src/guestfs-actions.pod:4735
10879 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10880 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10881 "inside that. You can unpack this as follows in guestfish:"
10885 #: ../fish/guestfish-actions.pod:3153 ../src/guestfs-actions.pod:4740
10888 " add-ro Fedora-11-i686-Live.iso\n"
10890 " mkmountpoint /cd\n"
10891 " mkmountpoint /sqsh\n"
10892 " mkmountpoint /ext3fs\n"
10893 " mount /dev/sda /cd\n"
10894 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10895 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10900 #: ../fish/guestfish-actions.pod:3162 ../src/guestfs-actions.pod:4749
10901 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10905 #: ../fish/guestfish-actions.pod:3164
10907 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
10908 "unexpected errors if you try to mix these calls. It is safest to manually "
10909 "unmount filesystems and remove mountpoints after use."
10913 #: ../fish/guestfish-actions.pod:3168
10915 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
10916 "for this to work for manual mountpoints, you must ensure that the innermost "
10917 "mountpoints have the longest pathnames, as in the example code above."
10921 #: ../fish/guestfish-actions.pod:3173 ../src/guestfs-actions.pod:4760
10923 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10927 #: ../fish/guestfish-actions.pod:3175
10929 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
10930 "L</umount-all> to be called when the handle is closed which can also trigger "
10935 #: ../fish/guestfish-actions.pod:3179
10940 #: ../fish/guestfish-actions.pod:3181
10943 " mknod mode devmajor devminor path\n"
10948 #: ../fish/guestfish-actions.pod:3183 ../src/guestfs-actions.pod:4779
10950 "This call creates block or character special devices, or named pipes (FIFOs)."
10954 #: ../fish/guestfish-actions.pod:3186 ../src/guestfs-actions.pod:4782
10956 "The C<mode> parameter should be the mode, using the standard constants. "
10957 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10958 "used when creating block and character special devices."
10962 #: ../fish/guestfish-actions.pod:3191
10964 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10965 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10966 "regular file). These constants are available in the standard Linux header "
10967 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
10968 "wrappers around this command which bitwise OR in the appropriate constant "
10973 #: ../fish/guestfish-actions.pod:3201
10978 #: ../fish/guestfish-actions.pod:3203
10981 " mknod-b mode devmajor devminor path\n"
10986 #: ../fish/guestfish-actions.pod:3205
10988 "This call creates a block device node called C<path> with mode C<mode> and "
10989 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10990 "wrapper around L</mknod>."
10994 #: ../fish/guestfish-actions.pod:3211
10999 #: ../fish/guestfish-actions.pod:3213
11002 " mknod-c mode devmajor devminor path\n"
11007 #: ../fish/guestfish-actions.pod:3215
11009 "This call creates a char device node called C<path> with mode C<mode> and "
11010 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11011 "wrapper around L</mknod>."
11015 #: ../fish/guestfish-actions.pod:3221
11020 #: ../fish/guestfish-actions.pod:3223
11028 #: ../fish/guestfish-actions.pod:3225 ../src/guestfs-actions.pod:4845
11029 msgid "Create a swap partition on C<device>."
11033 #: ../fish/guestfish-actions.pod:3227
11038 #: ../fish/guestfish-actions.pod:3229
11041 " mkswap-L label device\n"
11046 #: ../fish/guestfish-actions.pod:3231 ../src/guestfs-actions.pod:4858
11047 msgid "Create a swap partition on C<device> with label C<label>."
11051 #: ../fish/guestfish-actions.pod:3233 ../src/guestfs-actions.pod:4860
11053 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
11054 "sda>), just to a partition. This appears to be a limitation of the kernel "
11059 #: ../fish/guestfish-actions.pod:3237
11064 #: ../fish/guestfish-actions.pod:3239
11067 " mkswap-U uuid device\n"
11072 #: ../fish/guestfish-actions.pod:3241 ../src/guestfs-actions.pod:4875
11073 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11077 #: ../fish/guestfish-actions.pod:3243
11078 msgid "mkswap-file"
11082 #: ../fish/guestfish-actions.pod:3245
11085 " mkswap-file path\n"
11090 #: ../fish/guestfish-actions.pod:3247 ../src/guestfs-actions.pod:4887
11091 msgid "Create a swap file."
11095 #: ../fish/guestfish-actions.pod:3249
11097 "This command just writes a swap file signature to an existing file. To "
11098 "create the file itself, use something like L</fallocate>."
11102 #: ../fish/guestfish-actions.pod:3252
11107 #: ../fish/guestfish-actions.pod:3254
11110 " modprobe modulename\n"
11115 #: ../fish/guestfish-actions.pod:3256 ../src/guestfs-actions.pod:4902
11116 msgid "This loads a kernel module in the appliance."
11120 #: ../fish/guestfish-actions.pod:3258 ../src/guestfs-actions.pod:4904
11122 "The kernel module must have been whitelisted when libguestfs was built (see "
11123 "C<appliance/kmod.whitelist.in> in the source)."
11127 #: ../fish/guestfish-actions.pod:3261
11132 #: ../fish/guestfish-actions.pod:3263
11135 " mount device mountpoint\n"
11140 #: ../fish/guestfish-actions.pod:3265 ../src/guestfs-actions.pod:4918
11142 "Mount a guest disk at a position in the filesystem. Block devices are named "
11143 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11144 "those block devices contain partitions, they will have the usual names (eg. "
11145 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11149 #: ../fish/guestfish-actions.pod:3271 ../src/guestfs-actions.pod:4924
11151 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11152 "mounted on C</> before others can be mounted. Other filesystems can only be "
11153 "mounted on directories which already exist."
11157 #: ../fish/guestfish-actions.pod:3276 ../src/guestfs-actions.pod:4929
11159 "The mounted filesystem is writable, if we have sufficient permissions on the "
11160 "underlying device."
11164 #: ../fish/guestfish-actions.pod:3279
11166 "B<Important note:> When you use this call, the filesystem options C<sync> "
11167 "and C<noatime> are set implicitly. This was originally done because we "
11168 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11169 "very large negative performance impact and negligible effect on "
11170 "reliability. Therefore we recommend that you avoid using L</mount> in any "
11171 "code that needs performance, and instead use L</mount-options> (use an empty "
11172 "string for the first parameter if you don't want any options)."
11176 #: ../fish/guestfish-actions.pod:3289 ../src/guestfs-actions.pod:4944
11178 "This function is deprecated. In new code, use the C<mount_options> call "
11183 #: ../fish/guestfish-actions.pod:3296
11188 #: ../fish/guestfish-actions.pod:3298
11191 " mount-9p mounttag mountpoint [options:..]\n"
11196 #: ../fish/guestfish-actions.pod:3300 ../src/guestfs-actions.pod:4968
11198 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
11203 #: ../fish/guestfish-actions.pod:3303 ../src/guestfs-actions.pod:4971
11205 "If required, C<trans=virtio> will be automatically added to the options. "
11206 "Any other options required can be passed in the optional C<options> "
11211 #: ../fish/guestfish-actions.pod:3309
11216 #: ../fish/guestfish-actions.pod:3311
11219 " mount-loop file mountpoint\n"
11224 #: ../fish/guestfish-actions.pod:3313 ../src/guestfs-actions.pod:5010
11226 "This command lets you mount C<file> (a filesystem image in a file) on a "
11227 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11232 #: ../fish/guestfish-actions.pod:3317
11233 msgid "mount-options"
11237 #: ../fish/guestfish-actions.pod:3319
11240 " mount-options options device mountpoint\n"
11245 #: ../fish/guestfish-actions.pod:3321
11247 "This is the same as the L</mount> command, but it allows you to set the "
11248 "mount options as for the L<mount(8)> I<-o> flag."
11252 #: ../fish/guestfish-actions.pod:3325 ../src/guestfs-actions.pod:5030
11254 "If the C<options> parameter is an empty string, then no options are passed "
11255 "(all options default to whatever the filesystem uses)."
11259 #: ../fish/guestfish-actions.pod:3329
11264 #: ../fish/guestfish-actions.pod:3331
11267 " mount-ro device mountpoint\n"
11272 #: ../fish/guestfish-actions.pod:3333
11274 "This is the same as the L</mount> command, but it mounts the filesystem with "
11275 "the read-only (I<-o ro>) flag."
11279 #: ../fish/guestfish-actions.pod:3336
11284 #: ../fish/guestfish-actions.pod:3338
11287 " mount-vfs options vfstype device mountpoint\n"
11292 #: ../fish/guestfish-actions.pod:3340
11294 "This is the same as the L</mount> command, but it allows you to set both the "
11295 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
11299 #: ../fish/guestfish-actions.pod:3344
11300 msgid "mountpoints"
11304 #: ../fish/guestfish-actions.pod:3346
11312 #: ../fish/guestfish-actions.pod:3348
11314 "This call is similar to L</mounts>. That call returns a list of devices. "
11315 "This one returns a hash table (map) of device name to directory where the "
11316 "device is mounted."
11320 #: ../fish/guestfish-actions.pod:3352
11325 #: ../fish/guestfish-actions.pod:3354
11333 #: ../fish/guestfish-actions.pod:3356 ../src/guestfs-actions.pod:5091
11335 "This returns the list of currently mounted filesystems. It returns the list "
11336 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11340 #: ../fish/guestfish-actions.pod:3359 ../src/guestfs-actions.pod:5094
11341 msgid "Some internal mounts are not shown."
11345 #: ../fish/guestfish-actions.pod:3361
11346 msgid "See also: L</mountpoints>"
11350 #: ../fish/guestfish-actions.pod:3363
11355 #: ../fish/guestfish-actions.pod:3365
11363 #: ../fish/guestfish-actions.pod:3367 ../src/guestfs-actions.pod:5111
11365 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11366 "destination filename or destination directory."
11370 #: ../fish/guestfish-actions.pod:3370
11371 msgid "ntfs-3g-probe"
11375 #: ../fish/guestfish-actions.pod:3372
11378 " ntfs-3g-probe true|false device\n"
11383 #: ../fish/guestfish-actions.pod:3374 ../src/guestfs-actions.pod:5125
11385 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11386 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
11387 "write, and some cannot be mounted at all)."
11391 #: ../fish/guestfish-actions.pod:3378 ../src/guestfs-actions.pod:5129
11393 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11394 "can be mounted read-write. Set it to false if you want to test if the "
11395 "volume can be mounted read-only."
11399 #: ../fish/guestfish-actions.pod:3382 ../src/guestfs-actions.pod:5133
11401 "The return value is an integer which C<0> if the operation would succeed, or "
11402 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11406 #: ../fish/guestfish-actions.pod:3386
11411 #: ../fish/guestfish-actions.pod:3388
11414 " ntfsresize device\n"
11419 #: ../fish/guestfish-actions.pod:3390 ../fish/guestfish-actions.pod:3414
11420 #: ../src/guestfs-actions.pod:5147 ../src/guestfs-actions.pod:5186
11422 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11423 "size of the underlying device."
11427 #: ../fish/guestfish-actions.pod:3393 ../src/guestfs-actions.pod:5150
11429 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
11430 "consistency check (for safety). You have to boot into Windows to perform "
11431 "this check and clear this condition. Furthermore, ntfsresize refuses to "
11432 "resize filesystems which have been marked in this way. So in effect it is "
11433 "not possible to call ntfsresize multiple times on a single filesystem "
11434 "without booting into Windows between each resize."
11438 #: ../fish/guestfish-actions.pod:3401 ../fish/guestfish-actions.pod:3440
11439 #: ../src/guestfs-actions.pod:5158 ../src/guestfs-actions.pod:5212
11440 msgid "See also L<ntfsresize(8)>."
11444 #: ../fish/guestfish-actions.pod:3403 ../fish/guestfish-actions.pod:3451
11445 #: ../src/guestfs-actions.pod:5162 ../src/guestfs-actions.pod:5252
11447 "This function is deprecated. In new code, use the C<ntfsresize_opts> call "
11452 #: ../fish/guestfish-actions.pod:3410
11453 msgid "ntfsresize-opts"
11457 #: ../fish/guestfish-actions.pod:3412
11460 " ntfsresize-opts device [size:..] [force:..]\n"
11465 #: ../fish/guestfish-actions.pod:3423 ../src/guestfs-actions.pod:5195
11467 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
11468 "resized to fit the container (eg. partition)."
11472 #: ../fish/guestfish-actions.pod:3426 ../src/guestfs-actions.pod:5198
11477 #: ../fish/guestfish-actions.pod:3428 ../src/guestfs-actions.pod:5200
11479 "If this option is true, then force the resize of the filesystem even if the "
11480 "filesystem is marked as requiring a consistency check."
11484 #: ../fish/guestfish-actions.pod:3431
11486 "After the resize operation, the filesystem is always marked as requiring a "
11487 "consistency check (for safety). You have to boot into Windows to perform "
11488 "this check and clear this condition. If you I<don't> set the C<force> "
11489 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
11490 "a single filesystem without booting into Windows between each resize."
11494 #: ../fish/guestfish-actions.pod:3444
11495 msgid "ntfsresize-size"
11499 #: ../fish/guestfish-actions.pod:3446
11502 " ntfsresize-size device size\n"
11507 #: ../fish/guestfish-actions.pod:3448
11509 "This command is the same as L</ntfsresize> except that it allows you to "
11510 "specify the new size (in bytes) explicitly."
11514 #: ../fish/guestfish-actions.pod:3458
11519 #: ../fish/guestfish-actions.pod:3460
11522 " part-add device prlogex startsect endsect\n"
11527 #: ../fish/guestfish-actions.pod:3462
11529 "This command adds a partition to C<device>. If there is no partition table "
11530 "on the device, call L</part-init> first."
11534 #: ../fish/guestfish-actions.pod:3465 ../src/guestfs-actions.pod:5273
11536 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11537 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11538 "C<logical>) and C<e> (or C<extended>) partition types."
11542 #: ../fish/guestfish-actions.pod:3470 ../src/guestfs-actions.pod:5278
11544 "C<startsect> and C<endsect> are the start and end of the partition in "
11545 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11546 "from the end of the disk (C<-1> is the last sector)."
11550 #: ../fish/guestfish-actions.pod:3474
11552 "Creating a partition which covers the whole disk is not so easy. Use L</"
11553 "part-disk> to do that."
11557 #: ../fish/guestfish-actions.pod:3477
11562 #: ../fish/guestfish-actions.pod:3479
11565 " part-del device partnum\n"
11570 #: ../fish/guestfish-actions.pod:3481 ../src/guestfs-actions.pod:5296
11571 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11575 #: ../fish/guestfish-actions.pod:3483 ../src/guestfs-actions.pod:5298
11577 "Note that in the case of MBR partitioning, deleting an extended partition "
11578 "also deletes any logical partitions it contains."
11582 #: ../fish/guestfish-actions.pod:3487
11587 #: ../fish/guestfish-actions.pod:3489
11590 " part-disk device parttype\n"
11595 #: ../fish/guestfish-actions.pod:3491
11597 "This command is simply a combination of L</part-init> followed by L</part-"
11598 "add> to create a single primary partition covering the whole disk."
11602 #: ../fish/guestfish-actions.pod:3495
11604 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11605 "possible values are described in L</part-init>."
11609 #: ../fish/guestfish-actions.pod:3501
11610 msgid "part-get-bootable"
11614 #: ../fish/guestfish-actions.pod:3503
11617 " part-get-bootable device partnum\n"
11622 #: ../fish/guestfish-actions.pod:3505 ../src/guestfs-actions.pod:5334
11624 "This command returns true if the partition C<partnum> on C<device> has the "
11625 "bootable flag set."
11629 #: ../fish/guestfish-actions.pod:3508
11630 msgid "See also L</part-set-bootable>."
11634 #: ../fish/guestfish-actions.pod:3510
11635 msgid "part-get-mbr-id"
11639 #: ../fish/guestfish-actions.pod:3512
11642 " part-get-mbr-id device partnum\n"
11647 #: ../fish/guestfish-actions.pod:3514 ../src/guestfs-actions.pod:5350
11649 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11650 "partition C<partnum>."
11654 #: ../fish/guestfish-actions.pod:3517 ../fish/guestfish-actions.pod:3661
11656 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11657 "undefined results for other partition table types (see L</part-get-"
11662 #: ../fish/guestfish-actions.pod:3521
11663 msgid "part-get-parttype"
11667 #: ../fish/guestfish-actions.pod:3523
11670 " part-get-parttype device\n"
11675 #: ../fish/guestfish-actions.pod:3525 ../src/guestfs-actions.pod:5367
11677 "This command examines the partition table on C<device> and returns the "
11678 "partition table type (format) being used."
11682 #: ../fish/guestfish-actions.pod:3528
11684 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11685 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11686 "possible, although unusual. See L</part-init> for a full list."
11690 #: ../fish/guestfish-actions.pod:3533
11695 #: ../fish/guestfish-actions.pod:3535
11698 " part-init device parttype\n"
11703 #: ../fish/guestfish-actions.pod:3537 ../src/guestfs-actions.pod:5387
11705 "This creates an empty partition table on C<device> of one of the partition "
11706 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11707 "(for large disks)."
11711 #: ../fish/guestfish-actions.pod:3541
11713 "Initially there are no partitions. Following this, you should call L</part-"
11714 "add> for each partition required."
11718 #: ../fish/guestfish-actions.pod:3544 ../src/guestfs-actions.pod:5394
11719 msgid "Possible values for C<parttype> are:"
11723 #: ../fish/guestfish-actions.pod:3548 ../src/guestfs-actions.pod:5398
11728 #: ../fish/guestfish-actions.pod:3550 ../src/guestfs-actions.pod:5400
11733 #: ../fish/guestfish-actions.pod:3552 ../src/guestfs-actions.pod:5402
11734 msgid "Intel EFI / GPT partition table."
11738 #: ../fish/guestfish-actions.pod:3554 ../src/guestfs-actions.pod:5404
11740 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11741 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11742 "the C<mbr> format."
11746 #: ../fish/guestfish-actions.pod:3558 ../src/guestfs-actions.pod:5408
11751 #: ../fish/guestfish-actions.pod:3560 ../src/guestfs-actions.pod:5410
11756 #: ../fish/guestfish-actions.pod:3562 ../src/guestfs-actions.pod:5412
11758 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11759 "Windows. This partition type will B<only> work for device sizes up to 2 "
11760 "TB. For large disks we recommend using C<gpt>."
11764 #: ../fish/guestfish-actions.pod:3569 ../src/guestfs-actions.pod:5419
11766 "Other partition table types that may work but are not supported include:"
11770 #: ../fish/guestfish-actions.pod:3574 ../src/guestfs-actions.pod:5424
11775 #: ../fish/guestfish-actions.pod:3576 ../src/guestfs-actions.pod:5426
11776 msgid "AIX disk labels."
11780 #: ../fish/guestfish-actions.pod:3578 ../src/guestfs-actions.pod:5428
11785 #: ../fish/guestfish-actions.pod:3580 ../src/guestfs-actions.pod:5430
11790 #: ../fish/guestfish-actions.pod:3582 ../src/guestfs-actions.pod:5432
11791 msgid "Amiga \"Rigid Disk Block\" format."
11795 #: ../fish/guestfish-actions.pod:3584 ../src/guestfs-actions.pod:5434
11800 #: ../fish/guestfish-actions.pod:3586 ../src/guestfs-actions.pod:5436
11801 msgid "BSD disk labels."
11805 #: ../fish/guestfish-actions.pod:3588 ../src/guestfs-actions.pod:5438
11810 #: ../fish/guestfish-actions.pod:3590 ../src/guestfs-actions.pod:5440
11811 msgid "DASD, used on IBM mainframes."
11815 #: ../fish/guestfish-actions.pod:3592 ../src/guestfs-actions.pod:5442
11820 #: ../fish/guestfish-actions.pod:3594 ../src/guestfs-actions.pod:5444
11821 msgid "MIPS/SGI volumes."
11825 #: ../fish/guestfish-actions.pod:3596 ../src/guestfs-actions.pod:5446
11830 #: ../fish/guestfish-actions.pod:3598 ../src/guestfs-actions.pod:5448
11831 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11835 #: ../fish/guestfish-actions.pod:3600 ../src/guestfs-actions.pod:5450
11840 #: ../fish/guestfish-actions.pod:3602 ../src/guestfs-actions.pod:5452
11841 msgid "NEC PC-98 format, common in Japan apparently."
11845 #: ../fish/guestfish-actions.pod:3604 ../src/guestfs-actions.pod:5454
11850 #: ../fish/guestfish-actions.pod:3606 ../src/guestfs-actions.pod:5456
11851 msgid "Sun disk labels."
11855 #: ../fish/guestfish-actions.pod:3610
11860 #: ../fish/guestfish-actions.pod:3612
11863 " part-list device\n"
11868 #: ../fish/guestfish-actions.pod:3614 ../src/guestfs-actions.pod:5470
11870 "This command parses the partition table on C<device> and returns the list of "
11871 "partitions found."
11875 #: ../fish/guestfish-actions.pod:3617 ../src/guestfs-actions.pod:5473
11876 msgid "The fields in the returned structure are:"
11880 #: ../fish/guestfish-actions.pod:3621 ../src/guestfs-actions.pod:5477
11881 msgid "B<part_num>"
11885 #: ../fish/guestfish-actions.pod:3623 ../src/guestfs-actions.pod:5479
11886 msgid "Partition number, counting from 1."
11890 #: ../fish/guestfish-actions.pod:3625 ../src/guestfs-actions.pod:5481
11891 msgid "B<part_start>"
11895 #: ../fish/guestfish-actions.pod:3627
11897 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11898 "the device's sector size, see L</blockdev-getss>."
11902 #: ../fish/guestfish-actions.pod:3630 ../src/guestfs-actions.pod:5486
11903 msgid "B<part_end>"
11907 #: ../fish/guestfish-actions.pod:3632 ../src/guestfs-actions.pod:5488
11908 msgid "End of the partition in bytes."
11912 #: ../fish/guestfish-actions.pod:3634 ../src/guestfs-actions.pod:5490
11913 msgid "B<part_size>"
11917 #: ../fish/guestfish-actions.pod:3636 ../src/guestfs-actions.pod:5492
11918 msgid "Size of the partition in bytes."
11922 #: ../fish/guestfish-actions.pod:3640
11923 msgid "part-set-bootable"
11927 #: ../fish/guestfish-actions.pod:3642
11930 " part-set-bootable device partnum true|false\n"
11935 #: ../fish/guestfish-actions.pod:3644 ../src/guestfs-actions.pod:5510
11937 "This sets the bootable flag on partition numbered C<partnum> on device "
11938 "C<device>. Note that partitions are numbered from 1."
11942 #: ../fish/guestfish-actions.pod:3647 ../src/guestfs-actions.pod:5513
11944 "The bootable flag is used by some operating systems (notably Windows) to "
11945 "determine which partition to boot from. It is by no means universally "
11950 #: ../fish/guestfish-actions.pod:3651
11951 msgid "part-set-mbr-id"
11955 #: ../fish/guestfish-actions.pod:3653
11958 " part-set-mbr-id device partnum idbyte\n"
11963 #: ../fish/guestfish-actions.pod:3655 ../src/guestfs-actions.pod:5529
11965 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11966 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11967 "documentation are in fact hexadecimal numbers, but usually documented "
11968 "without any leading \"0x\" which might be confusing."
11972 #: ../fish/guestfish-actions.pod:3665
11973 msgid "part-set-name"
11977 #: ../fish/guestfish-actions.pod:3667
11980 " part-set-name device partnum name\n"
11985 #: ../fish/guestfish-actions.pod:3669 ../src/guestfs-actions.pod:5551
11987 "This sets the partition name on partition numbered C<partnum> on device "
11988 "C<device>. Note that partitions are numbered from 1."
11992 #: ../fish/guestfish-actions.pod:3672 ../src/guestfs-actions.pod:5554
11994 "The partition name can only be set on certain types of partition table. "
11995 "This works on C<gpt> but not on C<mbr> partitions."
11999 #: ../fish/guestfish-actions.pod:3675
12000 msgid "part-to-dev"
12004 #: ../fish/guestfish-actions.pod:3677
12007 " part-to-dev partition\n"
12012 #: ../fish/guestfish-actions.pod:3679 ../src/guestfs-actions.pod:5567
12014 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12015 "partition number, returning the device name (eg. \"/dev/sdb\")."
12019 #: ../fish/guestfish-actions.pod:3683
12021 "The named partition must exist, for example as a string returned from L</"
12022 "list-partitions>."
12026 #: ../fish/guestfish-actions.pod:3686
12027 msgid "ping-daemon"
12031 #: ../fish/guestfish-actions.pod:3688
12039 #: ../fish/guestfish-actions.pod:3690 ../src/guestfs-actions.pod:5584
12041 "This is a test probe into the guestfs daemon running inside the qemu "
12042 "subprocess. Calling this function checks that the daemon responds to the "
12043 "ping message, without affecting the daemon or attached block device(s) in "
12048 #: ../fish/guestfish-actions.pod:3695
12053 #: ../fish/guestfish-actions.pod:3697
12056 " pread path count offset\n"
12061 #: ../fish/guestfish-actions.pod:3699 ../src/guestfs-actions.pod:5602
12063 "This command lets you read part of a file. It reads C<count> bytes of the "
12064 "file, starting at C<offset>, from file C<path>."
12068 #: ../fish/guestfish-actions.pod:3702 ../fish/guestfish-actions.pod:3717
12069 #: ../src/guestfs-actions.pod:5605 ../src/guestfs-actions.pod:5631
12071 "This may read fewer bytes than requested. For further details see the "
12072 "L<pread(2)> system call."
12076 #: ../fish/guestfish-actions.pod:3705
12077 msgid "See also L</pwrite>, L</pread-device>."
12081 #: ../fish/guestfish-actions.pod:3710
12082 msgid "pread-device"
12086 #: ../fish/guestfish-actions.pod:3712
12089 " pread-device device count offset\n"
12094 #: ../fish/guestfish-actions.pod:3714 ../src/guestfs-actions.pod:5628
12096 "This command lets you read part of a file. It reads C<count> bytes of "
12097 "C<device>, starting at C<offset>."
12101 #: ../fish/guestfish-actions.pod:3720
12102 msgid "See also L</pread>."
12106 #: ../fish/guestfish-actions.pod:3725
12111 #: ../fish/guestfish-actions.pod:3727
12114 " pvcreate device\n"
12119 #: ../fish/guestfish-actions.pod:3729 ../src/guestfs-actions.pod:5651
12121 "This creates an LVM physical volume on the named C<device>, where C<device> "
12122 "should usually be a partition name such as C</dev/sda1>."
12126 #: ../fish/guestfish-actions.pod:3733
12131 #: ../fish/guestfish-actions.pod:3735
12134 " pvremove device\n"
12139 #: ../fish/guestfish-actions.pod:3737 ../src/guestfs-actions.pod:5665
12141 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12146 #: ../fish/guestfish-actions.pod:3740 ../src/guestfs-actions.pod:5668
12148 "The implementation uses the C<pvremove> command which refuses to wipe "
12149 "physical volumes that contain any volume groups, so you have to remove those "
12154 #: ../fish/guestfish-actions.pod:3744
12159 #: ../fish/guestfish-actions.pod:3746
12162 " pvresize device\n"
12167 #: ../fish/guestfish-actions.pod:3748 ../src/guestfs-actions.pod:5682
12169 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12170 "the new size of the underlying device."
12174 #: ../fish/guestfish-actions.pod:3751
12175 msgid "pvresize-size"
12179 #: ../fish/guestfish-actions.pod:3753
12182 " pvresize-size device size\n"
12187 #: ../fish/guestfish-actions.pod:3755
12189 "This command is the same as L</pvresize> except that it allows you to "
12190 "specify the new size (in bytes) explicitly."
12194 #: ../fish/guestfish-actions.pod:3758
12199 #: ../fish/guestfish-actions.pod:3760
12207 #: ../fish/guestfish-actions.pod:3762 ../src/guestfs-actions.pod:5708
12209 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12214 #: ../fish/guestfish-actions.pod:3765 ../src/guestfs-actions.pod:5711
12216 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12221 #: ../fish/guestfish-actions.pod:3768
12222 msgid "See also L</pvs-full>."
12226 #: ../fish/guestfish-actions.pod:3770
12231 #: ../fish/guestfish-actions.pod:3772
12239 #: ../fish/guestfish-actions.pod:3774 ../src/guestfs-actions.pod:5727
12241 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12242 "(8)> command. The \"full\" version includes all fields."
12246 #: ../fish/guestfish-actions.pod:3777
12251 #: ../fish/guestfish-actions.pod:3779
12259 #: ../fish/guestfish-actions.pod:3781 ../src/guestfs-actions.pod:5742
12260 msgid "This command returns the UUID of the LVM PV C<device>."
12264 #: ../fish/guestfish-actions.pod:3783
12269 #: ../fish/guestfish-actions.pod:3785
12272 " pwrite path content offset\n"
12277 #: ../fish/guestfish-actions.pod:3787 ../src/guestfs-actions.pod:5758
12279 "This command writes to part of a file. It writes the data buffer C<content> "
12280 "to the file C<path> starting at offset C<offset>."
12284 #: ../fish/guestfish-actions.pod:3790 ../src/guestfs-actions.pod:5761
12286 "This command implements the L<pwrite(2)> system call, and like that system "
12287 "call it may not write the full data requested. The return value is the "
12288 "number of bytes that were actually written to the file. This could even be "
12289 "0, although short writes are unlikely for regular files in ordinary "
12294 #: ../fish/guestfish-actions.pod:3796
12295 msgid "See also L</pread>, L</pwrite-device>."
12299 #: ../fish/guestfish-actions.pod:3801
12300 msgid "pwrite-device"
12304 #: ../fish/guestfish-actions.pod:3803
12307 " pwrite-device device content offset\n"
12312 #: ../fish/guestfish-actions.pod:3805 ../src/guestfs-actions.pod:5785
12314 "This command writes to part of a device. It writes the data buffer "
12315 "C<content> to C<device> starting at offset C<offset>."
12319 #: ../fish/guestfish-actions.pod:3808 ../src/guestfs-actions.pod:5788
12321 "This command implements the L<pwrite(2)> system call, and like that system "
12322 "call it may not write the full data requested (although short writes to disk "
12323 "devices and partitions are probably impossible with standard Linux kernels)."
12327 #: ../fish/guestfish-actions.pod:3813
12328 msgid "See also L</pwrite>."
12332 #: ../fish/guestfish-actions.pod:3818
12337 #: ../fish/guestfish-actions.pod:3820
12340 " read-file path\n"
12345 #: ../fish/guestfish-actions.pod:3822 ../src/guestfs-actions.pod:5809
12346 msgid "This calls returns the contents of the file C<path> as a buffer."
12350 #: ../fish/guestfish-actions.pod:3825
12352 "Unlike L</cat>, this function can correctly handle files that contain "
12353 "embedded ASCII NUL characters. However unlike L</download>, this function "
12354 "is limited in the total size of file that can be handled."
12358 #: ../fish/guestfish-actions.pod:3833
12363 #: ../fish/guestfish-actions.pod:3835
12366 " read-lines path\n"
12371 #: ../fish/guestfish-actions.pod:3839 ../src/guestfs-actions.pod:5834
12373 "The file contents are returned as a list of lines. Trailing C<LF> and "
12374 "C<CRLF> character sequences are I<not> returned."
12378 #: ../fish/guestfish-actions.pod:3842
12380 "Note that this function cannot correctly handle binary files (specifically, "
12381 "files containing C<\\0> character which is treated as end of line). For "
12382 "those you need to use the L</read-file> function which has a more complex "
12387 #: ../fish/guestfish-actions.pod:3847
12392 #: ../fish/guestfish-actions.pod:3849
12400 #: ../fish/guestfish-actions.pod:3851 ../src/guestfs-actions.pod:5854
12401 msgid "This returns the list of directory entries in directory C<dir>."
12405 #: ../fish/guestfish-actions.pod:3853 ../src/guestfs-actions.pod:5856
12407 "All entries in the directory are returned, including C<.> and C<..>. The "
12408 "entries are I<not> sorted, but returned in the same order as the underlying "
12413 #: ../fish/guestfish-actions.pod:3857 ../src/guestfs-actions.pod:5860
12415 "Also this call returns basic file type information about each file. The "
12416 "C<ftyp> field will contain one of the following characters:"
12420 #: ../fish/guestfish-actions.pod:3862 ../src/guestfs-actions.pod:5865
12425 #: ../fish/guestfish-actions.pod:3864 ../src/guestfs-actions.pod:5867
12426 msgid "Block special"
12430 #: ../fish/guestfish-actions.pod:3866 ../src/guestfs-actions.pod:5869
12435 #: ../fish/guestfish-actions.pod:3868 ../src/guestfs-actions.pod:5871
12436 msgid "Char special"
12440 #: ../fish/guestfish-actions.pod:3870 ../src/guestfs-actions.pod:5873
12445 #: ../fish/guestfish-actions.pod:3872 ../src/guestfs-actions.pod:5875
12450 #: ../fish/guestfish-actions.pod:3874 ../src/guestfs-actions.pod:5877
12455 #: ../fish/guestfish-actions.pod:3876 ../src/guestfs-actions.pod:5879
12456 msgid "FIFO (named pipe)"
12460 #: ../fish/guestfish-actions.pod:3878 ../src/guestfs-actions.pod:5881
12465 #: ../fish/guestfish-actions.pod:3880 ../src/guestfs-actions.pod:5883
12466 msgid "Symbolic link"
12470 #: ../fish/guestfish-actions.pod:3882 ../src/guestfs-actions.pod:5885
12475 #: ../fish/guestfish-actions.pod:3884 ../src/guestfs-actions.pod:5887
12476 msgid "Regular file"
12480 #: ../fish/guestfish-actions.pod:3886 ../src/guestfs-actions.pod:5889
12485 #: ../fish/guestfish-actions.pod:3888 ../src/guestfs-actions.pod:5891
12490 #: ../fish/guestfish-actions.pod:3890 ../src/guestfs-actions.pod:5893
12495 #: ../fish/guestfish-actions.pod:3892 ../src/guestfs-actions.pod:5895
12496 msgid "Unknown file type"
12500 #: ../fish/guestfish-actions.pod:3894 ../src/guestfs-actions.pod:5897
12505 #: ../fish/guestfish-actions.pod:3896 ../src/guestfs-actions.pod:5899
12507 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12511 #: ../fish/guestfish-actions.pod:3901
12513 "This function is primarily intended for use by programs. To get a simple "
12514 "list of names, use L</ls>. To get a printable directory for human "
12515 "consumption, use L</ll>."
12519 #: ../fish/guestfish-actions.pod:3905
12524 #: ../fish/guestfish-actions.pod:3907
12532 #: ../fish/guestfish-actions.pod:3909 ../src/guestfs-actions.pod:5920
12533 msgid "This command reads the target of a symbolic link."
12537 #: ../fish/guestfish-actions.pod:3911
12538 msgid "readlinklist"
12542 #: ../fish/guestfish-actions.pod:3913
12545 " readlinklist path 'names ...'\n"
12550 #: ../fish/guestfish-actions.pod:3915 ../src/guestfs-actions.pod:5934
12552 "This call allows you to do a C<readlink> operation on multiple files, where "
12553 "all files are in the directory C<path>. C<names> is the list of files from "
12558 #: ../fish/guestfish-actions.pod:3919 ../src/guestfs-actions.pod:5938
12560 "On return you get a list of strings, with a one-to-one correspondence to the "
12561 "C<names> list. Each string is the value of the symbolic link."
12565 #: ../fish/guestfish-actions.pod:3923 ../src/guestfs-actions.pod:5942
12567 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12568 "result string is the empty string C<\"\">. However the whole operation is "
12569 "completed even if there were C<readlink(2)> errors, and so you can call this "
12570 "function with names where you don't know if they are symbolic links already "
12571 "(albeit slightly less efficient)."
12575 #: ../fish/guestfish-actions.pod:3930 ../src/guestfs-actions.pod:5949
12577 "This call is intended for programs that want to efficiently list a directory "
12578 "contents without making many round-trips. Very long directory listings "
12579 "might cause the protocol message size to be exceeded, causing this call to "
12580 "fail. The caller must split up such requests into smaller groups of names."
12584 #: ../fish/guestfish-actions.pod:3937
12589 #: ../fish/guestfish-actions.pod:3939
12597 #: ../fish/guestfish-actions.pod:3941 ../src/guestfs-actions.pod:5968
12599 "Return the canonicalized absolute pathname of C<path>. The returned path "
12600 "has no C<.>, C<..> or symbolic link path elements."
12604 #: ../fish/guestfish-actions.pod:3944
12605 msgid "removexattr"
12609 #: ../fish/guestfish-actions.pod:3946
12612 " removexattr xattr path\n"
12617 #: ../fish/guestfish-actions.pod:3948 ../src/guestfs-actions.pod:5983
12619 "This call removes the extended attribute named C<xattr> of the file C<path>."
12623 #: ../fish/guestfish-actions.pod:3951
12624 msgid "See also: L</lremovexattr>, L<attr(5)>."
12628 #: ../fish/guestfish-actions.pod:3953
12633 #: ../fish/guestfish-actions.pod:3955
12636 " resize2fs device\n"
12641 #: ../fish/guestfish-actions.pod:3957 ../src/guestfs-actions.pod:5998
12643 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12644 "underlying device."
12648 #: ../fish/guestfish-actions.pod:3960
12650 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
12651 "before calling this command. For unknown reasons C<resize2fs> sometimes "
12652 "gives an error about this and sometimes not. In any case, it is always safe "
12653 "to call L</e2fsck-f> before calling this function."
12657 #: ../fish/guestfish-actions.pod:3966
12658 msgid "resize2fs-M"
12662 #: ../fish/guestfish-actions.pod:3968
12665 " resize2fs-M device\n"
12670 #: ../fish/guestfish-actions.pod:3970
12672 "This command is the same as L</resize2fs>, but the filesystem is resized to "
12673 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
12678 #: ../fish/guestfish-actions.pod:3974
12680 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
12681 "and read the C<Block size> and C<Block count> values. These two numbers, "
12682 "multiplied together, give the resulting size of the minimal filesystem in "
12687 #: ../fish/guestfish-actions.pod:3979
12688 msgid "resize2fs-size"
12692 #: ../fish/guestfish-actions.pod:3981
12695 " resize2fs-size device size\n"
12700 #: ../fish/guestfish-actions.pod:3983
12702 "This command is the same as L</resize2fs> except that it allows you to "
12703 "specify the new size (in bytes) explicitly."
12707 #: ../fish/guestfish-actions.pod:3986
12712 #: ../fish/guestfish-actions.pod:3988
12720 #: ../fish/guestfish-actions.pod:3990 ../src/guestfs-actions.pod:6050
12721 msgid "Remove the single file C<path>."
12725 #: ../fish/guestfish-actions.pod:3992
12730 #: ../fish/guestfish-actions.pod:3994
12738 #: ../fish/guestfish-actions.pod:3996 ../src/guestfs-actions.pod:6062
12740 "Remove the file or directory C<path>, recursively removing the contents if "
12741 "its a directory. This is like the C<rm -rf> shell command."
12745 #: ../fish/guestfish-actions.pod:4000
12750 #: ../fish/guestfish-actions.pod:4002
12758 #: ../fish/guestfish-actions.pod:4004 ../src/guestfs-actions.pod:6076
12759 msgid "Remove the single directory C<path>."
12763 #: ../fish/guestfish-actions.pod:4006
12764 msgid "rmmountpoint"
12768 #: ../fish/guestfish-actions.pod:4008
12771 " rmmountpoint exemptpath\n"
12776 #: ../fish/guestfish-actions.pod:4010
12778 "This calls removes a mountpoint that was previously created with L</"
12779 "mkmountpoint>. See L</mkmountpoint> for full details."
12783 #: ../fish/guestfish-actions.pod:4014
12784 msgid "scrub-device"
12788 #: ../fish/guestfish-actions.pod:4016
12791 " scrub-device device\n"
12796 #: ../fish/guestfish-actions.pod:4018 ../src/guestfs-actions.pod:6102
12798 "This command writes patterns over C<device> to make data retrieval more "
12803 #: ../fish/guestfish-actions.pod:4021 ../fish/guestfish-actions.pod:4036
12804 #: ../fish/guestfish-actions.pod:4049 ../src/guestfs-actions.pod:6105
12805 #: ../src/guestfs-actions.pod:6126 ../src/guestfs-actions.pod:6145
12807 "It is an interface to the L<scrub(1)> program. See that manual page for "
12812 #: ../fish/guestfish-actions.pod:4027
12817 #: ../fish/guestfish-actions.pod:4029
12820 " scrub-file file\n"
12825 #: ../fish/guestfish-actions.pod:4031 ../src/guestfs-actions.pod:6121
12827 "This command writes patterns over a file to make data retrieval more "
12832 #: ../fish/guestfish-actions.pod:4034 ../src/guestfs-actions.pod:6124
12833 msgid "The file is I<removed> after scrubbing."
12837 #: ../fish/guestfish-actions.pod:4039
12838 msgid "scrub-freespace"
12842 #: ../fish/guestfish-actions.pod:4041
12845 " scrub-freespace dir\n"
12850 #: ../fish/guestfish-actions.pod:4043
12852 "This command creates the directory C<dir> and then fills it with files until "
12853 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
12854 "deletes them. The intention is to scrub any free space on the partition "
12855 "containing C<dir>."
12859 #: ../fish/guestfish-actions.pod:4052
12864 #: ../fish/guestfish-actions.pod:4054
12869 #: ../fish/guestfish-actions.pod:4056
12872 " set-append append\n"
12877 #: ../fish/guestfish-actions.pod:4058 ../src/guestfs-actions.pod:6158
12879 "This function is used to add additional options to the guest kernel command "
12884 #: ../fish/guestfish-actions.pod:4061 ../src/guestfs-actions.pod:6161
12886 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12887 "environment variable."
12891 #: ../fish/guestfish-actions.pod:4064 ../src/guestfs-actions.pod:6164
12893 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12894 "(libguestfs always adds a few of its own)."
12898 #: ../fish/guestfish-actions.pod:4067
12899 msgid "set-attach-method"
12903 #: ../fish/guestfish-actions.pod:4069
12904 msgid "attach-method"
12908 #: ../fish/guestfish-actions.pod:4071
12911 " set-attach-method attachmethod\n"
12916 #: ../fish/guestfish-actions.pod:4073 ../src/guestfs-actions.pod:6177
12918 "Set the method that libguestfs uses to connect to the back end guestfsd "
12919 "daemon. Possible methods are:"
12923 #: ../fish/guestfish-actions.pod:4078 ../src/guestfs-actions.pod:6182
12924 #: ../src/guestfs.pod:2687
12925 msgid "C<appliance>"
12929 #: ../fish/guestfish-actions.pod:4080 ../src/guestfs-actions.pod:6184
12931 "Launch an appliance and connect to it. This is the ordinary method and the "
12936 #: ../fish/guestfish-actions.pod:4083 ../src/guestfs-actions.pod:6187
12937 msgid "C<unix:I<path>>"
12941 #: ../fish/guestfish-actions.pod:4085 ../src/guestfs-actions.pod:6189
12942 msgid "Connect to the Unix domain socket I<path>."
12946 #: ../fish/guestfish-actions.pod:4087 ../src/guestfs-actions.pod:6191
12948 "This method lets you connect to an existing daemon or (using virtio-serial) "
12949 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
12950 "RUNNING DAEMONS>."
12954 #: ../fish/guestfish-actions.pod:4093
12955 msgid "set-autosync"
12959 #: ../fish/guestfish-actions.pod:4095
12964 #: ../fish/guestfish-actions.pod:4097
12967 " set-autosync true|false\n"
12972 #: ../fish/guestfish-actions.pod:4099 ../src/guestfs-actions.pod:6207
12974 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12975 "effort attempt to make filesystems consistent and synchronized when the "
12976 "handle is closed (also if the program exits without closing handles)."
12980 #: ../fish/guestfish-actions.pod:4104 ../src/guestfs-actions.pod:6212
12982 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12983 "disabled by default)."
12987 #: ../fish/guestfish-actions.pod:4107
12992 #: ../fish/guestfish-actions.pod:4109
12997 #: ../fish/guestfish-actions.pod:4111
13000 " set-direct true|false\n"
13005 #: ../fish/guestfish-actions.pod:4113 ../src/guestfs-actions.pod:6225
13007 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13008 "passed directly through to the appliance once it is launched."
13012 #: ../fish/guestfish-actions.pod:4117
13014 "One consequence of this is that log messages aren't caught by the library "
13015 "and handled by L</set-log-message-callback>, but go straight to stdout."
13019 #: ../fish/guestfish-actions.pod:4121 ../src/guestfs-actions.pod:6233
13020 msgid "You probably don't want to use this unless you know what you are doing."
13024 #: ../fish/guestfish-actions.pod:4124 ../src/guestfs-actions.pod:6236
13025 msgid "The default is disabled."
13029 #: ../fish/guestfish-actions.pod:4126
13030 msgid "set-e2label"
13034 #: ../fish/guestfish-actions.pod:4128
13037 " set-e2label device label\n"
13042 #: ../fish/guestfish-actions.pod:4130 ../src/guestfs-actions.pod:6249
13044 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13045 "C<label>. Filesystem labels are limited to 16 characters."
13049 #: ../fish/guestfish-actions.pod:4134
13051 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
13052 "label on a filesystem."
13056 #: ../fish/guestfish-actions.pod:4137
13061 #: ../fish/guestfish-actions.pod:4139
13064 " set-e2uuid device uuid\n"
13069 #: ../fish/guestfish-actions.pod:4141 ../src/guestfs-actions.pod:6267
13071 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13072 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13073 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13077 #: ../fish/guestfish-actions.pod:4146
13079 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
13080 "UUID of a filesystem."
13084 #: ../fish/guestfish-actions.pod:4149
13085 msgid "set-memsize"
13089 #: ../fish/guestfish-actions.pod:4151
13094 #: ../fish/guestfish-actions.pod:4153
13097 " set-memsize memsize\n"
13102 #: ../fish/guestfish-actions.pod:4155
13104 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13105 "This only has any effect if called before L</launch>."
13109 #: ../fish/guestfish-actions.pod:4159 ../src/guestfs-actions.pod:6289
13111 "You can also change this by setting the environment variable "
13112 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13116 #: ../fish/guestfish-actions.pod:4166
13117 msgid "set-network"
13121 #: ../fish/guestfish-actions.pod:4168
13126 #: ../fish/guestfish-actions.pod:4170
13129 " set-network true|false\n"
13134 #: ../fish/guestfish-actions.pod:4172 ../src/guestfs-actions.pod:6306
13136 "If C<network> is true, then the network is enabled in the libguestfs "
13137 "appliance. The default is false."
13141 #: ../fish/guestfish-actions.pod:4175 ../src/guestfs-actions.pod:6309
13143 "This affects whether commands are able to access the network (see L<guestfs"
13144 "(3)/RUNNING COMMANDS>)."
13148 #: ../fish/guestfish-actions.pod:4178
13150 "You must call this before calling L</launch>, otherwise it has no effect."
13154 #: ../fish/guestfish-actions.pod:4181
13159 #: ../fish/guestfish-actions.pod:4185
13162 " set-path searchpath\n"
13167 #: ../fish/guestfish-actions.pod:4187 ../src/guestfs-actions.pod:6325
13168 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13172 #: ../fish/guestfish-actions.pod:4189 ../src/guestfs-actions.pod:6327
13174 "The default is C<$libdir/guestfs> unless overridden by setting "
13175 "C<LIBGUESTFS_PATH> environment variable."
13179 #: ../fish/guestfish-actions.pod:4192 ../src/guestfs-actions.pod:6330
13180 msgid "Setting C<path> to C<NULL> restores the default path."
13184 #: ../fish/guestfish-actions.pod:4194
13189 #: ../fish/guestfish-actions.pod:4196
13194 #: ../fish/guestfish-actions.pod:4198
13197 " set-pgroup true|false\n"
13202 #: ../fish/guestfish-actions.pod:4200 ../src/guestfs-actions.pod:6342
13204 "If C<pgroup> is true, child processes are placed into their own process "
13209 #: ../fish/guestfish-actions.pod:4203 ../src/guestfs-actions.pod:6345
13211 "The practical upshot of this is that signals like C<SIGINT> (from users "
13212 "pressing C<^C>) won't be received by the child process."
13216 #: ../fish/guestfish-actions.pod:4206 ../src/guestfs-actions.pod:6348
13218 "The default for this flag is false, because usually you want C<^C> to kill "
13223 #: ../fish/guestfish-actions.pod:4209
13228 #: ../fish/guestfish-actions.pod:4211
13233 #: ../fish/guestfish-actions.pod:4213
13241 #: ../fish/guestfish-actions.pod:4215 ../src/guestfs-actions.pod:6361
13242 msgid "Set the qemu binary that we will use."
13246 #: ../fish/guestfish-actions.pod:4217 ../src/guestfs-actions.pod:6363
13248 "The default is chosen when the library was compiled by the configure script."
13252 #: ../fish/guestfish-actions.pod:4220 ../src/guestfs-actions.pod:6366
13254 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13259 #: ../fish/guestfish-actions.pod:4223 ../src/guestfs-actions.pod:6369
13260 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13264 #: ../fish/guestfish-actions.pod:4225 ../src/guestfs-actions.pod:6371
13266 "Note that you should call this function as early as possible after creating "
13267 "the handle. This is because some pre-launch operations depend on testing "
13268 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13269 "don't retest features, and so you might see inconsistent results. Using the "
13270 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13271 "the qemu binary at the same time as the handle is created."
13275 #: ../fish/guestfish-actions.pod:4233
13276 msgid "set-recovery-proc"
13280 #: ../fish/guestfish-actions.pod:4235
13281 msgid "recovery-proc"
13285 #: ../fish/guestfish-actions.pod:4237
13288 " set-recovery-proc true|false\n"
13293 #: ../fish/guestfish-actions.pod:4239
13295 "If this is called with the parameter C<false> then L</launch> does not "
13296 "create a recovery process. The purpose of the recovery process is to stop "
13297 "runaway qemu processes in the case where the main program aborts abruptly."
13301 #: ../fish/guestfish-actions.pod:4244
13303 "This only has any effect if called before L</launch>, and the default is "
13308 #: ../fish/guestfish-actions.pod:4247 ../src/guestfs-actions.pod:6397
13310 "About the only time when you would want to disable this is if the main "
13311 "process will fork itself into the background (\"daemonize\" itself). In "
13312 "this case the recovery process thinks that the main program has disappeared "
13313 "and so kills qemu, which is not very helpful."
13317 #: ../fish/guestfish-actions.pod:4253
13318 msgid "set-selinux"
13322 #: ../fish/guestfish-actions.pod:4255
13327 #: ../fish/guestfish-actions.pod:4257
13330 " set-selinux true|false\n"
13335 #: ../fish/guestfish-actions.pod:4259 ../src/guestfs-actions.pod:6413
13337 "This sets the selinux flag that is passed to the appliance at boot time. "
13338 "The default is C<selinux=0> (disabled)."
13342 #: ../fish/guestfish-actions.pod:4262 ../src/guestfs-actions.pod:6416
13344 "Note that if SELinux is enabled, it is always in Permissive mode "
13345 "(C<enforcing=0>)."
13349 #: ../fish/guestfish-actions.pod:4268
13354 #: ../fish/guestfish-actions.pod:4270
13359 #: ../fish/guestfish-actions.pod:4272
13362 " set-trace true|false\n"
13367 #: ../fish/guestfish-actions.pod:4274 ../src/guestfs-actions.pod:6432
13369 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
13370 "return values are traced."
13374 #: ../fish/guestfish-actions.pod:4277 ../src/guestfs-actions.pod:6435
13376 "If you want to trace C API calls into libguestfs (and other libraries) then "
13377 "possibly a better way is to use the external ltrace(1) command."
13381 #: ../fish/guestfish-actions.pod:4281 ../src/guestfs-actions.pod:6439
13383 "Command traces are disabled unless the environment variable "
13384 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13388 #: ../fish/guestfish-actions.pod:4284
13390 "Trace messages are normally sent to C<stderr>, unless you register a "
13391 "callback to send them somewhere else (see L</set-event-callback>)."
13395 #: ../fish/guestfish-actions.pod:4288
13396 msgid "set-verbose"
13400 #: ../fish/guestfish-actions.pod:4290
13405 #: ../fish/guestfish-actions.pod:4292
13408 " set-verbose true|false\n"
13413 #: ../fish/guestfish-actions.pod:4294 ../src/guestfs-actions.pod:6456
13414 msgid "If C<verbose> is true, this turns on verbose messages."
13418 #: ../fish/guestfish-actions.pod:4296 ../src/guestfs-actions.pod:6458
13420 "Verbose messages are disabled unless the environment variable "
13421 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13425 #: ../fish/guestfish-actions.pod:4299
13427 "Verbose messages are normally sent to C<stderr>, unless you register a "
13428 "callback to send them somewhere else (see L</set-event-callback>)."
13432 #: ../fish/guestfish-actions.pod:4303
13437 #: ../fish/guestfish-actions.pod:4305
13440 " setcon context\n"
13445 #: ../fish/guestfish-actions.pod:4307 ../src/guestfs-actions.pod:6475
13447 "This sets the SELinux security context of the daemon to the string "
13452 #: ../fish/guestfish-actions.pod:4310 ../src/guestfs-actions.pod:6478
13453 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13457 #: ../fish/guestfish-actions.pod:4312
13462 #: ../fish/guestfish-actions.pod:4314
13465 " setxattr xattr val vallen path\n"
13470 #: ../fish/guestfish-actions.pod:4316 ../src/guestfs-actions.pod:6493
13472 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13473 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13477 #: ../fish/guestfish-actions.pod:4320
13478 msgid "See also: L</lsetxattr>, L<attr(5)>."
13482 #: ../fish/guestfish-actions.pod:4322
13487 #: ../fish/guestfish-actions.pod:4324
13490 " sfdisk device cyls heads sectors 'lines ...'\n"
13495 #: ../fish/guestfish-actions.pod:4326 ../src/guestfs-actions.pod:6513
13497 "This is a direct interface to the L<sfdisk(8)> program for creating "
13498 "partitions on block devices."
13502 #: ../fish/guestfish-actions.pod:4329 ../src/guestfs-actions.pod:6516
13503 msgid "C<device> should be a block device, for example C</dev/sda>."
13507 #: ../fish/guestfish-actions.pod:4331 ../src/guestfs-actions.pod:6518
13509 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13510 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
13511 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13512 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13513 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13514 "the kernel) cannot work out the right geometry and you will need to tell it."
13518 #: ../fish/guestfish-actions.pod:4339 ../src/guestfs-actions.pod:6526
13520 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13521 "refer to the L<sfdisk(8)> manpage."
13525 #: ../fish/guestfish-actions.pod:4342 ../src/guestfs-actions.pod:6529
13527 "To create a single partition occupying the whole disk, you would pass "
13528 "C<lines> as a single element list, when the single element being the string "
13533 #: ../fish/guestfish-actions.pod:4346
13534 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
13538 #: ../fish/guestfish-actions.pod:4352 ../fish/guestfish-actions.pod:4375
13539 #: ../fish/guestfish-actions.pod:4397 ../src/guestfs-actions.pod:6541
13540 #: ../src/guestfs-actions.pod:6571 ../src/guestfs-actions.pod:6604
13542 "This function is deprecated. In new code, use the C<part_add> call instead."
13546 #: ../fish/guestfish-actions.pod:4359
13551 #: ../fish/guestfish-actions.pod:4361
13554 " sfdiskM device 'lines ...'\n"
13559 #: ../fish/guestfish-actions.pod:4363
13561 "This is a simplified interface to the L</sfdisk> command, where partition "
13562 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
13563 "you don't need to specify the cyls, heads and sectors parameters which were "
13564 "rarely if ever used anyway."
13568 #: ../fish/guestfish-actions.pod:4369
13569 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
13573 #: ../fish/guestfish-actions.pod:4382
13578 #: ../fish/guestfish-actions.pod:4384
13581 " sfdisk-N device partnum cyls heads sectors line\n"
13586 #: ../fish/guestfish-actions.pod:4386 ../src/guestfs-actions.pod:6591
13588 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13589 "(note: C<n> counts from 1)."
13593 #: ../fish/guestfish-actions.pod:4389
13595 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
13596 "cyls/heads/sectors parameters."
13600 #: ../fish/guestfish-actions.pod:4392
13601 msgid "See also: L</part-add>"
13605 #: ../fish/guestfish-actions.pod:4404
13606 msgid "sfdisk-disk-geometry"
13610 #: ../fish/guestfish-actions.pod:4406
13613 " sfdisk-disk-geometry device\n"
13618 #: ../fish/guestfish-actions.pod:4408
13620 "This displays the disk geometry of C<device> read from the partition table. "
13621 "Especially in the case where the underlying block device has been resized, "
13622 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
13623 "kernel-geometry>)."
13627 #: ../fish/guestfish-actions.pod:4413 ../fish/guestfish-actions.pod:4422
13628 #: ../src/guestfs-actions.pod:6624 ../src/guestfs-actions.pod:6640
13629 msgid "The result is in human-readable format, and not designed to be parsed."
13633 #: ../fish/guestfish-actions.pod:4416
13634 msgid "sfdisk-kernel-geometry"
13638 #: ../fish/guestfish-actions.pod:4418
13641 " sfdisk-kernel-geometry device\n"
13646 #: ../fish/guestfish-actions.pod:4420 ../src/guestfs-actions.pod:6638
13647 msgid "This displays the kernel's idea of the geometry of C<device>."
13651 #: ../fish/guestfish-actions.pod:4425
13656 #: ../fish/guestfish-actions.pod:4427
13659 " sfdisk-l device\n"
13664 #: ../fish/guestfish-actions.pod:4429 ../src/guestfs-actions.pod:6654
13666 "This displays the partition table on C<device>, in the human-readable output "
13667 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13671 #: ../fish/guestfish-actions.pod:4433
13672 msgid "See also: L</part-list>"
13676 #: ../fish/guestfish-actions.pod:4435 ../src/guestfs-actions.pod:6663
13678 "This function is deprecated. In new code, use the C<part_list> call instead."
13682 #: ../fish/guestfish-actions.pod:4442
13687 #: ../fish/guestfish-actions.pod:4444
13695 #: ../fish/guestfish-actions.pod:4446 ../src/guestfs-actions.pod:6678
13697 "This call runs a command from the guest filesystem via the guest's C</bin/"
13702 #: ../fish/guestfish-actions.pod:4449
13703 msgid "This is like L</command>, but passes the command to:"
13707 #: ../fish/guestfish-actions.pod:4451 ../src/guestfs-actions.pod:6683
13710 " /bin/sh -c \"command\"\n"
13715 #: ../fish/guestfish-actions.pod:4453 ../src/guestfs-actions.pod:6685
13717 "Depending on the guest's shell, this usually results in wildcards being "
13718 "expanded, shell expressions being interpolated and so on."
13722 #: ../fish/guestfish-actions.pod:4457
13723 msgid "All the provisos about L</command> apply to this call."
13727 #: ../fish/guestfish-actions.pod:4459
13732 #: ../fish/guestfish-actions.pod:4461
13735 " sh-lines command\n"
13740 #: ../fish/guestfish-actions.pod:4463
13741 msgid "This is the same as L</sh>, but splits the result into a list of lines."
13745 #: ../fish/guestfish-actions.pod:4466
13746 msgid "See also: L</command-lines>"
13750 #: ../fish/guestfish-actions.pod:4468
13755 #: ../fish/guestfish-actions.pod:4470
13763 #: ../fish/guestfish-actions.pod:4472 ../src/guestfs-actions.pod:6719
13764 msgid "Sleep for C<secs> seconds."
13768 #: ../fish/guestfish-actions.pod:4474
13773 #: ../fish/guestfish-actions.pod:4476
13781 #: ../fish/guestfish-actions.pod:4480 ../src/guestfs-actions.pod:6733
13782 msgid "This is the same as the C<stat(2)> system call."
13786 #: ../fish/guestfish-actions.pod:4482
13791 #: ../fish/guestfish-actions.pod:4484
13799 #: ../fish/guestfish-actions.pod:4486 ../src/guestfs-actions.pod:6747
13801 "Returns file system statistics for any mounted file system. C<path> should "
13802 "be a file or directory in the mounted file system (typically it is the mount "
13803 "point itself, but it doesn't need to be)."
13807 #: ../fish/guestfish-actions.pod:4490 ../src/guestfs-actions.pod:6751
13808 msgid "This is the same as the C<statvfs(2)> system call."
13812 #: ../fish/guestfish-actions.pod:4492
13817 #: ../fish/guestfish-actions.pod:4494
13825 #: ../fish/guestfish-actions.pod:4496 ../src/guestfs-actions.pod:6765
13827 "This runs the L<strings(1)> command on a file and returns the list of "
13828 "printable strings found."
13832 #: ../fish/guestfish-actions.pod:4502
13837 #: ../fish/guestfish-actions.pod:4504
13840 " strings-e encoding path\n"
13845 #: ../fish/guestfish-actions.pod:4506
13847 "This is like the L</strings> command, but allows you to specify the encoding "
13848 "of strings that are looked for in the source file C<path>."
13852 #: ../fish/guestfish-actions.pod:4510 ../src/guestfs-actions.pod:6788
13853 msgid "Allowed encodings are:"
13857 #: ../fish/guestfish-actions.pod:4514 ../src/guestfs-actions.pod:6792
13862 #: ../fish/guestfish-actions.pod:4516
13864 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13865 "ISO-8859-X (this is what L</strings> uses)."
13869 #: ../fish/guestfish-actions.pod:4519 ../src/guestfs-actions.pod:6797
13874 #: ../fish/guestfish-actions.pod:4521 ../src/guestfs-actions.pod:6799
13875 msgid "Single 8-bit-byte characters."
13879 #: ../fish/guestfish-actions.pod:4523 ../src/guestfs-actions.pod:6801
13884 #: ../fish/guestfish-actions.pod:4525 ../src/guestfs-actions.pod:6803
13885 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13889 #: ../fish/guestfish-actions.pod:4528 ../src/guestfs-actions.pod:6806
13890 msgid "l (lower case letter L)"
13894 #: ../fish/guestfish-actions.pod:4530 ../src/guestfs-actions.pod:6808
13896 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13897 "examining binaries in Windows guests."
13901 #: ../fish/guestfish-actions.pod:4533 ../src/guestfs-actions.pod:6811
13906 #: ../fish/guestfish-actions.pod:4535 ../src/guestfs-actions.pod:6813
13907 msgid "32-bit big endian such as UCS-4BE."
13911 #: ../fish/guestfish-actions.pod:4537 ../src/guestfs-actions.pod:6815
13916 #: ../fish/guestfish-actions.pod:4539 ../src/guestfs-actions.pod:6817
13917 msgid "32-bit little endian such as UCS-4LE."
13921 #: ../fish/guestfish-actions.pod:4543 ../src/guestfs-actions.pod:6821
13922 msgid "The returned strings are transcoded to UTF-8."
13926 #: ../fish/guestfish-actions.pod:4548
13927 msgid "swapoff-device"
13931 #: ../fish/guestfish-actions.pod:4550
13934 " swapoff-device device\n"
13939 #: ../fish/guestfish-actions.pod:4552
13941 "This command disables the libguestfs appliance swap device or partition "
13942 "named C<device>. See L</swapon-device>."
13946 #: ../fish/guestfish-actions.pod:4556
13947 msgid "swapoff-file"
13951 #: ../fish/guestfish-actions.pod:4558
13954 " swapoff-file file\n"
13959 #: ../fish/guestfish-actions.pod:4560 ../src/guestfs-actions.pod:6852
13960 msgid "This command disables the libguestfs appliance swap on file."
13964 #: ../fish/guestfish-actions.pod:4562
13965 msgid "swapoff-label"
13969 #: ../fish/guestfish-actions.pod:4564
13972 " swapoff-label label\n"
13977 #: ../fish/guestfish-actions.pod:4566 ../src/guestfs-actions.pod:6864
13979 "This command disables the libguestfs appliance swap on labeled swap "
13984 #: ../fish/guestfish-actions.pod:4569
13985 msgid "swapoff-uuid"
13989 #: ../fish/guestfish-actions.pod:4571
13992 " swapoff-uuid uuid\n"
13997 #: ../fish/guestfish-actions.pod:4573 ../src/guestfs-actions.pod:6877
13999 "This command disables the libguestfs appliance swap partition with the given "
14004 #: ../fish/guestfish-actions.pod:4576
14005 msgid "swapon-device"
14009 #: ../fish/guestfish-actions.pod:4578
14012 " swapon-device device\n"
14017 #: ../fish/guestfish-actions.pod:4580
14019 "This command enables the libguestfs appliance to use the swap device or "
14020 "partition named C<device>. The increased memory is made available for all "
14021 "commands, for example those run using L</command> or L</sh>."
14025 #: ../fish/guestfish-actions.pod:4585 ../src/guestfs-actions.pod:6895
14027 "Note that you should not swap to existing guest swap partitions unless you "
14028 "know what you are doing. They may contain hibernation information, or other "
14029 "information that the guest doesn't want you to trash. You also risk leaking "
14030 "information about the host to the guest this way. Instead, attach a new "
14031 "host device to the guest and swap on that."
14035 #: ../fish/guestfish-actions.pod:4592
14036 msgid "swapon-file"
14040 #: ../fish/guestfish-actions.pod:4594
14043 " swapon-file file\n"
14048 #: ../fish/guestfish-actions.pod:4596
14050 "This command enables swap to a file. See L</swapon-device> for other notes."
14054 #: ../fish/guestfish-actions.pod:4599
14055 msgid "swapon-label"
14059 #: ../fish/guestfish-actions.pod:4601
14062 " swapon-label label\n"
14067 #: ../fish/guestfish-actions.pod:4603
14069 "This command enables swap to a labeled swap partition. See L</swapon-"
14070 "device> for other notes."
14074 #: ../fish/guestfish-actions.pod:4606
14075 msgid "swapon-uuid"
14079 #: ../fish/guestfish-actions.pod:4608
14082 " swapon-uuid uuid\n"
14087 #: ../fish/guestfish-actions.pod:4610
14089 "This command enables swap to a swap partition with the given UUID. See L</"
14090 "swapon-device> for other notes."
14094 #: ../fish/guestfish-actions.pod:4613
14099 #: ../fish/guestfish-actions.pod:4615
14107 #: ../fish/guestfish-actions.pod:4617 ../src/guestfs-actions.pod:6950
14109 "This syncs the disk, so that any writes are flushed through to the "
14110 "underlying disk image."
14114 #: ../fish/guestfish-actions.pod:4620 ../src/guestfs-actions.pod:6953
14116 "You should always call this if you have modified a disk image, before "
14117 "closing the handle."
14121 #: ../fish/guestfish-actions.pod:4623
14126 #: ../fish/guestfish-actions.pod:4625
14134 #: ../fish/guestfish-actions.pod:4627 ../src/guestfs-actions.pod:6966
14136 "This command returns up to the last 10 lines of a file as a list of strings."
14140 #: ../fish/guestfish-actions.pod:4633
14145 #: ../fish/guestfish-actions.pod:4635
14148 " tail-n nrlines path\n"
14153 #: ../fish/guestfish-actions.pod:4637 ../src/guestfs-actions.pod:6985
14155 "If the parameter C<nrlines> is a positive number, this returns the last "
14156 "C<nrlines> lines of the file C<path>."
14160 #: ../fish/guestfish-actions.pod:4640 ../src/guestfs-actions.pod:6988
14162 "If the parameter C<nrlines> is a negative number, this returns lines from "
14163 "the file C<path>, starting with the C<-nrlines>th line."
14167 #: ../fish/guestfish-actions.pod:4648
14172 #: ../fish/guestfish-actions.pod:4650
14175 " tar-in (tarfile|-) directory\n"
14180 #: ../fish/guestfish-actions.pod:4652 ../src/guestfs-actions.pod:7009
14182 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14183 "tar file) into C<directory>."
14187 #: ../fish/guestfish-actions.pod:4655
14188 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
14192 #: ../fish/guestfish-actions.pod:4660
14197 #: ../fish/guestfish-actions.pod:4662
14200 " tar-out directory (tarfile|-)\n"
14205 #: ../fish/guestfish-actions.pod:4664 ../src/guestfs-actions.pod:7026
14207 "This command packs the contents of C<directory> and downloads it to local "
14212 #: ../fish/guestfish-actions.pod:4667
14213 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
14217 #: ../fish/guestfish-actions.pod:4672
14222 #: ../fish/guestfish-actions.pod:4674
14225 " tgz-in (tarball|-) directory\n"
14230 #: ../fish/guestfish-actions.pod:4676 ../src/guestfs-actions.pod:7043
14232 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14233 "tar file) into C<directory>."
14237 #: ../fish/guestfish-actions.pod:4679
14238 msgid "To upload an uncompressed tarball, use L</tar-in>."
14242 #: ../fish/guestfish-actions.pod:4683
14247 #: ../fish/guestfish-actions.pod:4685
14250 " tgz-out directory (tarball|-)\n"
14255 #: ../fish/guestfish-actions.pod:4687 ../src/guestfs-actions.pod:7059
14257 "This command packs the contents of C<directory> and downloads it to local "
14262 #: ../fish/guestfish-actions.pod:4690
14263 msgid "To download an uncompressed tarball, use L</tar-out>."
14267 #: ../fish/guestfish-actions.pod:4694
14272 #: ../fish/guestfish-actions.pod:4696
14280 #: ../fish/guestfish-actions.pod:4698 ../src/guestfs-actions.pod:7074
14282 "Touch acts like the L<touch(1)> command. It can be used to update the "
14283 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14288 #: ../fish/guestfish-actions.pod:4702 ../src/guestfs-actions.pod:7078
14290 "This command only works on regular files, and will fail on other file types "
14291 "such as directories, symbolic links, block special etc."
14295 #: ../fish/guestfish-actions.pod:4705
14300 #: ../fish/guestfish-actions.pod:4707
14308 #: ../fish/guestfish-actions.pod:4709 ../src/guestfs-actions.pod:7091
14310 "This command truncates C<path> to a zero-length file. The file must exist "
14315 #: ../fish/guestfish-actions.pod:4712
14316 msgid "truncate-size"
14320 #: ../fish/guestfish-actions.pod:4714
14323 " truncate-size path size\n"
14328 #: ../fish/guestfish-actions.pod:4716 ../src/guestfs-actions.pod:7105
14330 "This command truncates C<path> to size C<size> bytes. The file must exist "
14335 #: ../fish/guestfish-actions.pod:4719
14337 "If the current file size is less than C<size> then the file is extended to "
14338 "the required size with zero bytes. This creates a sparse file (ie. disk "
14339 "blocks are not allocated for the file until you write to it). To create a "
14340 "non-sparse file of zeroes, use L</fallocate64> instead."
14344 #: ../fish/guestfish-actions.pod:4725
14349 #: ../fish/guestfish-actions.pod:4727
14352 " tune2fs-l device\n"
14357 #: ../fish/guestfish-actions.pod:4729 ../src/guestfs-actions.pod:7124
14359 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14364 #: ../fish/guestfish-actions.pod:4732 ../src/guestfs-actions.pod:7127
14366 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14367 "for more details. The list of fields returned isn't clearly defined, and "
14368 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14369 "and the filesystem itself."
14373 #: ../fish/guestfish-actions.pod:4737
14378 #: ../fish/guestfish-actions.pod:4739
14381 " txz-in (tarball|-) directory\n"
14386 #: ../fish/guestfish-actions.pod:4741 ../src/guestfs-actions.pod:7147
14388 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14389 "tar file) into C<directory>."
14393 #: ../fish/guestfish-actions.pod:4746
14398 #: ../fish/guestfish-actions.pod:4748
14401 " txz-out directory (tarball|-)\n"
14406 #: ../fish/guestfish-actions.pod:4750 ../src/guestfs-actions.pod:7161
14408 "This command packs the contents of C<directory> and downloads it to local "
14409 "file C<tarball> (as an xz compressed tar archive)."
14413 #: ../fish/guestfish-actions.pod:4755
14418 #: ../fish/guestfish-actions.pod:4757
14426 #: ../fish/guestfish-actions.pod:4759 ../src/guestfs-actions.pod:7174
14428 "This function sets the mask used for creating new files and device nodes to "
14433 #: ../fish/guestfish-actions.pod:4762 ../src/guestfs-actions.pod:7177
14435 "Typical umask values would be C<022> which creates new files with "
14436 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14437 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14441 #: ../fish/guestfish-actions.pod:4767 ../src/guestfs-actions.pod:7182
14443 "The default umask is C<022>. This is important because it means that "
14444 "directories and device nodes will be created with C<0644> or C<0755> mode "
14445 "even if you specify C<0777>."
14449 #: ../fish/guestfish-actions.pod:4771
14450 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
14454 #: ../fish/guestfish-actions.pod:4774 ../src/guestfs-actions.pod:7189
14455 msgid "This call returns the previous umask."
14459 #: ../fish/guestfish-actions.pod:4776
14464 #: ../fish/guestfish-actions.pod:4778
14469 #: ../fish/guestfish-actions.pod:4780
14472 " umount pathordevice\n"
14477 #: ../fish/guestfish-actions.pod:4782 ../src/guestfs-actions.pod:7201
14479 "This unmounts the given filesystem. The filesystem may be specified either "
14480 "by its mountpoint (path) or the device which contains the filesystem."
14484 #: ../fish/guestfish-actions.pod:4786
14489 #: ../fish/guestfish-actions.pod:4788
14490 msgid "unmount-all"
14494 #: ../fish/guestfish-actions.pod:4790
14502 #: ../fish/guestfish-actions.pod:4792 ../src/guestfs-actions.pod:7214
14503 msgid "This unmounts all mounted filesystems."
14507 #: ../fish/guestfish-actions.pod:4794 ../src/guestfs-actions.pod:7216
14508 msgid "Some internal mounts are not unmounted by this call."
14512 #: ../fish/guestfish-actions.pod:4796
14517 #: ../fish/guestfish-actions.pod:4798
14520 " upload (filename|-) remotefilename\n"
14525 #: ../fish/guestfish-actions.pod:4800 ../fish/guestfish-actions.pod:4813
14526 #: ../src/guestfs-actions.pod:7229 ../src/guestfs-actions.pod:7253
14527 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14531 #: ../fish/guestfish-actions.pod:4805
14532 msgid "See also L</download>."
14536 #: ../fish/guestfish-actions.pod:4809
14537 msgid "upload-offset"
14541 #: ../fish/guestfish-actions.pod:4811
14544 " upload-offset (filename|-) remotefilename offset\n"
14549 #: ../fish/guestfish-actions.pod:4816 ../src/guestfs-actions.pod:7256
14551 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14552 "The intention is to overwrite parts of existing files or devices, although "
14553 "if a non-existant file is specified then it is created with a \"hole\" "
14554 "before C<offset>. The size of the data written is implicit in the size of "
14555 "the source C<filename>."
14559 #: ../fish/guestfish-actions.pod:4823
14561 "Note that there is no limit on the amount of data that can be uploaded with "
14562 "this call, unlike with L</pwrite>, and this call always writes the full "
14563 "amount unless an error occurs."
14567 #: ../fish/guestfish-actions.pod:4828
14568 msgid "See also L</upload>, L</pwrite>."
14572 #: ../fish/guestfish-actions.pod:4832
14577 #: ../fish/guestfish-actions.pod:4834
14580 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
14585 #: ../fish/guestfish-actions.pod:4836 ../src/guestfs-actions.pod:7289
14586 msgid "This command sets the timestamps of a file with nanosecond precision."
14590 #: ../fish/guestfish-actions.pod:4839 ../src/guestfs-actions.pod:7292
14592 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14597 #: ../fish/guestfish-actions.pod:4842 ../src/guestfs-actions.pod:7295
14599 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14600 "nanoseconds from the epoch."
14604 #: ../fish/guestfish-actions.pod:4845 ../src/guestfs-actions.pod:7298
14606 "If the C<*nsecs> field contains the special value C<-1> then the "
14607 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14608 "ignored in this case)."
14612 #: ../fish/guestfish-actions.pod:4849 ../src/guestfs-actions.pod:7302
14614 "If the C<*nsecs> field contains the special value C<-2> then the "
14615 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14620 #: ../fish/guestfish-actions.pod:4853
14625 #: ../fish/guestfish-actions.pod:4855
14633 #: ../fish/guestfish-actions.pod:4857 ../src/guestfs-actions.pod:7315
14635 "Return the libguestfs version number that the program is linked against."
14639 #: ../fish/guestfish-actions.pod:4860 ../src/guestfs-actions.pod:7318
14641 "Note that because of dynamic linking this is not necessarily the version of "
14642 "libguestfs that you compiled against. You can compile the program, and then "
14643 "at runtime dynamically link against a completely different C<libguestfs.so> "
14648 #: ../fish/guestfish-actions.pod:4865 ../src/guestfs-actions.pod:7323
14650 "This call was added in version C<1.0.58>. In previous versions of "
14651 "libguestfs there was no way to get the version number. From C code you can "
14652 "use dynamic linker functions to find out if this symbol exists (if it "
14653 "doesn't, then it's an earlier version)."
14657 #: ../fish/guestfish-actions.pod:4871 ../src/guestfs-actions.pod:7329
14659 "The call returns a structure with four elements. The first three (C<major>, "
14660 "C<minor> and C<release>) are numbers and correspond to the usual version "
14661 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14662 "but may be used for distro-specific information."
14666 #: ../fish/guestfish-actions.pod:4877 ../src/guestfs-actions.pod:7335
14668 "To construct the original version string: C<$major.$minor.$release$extra>"
14672 #: ../fish/guestfish-actions.pod:4880 ../src/guestfs-actions.pod:7338
14673 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14677 #: ../fish/guestfish-actions.pod:4882
14679 "I<Note:> Don't use this call to test for availability of features. In "
14680 "enterprise distributions we backport features from later versions into "
14681 "earlier versions, making this an unreliable way to test for features. Use "
14682 "L</available> instead."
14686 #: ../fish/guestfish-actions.pod:4888
14691 #: ../fish/guestfish-actions.pod:4890
14694 " vfs-label device\n"
14699 #: ../fish/guestfish-actions.pod:4892 ../src/guestfs-actions.pod:7358
14700 msgid "This returns the filesystem label of the filesystem on C<device>."
14704 #: ../fish/guestfish-actions.pod:4895 ../src/guestfs-actions.pod:7361
14705 msgid "If the filesystem is unlabeled, this returns the empty string."
14709 #: ../fish/guestfish-actions.pod:4897
14710 msgid "To find a filesystem from the label, use L</findfs-label>."
14714 #: ../fish/guestfish-actions.pod:4899
14719 #: ../fish/guestfish-actions.pod:4901
14722 " vfs-type device\n"
14727 #: ../fish/guestfish-actions.pod:4903 ../src/guestfs-actions.pod:7376
14729 "This command gets the filesystem type corresponding to the filesystem on "
14734 #: ../fish/guestfish-actions.pod:4906 ../src/guestfs-actions.pod:7379
14736 "For most filesystems, the result is the name of the Linux VFS module which "
14737 "would be used to mount this filesystem if you mounted it without specifying "
14738 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14742 #: ../fish/guestfish-actions.pod:4911
14747 #: ../fish/guestfish-actions.pod:4913
14750 " vfs-uuid device\n"
14755 #: ../fish/guestfish-actions.pod:4915 ../src/guestfs-actions.pod:7395
14756 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14760 #: ../fish/guestfish-actions.pod:4918 ../src/guestfs-actions.pod:7398
14761 msgid "If the filesystem does not have a UUID, this returns the empty string."
14765 #: ../fish/guestfish-actions.pod:4920
14766 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
14770 #: ../fish/guestfish-actions.pod:4922
14771 msgid "vg-activate"
14775 #: ../fish/guestfish-actions.pod:4924
14778 " vg-activate true|false 'volgroups ...'\n"
14783 #: ../fish/guestfish-actions.pod:4926 ../src/guestfs-actions.pod:7414
14785 "This command activates or (if C<activate> is false) deactivates all logical "
14786 "volumes in the listed volume groups C<volgroups>."
14790 #: ../fish/guestfish-actions.pod:4929 ../src/guestfs-actions.pod:7417
14791 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14795 #: ../fish/guestfish-actions.pod:4931 ../src/guestfs-actions.pod:7419
14797 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14798 "activated or deactivated."
14802 #: ../fish/guestfish-actions.pod:4934
14803 msgid "vg-activate-all"
14807 #: ../fish/guestfish-actions.pod:4936
14810 " vg-activate-all true|false\n"
14815 #: ../fish/guestfish-actions.pod:4938 ../src/guestfs-actions.pod:7432
14817 "This command activates or (if C<activate> is false) deactivates all logical "
14818 "volumes in all volume groups."
14822 #: ../fish/guestfish-actions.pod:4941 ../src/guestfs-actions.pod:7435
14823 msgid "This command is the same as running C<vgchange -a y|n>"
14827 #: ../fish/guestfish-actions.pod:4943
14832 #: ../fish/guestfish-actions.pod:4945
14835 " vgcreate volgroup 'physvols ...'\n"
14840 #: ../fish/guestfish-actions.pod:4947 ../src/guestfs-actions.pod:7448
14842 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14843 "of physical volumes C<physvols>."
14847 #: ../fish/guestfish-actions.pod:4950
14852 #: ../fish/guestfish-actions.pod:4952
14855 " vglvuuids vgname\n"
14860 #: ../fish/guestfish-actions.pod:4954 ../src/guestfs-actions.pod:7461
14862 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14863 "volumes created in this volume group."
14867 #: ../fish/guestfish-actions.pod:4957
14869 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
14870 "logical volumes and volume groups."
14874 #: ../fish/guestfish-actions.pod:4960
14875 msgid "See also L</vgpvuuids>."
14879 #: ../fish/guestfish-actions.pod:4962
14884 #: ../fish/guestfish-actions.pod:4964
14887 " vgpvuuids vgname\n"
14892 #: ../fish/guestfish-actions.pod:4966 ../src/guestfs-actions.pod:7481
14894 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14895 "volumes that this volume group resides on."
14899 #: ../fish/guestfish-actions.pod:4969
14901 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
14902 "physical volumes and volume groups."
14906 #: ../fish/guestfish-actions.pod:4972
14907 msgid "See also L</vglvuuids>."
14911 #: ../fish/guestfish-actions.pod:4974
14916 #: ../fish/guestfish-actions.pod:4976
14919 " vgremove vgname\n"
14924 #: ../fish/guestfish-actions.pod:4978 ../src/guestfs-actions.pod:7501
14925 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14929 #: ../fish/guestfish-actions.pod:4980 ../src/guestfs-actions.pod:7503
14931 "This also forcibly removes all logical volumes in the volume group (if any)."
14935 #: ../fish/guestfish-actions.pod:4983
14940 #: ../fish/guestfish-actions.pod:4985
14943 " vgrename volgroup newvolgroup\n"
14948 #: ../fish/guestfish-actions.pod:4987 ../src/guestfs-actions.pod:7517
14949 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14953 #: ../fish/guestfish-actions.pod:4989
14958 #: ../fish/guestfish-actions.pod:4991
14966 #: ../fish/guestfish-actions.pod:4993 ../src/guestfs-actions.pod:7528
14968 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
14973 #: ../fish/guestfish-actions.pod:4996 ../src/guestfs-actions.pod:7531
14975 "This returns a list of just the volume group names that were detected (eg. "
14980 #: ../fish/guestfish-actions.pod:4999
14981 msgid "See also L</vgs-full>."
14985 #: ../fish/guestfish-actions.pod:5001
14990 #: ../fish/guestfish-actions.pod:5003
14998 #: ../fish/guestfish-actions.pod:5005 ../src/guestfs-actions.pod:7547
15000 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15001 "> command. The \"full\" version includes all fields."
15005 #: ../fish/guestfish-actions.pod:5008
15010 #: ../fish/guestfish-actions.pod:5010
15018 #: ../fish/guestfish-actions.pod:5012 ../src/guestfs-actions.pod:7561
15020 "This rescans all block devices and rebuilds the list of LVM physical "
15021 "volumes, volume groups and logical volumes."
15025 #: ../fish/guestfish-actions.pod:5015
15030 #: ../fish/guestfish-actions.pod:5017
15038 #: ../fish/guestfish-actions.pod:5019 ../src/guestfs-actions.pod:7574
15039 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15043 #: ../fish/guestfish-actions.pod:5021
15048 #: ../fish/guestfish-actions.pod:5023
15056 #: ../fish/guestfish-actions.pod:5025 ../src/guestfs-actions.pod:7614
15058 "This command counts the characters in a file, using the C<wc -c> external "
15063 #: ../fish/guestfish-actions.pod:5028
15068 #: ../fish/guestfish-actions.pod:5030
15076 #: ../fish/guestfish-actions.pod:5032 ../src/guestfs-actions.pod:7627
15078 "This command counts the lines in a file, using the C<wc -l> external command."
15082 #: ../fish/guestfish-actions.pod:5035
15087 #: ../fish/guestfish-actions.pod:5037
15095 #: ../fish/guestfish-actions.pod:5039 ../src/guestfs-actions.pod:7640
15097 "This command counts the words in a file, using the C<wc -w> external command."
15101 #: ../fish/guestfish-actions.pod:5042
15106 #: ../fish/guestfish-actions.pod:5044
15109 " write path content\n"
15114 #: ../fish/guestfish-actions.pod:5046 ../src/guestfs-actions.pod:7655
15116 "This call creates a file called C<path>. The content of the file is the "
15117 "string C<content> (which can contain any 8 bit data)."
15121 #: ../fish/guestfish-actions.pod:5049
15122 msgid "See also L</write-append>."
15126 #: ../fish/guestfish-actions.pod:5054
15127 msgid "write-append"
15131 #: ../fish/guestfish-actions.pod:5056
15134 " write-append path content\n"
15139 #: ../fish/guestfish-actions.pod:5058 ../src/guestfs-actions.pod:7675
15141 "This call appends C<content> to the end of file C<path>. If C<path> does "
15142 "not exist, then a new file is created."
15146 #: ../fish/guestfish-actions.pod:5061
15147 msgid "See also L</write>."
15151 #: ../fish/guestfish-actions.pod:5066
15156 #: ../fish/guestfish-actions.pod:5068
15159 " write-file path content size\n"
15164 #: ../fish/guestfish-actions.pod:5070 ../src/guestfs-actions.pod:7695
15166 "This call creates a file called C<path>. The contents of the file is the "
15167 "string C<content> (which can contain any 8 bit data), with length C<size>."
15171 #: ../fish/guestfish-actions.pod:5074 ../src/guestfs-actions.pod:7699
15173 "As a special case, if C<size> is C<0> then the length is calculated using "
15174 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15178 #: ../fish/guestfish-actions.pod:5078 ../src/guestfs-actions.pod:7703
15180 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15181 "I<not> work, even if the length is specified."
15185 #: ../fish/guestfish-actions.pod:5084 ../src/guestfs-actions.pod:7711
15187 "This function is deprecated. In new code, use the C<write> call instead."
15191 #: ../fish/guestfish-actions.pod:5091
15196 #: ../fish/guestfish-actions.pod:5093
15199 " zegrep regex path\n"
15204 #: ../fish/guestfish-actions.pod:5095 ../src/guestfs-actions.pod:7727
15206 "This calls the external C<zegrep> program and returns the matching lines."
15210 #: ../fish/guestfish-actions.pod:5101
15215 #: ../fish/guestfish-actions.pod:5103
15218 " zegrepi regex path\n"
15223 #: ../fish/guestfish-actions.pod:5105 ../src/guestfs-actions.pod:7746
15225 "This calls the external C<zegrep -i> program and returns the matching lines."
15229 #: ../fish/guestfish-actions.pod:5111
15234 #: ../fish/guestfish-actions.pod:5113
15242 #: ../fish/guestfish-actions.pod:5115 ../src/guestfs-actions.pod:7764
15243 msgid "This command writes zeroes over the first few blocks of C<device>."
15247 #: ../fish/guestfish-actions.pod:5117 ../src/guestfs-actions.pod:7766
15249 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15250 "securely wipe the device). It should be sufficient to remove any partition "
15251 "tables, filesystem superblocks and so on."
15255 #: ../fish/guestfish-actions.pod:5121
15256 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
15260 #: ../fish/guestfish-actions.pod:5124
15261 msgid "zero-device"
15265 #: ../fish/guestfish-actions.pod:5126
15268 " zero-device device\n"
15273 #: ../fish/guestfish-actions.pod:5128
15275 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
15276 "which just zeroes the first few blocks of a device."
15280 #: ../fish/guestfish-actions.pod:5135
15285 #: ../fish/guestfish-actions.pod:5137
15288 " zerofree device\n"
15293 #: ../fish/guestfish-actions.pod:5139 ../src/guestfs-actions.pod:7810
15295 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15296 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15297 "possible to compress the filesystem more effectively."
15301 #: ../fish/guestfish-actions.pod:5144 ../src/guestfs-actions.pod:7815
15302 msgid "You should B<not> run this program if the filesystem is mounted."
15306 #: ../fish/guestfish-actions.pod:5147 ../src/guestfs-actions.pod:7818
15308 "It is possible that using this program can damage the filesystem or data on "
15313 #: ../fish/guestfish-actions.pod:5150
15318 #: ../fish/guestfish-actions.pod:5152
15321 " zfgrep pattern path\n"
15326 #: ../fish/guestfish-actions.pod:5154 ../src/guestfs-actions.pod:7832
15328 "This calls the external C<zfgrep> program and returns the matching lines."
15332 #: ../fish/guestfish-actions.pod:5160
15337 #: ../fish/guestfish-actions.pod:5162
15340 " zfgrepi pattern path\n"
15345 #: ../fish/guestfish-actions.pod:5164 ../src/guestfs-actions.pod:7851
15347 "This calls the external C<zfgrep -i> program and returns the matching lines."
15351 #: ../fish/guestfish-actions.pod:5170
15356 #: ../fish/guestfish-actions.pod:5172
15359 " zfile meth path\n"
15364 #: ../fish/guestfish-actions.pod:5174 ../src/guestfs-actions.pod:7870
15366 "This command runs C<file> after first decompressing C<path> using C<method>."
15370 #: ../fish/guestfish-actions.pod:5177 ../src/guestfs-actions.pod:7873
15371 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15375 #: ../fish/guestfish-actions.pod:5179
15377 "Since 1.0.63, use L</file> instead which can now process compressed files."
15381 #: ../fish/guestfish-actions.pod:5182 ../src/guestfs-actions.pod:7881
15383 "This function is deprecated. In new code, use the C<file> call instead."
15387 #: ../fish/guestfish-actions.pod:5189
15392 #: ../fish/guestfish-actions.pod:5191
15395 " zgrep regex path\n"
15400 #: ../fish/guestfish-actions.pod:5193 ../src/guestfs-actions.pod:7897
15402 "This calls the external C<zgrep> program and returns the matching lines."
15406 #: ../fish/guestfish-actions.pod:5199
15411 #: ../fish/guestfish-actions.pod:5201
15414 " zgrepi regex path\n"
15419 #: ../fish/guestfish-actions.pod:5203 ../src/guestfs-actions.pod:7916
15421 "This calls the external C<zgrep -i> program and returns the matching lines."
15425 #: ../fish/guestfish-commands.pod:1
15430 #: ../fish/guestfish-commands.pod:3
15435 #: ../fish/guestfish-commands.pod:5
15438 " alloc filename size\n"
15443 #: ../fish/guestfish-commands.pod:7
15445 "This creates an empty (zeroed) file of the given size, and then adds so it "
15446 "can be further examined."
15450 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
15451 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
15455 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
15456 msgid "Size can be specified using standard suffixes, eg. C<1M>."
15460 #: ../fish/guestfish-commands.pod:14
15462 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
15463 "image, see L</PREPARED DISK IMAGES>."
15467 #: ../fish/guestfish-commands.pod:17
15472 #: ../fish/guestfish-commands.pod:19
15475 " copy-in local [local ...] /remotedir\n"
15480 #: ../fish/guestfish-commands.pod:21
15482 "C<copy-in> copies local files or directories recursively into the disk "
15483 "image, placing them in the directory called C</remotedir> (which must "
15484 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
15485 "other commands as necessary."
15489 #: ../fish/guestfish-commands.pod:26
15491 "Multiple local files and directories can be specified, but the last "
15492 "parameter must always be a remote directory. Wildcards cannot be used."
15496 #: ../fish/guestfish-commands.pod:30
15501 #: ../fish/guestfish-commands.pod:32
15504 " copy-out remote [remote ...] localdir\n"
15509 #: ../fish/guestfish-commands.pod:34
15511 "C<copy-out> copies remote files or directories recursively out of the disk "
15512 "image, placing them on the host disk in a local directory called C<localdir> "
15513 "(which must exist). This guestfish meta-command turns into a sequence of L</"
15514 "download>, L</tar-out> and other commands as necessary."
15518 #: ../fish/guestfish-commands.pod:40
15520 "Multiple remote files and directories can be specified, but the last "
15521 "parameter must always be a local directory. To download to the current "
15522 "directory, use C<.> as in:"
15526 #: ../fish/guestfish-commands.pod:44
15529 " copy-out /home .\n"
15534 #: ../fish/guestfish-commands.pod:46
15536 "Wildcards cannot be used in the ordinary command, but you can use them with "
15537 "the help of L</glob> like this:"
15541 #: ../fish/guestfish-commands.pod:49
15544 " glob copy-out /home/* .\n"
15549 #: ../fish/guestfish-commands.pod:51
15554 #: ../fish/guestfish-commands.pod:53
15557 " display filename\n"
15562 #: ../fish/guestfish-commands.pod:55
15564 "Use C<display> (a graphical display program) to display an image file. It "
15565 "downloads the file, and runs C<display> on it."
15569 #: ../fish/guestfish-commands.pod:58
15571 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
15572 "environment variable. For example to use the GNOME display program:"
15576 #: ../fish/guestfish-commands.pod:61
15579 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
15584 #: ../fish/guestfish-commands.pod:63
15585 msgid "See also L<display(1)>."
15589 #: ../fish/guestfish-commands.pod:65
15594 #: ../fish/guestfish-commands.pod:67
15597 " echo [params ...]\n"
15602 #: ../fish/guestfish-commands.pod:69
15603 msgid "This echos the parameters to the terminal."
15607 #: ../fish/guestfish-commands.pod:71
15612 #: ../fish/guestfish-commands.pod:73
15617 #: ../fish/guestfish-commands.pod:75
15622 #: ../fish/guestfish-commands.pod:77
15630 #: ../fish/guestfish-commands.pod:79
15632 "This is used to edit a file. It downloads the file, edits it locally using "
15633 "your editor, then uploads the result."
15637 #: ../fish/guestfish-commands.pod:82
15639 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
15640 "or C<emacs> you will get those corresponding editors."
15644 #: ../fish/guestfish-commands.pod:86
15649 #: ../fish/guestfish-commands.pod:88
15652 " glob command args...\n"
15657 #: ../fish/guestfish-commands.pod:90
15659 "Expand wildcards in any paths in the args list, and run C<command> "
15660 "repeatedly on each matching path."
15664 #: ../fish/guestfish-commands.pod:93
15665 msgid "See L</WILDCARDS AND GLOBBING>."
15669 #: ../fish/guestfish-commands.pod:95
15674 #: ../fish/guestfish-commands.pod:97
15677 " hexedit <filename|device>\n"
15678 " hexedit <filename|device> <max>\n"
15679 " hexedit <filename|device> <start> <max>\n"
15684 #: ../fish/guestfish-commands.pod:101
15686 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
15691 #: ../fish/guestfish-commands.pod:104
15693 "This command works by downloading potentially the whole file or device, "
15694 "editing it locally, then uploading it. If the file or device is large, you "
15695 "have to specify which part you wish to edit by using C<max> and/or C<start> "
15696 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
15697 "usual modifiers allowed such as C<1M> (1 megabyte)."
15701 #: ../fish/guestfish-commands.pod:111
15702 msgid "For example to edit the first few sectors of a disk you might do:"
15706 #: ../fish/guestfish-commands.pod:114
15709 " hexedit /dev/sda 1M\n"
15714 #: ../fish/guestfish-commands.pod:116
15716 "which would allow you to edit anywhere within the first megabyte of the disk."
15720 #: ../fish/guestfish-commands.pod:119
15721 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
15725 #: ../fish/guestfish-commands.pod:121
15728 " hexedit /dev/sda1 0x400 0x400\n"
15733 #: ../fish/guestfish-commands.pod:123
15734 msgid "(assuming the superblock is in the standard location)."
15738 #: ../fish/guestfish-commands.pod:125
15740 "This command requires the external L<hexedit(1)> program. You can specify "
15741 "another program to use by setting the C<HEXEDITOR> environment variable."
15745 #: ../fish/guestfish-commands.pod:129
15746 msgid "See also L</hexdump>."
15750 #: ../fish/guestfish-commands.pod:131
15755 #: ../fish/guestfish-commands.pod:133
15763 #: ../fish/guestfish-commands.pod:135
15765 "Change the local directory, ie. the current directory of guestfish itself."
15769 #: ../fish/guestfish-commands.pod:138
15770 msgid "Note that C<!cd> won't do what you might expect."
15774 #: ../fish/guestfish-commands.pod:140
15779 #: ../fish/guestfish-commands.pod:142
15784 #: ../fish/guestfish-commands.pod:144
15792 #: ../fish/guestfish-commands.pod:146
15793 msgid "Opens the manual page for guestfish."
15797 #: ../fish/guestfish-commands.pod:148
15802 #: ../fish/guestfish-commands.pod:150
15807 #: ../fish/guestfish-commands.pod:152
15815 #: ../fish/guestfish-commands.pod:154
15823 #: ../fish/guestfish-commands.pod:156
15824 msgid "This is used to view a file."
15828 #: ../fish/guestfish-commands.pod:158
15830 "The default viewer is C<$PAGER>. However if you use the alternate command "
15831 "C<less> you will get the C<less> command specifically."
15835 #: ../fish/guestfish-commands.pod:161
15840 #: ../fish/guestfish-commands.pod:163
15848 #: ../fish/guestfish-commands.pod:165
15850 "Close and reopen the libguestfs handle. It is not necessary to use this "
15851 "normally, because the handle is closed properly when guestfish exits. "
15852 "However this is occasionally useful for testing."
15856 #: ../fish/guestfish-commands.pod:169
15861 #: ../fish/guestfish-commands.pod:171
15864 " sparse filename size\n"
15869 #: ../fish/guestfish-commands.pod:173
15871 "This creates an empty sparse file of the given size, and then adds so it can "
15872 "be further examined."
15876 #: ../fish/guestfish-commands.pod:176
15878 "In all respects it works the same as the L</alloc> command, except that the "
15879 "image file is allocated sparsely, which means that disk blocks are not "
15880 "assigned to the file until they are needed. Sparse disk files only use "
15881 "space when written to, but they are slower and there is a danger you could "
15882 "run out of real disk space during a write operation."
15886 #: ../fish/guestfish-commands.pod:186
15891 #: ../fish/guestfish-commands.pod:188
15899 #: ../fish/guestfish-commands.pod:190
15901 "This command returns a list of the optional groups known to the daemon, and "
15902 "indicates which ones are supported by this build of the libguestfs appliance."
15906 #: ../fish/guestfish-commands.pod:194
15907 msgid "See also L<guestfs(3)/AVAILABILITY>."
15911 #: ../fish/guestfish-commands.pod:196
15916 #: ../fish/guestfish-commands.pod:198
15919 " time command args...\n"
15924 #: ../fish/guestfish-commands.pod:200
15926 "Run the command as usual, but print the elapsed time afterwards. This can "
15927 "be useful for benchmarking operations."
15931 #: ../fish/guestfish.pod:5
15932 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
15936 #: ../fish/guestfish.pod:9
15939 " guestfish [--options] [commands]\n"
15944 #: ../fish/guestfish.pod:11
15952 #: ../fish/guestfish.pod:13
15955 " guestfish [--ro|--rw] -a disk.img\n"
15960 #: ../fish/guestfish.pod:15
15963 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
15968 #: ../fish/guestfish.pod:17
15971 " guestfish -d libvirt-domain\n"
15976 #: ../fish/guestfish.pod:19
15979 " guestfish [--ro|--rw] -a disk.img -i\n"
15984 #: ../fish/guestfish.pod:21
15987 " guestfish -d libvirt-domain -i\n"
15992 #: ../fish/guestfish.pod:25
15994 "Using guestfish in read/write mode on live virtual machines can be "
15995 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
15996 "option to use guestfish safely if the disk image or virtual machine might be "
16001 #: ../fish/guestfish.pod:32
16003 "Guestfish is a shell and command-line tool for examining and modifying "
16004 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16005 "functionality of the guestfs API, see L<guestfs(3)>."
16009 #: ../fish/guestfish.pod:36
16011 "Guestfish gives you structured access to the libguestfs API, from shell "
16012 "scripts or the command line or interactively. If you want to rescue a "
16013 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16018 #: ../fish/guestfish.pod:43
16019 msgid "As an interactive shell"
16023 #: ../fish/guestfish.pod:45
16031 #: ../fish/guestfish.pod:47
16034 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16035 " editing virtual machine filesystems.\n"
16040 #: ../fish/guestfish.pod:50
16043 " Type: 'help' for a list of commands\n"
16044 " 'man' to read the manual\n"
16045 " 'quit' to quit the shell\n"
16050 #: ../fish/guestfish.pod:54
16053 " ><fs> add-ro disk.img\n"
16055 " ><fs> list-filesystems\n"
16056 " /dev/sda1: ext4\n"
16057 " /dev/vg_guest/lv_root: ext4\n"
16058 " /dev/vg_guest/lv_swap: swap\n"
16059 " ><fs> mount /dev/vg_guest/lv_root /\n"
16060 " ><fs> cat /etc/fstab\n"
16062 " # Created by anaconda\n"
16069 #: ../fish/guestfish.pod:67
16070 msgid "From shell scripts"
16074 #: ../fish/guestfish.pod:69
16075 msgid "Create a new C</etc/motd> file in a guest or disk image:"
16079 #: ../fish/guestfish.pod:71
16082 " guestfish <<_EOF_\n"
16085 " mount /dev/vg_guest/lv_root /\n"
16086 " write /etc/motd \"Welcome, new users\"\n"
16092 #: ../fish/guestfish.pod:78
16093 msgid "List the LVM logical volumes in a disk image:"
16097 #: ../fish/guestfish.pod:80
16100 " guestfish -a disk.img --ro <<_EOF_\n"
16108 #: ../fish/guestfish.pod:85
16109 msgid "List all the filesystems in a disk image:"
16113 #: ../fish/guestfish.pod:87
16116 " guestfish -a disk.img --ro <<_EOF_\n"
16118 " list-filesystems\n"
16124 #: ../fish/guestfish.pod:92
16125 msgid "On one command line"
16129 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
16130 msgid "Update C</etc/resolv.conf> in a guest:"
16134 #: ../fish/guestfish.pod:96
16138 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16139 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16144 #: ../fish/guestfish.pod:100
16145 msgid "Edit C</boot/grub/grub.conf> interactively:"
16149 #: ../fish/guestfish.pod:102
16152 " guestfish --rw --add disk.img \\\n"
16153 " --mount /dev/vg_guest/lv_root \\\n"
16154 " --mount /dev/sda1:/boot \\\n"
16155 " edit /boot/grub/grub.conf\n"
16160 #: ../fish/guestfish.pod:107
16161 msgid "Mount disks automatically"
16165 #: ../fish/guestfish.pod:109
16167 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
16171 #: ../fish/guestfish.pod:112
16174 " guestfish --ro -a disk.img -i cat /etc/group\n"
16179 #: ../fish/guestfish.pod:114
16182 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16187 #: ../fish/guestfish.pod:116
16188 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16192 #: ../fish/guestfish.pod:118
16195 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16200 #: ../fish/guestfish.pod:120
16201 msgid "As a script interpreter"
16205 #: ../fish/guestfish.pod:122
16206 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16210 #: ../fish/guestfish.pod:124
16213 " #!/usr/bin/guestfish -f\n"
16214 " sparse test1.img 100M\n"
16216 " part-disk /dev/sda mbr\n"
16217 " mkfs ext2 /dev/sda1\n"
16222 #: ../fish/guestfish.pod:130
16223 msgid "Start with a prepared disk"
16227 #: ../fish/guestfish.pod:132
16229 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16230 "single ext2-formatted partition:"
16234 #: ../fish/guestfish.pod:135
16237 " guestfish -N fs\n"
16242 #: ../fish/guestfish.pod:137
16243 msgid "To list what is available do:"
16247 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:998
16250 " guestfish -N help | less\n"
16255 #: ../fish/guestfish.pod:141
16256 msgid "Remote control"
16260 #: ../fish/guestfish.pod:143
16263 " eval \"`guestfish --listen`\"\n"
16264 " guestfish --remote add-ro disk.img\n"
16265 " guestfish --remote run\n"
16266 " guestfish --remote lvs\n"
16271 #: ../fish/guestfish.pod:154
16272 msgid "Displays general help on options."
16276 #: ../fish/guestfish.pod:158
16277 msgid "B<--cmd-help>"
16281 #: ../fish/guestfish.pod:160
16282 msgid "Lists all available guestfish commands."
16286 #: ../fish/guestfish.pod:162
16291 #: ../fish/guestfish.pod:164
16292 msgid "B<--cmd-help cmd>"
16296 #: ../fish/guestfish.pod:166
16297 msgid "Displays detailed help on a single command C<cmd>."
16301 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:87
16302 msgid "B<-a image>"
16306 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:89
16307 msgid "B<--add image>"
16311 #: ../fish/guestfish.pod:172
16312 msgid "Add a block device or virtual machine image to the shell."
16316 #: ../fish/guestfish.pod:177
16318 "Using this flag is mostly equivalent to using the C<add> command, with "
16319 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
16320 "the I<--format=...> flag was given."
16324 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:100
16326 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16327 "URI to use. The default is to use the default libvirt connection."
16331 #: ../fish/guestfish.pod:189
16336 #: ../fish/guestfish.pod:191
16338 "If using the I<--listen> option and a csh-like shell, use this option. See "
16339 "section L</REMOTE CONTROL AND CSH> below."
16343 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:104
16344 msgid "B<-d libvirt-domain>"
16348 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:106
16349 msgid "B<--domain libvirt-domain>"
16353 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:108
16355 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16356 "used, then any libvirt domain can be used. However in write mode, only "
16357 "libvirt domains which are shut down can be named here."
16361 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:112
16362 msgid "Domain UUIDs can be used instead of names."
16366 #: ../fish/guestfish.pod:204
16368 "Using this flag is mostly equivalent to using the C<add-domain> command, "
16369 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
16370 "if the I<--format:...> flag was given."
16374 #: ../fish/guestfish.pod:208
16379 #: ../fish/guestfish.pod:210
16380 msgid "B<--no-dest-paths>"
16384 #: ../fish/guestfish.pod:212
16386 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16387 "to hit the tab key to complete paths on the guest filesystem, but this "
16388 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16389 "allow this feature to be disabled."
16393 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:128
16395 "When prompting for keys and passphrases, guestfish normally turns echoing "
16396 "off so you cannot see what you are typing. If you are not worried about "
16397 "Tempest attacks and there is no one else in the room you can specify this "
16398 "flag to see what you are typing."
16402 #: ../fish/guestfish.pod:224
16407 #: ../fish/guestfish.pod:226
16408 msgid "B<--file file>"
16412 #: ../fish/guestfish.pod:228
16413 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16417 #: ../fish/guestfish.pod:231
16420 " #!/usr/bin/guestfish -f\n"
16425 #: ../fish/guestfish.pod:244
16428 " guestfish --format=raw -a disk.img\n"
16433 #: ../fish/guestfish.pod:248
16436 " guestfish --format=raw -a disk.img --format -a another.img\n"
16441 #: ../fish/guestfish.pod:253
16443 "If you have untrusted raw-format guest disk images, you should use this "
16444 "option to specify the disk format. This avoids a possible security problem "
16445 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16449 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:157
16450 msgid "B<--inspector>"
16454 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:159
16456 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16457 "system and mount filesystems as they would be mounted on the real virtual "
16462 #: ../fish/guestfish.pod:266
16463 msgid "Typical usage is either:"
16467 #: ../fish/guestfish.pod:268
16470 " guestfish -d myguest -i\n"
16475 #: ../fish/guestfish.pod:270
16476 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16480 #: ../fish/guestfish.pod:272
16483 " guestfish --ro -d myguest -i\n"
16488 #: ../fish/guestfish.pod:274
16489 msgid "(for active domains, readonly), or specify the block device directly:"
16493 #: ../fish/guestfish.pod:276
16496 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16501 #: ../fish/guestfish.pod:278
16503 "Note that the command line syntax changed slightly over older versions of "
16504 "guestfish. You can still use the old syntax:"
16508 #: ../fish/guestfish.pod:281
16511 " guestfish [--ro] -i disk.img\n"
16516 #: ../fish/guestfish.pod:283
16519 " guestfish [--ro] -i libvirt-domain\n"
16524 #: ../fish/guestfish.pod:285
16526 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
16527 "then using other commands to mount the filesystems that were found."
16531 #: ../fish/guestfish.pod:294
16532 msgid "B<--listen>"
16536 #: ../fish/guestfish.pod:296
16538 "Fork into the background and listen for remote commands. See section L</"
16539 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16543 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:168
16548 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:170
16550 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
16551 "ATTACHING TO RUNNING DAEMONS>)."
16555 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:173
16556 msgid "B<-m dev[:mountpoint[:options]]>"
16560 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:175
16561 msgid "B<--mount dev[:mountpoint[:options]]>"
16565 #: ../fish/guestfish.pod:308
16566 msgid "Mount the named partition or logical volume on the given mountpoint."
16570 #: ../fish/guestfish.pod:310
16571 msgid "If the mountpoint is omitted, it defaults to C</>."
16575 #: ../fish/guestfish.pod:312
16576 msgid "You have to mount something on C</> before most commands will work."
16580 #: ../fish/guestfish.pod:314
16582 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16587 #: ../fish/guestfish.pod:317
16589 "If you don't know what filesystems a disk image contains, you can either run "
16590 "guestfish without this option, then list the partitions, filesystems and LVs "
16591 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
16592 "commands), or you can use the L<virt-filesystems(1)> program."
16596 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:183
16598 "The third (and rarely used) part of the mount parameter is the list of mount "
16599 "options used to mount the underlying filesystem. If this is not given, then "
16600 "the mount options are either the empty string or C<ro> (the latter if the "
16601 "I<--ro> flag is used). By specifying the mount options, you override this "
16602 "default choice. Probably the only time you would use this is to enable ACLs "
16603 "and/or extended attributes if the filesystem can support them:"
16607 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:191
16610 " -m /dev/sda1:/:acl,user_xattr\n"
16615 #: ../fish/guestfish.pod:333
16616 msgid "Using this flag is equivalent to using the C<mount-options> command."
16620 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:193
16621 #: ../resize/virt-resize.pod:352
16626 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:195
16627 msgid "B<--no-sync>"
16631 #: ../fish/guestfish.pod:339
16633 "Disable autosync. This is enabled by default. See the discussion of "
16634 "autosync in the L<guestfs(3)> manpage."
16638 #: ../fish/guestfish.pod:342
16643 #: ../fish/guestfish.pod:344
16644 msgid "B<--new type>"
16648 #: ../fish/guestfish.pod:346
16653 #: ../fish/guestfish.pod:348
16655 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16656 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16657 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16662 #: ../fish/guestfish.pod:353
16663 msgid "B<--progress-bars>"
16667 #: ../fish/guestfish.pod:355
16668 msgid "Enable progress bars, even when guestfish is used non-interactively."
16672 #: ../fish/guestfish.pod:357
16674 "Progress bars are enabled by default when guestfish is used as an "
16675 "interactive shell."
16679 #: ../fish/guestfish.pod:360
16680 msgid "B<--no-progress-bars>"
16684 #: ../fish/guestfish.pod:362
16685 msgid "Disable progress bars."
16689 #: ../fish/guestfish.pod:364
16690 msgid "B<--remote[=pid]>"
16694 #: ../fish/guestfish.pod:366
16696 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16697 "CONTROL GUESTFISH OVER A SOCKET> below."
16701 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:239
16702 #: ../rescue/virt-rescue.pod:161
16707 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:241
16708 #: ../rescue/virt-rescue.pod:163
16713 #: ../fish/guestfish.pod:373
16715 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16716 "mounts are done read-only."
16720 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
16722 "The option must always be used if the disk image or virtual machine might be "
16723 "running, and is generally recommended in cases where you don't need write "
16724 "access to the disk."
16728 #: ../fish/guestfish.pod:380
16730 "Note that prepared disk images created with I<-N> are not affected by this "
16731 "option. Also commands like C<add> are not affected - you have to specify "
16732 "the C<readonly:true> option explicitly if you need it."
16736 #: ../fish/guestfish.pod:384
16737 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
16741 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:253
16742 #: ../rescue/virt-rescue.pod:173
16743 msgid "B<--selinux>"
16747 #: ../fish/guestfish.pod:388
16748 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16752 #: ../fish/guestfish.pod:394
16754 "Enable very verbose messages. This is particularly useful if you find a bug."
16758 #: ../fish/guestfish.pod:401
16759 msgid "Display the guestfish / libguestfs version number and exit."
16763 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:269
16764 #: ../rescue/virt-rescue.pod:190
16769 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:271
16770 #: ../rescue/virt-rescue.pod:192
16775 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:273
16777 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16778 "mounts are done read-write."
16782 #: ../fish/guestfish.pod:410
16783 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
16787 #: ../fish/guestfish.pod:414
16788 msgid "Echo each command before executing it."
16792 #: ../fish/guestfish.pod:418
16793 msgid "COMMANDS ON COMMAND LINE"
16797 #: ../fish/guestfish.pod:420
16799 "Any additional (non-option) arguments are treated as commands to execute."
16803 #: ../fish/guestfish.pod:423
16805 "Commands to execute should be separated by a colon (C<:>), where the colon "
16806 "is a separate parameter. Thus:"
16810 #: ../fish/guestfish.pod:426
16813 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16818 #: ../fish/guestfish.pod:428
16820 "If there are no additional arguments, then we enter a shell, either an "
16821 "interactive shell with a prompt (if the input is a terminal) or a non-"
16822 "interactive shell."
16826 #: ../fish/guestfish.pod:432
16828 "In either command line mode or non-interactive shell, the first command that "
16829 "gives an error causes the whole shell to exit. In interactive mode (with a "
16830 "prompt) if a command fails, you can continue to enter commands."
16834 #: ../fish/guestfish.pod:437
16835 msgid "USING launch (OR run)"
16839 #: ../fish/guestfish.pod:439
16841 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16842 "then launch it, then mount any disks you need, and finally issue actions/"
16843 "commands. So the general order of the day is:"
16847 #: ../fish/guestfish.pod:447
16848 msgid "add or -a/--add"
16852 #: ../fish/guestfish.pod:451
16853 msgid "launch (aka run)"
16857 #: ../fish/guestfish.pod:455
16858 msgid "mount or -m/--mount"
16862 #: ../fish/guestfish.pod:459
16863 msgid "any other commands"
16867 #: ../fish/guestfish.pod:463
16869 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16870 "guest before mounting or performing any other commands."
16874 #: ../fish/guestfish.pod:466
16876 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16877 "I<--new> options were given then C<run> is done automatically, simply "
16878 "because guestfish can't perform the action you asked for without doing this."
16882 #: ../fish/guestfish.pod:471
16883 msgid "OPENING DISKS FOR READ AND WRITE"
16887 #: ../fish/guestfish.pod:473
16889 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
16890 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
16891 "I<-i> and I<-m> open disk images read-only or for writing."
16895 #: ../fish/guestfish.pod:478
16897 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
16898 "opening disk images supplied on the command line for write. To open a disk "
16899 "image read-only you have to do I<-a image --ro>."
16903 #: ../fish/guestfish.pod:482
16905 "This matters: If you accidentally open a live VM disk image writable then "
16906 "you will cause irreversible disk corruption."
16910 #: ../fish/guestfish.pod:485
16912 "In a future libguestfs we intend to change the default the other way. Disk "
16913 "images will be opened read-only. You will have to either specify "
16914 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
16915 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
16916 "access for disk images specified by those other command line options."
16920 #: ../fish/guestfish.pod:492
16922 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
16923 "which does nothing (it is already the default). However it is highly "
16924 "recommended that you use this option to indicate that you need write access, "
16925 "and prepare your scripts for the day when this option will be required for "
16930 #: ../fish/guestfish.pod:498
16932 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
16933 "other libguestfs program apart from guestfish and guestmount."
16937 #: ../fish/guestfish.pod:501
16942 #: ../fish/guestfish.pod:503
16944 "You can quote ordinary parameters using either single or double quotes. For "
16949 #: ../fish/guestfish.pod:506
16952 " add \"file with a space.img\"\n"
16957 #: ../fish/guestfish.pod:508
16960 " rm '/file name'\n"
16965 #: ../fish/guestfish.pod:510
16973 #: ../fish/guestfish.pod:512
16975 "A few commands require a list of strings to be passed. For these, use a "
16976 "whitespace-separated list, enclosed in quotes. Strings containing "
16977 "whitespace to be passed through must be enclosed in single quotes. A "
16978 "literal single quote must be escaped with a backslash."
16982 #: ../fish/guestfish.pod:517
16985 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
16986 " command \"/bin/echo 'foo bar'\"\n"
16987 " command \"/bin/echo \\'foo\\'\"\n"
16992 #: ../fish/guestfish.pod:521
16993 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
16997 #: ../fish/guestfish.pod:523
16999 "In double-quoted arguments (only) use backslash to insert special characters:"
17003 #: ../fish/guestfish.pod:528
17008 #: ../fish/guestfish.pod:530
17009 msgid "Alert (bell) character."
17013 #: ../fish/guestfish.pod:532
17018 #: ../fish/guestfish.pod:534
17019 msgid "Backspace character."
17023 #: ../fish/guestfish.pod:536
17028 #: ../fish/guestfish.pod:538
17029 msgid "Form feed character."
17033 #: ../fish/guestfish.pod:540
17038 #: ../fish/guestfish.pod:542
17039 msgid "Newline character."
17043 #: ../fish/guestfish.pod:544
17048 #: ../fish/guestfish.pod:546
17049 msgid "Carriage return character."
17053 #: ../fish/guestfish.pod:548
17058 #: ../fish/guestfish.pod:550
17059 msgid "Horizontal tab character."
17063 #: ../fish/guestfish.pod:552
17068 #: ../fish/guestfish.pod:554
17069 msgid "Vertical tab character."
17073 #: ../fish/guestfish.pod:556
17078 #: ../fish/guestfish.pod:558
17079 msgid "A literal double quote character."
17083 #: ../fish/guestfish.pod:560
17088 #: ../fish/guestfish.pod:562
17090 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
17095 #: ../fish/guestfish.pod:565
17100 #: ../fish/guestfish.pod:567
17102 "A character with hex value I<hh>. There must be precisely 2 hex digits."
17106 #: ../fish/guestfish.pod:570
17108 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
17113 #: ../fish/guestfish.pod:573
17118 #: ../fish/guestfish.pod:575
17119 msgid "A literal backslash character."
17123 #: ../fish/guestfish.pod:579
17124 msgid "OPTIONAL ARGUMENTS"
17128 #: ../fish/guestfish.pod:581
17130 "Some commands take optional arguments. These arguments appear in this "
17131 "documentation as C<[argname:..]>. You can use them as in these examples:"
17135 #: ../fish/guestfish.pod:585
17138 " add-drive-opts filename\n"
17143 #: ../fish/guestfish.pod:587
17146 " add-drive-opts filename readonly:true\n"
17151 #: ../fish/guestfish.pod:589
17154 " add-drive-opts filename format:qcow2 readonly:false\n"
17159 #: ../fish/guestfish.pod:591
17161 "Each optional argument can appear at most once. All optional arguments must "
17162 "appear after the required ones."
17166 #: ../fish/guestfish.pod:594
17171 #: ../fish/guestfish.pod:596
17173 "This section applies to all commands which can take integers as parameters."
17177 #: ../fish/guestfish.pod:599
17178 msgid "SIZE SUFFIX"
17182 #: ../fish/guestfish.pod:601
17184 "When the command takes a parameter measured in bytes, you can use one of the "
17185 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17189 #: ../fish/guestfish.pod:607
17190 msgid "B<k> or B<K> or B<KiB>"
17194 #: ../fish/guestfish.pod:609
17195 msgid "The size in kilobytes (multiplied by 1024)."
17199 #: ../fish/guestfish.pod:611
17204 #: ../fish/guestfish.pod:613
17205 msgid "The size in SI 1000 byte units."
17209 #: ../fish/guestfish.pod:615
17210 msgid "B<M> or B<MiB>"
17214 #: ../fish/guestfish.pod:617
17215 msgid "The size in megabytes (multiplied by 1048576)."
17219 #: ../fish/guestfish.pod:619
17224 #: ../fish/guestfish.pod:621
17225 msgid "The size in SI 1000000 byte units."
17229 #: ../fish/guestfish.pod:623
17230 msgid "B<G> or B<GiB>"
17234 #: ../fish/guestfish.pod:625
17235 msgid "The size in gigabytes (multiplied by 2**30)."
17239 #: ../fish/guestfish.pod:627
17244 #: ../fish/guestfish.pod:629
17245 msgid "The size in SI 10**9 byte units."
17249 #: ../fish/guestfish.pod:631
17250 msgid "B<T> or B<TiB>"
17254 #: ../fish/guestfish.pod:633
17255 msgid "The size in terabytes (multiplied by 2**40)."
17259 #: ../fish/guestfish.pod:635
17264 #: ../fish/guestfish.pod:637
17265 msgid "The size in SI 10**12 byte units."
17269 #: ../fish/guestfish.pod:639
17270 msgid "B<P> or B<PiB>"
17274 #: ../fish/guestfish.pod:641
17275 msgid "The size in petabytes (multiplied by 2**50)."
17279 #: ../fish/guestfish.pod:643
17284 #: ../fish/guestfish.pod:645
17285 msgid "The size in SI 10**15 byte units."
17289 #: ../fish/guestfish.pod:647
17290 msgid "B<E> or B<EiB>"
17294 #: ../fish/guestfish.pod:649
17295 msgid "The size in exabytes (multiplied by 2**60)."
17299 #: ../fish/guestfish.pod:651
17304 #: ../fish/guestfish.pod:653
17305 msgid "The size in SI 10**18 byte units."
17309 #: ../fish/guestfish.pod:655
17310 msgid "B<Z> or B<ZiB>"
17314 #: ../fish/guestfish.pod:657
17315 msgid "The size in zettabytes (multiplied by 2**70)."
17319 #: ../fish/guestfish.pod:659
17324 #: ../fish/guestfish.pod:661
17325 msgid "The size in SI 10**21 byte units."
17329 #: ../fish/guestfish.pod:663
17330 msgid "B<Y> or B<YiB>"
17334 #: ../fish/guestfish.pod:665
17335 msgid "The size in yottabytes (multiplied by 2**80)."
17339 #: ../fish/guestfish.pod:667
17344 #: ../fish/guestfish.pod:669
17345 msgid "The size in SI 10**24 byte units."
17349 #: ../fish/guestfish.pod:675
17352 " truncate-size /file 1G\n"
17357 #: ../fish/guestfish.pod:677
17358 msgid "would truncate the file to 1 gigabyte."
17362 #: ../fish/guestfish.pod:679
17364 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
17365 "the parameter to L</memsize> is specified in megabytes already). Adding a "
17366 "suffix will probably not do what you expect."
17370 #: ../fish/guestfish.pod:683
17371 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17375 #: ../fish/guestfish.pod:685
17377 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17378 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17382 #: ../fish/guestfish.pod:688
17385 " 1234 decimal number 1234\n"
17386 " 02322 octal number, equivalent to decimal 1234\n"
17387 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17392 #: ../fish/guestfish.pod:692
17394 "When using the C<chmod> command, you almost always want to specify an octal "
17395 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17396 "L<chmod(1)> program):"
17400 #: ../fish/guestfish.pod:696
17403 " chmod 0777 /public # OK\n"
17404 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17409 #: ../fish/guestfish.pod:699
17411 "Commands that return numbers usually print them in decimal, but some "
17412 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17413 "octal, preceeded by C<0>)."
17417 #: ../fish/guestfish.pod:703
17418 msgid "WILDCARDS AND GLOBBING"
17422 #: ../fish/guestfish.pod:705
17424 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17425 "(globbing) by default. So for example the following will not do what you "
17430 #: ../fish/guestfish.pod:709
17438 #: ../fish/guestfish.pod:711
17440 "Assuming you don't have a directory called literally C</home/*> then the "
17441 "above command will return an error."
17445 #: ../fish/guestfish.pod:714
17446 msgid "To perform wildcard expansion, use the C<glob> command."
17450 #: ../fish/guestfish.pod:716
17453 " glob rm-rf /home/*\n"
17458 #: ../fish/guestfish.pod:718
17460 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17461 "many times), equivalent to:"
17465 #: ../fish/guestfish.pod:721
17468 " rm-rf /home/jim\n"
17469 " rm-rf /home/joe\n"
17470 " rm-rf /home/mary\n"
17475 #: ../fish/guestfish.pod:725
17476 msgid "C<glob> only works on simple guest paths and not on device names."
17480 #: ../fish/guestfish.pod:727
17482 "If you have several parameters, each containing a wildcard, then glob will "
17483 "perform a Cartesian product."
17487 #: ../fish/guestfish.pod:730
17492 #: ../fish/guestfish.pod:732
17494 "Any line which starts with a I<#> character is treated as a comment and "
17495 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17496 "a command. For example:"
17500 #: ../fish/guestfish.pod:736
17503 " # this is a comment\n"
17504 " # this is a comment\n"
17505 " foo # NOT a comment\n"
17510 #: ../fish/guestfish.pod:740
17511 msgid "Blank lines are also ignored."
17515 #: ../fish/guestfish.pod:742
17516 msgid "RUNNING COMMANDS LOCALLY"
17520 #: ../fish/guestfish.pod:744
17522 "Any line which starts with a I<!> character is treated as a command sent to "
17523 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17527 #: ../fish/guestfish.pod:748
17531 " tgz-out /remote local/remote-data.tar.gz\n"
17536 #: ../fish/guestfish.pod:751
17538 "will create a directory C<local> on the host, and then export the contents "
17539 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17540 "(See C<tgz-out>)."
17544 #: ../fish/guestfish.pod:755
17546 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17547 "effect, due to the way that subprocesses work in Unix."
17551 #: ../fish/guestfish.pod:758
17552 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
17556 #: ../fish/guestfish.pod:760
17558 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
17559 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
17560 "and executed as guestfish commands."
17564 #: ../fish/guestfish.pod:764
17566 "Thus you can use shell script to construct arbitrary guestfish commands "
17567 "which are then parsed by guestfish."
17571 #: ../fish/guestfish.pod:767
17573 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
17574 "through C</foo.100>) using guestfish commands alone. However this is simple "
17575 "if we use a shell script to create the guestfish commands for us:"
17579 #: ../fish/guestfish.pod:772
17582 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
17587 #: ../fish/guestfish.pod:774
17588 msgid "or with names like C</foo.001>:"
17592 #: ../fish/guestfish.pod:776
17595 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
17600 #: ../fish/guestfish.pod:778
17602 "When using guestfish interactively it can be helpful to just run the shell "
17603 "script first (ie. remove the initial C<E<lt>> character so it is just an "
17604 "ordinary I<!> local command), see what guestfish commands it would run, and "
17605 "when you are happy with those prepend the C<E<lt>> character to run the "
17606 "guestfish commands for real."
17610 #: ../fish/guestfish.pod:784
17615 #: ../fish/guestfish.pod:786
17617 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17618 "command (a guestfish command) to the second command (any host command). For "
17623 #: ../fish/guestfish.pod:790
17626 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17631 #: ../fish/guestfish.pod:792
17633 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17634 "program). The above command would list all accounts in the guest filesystem "
17635 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17639 #: ../fish/guestfish.pod:797
17642 " hexdump /bin/ls | head\n"
17643 " list-devices | tail -1\n"
17644 " tgz-out / - | tar ztf -\n"
17649 #: ../fish/guestfish.pod:801
17651 "The space before the pipe symbol is required, any space after the pipe "
17652 "symbol is optional. Everything after the pipe symbol is just passed "
17653 "straight to the host shell, so it can contain redirections, globs and "
17654 "anything else that makes sense on the host side."
17658 #: ../fish/guestfish.pod:806
17660 "To use a literal argument which begins with a pipe symbol, you have to quote "
17665 #: ../fish/guestfish.pod:809
17673 #: ../fish/guestfish.pod:811
17674 msgid "HOME DIRECTORIES"
17678 #: ../fish/guestfish.pod:813
17680 "If a parameter starts with the character C<~> then the tilde may be expanded "
17681 "as a home directory path (either C<~> for the current user's home directory, "
17682 "or C<~user> for another user)."
17686 #: ../fish/guestfish.pod:817
17688 "Note that home directory expansion happens for users known I<on the host>, "
17689 "not in the guest filesystem."
17693 #: ../fish/guestfish.pod:820
17695 "To use a literal argument which begins with a tilde, you have to quote it, "
17700 #: ../fish/guestfish.pod:823
17708 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:519
17709 msgid "ENCRYPTED DISKS"
17713 #: ../fish/guestfish.pod:827
17715 "Libguestfs has some support for Linux guests encrypted according to the "
17716 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17717 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
17718 "LUKS is supported."
17722 #: ../fish/guestfish.pod:832
17723 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17727 #: ../fish/guestfish.pod:834
17730 " ><fs> vfs-type /dev/sda2\n"
17736 #: ../fish/guestfish.pod:837
17738 "Then open those devices using L</luks-open>. This creates a device-mapper "
17739 "device called C</dev/mapper/luksdev>."
17743 #: ../fish/guestfish.pod:840
17746 " ><fs> luks-open /dev/sda2 luksdev\n"
17747 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17752 #: ../fish/guestfish.pod:843
17754 "Finally you have to tell LVM to scan for volume groups on the newly created "
17759 #: ../fish/guestfish.pod:846
17763 " vg-activate-all true\n"
17768 #: ../fish/guestfish.pod:849
17769 msgid "The logical volume(s) can now be mounted in the usual way."
17773 #: ../fish/guestfish.pod:851
17775 "Before closing a LUKS device you must unmount any logical volumes on it and "
17776 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17777 "one. Then you can close the mapper device:"
17781 #: ../fish/guestfish.pod:855
17784 " vg-activate false /dev/VG\n"
17785 " luks-close /dev/mapper/luksdev\n"
17790 #: ../fish/guestfish.pod:860
17792 "If a path is prefixed with C<win:> then you can use Windows-style drive "
17793 "letters and paths (with some limitations). The following commands are "
17798 #: ../fish/guestfish.pod:864
17801 " file /WINDOWS/system32/config/system.LOG\n"
17806 #: ../fish/guestfish.pod:866
17809 " file win:\\windows\\system32\\config\\system.log\n"
17814 #: ../fish/guestfish.pod:868
17817 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
17822 #: ../fish/guestfish.pod:870
17824 "The parameter is rewritten \"behind the scenes\" by looking up the position "
17825 "where the drive is mounted, prepending that to the path, changing all "
17826 "backslash characters to forward slash, then resolving the result using L</"
17827 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
17828 "the parameter might be rewritten like this:"
17832 #: ../fish/guestfish.pod:876
17835 " win:e:\\foo\\bar => /e/FOO/bar\n"
17840 #: ../fish/guestfish.pod:878
17841 msgid "This only works in argument positions that expect a path."
17845 #: ../fish/guestfish.pod:880
17846 msgid "UPLOADING AND DOWNLOADING FILES"
17850 #: ../fish/guestfish.pod:882
17852 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17853 "others which upload from or download to a local file, you can use the "
17854 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17858 #: ../fish/guestfish.pod:886
17866 #: ../fish/guestfish.pod:888
17868 "reads stdin and creates from that a file C</foo> in the disk image, and:"
17872 #: ../fish/guestfish.pod:891
17875 " tar-out /etc - | tar tf -\n"
17880 #: ../fish/guestfish.pod:893
17882 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17883 "command (see L</PIPES>)."
17887 #: ../fish/guestfish.pod:896
17889 "When using C<-> to read from stdin, the input is read up to the end of "
17890 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17891 "some arbitrary end marker:"
17895 #: ../fish/guestfish.pod:900
17898 " upload -<<END /foo\n"
17907 #: ../fish/guestfish.pod:906
17909 "Any string of characters can be used instead of C<END>. The end marker must "
17910 "appear on a line of its own, without any preceeding or following characters "
17911 "(not even spaces)."
17915 #: ../fish/guestfish.pod:910
17917 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17918 "upload local files (so-called \"FileIn\" parameters in the generator)."
17922 #: ../fish/guestfish.pod:913
17923 msgid "EXIT ON ERROR BEHAVIOUR"
17927 #: ../fish/guestfish.pod:915
17929 "By default, guestfish will ignore any errors when in interactive mode (ie. "
17930 "taking commands from a human over a tty), and will exit on the first error "
17931 "in non-interactive mode (scripts, commands given on the command line)."
17935 #: ../fish/guestfish.pod:920
17937 "If you prefix a command with a I<-> character, then that command will not "
17938 "cause guestfish to exit, even if that (one) command returns an error."
17942 #: ../fish/guestfish.pod:924
17943 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
17947 #: ../fish/guestfish.pod:926
17949 "Guestfish can be remote-controlled over a socket. This is useful "
17950 "particularly in shell scripts where you want to make several different "
17951 "changes to a filesystem, but you don't want the overhead of starting up a "
17952 "guestfish process each time."
17956 #: ../fish/guestfish.pod:931
17957 msgid "Start a guestfish server process using:"
17961 #: ../fish/guestfish.pod:933
17964 " eval \"`guestfish --listen`\"\n"
17969 #: ../fish/guestfish.pod:935
17970 msgid "and then send it commands by doing:"
17974 #: ../fish/guestfish.pod:937
17977 " guestfish --remote cmd [...]\n"
17982 #: ../fish/guestfish.pod:939
17983 msgid "To cause the server to exit, send it the exit command:"
17987 #: ../fish/guestfish.pod:943
17989 "Note that the server will normally exit if there is an error in a command. "
17990 "You can change this in the usual way. See section L</EXIT ON ERROR "
17995 #: ../fish/guestfish.pod:947
17996 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18000 #: ../fish/guestfish.pod:949
18002 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18003 "is how the I<--remote> option knows where to send the commands. You can "
18004 "have several guestfish listener processes running using:"
18008 #: ../fish/guestfish.pod:953
18011 " eval \"`guestfish --listen`\"\n"
18012 " pid1=$GUESTFISH_PID\n"
18013 " eval \"`guestfish --listen`\"\n"
18014 " pid2=$GUESTFISH_PID\n"
18016 " guestfish --remote=$pid1 cmd\n"
18017 " guestfish --remote=$pid2 cmd\n"
18022 #: ../fish/guestfish.pod:961
18023 msgid "REMOTE CONTROL AND CSH"
18027 #: ../fish/guestfish.pod:963
18029 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18034 #: ../fish/guestfish.pod:966
18037 " eval \"`guestfish --listen --csh`\"\n"
18042 #: ../fish/guestfish.pod:968
18043 msgid "REMOTE CONTROL DETAILS"
18047 #: ../fish/guestfish.pod:970
18049 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18050 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18051 "and C<$PID> is the process ID of the server."
18055 #: ../fish/guestfish.pod:974
18056 msgid "Guestfish client and server versions must match exactly."
18060 #: ../fish/guestfish.pod:976
18061 msgid "PREPARED DISK IMAGES"
18065 #: ../fish/guestfish.pod:978
18067 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18068 "preformatted disk images that guestfish can make for you to save typing. "
18069 "This is particularly useful for testing purposes. This option is used "
18070 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18071 "can be mixed with I<-a>)."
18075 #: ../fish/guestfish.pod:984
18077 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18078 "the second and so on. Existing files in the current directory are "
18083 #: ../fish/guestfish.pod:988
18085 "The type briefly describes how the disk should be sized, partitioned, how "
18086 "filesystem(s) should be created, and how content should be added. "
18087 "Optionally the type can be followed by extra parameters, separated by C<:> "
18088 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18089 "allocated disk, containing a single partition, with the partition formatted "
18090 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18095 #: ../fish/guestfish.pod:996
18096 msgid "To list the available types and any extra parameters they take, run:"
18100 #: ../fish/guestfish.pod:1000
18102 "Note that the prepared filesystem is not mounted. You would usually have to "
18103 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18107 #: ../fish/guestfish.pod:1004
18109 "If any I<-N> or I<--new> options are given, the guest is automatically "
18114 #: ../fish/guestfish.pod:1009
18115 msgid "Create a 100MB disk with an ext4-formatted partition:"
18119 #: ../fish/guestfish.pod:1011
18122 " guestfish -N fs:ext4\n"
18127 #: ../fish/guestfish.pod:1013
18128 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18132 #: ../fish/guestfish.pod:1015
18135 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18140 #: ../fish/guestfish.pod:1017
18141 msgid "Create a blank 200MB disk:"
18145 #: ../fish/guestfish.pod:1019
18148 " guestfish -N disk:200M\n"
18153 #: ../fish/guestfish.pod:1021
18154 msgid "PROGRESS BARS"
18158 #: ../fish/guestfish.pod:1023
18160 "Some (not all) long-running commands send progress notification messages as "
18161 "they are running. Guestfish turns these messages into progress bars."
18165 #: ../fish/guestfish.pod:1027
18167 "When a command that supports progress bars takes longer than two seconds to "
18168 "run, and if progress bars are enabled, then you will see one appearing below "
18173 #: ../fish/guestfish.pod:1031
18176 " ><fs> copy-size /large-file /another-file 2048M\n"
18177 " / 10% [#####-----------------------------------------] 00:30\n"
18182 #: ../fish/guestfish.pod:1034
18184 "The spinner on the left hand side moves round once for every progress "
18185 "notification received from the backend. This is a (reasonably) golden "
18186 "assurance that the command is \"doing something\" even if the progress bar "
18187 "is not moving, because the command is able to send the progress "
18188 "notifications. When the bar reaches 100% and the command finishes, the "
18189 "spinner disappears."
18193 #: ../fish/guestfish.pod:1041
18195 "Progress bars are enabled by default when guestfish is used interactively. "
18196 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18197 "and you can disable them completely using I<--no-progress-bars>."
18201 #: ../fish/guestfish.pod:1046
18202 msgid "GUESTFISH COMMANDS"
18206 #: ../fish/guestfish.pod:1048
18208 "The commands in this section are guestfish convenience commands, in other "
18209 "words, they are not part of the L<guestfs(3)> API."
18213 #: ../fish/guestfish.pod:1051
18218 #: ../fish/guestfish.pod:1053
18227 #: ../fish/guestfish.pod:1056
18228 msgid "Without any parameter, this provides general help."
18232 #: ../fish/guestfish.pod:1058
18233 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18237 #: ../fish/guestfish.pod:1060
18238 msgid "quit | exit"
18242 #: ../fish/guestfish.pod:1062
18243 msgid "This exits guestfish. You can also use C<^D> key."
18247 #: ../fish/guestfish.pod:1064
18248 msgid "@FISH_COMMANDS@"
18252 #: ../fish/guestfish.pod:1066
18257 #: ../fish/guestfish.pod:1068 ../src/guestfs.pod:1474
18262 #: ../fish/guestfish.pod:1070 ../test-tool/libguestfs-test-tool.pod:77
18267 #: ../fish/guestfish.pod:1072
18269 "guestfish returns 0 if the commands completed without error, or 1 if there "
18274 #: ../fish/guestfish.pod:1079
18279 #: ../fish/guestfish.pod:1081
18281 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18286 #: ../fish/guestfish.pod:1084
18287 msgid "GUESTFISH_DISPLAY_IMAGE"
18291 #: ../fish/guestfish.pod:1086
18293 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
18294 "If not set, it uses L<display(1)>."
18298 #: ../fish/guestfish.pod:1089
18299 msgid "GUESTFISH_PID"
18303 #: ../fish/guestfish.pod:1091
18305 "Used with the I<--remote> option to specify the remote guestfish process to "
18306 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18310 #: ../fish/guestfish.pod:1095
18315 #: ../fish/guestfish.pod:1097
18317 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18318 "not specified, the external L<hexedit(1)> program is used."
18322 #: ../fish/guestfish.pod:1101
18327 #: ../fish/guestfish.pod:1103
18329 "If compiled with GNU readline support, various files in the home directory "
18330 "can be used. See L</FILES>."
18334 #: ../fish/guestfish.pod:1106 ../src/guestfs.pod:2969
18335 msgid "LIBGUESTFS_APPEND"
18339 #: ../fish/guestfish.pod:1108 ../src/guestfs.pod:2971
18340 msgid "Pass additional options to the guest kernel."
18344 #: ../fish/guestfish.pod:1110 ../src/guestfs.pod:2973
18345 msgid "LIBGUESTFS_DEBUG"
18349 #: ../fish/guestfish.pod:1112
18351 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18352 "effect as using the B<-v> option."
18356 #: ../fish/guestfish.pod:1115 ../src/guestfs.pod:2978
18357 msgid "LIBGUESTFS_MEMSIZE"
18361 #: ../fish/guestfish.pod:1117 ../src/guestfs.pod:2980
18363 "Set the memory allocated to the qemu process, in megabytes. For example:"
18367 #: ../fish/guestfish.pod:1120 ../src/guestfs.pod:2983
18370 " LIBGUESTFS_MEMSIZE=700\n"
18375 #: ../fish/guestfish.pod:1122 ../src/guestfs.pod:2985
18376 msgid "LIBGUESTFS_PATH"
18380 #: ../fish/guestfish.pod:1124
18382 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18383 "the discussion of paths in L<guestfs(3)>."
18387 #: ../fish/guestfish.pod:1127 ../src/guestfs.pod:2990
18388 msgid "LIBGUESTFS_QEMU"
18392 #: ../fish/guestfish.pod:1129 ../src/guestfs.pod:2992
18394 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
18395 "which was found at compile time by the configure script is used."
18399 #: ../fish/guestfish.pod:1133 ../src/guestfs.pod:2998
18400 msgid "LIBGUESTFS_TRACE"
18404 #: ../fish/guestfish.pod:1135
18405 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18409 #: ../fish/guestfish.pod:1137
18414 #: ../fish/guestfish.pod:1139
18416 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18421 #: ../fish/guestfish.pod:1142 ../src/guestfs.pod:3003
18426 #: ../fish/guestfish.pod:1144 ../src/guestfs.pod:3005
18428 "Location of temporary directory, defaults to C</tmp> except for the cached "
18429 "supermin appliance which defaults to C</var/tmp>."
18433 #: ../fish/guestfish.pod:1147 ../src/guestfs.pod:3008
18435 "If libguestfs was compiled to use the supermin appliance then the real "
18436 "appliance is cached in this directory, shared between all handles belonging "
18437 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
18438 "use in case C</var/tmp> is not large enough."
18442 #: ../fish/guestfish.pod:1155 ../fuse/guestmount.pod:288
18443 #: ../rescue/virt-rescue.pod:269
18448 #: ../fish/guestfish.pod:1159 ../fuse/guestmount.pod:292
18449 #: ../rescue/virt-rescue.pod:273
18450 msgid "$HOME/.libguestfs-tools.rc"
18454 #: ../fish/guestfish.pod:1161 ../fuse/guestmount.pod:294
18455 #: ../rescue/virt-rescue.pod:275
18456 msgid "/etc/libguestfs-tools.conf"
18460 #: ../fish/guestfish.pod:1163 ../fuse/guestmount.pod:296
18461 #: ../rescue/virt-rescue.pod:277
18463 "This configuration file controls the default read-only or read-write mode "
18464 "(I<--ro> or I<--rw>)."
18468 #: ../fish/guestfish.pod:1166
18469 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
18473 #: ../fish/guestfish.pod:1168
18474 msgid "$HOME/.guestfish"
18478 #: ../fish/guestfish.pod:1170
18480 "If compiled with GNU readline support, then the command history is saved in "
18485 #: ../fish/guestfish.pod:1173
18486 msgid "$HOME/.inputrc"
18490 #: ../fish/guestfish.pod:1175
18491 msgid "/etc/inputrc"
18495 #: ../fish/guestfish.pod:1177
18497 "If compiled with GNU readline support, then these files can be used to "
18498 "configure readline. For further information, please see L<readline(3)/"
18499 "INITIALIZATION FILE>."
18503 #: ../fish/guestfish.pod:1181
18504 msgid "To write rules which only apply to guestfish, use:"
18508 #: ../fish/guestfish.pod:1183
18518 #: ../fish/guestfish.pod:1187
18520 "Variables that you can set in inputrc that change the behaviour of guestfish "
18521 "in useful ways include:"
18525 #: ../fish/guestfish.pod:1192
18526 msgid "completion-ignore-case (default: on)"
18530 #: ../fish/guestfish.pod:1194
18532 "By default, guestfish will ignore case when tab-completing paths on the "
18537 #: ../fish/guestfish.pod:1197
18540 " set completion-ignore-case off\n"
18545 #: ../fish/guestfish.pod:1199
18546 msgid "to make guestfish case sensitive."
18550 #: ../fish/guestfish.pod:1203
18555 #: ../fish/guestfish.pod:1205
18556 msgid "test2.img (etc)"
18560 #: ../fish/guestfish.pod:1207
18562 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
18563 "will be created in the file C<test1.img> in the current directory. The "
18564 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
18565 "the same name will be overwritten."
18569 #: ../fish/guestfish.pod:1216
18571 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
18572 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
18573 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
18574 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
18575 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
18576 ">, L<display(1)>, L<hexedit(1)>."
18580 #: ../fish/guestfish.pod:1244 ../src/guestfs.pod:3093
18581 #: ../test-tool/libguestfs-test-tool.pod:99
18582 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
18586 #: ../fish/virt-copy-in.pod:5
18588 "virt-copy-in - Copy files and directories into a virtual machine disk image."
18592 #: ../fish/virt-copy-in.pod:9
18595 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
18600 #: ../fish/virt-copy-in.pod:11
18603 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
18608 #: ../fish/virt-copy-in.pod:15
18610 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
18611 "causing disk corruption. The virtual machine must be shut down before you "
18612 "use this command."
18616 #: ../fish/virt-copy-in.pod:21
18618 "C<virt-copy-in> copies files and directories from the local disk into a "
18619 "virtual machine disk image or named libvirt domain."
18623 #: ../fish/virt-copy-in.pod:24
18625 "You can give one of more filenames and directories on the command line. "
18626 "Directories are copied in recursively. The final parameter must be the "
18627 "destination directory in the disk image which must be an absolute path "
18628 "starting with a C</> character."
18632 #: ../fish/virt-copy-in.pod:33
18635 " virt-copy-in -d MyGuest resolv.conf /etc\n"
18640 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
18641 msgid "Upload a home directory to a guest:"
18645 #: ../fish/virt-copy-in.pod:37
18648 " virt-copy-in -d MyGuest skel /home\n"
18653 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28
18654 #: ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
18655 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
18659 #: ../fish/virt-copy-in.pod:41
18661 "This command is just a simple shell script wrapper around the L<guestfish(1)"
18662 "> C<copy-in> command. For anything more complex than a trivial copy, you "
18663 "are probably better off using guestfish directly."
18667 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36
18668 #: ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
18670 "Since the shell script just passes options straight to guestfish, read "
18671 "L<guestfish(1)> to see the full list of options."
18675 #: ../fish/virt-copy-in.pod:52
18677 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
18678 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18682 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55
18683 #: ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
18684 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
18688 #: ../fish/virt-copy-out.pod:5
18690 "virt-copy-out - Copy files and directories out of a virtual machine disk "
18695 #: ../fish/virt-copy-out.pod:9
18698 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
18703 #: ../fish/virt-copy-out.pod:11
18706 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
18711 #: ../fish/virt-copy-out.pod:15
18713 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
18714 "image or named libvirt domain."
18718 #: ../fish/virt-copy-out.pod:18
18720 "You can give one of more filenames and directories on the command line. "
18721 "Directories are copied out recursively."
18725 #: ../fish/virt-copy-out.pod:23
18726 msgid "Download the home directories from a virtual machine:"
18730 #: ../fish/virt-copy-out.pod:25
18734 " virt-copy-out -d MyGuest /home homes\n"
18739 #: ../fish/virt-copy-out.pod:30
18741 "This command is just a simple shell script wrapper around the L<guestfish(1)"
18742 "> C<copy-out> command. For anything more complex than a trivial copy, you "
18743 "are probably better off using guestfish directly."
18747 #: ../fish/virt-copy-out.pod:41
18749 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, L<virt-"
18750 "tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18754 #: ../fish/virt-tar-in.pod:5
18755 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
18759 #: ../fish/virt-tar-in.pod:9
18762 " virt-tar-in -a disk.img data.tar /destination\n"
18767 #: ../fish/virt-tar-in.pod:11
18770 " virt-tar-in -d domain data.tar /destination\n"
18775 #: ../fish/virt-tar-in.pod:13
18778 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
18783 #: ../fish/virt-tar-in.pod:17
18785 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
18786 "causing disk corruption. The virtual machine must be shut down before you "
18787 "use this command."
18791 #: ../fish/virt-tar-in.pod:23
18793 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
18794 "image or named libvirt domain."
18798 #: ../fish/virt-tar-in.pod:26
18800 "The first parameter is the tar file. Use C<-> to read the tar file from "
18801 "standard input. The second parameter is the absolute target directory to "
18806 #: ../fish/virt-tar-in.pod:34
18809 " virt-tar-in -d MyGuest homes.tar /home\n"
18814 #: ../fish/virt-tar-in.pod:38
18816 "This command is just a simple shell script wrapper around the L<guestfish(1)"
18817 "> C<tar-in> command. For anything more complex than a trivial copy, you are "
18818 "probably better off using guestfish directly."
18822 #: ../fish/virt-tar-in.pod:49
18824 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18825 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, L<http://libguestfs."
18830 #: ../fish/virt-tar-out.pod:5
18832 "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
18836 #: ../fish/virt-tar-out.pod:9
18839 " virt-tar-out -a disk.img /dir files.tar\n"
18844 #: ../fish/virt-tar-out.pod:11
18847 " virt-tar-out -d domain /dir files.tar\n"
18852 #: ../fish/virt-tar-out.pod:13
18855 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
18860 #: ../fish/virt-tar-out.pod:17
18862 "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
18866 #: ../fish/virt-tar-out.pod:20
18868 "The first parameter is the absolute path of the virtual machine directory. "
18869 "The second parameter is the tar file to write. Use C<-> to write to "
18874 #: ../fish/virt-tar-out.pod:26
18875 msgid "Download the home directories from a guest:"
18879 #: ../fish/virt-tar-out.pod:28
18882 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
18887 #: ../fish/virt-tar-out.pod:32
18889 "This command is just a simple shell script wrapper around the L<guestfish(1)"
18890 "> C<tar-out> command. For anything more complex than a trivial copy, you "
18891 "are probably better off using guestfish directly."
18895 #: ../fish/virt-tar-out.pod:43
18897 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18898 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
18902 #: ../fuse/guestmount.pod:5
18904 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
18908 #: ../fuse/guestmount.pod:9
18911 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
18916 #: ../fuse/guestmount.pod:11
18919 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
18924 #: ../fuse/guestmount.pod:13
18927 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
18932 #: ../fuse/guestmount.pod:17
18934 "You must I<not> use C<guestmount> in read-write mode on live virtual "
18935 "machines. If you do this, you risk disk corruption in the VM."
18939 #: ../fuse/guestmount.pod:22
18941 "The guestmount program can be used to mount virtual machine filesystems and "
18942 "other disk images on the host. It uses libguestfs for access to the guest "
18943 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
18944 "a mountable device."
18948 #: ../fuse/guestmount.pod:27
18950 "Along with other options, you have to give at least one device (I<-a> "
18951 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
18952 "option) or use the I<-i> inspection option. How this works is better "
18953 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
18958 #: ../fuse/guestmount.pod:33
18960 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
18961 "by you, and the filesystem will not be visible to any other users unless you "
18962 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
18963 "the filesystem, use the C<fusermount -u> command."
18967 #: ../fuse/guestmount.pod:41
18969 "For a typical Windows guest which has its main filesystem on the first "
18974 #: ../fuse/guestmount.pod:44
18977 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
18982 #: ../fuse/guestmount.pod:46
18984 "For a typical Linux guest which has a /boot filesystem on the first "
18985 "partition, and the root filesystem on a logical volume:"
18989 #: ../fuse/guestmount.pod:49
18992 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
18997 #: ../fuse/guestmount.pod:51
18998 msgid "To get libguestfs to detect guest mountpoints for you:"
19002 #: ../fuse/guestmount.pod:53
19005 " guestmount -a guest.img -i --ro /mnt\n"
19010 #: ../fuse/guestmount.pod:55
19011 msgid "For a libvirt guest called \"Guest\" you could do:"
19015 #: ../fuse/guestmount.pod:57
19018 " guestmount -d Guest -i --ro /mnt\n"
19023 #: ../fuse/guestmount.pod:59
19025 "If you don't know what filesystems are contained in a guest or disk image, "
19026 "use L<virt-filesystems(1)> first:"
19030 #: ../fuse/guestmount.pod:62
19033 " virt-filesystems MyGuest\n"
19038 #: ../fuse/guestmount.pod:64
19040 "If you want to trace the libguestfs calls but without excessive debugging "
19041 "information, we recommend:"
19045 #: ../fuse/guestmount.pod:67
19048 " guestmount [...] --trace /mnt\n"
19053 #: ../fuse/guestmount.pod:69
19054 msgid "If you want to debug the program, we recommend:"
19058 #: ../fuse/guestmount.pod:71
19061 " guestmount [...] --trace --verbose /mnt\n"
19066 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68
19067 #: ../resize/virt-resize.pod:486
19072 #: ../fuse/guestmount.pod:75
19073 msgid "Other users cannot see the filesystem by default"
19077 #: ../fuse/guestmount.pod:77
19079 "If you mount a filesystem as one user (eg. root), then other users will not "
19080 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
19081 "option when mounting:"
19085 #: ../fuse/guestmount.pod:81
19088 " sudo guestmount [...] -o allow_other /mnt\n"
19093 #: ../fuse/guestmount.pod:91
19094 msgid "Add a block device or virtual machine image."
19098 #: ../fuse/guestmount.pod:114
19099 msgid "B<--dir-cache-timeout N>"
19103 #: ../fuse/guestmount.pod:116
19105 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
19106 "seconds. The readdir cache [actually, there are several semi-independent "
19107 "caches] is populated after a readdir(2) call with the stat and extended "
19108 "attributes of the files in the directory, in anticipation that they will be "
19109 "requested soon after."
19113 #: ../fuse/guestmount.pod:122
19115 "There is also a different attribute cache implemented by FUSE (see the FUSE "
19116 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
19117 "requests, only cache existing ones."
19121 #: ../fuse/guestmount.pod:142
19123 "If you have untrusted raw-format guest disk images, you should use this "
19124 "option to specify the disk format. This avoids a possible security problem "
19125 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
19126 "guestfs_add_drive_opts>."
19130 #: ../fuse/guestmount.pod:147
19131 msgid "B<--fuse-help>"
19135 #: ../fuse/guestmount.pod:149
19136 msgid "Display help on special FUSE options (see I<-o> below)."
19140 #: ../fuse/guestmount.pod:153
19141 msgid "Display brief help and exit."
19145 #: ../fuse/guestmount.pod:177
19147 "Mount the named partition or logical volume on the given mountpoint B<in the "
19148 "guest> (this has nothing to do with mountpoints in the host)."
19152 #: ../fuse/guestmount.pod:180
19154 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
19155 "something on C</>."
19159 #: ../fuse/guestmount.pod:197
19161 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
19162 "unmounted. If you specify this option, then we don't attempt to sync the "
19163 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
19167 #: ../fuse/guestmount.pod:202
19168 msgid "B<-o option>"
19172 #: ../fuse/guestmount.pod:204
19173 msgid "B<--option option>"
19177 #: ../fuse/guestmount.pod:206
19178 msgid "Pass extra options to FUSE."
19182 #: ../fuse/guestmount.pod:208
19184 "To get a list of all the extra options supported by FUSE, use the command "
19185 "below. Note that only the FUSE I<-o> options can be passed, and only some "
19186 "of them are a good idea."
19190 #: ../fuse/guestmount.pod:212
19193 " guestmount --fuse-help\n"
19198 #: ../fuse/guestmount.pod:214
19199 msgid "Some potentially useful FUSE options:"
19203 #: ../fuse/guestmount.pod:218
19204 msgid "B<-o allow_other>"
19208 #: ../fuse/guestmount.pod:220
19209 msgid "Allow other users to see the filesystem."
19213 #: ../fuse/guestmount.pod:222
19214 msgid "B<-o attr_timeout=N>"
19218 #: ../fuse/guestmount.pod:224
19219 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
19223 #: ../fuse/guestmount.pod:226
19224 msgid "B<-o kernel_cache>"
19228 #: ../fuse/guestmount.pod:228
19230 "Allow the kernel to cache files (reduces the number of reads that have to go "
19231 "through the L<guestfs(3)> API). This is generally a good idea if you can "
19232 "afford the extra memory usage."
19236 #: ../fuse/guestmount.pod:232
19237 msgid "B<-o uid=N> B<-o gid=N>"
19241 #: ../fuse/guestmount.pod:234
19243 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
19244 "the chosen values."
19248 #: ../fuse/guestmount.pod:243
19250 "Add devices and mount everything read-only. Also disallow writes and make "
19251 "the disk appear read-only to FUSE."
19255 #: ../fuse/guestmount.pod:246
19257 "This is highly recommended if you are not going to edit the guest disk. If "
19258 "the guest is running and this option is I<not> supplied, then there is a "
19259 "strong risk of disk corruption in the guest. We try to prevent this from "
19260 "happening, but it is not always possible."
19264 #: ../fuse/guestmount.pod:251 ../rescue/virt-rescue.pod:171
19265 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19269 #: ../fuse/guestmount.pod:255
19270 msgid "Enable SELinux support for the guest."
19274 #: ../fuse/guestmount.pod:261
19275 msgid "Enable verbose messages from underlying libguestfs."
19279 #: ../fuse/guestmount.pod:267
19280 msgid "Display the program version and exit."
19284 #: ../fuse/guestmount.pod:276 ../fuse/guestmount.pod:299
19285 #: ../rescue/virt-rescue.pod:197 ../rescue/virt-rescue.pod:280
19286 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19290 #: ../fuse/guestmount.pod:280
19295 #: ../fuse/guestmount.pod:282
19296 msgid "Trace libguestfs calls and entry into each FUSE function."
19300 #: ../fuse/guestmount.pod:284
19301 msgid "This also stops the daemon from forking into the background."
19305 #: ../fuse/guestmount.pod:305
19307 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
19308 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
19313 #: ../fuse/guestmount.pod:320
19314 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
19318 #: ../inspector/virt-inspector.pod:5
19320 "virt-inspector - Display operating system version and other information "
19321 "about a virtual machine"
19325 #: ../inspector/virt-inspector.pod:9
19328 " virt-inspector [--options] -d domname\n"
19333 #: ../inspector/virt-inspector.pod:11
19336 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
19341 #: ../inspector/virt-inspector.pod:15
19344 " virt-inspector domname\n"
19349 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
19352 " virt-inspector disk.img [disk.img ...]\n"
19357 #: ../inspector/virt-inspector.pod:21
19359 "B<virt-inspector> examines a virtual machine or disk image and tries to "
19360 "determine the version of the operating system and other information about "
19361 "the virtual machine."
19365 #: ../inspector/virt-inspector.pod:25
19366 msgid "Virt-inspector produces XML output for feeding into other programs."
19370 #: ../inspector/virt-inspector.pod:27
19372 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
19373 "the libvirt domain (see: C<virsh list --all>)."
19377 #: ../inspector/virt-inspector.pod:30
19379 "You can also run virt-inspector directly on disk images from a single "
19380 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
19381 "has several block devices, in which case you should list several I<-a> "
19382 "options one after another, with the first corresponding to the guest's C</"
19383 "dev/sda>, the second to the guest's C</dev/sdb> and so on."
19387 #: ../inspector/virt-inspector.pod:37
19389 "You can also run virt-inspector on install disks, live CDs, bootable USB "
19390 "keys and similar."
19394 #: ../inspector/virt-inspector.pod:40
19396 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
19397 "inspect several virtual machines, you have to run virt-inspector several "
19398 "times (for example, from a shell script for-loop)."
19402 #: ../inspector/virt-inspector.pod:45
19404 "Because virt-inspector needs direct access to guest images, it won't "
19405 "normally work over remote libvirt connections."
19409 #: ../inspector/virt-inspector.pod:48
19411 "All of the information available from virt-inspector is also available "
19412 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
19413 "The same information can also be fetched using guestfish or via libguestfs "
19414 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
19415 "WITH OTHER PROGRAMMING LANGUAGES>)."
19419 #: ../inspector/virt-inspector.pod:81
19421 "Libvirt is only used if you specify a C<domname> on the command line. If "
19422 "you specify guest block devices directly (I<-a>), then libvirt is not used "
19427 #: ../inspector/virt-inspector.pod:94
19429 "When prompting for keys and passphrases, virt-inspector normally turns "
19430 "echoing off so you cannot see what you are typing. If you are not worried "
19431 "about Tempest attacks and there is no one else in the room you can specify "
19432 "this flag to see what you are typing."
19436 #: ../inspector/virt-inspector.pod:103 ../tools/virt-list-filesystems.pl:93
19437 #: ../tools/virt-list-partitions.pl:94 ../tools/virt-tar.pl:143
19438 #: ../tools/virt-win-reg.pl:144
19440 "Specify the format of disk images given on the command line. If this is "
19441 "omitted then the format is autodetected from the content of the disk image."
19445 #: ../inspector/virt-inspector.pod:107 ../tools/virt-list-filesystems.pl:97
19446 #: ../tools/virt-list-partitions.pl:98 ../tools/virt-tar.pl:147
19447 #: ../tools/virt-win-reg.pl:148
19449 "If disk images are requested from libvirt, then this program asks libvirt "
19450 "for this information. In this case, the value of the format parameter is "
19455 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:314
19456 #: ../resize/virt-resize.pod:400 ../tools/virt-list-filesystems.pl:101
19457 #: ../tools/virt-list-partitions.pl:102 ../tools/virt-tar.pl:151
19458 #: ../tools/virt-win-reg.pl:152
19460 "If working with untrusted raw-format guest disk images, you should ensure "
19461 "the format is always specified."
19465 #: ../inspector/virt-inspector.pod:139
19466 msgid "Previous versions of virt-inspector allowed you to write either:"
19470 #: ../inspector/virt-inspector.pod:145
19473 " virt-inspector guestname\n"
19478 #: ../inspector/virt-inspector.pod:153
19483 #: ../inspector/virt-inspector.pod:155
19485 "The virt-inspector XML is described precisely in a RELAX NG schema file "
19486 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
19487 "just an overview."
19491 #: ../inspector/virt-inspector.pod:159
19493 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
19494 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
19495 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
19496 "which is vanishingly rare in real world VMs."
19500 #: ../inspector/virt-inspector.pod:164
19501 msgid "E<lt>operatingsystemE<gt>"
19505 #: ../inspector/virt-inspector.pod:166
19507 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
19508 "describe the operating system, its architecture, the descriptive \"product "
19509 "name\" string, the type of OS and so on, as in this example:"
19513 #: ../inspector/virt-inspector.pod:170
19516 " <operatingsystems>\n"
19517 " <operatingsystem>\n"
19518 " <root>/dev/sda2</root>\n"
19519 " <name>windows</name>\n"
19520 " <arch>i386</arch>\n"
19521 " <distro>windows</distro>\n"
19522 " <product_name>Windows 7 Enterprise</product_name>\n"
19523 " <product_variant>Client</product_variant>\n"
19524 " <major_version>6</major_version>\n"
19525 " <minor_version>1</minor_version>\n"
19526 " <windows_systemroot>/Windows</windows_systemroot>\n"
19527 " <format>installed</format>\n"
19532 #: ../inspector/virt-inspector.pod:183
19534 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
19535 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
19536 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
19537 "architecture. The other fields are fairly self-explanatory, but because "
19538 "these fields are taken directly from the libguestfs inspection API you can "
19539 "find precise information from L<guestfs(3)/INSPECTION>."
19543 #: ../inspector/virt-inspector.pod:191
19545 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
19546 "of view of libguestfs (block devices may have completely different names "
19547 "inside the VM itself)."
19551 #: ../inspector/virt-inspector.pod:195
19552 msgid "E<lt>mountpointsE<gt>"
19556 #: ../inspector/virt-inspector.pod:197
19558 "Un*x-like guests typically have multiple filesystems which are mounted at "
19559 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
19560 "element which looks like this:"
19564 #: ../inspector/virt-inspector.pod:201
19567 " <operatingsystems>\n"
19568 " <operatingsystem>\n"
19571 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
19572 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
19573 " </mountpoints>\n"
19578 #: ../inspector/virt-inspector.pod:209
19580 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
19581 "and may have completely different names inside the guest. Only mountable "
19582 "filesystems appear in this list, not things like swap devices."
19586 #: ../inspector/virt-inspector.pod:214
19587 msgid "E<lt>filesystemsE<gt>"
19591 #: ../inspector/virt-inspector.pod:216
19593 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
19594 "filesystems belonging to the guest, including swap and empty partitions. "
19595 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
19596 "this OS or shared with this OS and other OSes)."
19600 #: ../inspector/virt-inspector.pod:222
19601 msgid "You might see something like this:"
19605 #: ../inspector/virt-inspector.pod:224
19608 " <operatingsystems>\n"
19609 " <operatingsystem>\n"
19612 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19613 " <type>ext4</type>\n"
19614 " <label>Fedora-13-x86_64</label>\n"
19615 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
19621 #: ../inspector/virt-inspector.pod:234
19623 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
19624 "the label, and the UUID."
19628 #: ../inspector/virt-inspector.pod:237
19629 msgid "E<lt>applicationsE<gt>"
19633 #: ../inspector/virt-inspector.pod:239
19635 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
19636 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
19641 #: ../inspector/virt-inspector.pod:243
19643 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
19644 "Typical values would be C<rpm> and C<deb>."
19648 #: ../inspector/virt-inspector.pod:246
19650 "E<lt>package_managementE<gt>, if present, describes the package manager. "
19651 "Typical values include C<yum>, C<up2date> and C<apt>"
19655 #: ../inspector/virt-inspector.pod:249
19656 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
19660 #: ../inspector/virt-inspector.pod:252
19663 " <operatingsystems>\n"
19664 " <operatingsystem>\n"
19666 " <applications>\n"
19668 " <name>coreutils</name>\n"
19669 " <version>8.5</version>\n"
19670 " <release>1</release>\n"
19671 " </application>\n"
19676 #: ../inspector/virt-inspector.pod:262
19678 "The version and release fields may not be available for some types guests. "
19679 "Other fields are possible, see L<guestfs(3)/"
19680 "guestfs_inspect_list_applications>."
19684 #: ../inspector/virt-inspector.pod:266
19685 msgid "E<lt>drive_mappingsE<gt>"
19689 #: ../inspector/virt-inspector.pod:268
19691 "For operating systems like Windows which use drive letters, virt-inspector "
19692 "is able to find out how drive letters map to filesystems."
19696 #: ../inspector/virt-inspector.pod:272
19699 " <operatingsystems>\n"
19700 " <operatingsystem>\n"
19702 " <drive_mappings>\n"
19703 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
19704 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
19705 " </drive_mappings>\n"
19710 #: ../inspector/virt-inspector.pod:280
19712 "In the example above, drive C maps to the filesystem on the second partition "
19713 "on the first disk, and drive E maps to the filesystem on the first partition "
19714 "on the second disk."
19718 #: ../inspector/virt-inspector.pod:284
19720 "Note that this only covers permanent local filesystem mappings, not things "
19721 "like network shares. Furthermore NTFS volume mount points may not be listed "
19726 #: ../inspector/virt-inspector.pod:288
19727 msgid "E<lt>iconE<gt>"
19731 #: ../inspector/virt-inspector.pod:290
19733 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
19734 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
19735 "very large and high quality."
19739 #: ../inspector/virt-inspector.pod:294
19742 " <operatingsystems>\n"
19743 " <operatingsystem>\n"
19746 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
19747 " [... many lines of base64 data ...]\n"
19753 #: ../inspector/virt-inspector.pod:302
19755 "To display the icon, you have to extract it and convert the base64 data back "
19756 "to a binary file. Use an XPath query or simply an editor to extract the "
19757 "data, then use the coreutils L<base64(1)> program to do the conversion back "
19762 #: ../inspector/virt-inspector.pod:307
19765 " base64 -i -d < icon.data > icon.png\n"
19770 #: ../inspector/virt-inspector.pod:309
19771 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
19775 #: ../inspector/virt-inspector.pod:311
19777 "Virt-inspector can detect some operating system installers on install disks, "
19778 "live CDs, bootable USB keys and more."
19782 #: ../inspector/virt-inspector.pod:314
19784 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
19785 "fields may be present to indicate a live CD, network installer, or one part "
19786 "of a multipart CD. For example:"
19790 #: ../inspector/virt-inspector.pod:318
19793 " <operatingsystems>\n"
19794 " <operatingsystem>\n"
19795 " <root>/dev/sda</root>\n"
19796 " <name>linux</name>\n"
19797 " <arch>i386</arch>\n"
19798 " <distro>ubuntu</distro>\n"
19799 " <product_name>Ubuntu 10.10 "Maverick Meerkat"</product_name>\n"
19800 " <major_version>10</major_version>\n"
19801 " <minor_version>10</minor_version>\n"
19802 " <format>installer</format>\n"
19808 #: ../inspector/virt-inspector.pod:330
19809 msgid "USING XPATH"
19813 #: ../inspector/virt-inspector.pod:332
19815 "You can use the XPath query language, and/or the xpath tool, in order to "
19816 "select parts of the XML."
19820 #: ../inspector/virt-inspector.pod:337
19823 " $ virt-inspector -d Guest | xpath //filesystems\n"
19824 " Found 1 nodes:\n"
19827 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19828 " <type>ext4</type>\n"
19834 #: ../inspector/virt-inspector.pod:345
19837 " $ virt-inspector -d Guest | \\\n"
19838 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
19839 " Query didn't return a nodeset. Value: ext4\n"
19844 #: ../inspector/virt-inspector.pod:356
19845 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
19849 #: ../inspector/virt-inspector.pod:358
19851 "Early versions of libguestfs shipped with a different virt-inspector program "
19852 "written in Perl (the current version is written in C). The XML output of "
19853 "the Perl virt-inspector was different and it could also output in other "
19854 "formats like text."
19858 #: ../inspector/virt-inspector.pod:363
19860 "The old virt-inspector is no longer supported or shipped with libguestfs."
19864 #: ../inspector/virt-inspector.pod:366
19866 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
19867 "versions of virt-inspector with different names:"
19871 #: ../inspector/virt-inspector.pod:369
19874 " virt-inspector Old Perl version.\n"
19875 " virt-inspector2 New C version.\n"
19880 #: ../inspector/virt-inspector.pod:374
19882 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, L<base64(1)"
19883 ">, L<http://libguestfs.org/>."
19887 #: ../inspector/virt-inspector.pod:390
19888 msgid "Matthew Booth L<mbooth@redhat.com>"
19892 #: ../java/examples/guestfs-java.pod:5
19893 msgid "guestfs-java - How to use libguestfs from Java"
19897 #: ../java/examples/guestfs-java.pod:9
19900 " import com.redhat.et.libguestfs.*;\n"
19905 #: ../java/examples/guestfs-java.pod:11
19908 " GuestFS g = new GuestFS ();\n"
19909 " g.add_drive_opts (\"disk.img\", null);\n"
19915 #: ../java/examples/guestfs-java.pod:17
19917 "This manual page documents how to call libguestfs from the Java programming "
19918 "language. This page just documents the differences from the C API and gives "
19919 "some examples. If you are not familiar with using libguestfs, you also need "
19920 "to read L<guestfs(3)>."
19924 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
19925 msgid "CLOSING THE HANDLE"
19929 #: ../java/examples/guestfs-java.pod:24
19931 "The handle is closed when it is reaped by the garbage collector. Because "
19932 "libguestfs handles include a lot of state, it is also possible to close (and "
19933 "hence free) them explicitly by calling the C<close> method."
19937 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60
19938 #: ../python/examples/guestfs-python.pod:21
19939 #: ../ruby/examples/guestfs-ruby.pod:22
19944 #: ../java/examples/guestfs-java.pod:31
19946 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
19947 "exception. This has a single parameter which is the error message (a "
19952 #: ../java/examples/guestfs-java.pod:35
19953 msgid "Calling any method on a closed handle raises the same exception."
19957 #: ../java/examples/guestfs-java.pod:47
19959 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)"
19960 ">, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
19961 "libguestfs.org/>, L<http://caml.inria.fr/>."
19965 #: ../java/examples/guestfs-java.pod:63 ../perl/examples/guestfs-perl.pod:57
19966 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
19970 #: ../ocaml/examples/guestfs-ocaml.pod:5
19971 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
19975 #: ../ocaml/examples/guestfs-ocaml.pod:9
19976 msgid "Module style:"
19980 #: ../ocaml/examples/guestfs-ocaml.pod:11
19983 " let g = Guestfs.create () in\n"
19984 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19985 " Guestfs.launch g;\n"
19990 #: ../ocaml/examples/guestfs-ocaml.pod:15
19991 msgid "Object-oriented style:"
19995 #: ../ocaml/examples/guestfs-ocaml.pod:17
19998 " let g = new Guestfs.guestfs () in\n"
19999 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
20005 #: ../ocaml/examples/guestfs-ocaml.pod:21
20008 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
20010 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
20015 #: ../ocaml/examples/guestfs-ocaml.pod:27
20017 "This manual page documents how to call libguestfs from the OCaml programming "
20018 "language. This page just documents the differences from the C API and gives "
20019 "some examples. If you are not familiar with using libguestfs, you also need "
20020 "to read L<guestfs(3)>."
20024 #: ../ocaml/examples/guestfs-ocaml.pod:32
20025 msgid "PROGRAMMING STYLES"
20029 #: ../ocaml/examples/guestfs-ocaml.pod:34
20031 "There are two different programming styles supported by the OCaml bindings. "
20032 "You can use a module style, with each C function mapped to an OCaml function:"
20036 #: ../ocaml/examples/guestfs-ocaml.pod:38
20039 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
20044 #: ../ocaml/examples/guestfs-ocaml.pod:40
20049 #: ../ocaml/examples/guestfs-ocaml.pod:42
20052 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
20057 #: ../ocaml/examples/guestfs-ocaml.pod:44
20059 "Alternately you can use an object-oriented style, calling methods on the "
20060 "class C<Guestfs.guestfs>:"
20064 #: ../ocaml/examples/guestfs-ocaml.pod:47
20067 " method set_verbose : bool -> unit\n"
20072 #: ../ocaml/examples/guestfs-ocaml.pod:49
20074 "The object-oriented style is usually briefer, and the minor performance "
20075 "penalty isn't noticable in the general overhead of performing libguestfs "
20080 #: ../ocaml/examples/guestfs-ocaml.pod:55
20082 "The handle is closed when it is reaped by the garbage collector. Because "
20083 "libguestfs handles include a lot of state, it is also possible to close (and "
20084 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
20089 #: ../ocaml/examples/guestfs-ocaml.pod:62
20091 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
20092 "exception. This has a single parameter which is the error message (a "
20097 #: ../ocaml/examples/guestfs-ocaml.pod:66
20099 "Calling any function/method on a closed handle raises C<Guestfs."
20100 "Handle_closed>. The single parameter is the name of the function that you "
20105 #: ../ocaml/examples/guestfs-ocaml.pod:80
20107 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-perl(3)"
20108 ">, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
20109 "libguestfs.org/>, L<http://caml.inria.fr/>."
20113 #: ../perl/examples/guestfs-perl.pod:5
20114 msgid "guestfs-perl - How to use libguestfs from Perl"
20118 #: ../perl/examples/guestfs-perl.pod:9
20121 " use Sys::Guestfs;\n"
20126 #: ../perl/examples/guestfs-perl.pod:11
20129 " my $h = Sys::Guestfs->new ();\n"
20130 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
20131 " $h->launch ();\n"
20132 " $h->mount_options ('', '/dev/sda1', '/');\n"
20133 " $h->touch ('/hello');\n"
20139 #: ../perl/examples/guestfs-perl.pod:20
20141 "This manual page documents how to call libguestfs from the Perl programming "
20142 "language. This page just documents the differences from the C API and gives "
20143 "some examples. If you are not familiar with using libguestfs, you also need "
20144 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
20148 #: ../perl/examples/guestfs-perl.pod:26
20153 #: ../perl/examples/guestfs-perl.pod:28
20155 "Errors from libguestfs functions turn into calls to C<croak> (see L<Carp(3)"
20160 #: ../perl/examples/guestfs-perl.pod:41
20162 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)"
20163 ">, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
20164 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
20168 #: ../python/examples/guestfs-python.pod:5
20169 msgid "guestfs-python - How to use libguestfs from Python"
20173 #: ../python/examples/guestfs-python.pod:9
20176 " import guestfs\n"
20177 " g = guestfs.GuestFS ()\n"
20178 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
20184 #: ../python/examples/guestfs-python.pod:16
20186 "This manual page documents how to call libguestfs from the Python "
20187 "programming language. This page just documents the differences from the C "
20188 "API and gives some examples. If you are not familiar with using libguestfs, "
20189 "you also need to read L<guestfs(3)>."
20193 #: ../python/examples/guestfs-python.pod:23
20195 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
20196 "single string argument which is the error message."
20200 #: ../python/examples/guestfs-python.pod:26
20201 msgid "MORE DOCUMENTATION"
20205 #: ../python/examples/guestfs-python.pod:28
20210 #: ../python/examples/guestfs-python.pod:30
20214 " >>> import guestfs\n"
20215 " >>> help (guestfs)\n"
20220 #: ../python/examples/guestfs-python.pod:44
20222 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
20223 ">, L<guestfs-perl(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
20224 "libguestfs.org/>."
20228 #: ../rescue/virt-rescue.pod:5
20229 msgid "virt-rescue - Run a rescue shell on a virtual machine"
20233 #: ../rescue/virt-rescue.pod:9
20236 " virt-rescue [--options] -d domname\n"
20241 #: ../rescue/virt-rescue.pod:11
20244 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
20249 #: ../rescue/virt-rescue.pod:15
20252 " virt-rescue [--options] domname\n"
20257 #: ../rescue/virt-rescue.pod:17
20260 " virt-rescue [--options] disk.img [disk.img ...]\n"
20265 #: ../rescue/virt-rescue.pod:21
20267 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
20268 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
20269 "you from doing this, but doesn't catch all cases."
20273 #: ../rescue/virt-rescue.pod:25
20275 "However if you use the I<--ro> (read only) option, then you can attach a "
20276 "shell to a live virtual machine. The results might be strange or "
20277 "inconsistent at times but you won't get disk corruption."
20281 #: ../rescue/virt-rescue.pod:31
20283 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
20284 "need for a CD. virt-rescue gives you a rescue shell and some simple "
20285 "recovery tools which you can use to examine or rescue a virtual machine or "
20290 #: ../rescue/virt-rescue.pod:36
20292 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
20293 "on disk image(s):"
20297 #: ../rescue/virt-rescue.pod:39
20300 " virt-rescue -d GuestName\n"
20305 #: ../rescue/virt-rescue.pod:41
20308 " virt-rescue --ro -a /path/to/disk.img\n"
20313 #: ../rescue/virt-rescue.pod:43
20316 " virt-rescue -a /dev/sdc\n"
20321 #: ../rescue/virt-rescue.pod:45
20322 msgid "For live VMs you I<must> use the --ro option."
20326 #: ../rescue/virt-rescue.pod:47
20328 "When you run virt-rescue on a virtual machine or disk image, you are placed "
20329 "in an interactive bash shell where you can use many ordinary Linux "
20330 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
20331 "appliance. You must mount the virtual machine's filesystems by hand. There "
20332 "is an empty directory called C</sysroot> where you can mount filesystems."
20336 #: ../rescue/virt-rescue.pod:54
20338 "In the example below, we list logical volumes, then choose one to mount "
20339 "under C</sysroot>:"
20343 #: ../rescue/virt-rescue.pod:57
20347 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
20348 " lv_root vg_f11x64 -wi-a- 8.83G\n"
20349 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
20350 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
20351 " ><rescue> ls /sysroot\n"
20356 #: ../rescue/virt-rescue.pod:64
20358 "If you don't know what filesystems are available on the virtual machine then "
20359 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
20363 #: ../rescue/virt-rescue.pod:70
20365 "Virt-rescue can be used on I<any> disk image file or device, not just a "
20366 "virtual machine. For example you can use it on a blank file if you want to "
20367 "partition that file (although we would recommend using L<guestfish(1)> "
20368 "instead as it is more suitable for this purpose). You can even use virt-"
20369 "rescue on things like SD cards."
20373 #: ../rescue/virt-rescue.pod:76
20375 "Virt-rescue does not require root. You only need to run it as root if you "
20376 "need root to open the disk image."
20380 #: ../rescue/virt-rescue.pod:79
20382 "This tool is just designed for quick interactive hacking on a virtual "
20383 "machine. For more structured access to a virtual machine disk image, you "
20384 "should use L<guestfs(3)>. To get a structured shell that you can use to "
20385 "make scripted changes to guests, use L<guestfish(1)>."
20389 #: ../rescue/virt-rescue.pod:103
20390 msgid "B<--append kernelopts>"
20394 #: ../rescue/virt-rescue.pod:105
20395 msgid "Pass additional options to the rescue kernel."
20399 #: ../rescue/virt-rescue.pod:135
20402 " virt-rescue --format=raw -a disk.img\n"
20407 #: ../rescue/virt-rescue.pod:139
20410 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
20415 #: ../rescue/virt-rescue.pod:148
20420 #: ../rescue/virt-rescue.pod:150
20421 msgid "B<--memsize MB>"
20425 #: ../rescue/virt-rescue.pod:152
20427 "Change the amount of memory allocated to the rescue system. The default is "
20428 "set by libguestfs and is small but adequate for running system tools. The "
20429 "occasional program might need more memory. The parameter is specified in "
20434 #: ../rescue/virt-rescue.pod:157
20435 msgid "B<--network>"
20439 #: ../rescue/virt-rescue.pod:159
20440 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
20444 #: ../rescue/virt-rescue.pod:165
20445 msgid "Open the image read-only."
20449 #: ../rescue/virt-rescue.pod:175
20451 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
20452 "SELINUX> before using this option."
20456 #: ../rescue/virt-rescue.pod:194
20458 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
20459 "are done read-write."
20463 #: ../rescue/virt-rescue.pod:207
20464 msgid "Previous versions of virt-rescue allowed you to write either:"
20468 #: ../rescue/virt-rescue.pod:209
20471 " virt-rescue disk.img [disk.img ...]\n"
20476 #: ../rescue/virt-rescue.pod:213
20479 " virt-rescue guestname\n"
20484 #: ../rescue/virt-rescue.pod:221
20489 #: ../rescue/virt-rescue.pod:223
20491 "Adding the I<--network> option enables QEMU user networking in the rescue "
20492 "appliance. There are some differences between user networking and ordinary "
20497 #: ../rescue/virt-rescue.pod:229
20498 msgid "ping does not work"
20502 #: ../rescue/virt-rescue.pod:231
20504 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
20505 "send the ping packets, and because virt-rescue must be able to run as non-"
20506 "root, QEMU user networking is not able to emulate the L<ping(8)> command. "
20507 "The ping command will appear to resolve addresses but will not be able to "
20508 "send or receive any packets. This does not mean that the network is not "
20513 #: ../rescue/virt-rescue.pod:238
20514 msgid "cannot receive connections"
20518 #: ../rescue/virt-rescue.pod:240
20519 msgid "QEMU user networking cannot receive incoming connections."
20523 #: ../rescue/virt-rescue.pod:242
20524 msgid "making TCP connections"
20528 #: ../rescue/virt-rescue.pod:244
20530 "The virt-rescue appliance needs to be small and so does not include many "
20531 "network tools. In particular there is no L<telnet(1)> command. You can "
20532 "make TCP connections from the shell using the magical C</dev/tcp/"
20533 "E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
20537 #: ../rescue/virt-rescue.pod:249
20540 " exec 3<>/dev/tcp/redhat.com/80\n"
20541 " echo \"GET /\" >&3\n"
20547 #: ../rescue/virt-rescue.pod:253
20548 msgid "See L<bash(1)> for more details."
20552 #: ../rescue/virt-rescue.pod:259
20554 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
20555 "ENVIRONMENT VARIABLES> for the complete list."
20559 #: ../rescue/virt-rescue.pod:286
20561 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<http://"
20562 "libguestfs.org/>."
20566 #: ../resize/virt-resize.pod:5
20567 msgid "virt-resize - Resize a virtual machine disk"
20571 #: ../resize/virt-resize.pod:9
20574 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
20575 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
20576 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
20581 #: ../resize/virt-resize.pod:15
20583 "Virt-resize is a tool which can resize a virtual machine disk, making it "
20584 "larger or smaller overall, and resizing or deleting any partitions contained "
20589 #: ../resize/virt-resize.pod:19
20591 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
20592 "not> be used on live virtual machines - for consistent results, shut the "
20593 "virtual machine down before resizing it."
20597 #: ../resize/virt-resize.pod:23
20599 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
20600 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
20604 #: ../resize/virt-resize.pod:31 ../src/guestfs.pod:469 ../src/guestfs.pod:1257
20605 #: ../src/guestfs.pod:1395 ../src/guestfs.pod:2465
20610 #: ../resize/virt-resize.pod:33
20612 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
20613 "fill the extra 5GB of space."
20617 #: ../resize/virt-resize.pod:36
20620 " virt-filesystems --long -h --all -a olddisk\n"
20625 #: ../resize/virt-resize.pod:38
20628 " truncate -r olddisk newdisk\n"
20629 " truncate -s +5G newdisk\n"
20634 #: ../resize/virt-resize.pod:41
20637 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
20638 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
20643 #: ../resize/virt-resize.pod:44 ../src/guestfs.pod:475 ../src/guestfs.pod:1261
20644 #: ../src/guestfs.pod:1399 ../src/guestfs.pod:2490
20649 #: ../resize/virt-resize.pod:46
20651 "As above, but make the /boot partition 200MB bigger, while giving the "
20652 "remaining space to /dev/sda2:"
20656 #: ../resize/virt-resize.pod:49
20659 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20660 " olddisk newdisk\n"
20665 #: ../resize/virt-resize.pod:52 ../src/guestfs.pod:486 ../src/guestfs.pod:1405
20670 #: ../resize/virt-resize.pod:54
20672 "As in the first example, but expand a logical volume as the final step. "
20673 "This is what you would typically use for Linux guests that use LVM:"
20677 #: ../resize/virt-resize.pod:58
20680 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
20681 " olddisk newdisk\n"
20686 #: ../resize/virt-resize.pod:61
20691 #: ../resize/virt-resize.pod:63
20693 "As in the first example, but the output format will be qcow2 instead of a "
20698 #: ../resize/virt-resize.pod:66
20701 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
20702 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
20707 #: ../resize/virt-resize.pod:71
20708 msgid "DETAILED USAGE"
20712 #: ../resize/virt-resize.pod:73
20713 msgid "EXPANDING A VIRTUAL MACHINE DISK"
20717 #: ../resize/virt-resize.pod:77
20718 msgid "1. Shut down the virtual machine"
20722 #: ../resize/virt-resize.pod:79
20723 msgid "2. Locate input disk image"
20727 #: ../resize/virt-resize.pod:81
20729 "Locate the input disk image (ie. the file or device on the host containing "
20730 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
20731 "dumpxml> like this to find the disk image name:"
20735 #: ../resize/virt-resize.pod:85
20738 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
20739 " Found 1 nodes:\n"
20741 " <source dev=\"/dev/vg/lv_guest\" />\n"
20746 #: ../resize/virt-resize.pod:90
20747 msgid "3. Look at current sizing"
20751 #: ../resize/virt-resize.pod:92
20752 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
20756 #: ../resize/virt-resize.pod:95
20759 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
20760 " Name Type Size Parent\n"
20761 " /dev/sda1 partition 101M /dev/sda\n"
20762 " /dev/sda2 partition 7.9G /dev/sda\n"
20763 " /dev/sda device 8.0G -\n"
20768 #: ../resize/virt-resize.pod:101
20770 "(This example is a virtual machine with an 8 GB disk which we would like to "
20771 "expand up to 10 GB)."
20775 #: ../resize/virt-resize.pod:104
20776 msgid "4. Create output disk"
20780 #: ../resize/virt-resize.pod:106
20782 "Virt-resize cannot do in-place disk modifications. You have to have space "
20783 "to store the resized output disk."
20787 #: ../resize/virt-resize.pod:109
20789 "To store the resized disk image in a file, create a file of a suitable size:"
20793 #: ../resize/virt-resize.pod:112
20796 " # rm -f outdisk\n"
20797 " # truncate -s 10G outdisk\n"
20802 #: ../resize/virt-resize.pod:115
20803 msgid "Or use L<lvcreate(1)> to create a logical volume:"
20807 #: ../resize/virt-resize.pod:117
20810 " # lvcreate -L 10G -n lv_name vg_name\n"
20815 #: ../resize/virt-resize.pod:119
20816 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
20820 #: ../resize/virt-resize.pod:121
20823 " # virsh pool-list\n"
20824 " # virsh vol-create-as poolname newvol 10G\n"
20829 #: ../resize/virt-resize.pod:124
20834 #: ../resize/virt-resize.pod:126
20836 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
20837 "file) and the output disk. The output disk is the one created in the "
20842 #: ../resize/virt-resize.pod:130
20845 " # virt-resize indisk outdisk\n"
20850 #: ../resize/virt-resize.pod:132
20852 "This command just copies disk image C<indisk> to disk image C<outdisk> "
20853 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
20854 "larger, then an extra, empty partition is created at the end of the disk "
20855 "covering the extra space. If C<outdisk> is smaller, then it will give an "
20860 #: ../resize/virt-resize.pod:138
20862 "More realistically you'd want to expand existing partitions in the disk "
20863 "image by passing extra options (for the full list see the L</OPTIONS> "
20868 #: ../resize/virt-resize.pod:142
20870 "L</--expand> is the most useful option. It expands the named partition "
20871 "within the disk to fill any extra space:"
20875 #: ../resize/virt-resize.pod:145
20878 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
20883 #: ../resize/virt-resize.pod:147
20885 "(In this case, an extra partition is I<not> created at the end of the disk, "
20886 "because there will be no unused space)."
20890 #: ../resize/virt-resize.pod:150
20892 "L</--resize> is the other commonly used option. The following would "
20893 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
20894 "rest of the available space:"
20898 #: ../resize/virt-resize.pod:154
20901 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20902 " indisk outdisk\n"
20907 #: ../resize/virt-resize.pod:157
20909 "If the expanded partition in the image contains a filesystem or LVM PV, then "
20910 "if virt-resize knows how, it will resize the contents, the equivalent of "
20911 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
20912 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
20913 "filesystems, so you would have to online resize them after booting the guest."
20917 #: ../resize/virt-resize.pod:164
20918 msgid "Other options are covered below."
20922 #: ../resize/virt-resize.pod:166
20927 #: ../resize/virt-resize.pod:168
20928 msgid "Thoroughly test the new disk image I<before> discarding the old one."
20932 #: ../resize/virt-resize.pod:170
20933 msgid "If you are using libvirt, edit the XML to point at the new disk:"
20937 #: ../resize/virt-resize.pod:172
20940 " # virsh edit guestname\n"
20945 #: ../resize/virt-resize.pod:174
20947 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
20948 "html#elementsDisks>"
20952 #: ../resize/virt-resize.pod:177
20953 msgid "Then start up the domain with the new, resized disk:"
20957 #: ../resize/virt-resize.pod:179
20960 " # virsh start guestname\n"
20965 #: ../resize/virt-resize.pod:181
20967 "and check that it still works. See also the L</NOTES> section below for "
20968 "additional information."
20972 #: ../resize/virt-resize.pod:184
20973 msgid "7. Resize LVs etc inside the guest"
20977 #: ../resize/virt-resize.pod:186
20978 msgid "(This can also be done offline using L<guestfish(1)>)"
20982 #: ../resize/virt-resize.pod:188
20984 "Once the guest has booted you should see the new space available, at least "
20985 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
20986 "may need to resize LVs inside PVs, and also resize filesystem types that "
20987 "virt-resize does not know how to expand."
20991 #: ../resize/virt-resize.pod:195
20992 msgid "SHRINKING A VIRTUAL MACHINE DISK"
20996 #: ../resize/virt-resize.pod:197
20998 "Shrinking is somewhat more complex than expanding, and only an overview is "
21003 #: ../resize/virt-resize.pod:200
21005 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
21006 "filesystems). The user has to shrink content before passing the disk image "
21007 "to virt-resize, and virt-resize will check that the content has been shrunk "
21012 #: ../resize/virt-resize.pod:205
21013 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
21017 #: ../resize/virt-resize.pod:207
21019 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
21020 "steps 3 and 4 above to allocate a new disk image."
21024 #: ../resize/virt-resize.pod:210
21026 "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
21030 #: ../resize/virt-resize.pod:213
21031 msgid "IGNORING OR DELETING PARTITIONS"
21035 #: ../resize/virt-resize.pod:215
21037 "virt-resize also gives a convenient way to ignore or delete partitions when "
21038 "copying from the input disk to the output disk. Ignoring a partition speeds "
21039 "up the copy where you don't care about the existing contents of a "
21040 "partition. Deleting a partition removes it completely, but note that it "
21041 "also renumbers any partitions after the one which is deleted, which can "
21042 "leave some guests unbootable."
21046 #: ../resize/virt-resize.pod:222
21047 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
21051 #: ../resize/virt-resize.pod:224
21053 "If the input disk is in qcow2 format, then you may prefer that the output is "
21054 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
21055 "the fly. The output format is simply determined by the format of the empty "
21056 "output container that you provide. Thus to create qcow2 output, use:"
21060 #: ../resize/virt-resize.pod:230
21063 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
21068 #: ../resize/virt-resize.pod:232
21069 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
21073 #: ../resize/virt-resize.pod:234
21074 msgid "Similarly, to get non-sparse raw output use:"
21078 #: ../resize/virt-resize.pod:236
21081 " fallocate -l size outdisk\n"
21086 #: ../resize/virt-resize.pod:238
21088 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
21089 "dev/zero of=outdisk bs=1M count=..>)"
21093 #: ../resize/virt-resize.pod:247
21094 msgid "Display help."
21098 #: ../resize/virt-resize.pod:249
21103 #: ../resize/virt-resize.pod:251 ../tools/virt-make-fs.pl:177
21104 #: ../tools/virt-win-reg.pl:120
21109 #: ../resize/virt-resize.pod:253 ../tools/virt-win-reg.pl:122
21110 msgid "Enable debugging messages."
21114 #: ../resize/virt-resize.pod:255
21115 msgid "B<--delete part>"
21119 #: ../resize/virt-resize.pod:257
21121 "Delete the named partition. It would be more accurate to describe this as "
21122 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
21123 "the original disk image is left intact."
21127 #: ../resize/virt-resize.pod:261
21129 "Note that when you delete a partition, then anything contained in the "
21130 "partition is also deleted. Furthermore, this causes any partitions that "
21131 "come after to be I<renumbered>, which can easily make your guest unbootable."
21135 #: ../resize/virt-resize.pod:266 ../resize/virt-resize.pod:327
21136 #: ../resize/virt-resize.pod:448
21137 msgid "You can give this option multiple times."
21141 #: ../resize/virt-resize.pod:268
21142 msgid "B<--expand part>"
21146 #: ../resize/virt-resize.pod:270
21148 "Expand the named partition so it uses up all extra space (space left over "
21149 "after any other resize changes that you request have been done)."
21153 #: ../resize/virt-resize.pod:273
21155 "If virt-resize knows how, it will expand the direct content of the "
21156 "partition. For example, if the partition is an LVM PV, it will expand the "
21157 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
21158 "content it doesn't know about alone."
21162 #: ../resize/virt-resize.pod:278
21163 msgid "Currently virt-resize can resize:"
21167 #: ../resize/virt-resize.pod:284
21168 msgid "ext2, ext3 and ext4 filesystems."
21172 #: ../resize/virt-resize.pod:288
21173 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
21177 #: ../resize/virt-resize.pod:290
21179 "The filesystem must have been shut down consistently last time it was used. "
21180 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
21181 "consistency check, so at the first boot after resizing Windows will check "
21186 #: ../resize/virt-resize.pod:297
21188 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
21189 "inside the PV, but see the I<--LV-expand> option. The user could also "
21190 "resize LVs as desired after boot."
21194 #: ../resize/virt-resize.pod:303
21195 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
21199 #: ../resize/virt-resize.pod:307 ../resize/virt-resize.pod:476
21200 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
21204 #: ../resize/virt-resize.pod:309 ../tools/virt-list-filesystems.pl:91
21205 #: ../tools/virt-list-partitions.pl:92 ../tools/virt-tar.pl:141
21206 #: ../tools/virt-win-reg.pl:142
21207 msgid "B<--format> raw"
21211 #: ../resize/virt-resize.pod:311
21213 "Specify the format of the input disk image. If this flag is not given then "
21214 "it is auto-detected from the image itself."
21218 #: ../resize/virt-resize.pod:317
21220 "Note that this option I<does not> affect the output format. See L</QCOW2 "
21221 "AND NON-SPARSE RAW FORMATS>."
21225 #: ../resize/virt-resize.pod:320
21226 msgid "B<--ignore part>"
21230 #: ../resize/virt-resize.pod:322
21232 "Ignore the named partition. Effectively this means the partition is "
21233 "allocated on the destination disk, but the content is not copied across from "
21234 "the source disk. The content of the partition will be blank (all zero "
21239 #: ../resize/virt-resize.pod:329
21240 msgid "B<--LV-expand logvol>"
21244 #: ../resize/virt-resize.pod:331
21246 "This takes the logical volume and, as a final step, expands it to fill all "
21247 "the space available in its volume group. A typical usage, assuming a Linux "
21248 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
21249 "lv_root> would be:"
21253 #: ../resize/virt-resize.pod:336
21256 " virt-resize indisk outdisk \\\n"
21257 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
21262 #: ../resize/virt-resize.pod:339
21264 "This would first expand the partition (and PV), and then expand the root "
21265 "device to fill the extra space in the PV."
21269 #: ../resize/virt-resize.pod:342
21271 "The contents of the LV are also resized if virt-resize knows how to do "
21272 "that. You can stop virt-resize from trying to expand the content by using "
21273 "the option I<--no-expand-content>."
21277 #: ../resize/virt-resize.pod:346
21278 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
21282 #: ../resize/virt-resize.pod:348
21284 "You can give this option multiple times, I<but> it doesn't make sense to do "
21285 "this unless the logical volumes you specify are all in different volume "
21290 #: ../resize/virt-resize.pod:354
21291 msgid "B<--dryrun>"
21295 #: ../resize/virt-resize.pod:356
21296 msgid "Print a summary of what would be done, but don't do anything."
21300 #: ../resize/virt-resize.pod:358
21301 msgid "B<--no-copy-boot-loader>"
21305 #: ../resize/virt-resize.pod:360
21307 "By default, virt-resize copies over some sectors at the start of the disk "
21308 "(up to the beginning of the first partition). Commonly these sectors "
21309 "contain the Master Boot Record (MBR) and the boot loader, and are required "
21310 "in order for the guest to boot correctly."
21314 #: ../resize/virt-resize.pod:365
21316 "If you specify this flag, then this initial copy is not done. You may need "
21317 "to reinstall the boot loader in this case."
21321 #: ../resize/virt-resize.pod:368
21322 msgid "B<--no-extra-partition>"
21326 #: ../resize/virt-resize.pod:370
21328 "By default, virt-resize creates an extra partition if there is any extra, "
21329 "unused space after all resizing has happened. Use this option to prevent "
21330 "the extra partition from being created. If you do this then the extra space "
21331 "will be inaccessible until you run fdisk, parted, or some other partitioning "
21332 "tool in the guest."
21336 #: ../resize/virt-resize.pod:376
21338 "Note that if the surplus space is smaller than 10 MB, no extra partition "
21343 #: ../resize/virt-resize.pod:379
21344 msgid "B<--no-expand-content>"
21348 #: ../resize/virt-resize.pod:381
21350 "By default, virt-resize will try to expand the direct contents of "
21351 "partitions, if it knows how (see I<--expand> option above)."
21355 #: ../resize/virt-resize.pod:384
21357 "If you give the I<--no-expand-content> option then virt-resize will not "
21362 #: ../resize/virt-resize.pod:387
21363 msgid "B<--ntfsresize-force>"
21367 #: ../resize/virt-resize.pod:389
21369 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
21370 "the NTFS disk is marked as needing a consistency check. You have to use "
21371 "this option if you want to resize a Windows guest multiple times without "
21372 "booting into Windows between each resize."
21376 #: ../resize/virt-resize.pod:395
21377 msgid "B<--output-format> raw"
21381 #: ../resize/virt-resize.pod:397
21383 "Specify the format of the output disk image. If this flag is not given then "
21384 "it is auto-detected from the image itself."
21388 #: ../resize/virt-resize.pod:403
21390 "Note that this option I<does not create> the output format. This option "
21391 "just tells libguestfs what it is so it doesn't try to guess it. You still "
21392 "need to create the output disk with the right format. See L</QCOW2 AND NON-"
21393 "SPARSE RAW FORMATS>."
21397 #: ../resize/virt-resize.pod:408
21402 #: ../resize/virt-resize.pod:410
21407 #: ../resize/virt-resize.pod:412
21408 msgid "Don't print the summary."
21412 #: ../resize/virt-resize.pod:414
21413 msgid "B<--resize part=size>"
21417 #: ../resize/virt-resize.pod:416
21419 "Resize the named partition (expanding or shrinking it) so that it has the "
21424 #: ../resize/virt-resize.pod:419
21426 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
21427 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
21428 "size; or as a relative number or percentage. For example:"
21432 #: ../resize/virt-resize.pod:425
21435 " --resize /dev/sda2=10G\n"
21440 #: ../resize/virt-resize.pod:427
21443 " --resize /dev/sda4=90%\n"
21448 #: ../resize/virt-resize.pod:429
21451 " --resize /dev/sda2=+1G\n"
21456 #: ../resize/virt-resize.pod:431
21459 " --resize /dev/sda2=-200M\n"
21464 #: ../resize/virt-resize.pod:433
21467 " --resize /dev/sda1=+128K\n"
21472 #: ../resize/virt-resize.pod:435
21475 " --resize /dev/sda1=+10%\n"
21480 #: ../resize/virt-resize.pod:437
21483 " --resize /dev/sda1=-10%\n"
21488 #: ../resize/virt-resize.pod:439
21490 "You can increase the size of any partition. Virt-resize will expand the "
21491 "direct content of the partition if it knows how (see I<--expand> below)."
21495 #: ../resize/virt-resize.pod:443
21497 "You can only I<decrease> the size of partitions that contain filesystems or "
21498 "PVs which have already been shrunk. Virt-resize will check this has been "
21499 "done before proceeding, or else will print an error (see also I<--resize-"
21504 #: ../resize/virt-resize.pod:450
21505 msgid "B<--resize-force part=size>"
21509 #: ../resize/virt-resize.pod:452
21511 "This is the same as I<--resize> except that it will let you decrease the "
21512 "size of any partition. Generally this means you will lose any data which "
21513 "was at the end of the partition you shrink, but you may not care about that "
21514 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
21515 "as a swap partition)."
21519 #: ../resize/virt-resize.pod:458
21520 msgid "See also the I<--ignore> option."
21524 #: ../resize/virt-resize.pod:460
21525 msgid "B<--shrink part>"
21529 #: ../resize/virt-resize.pod:462
21531 "Shrink the named partition until the overall disk image fits in the "
21532 "destination. The named partition B<must> contain a filesystem or PV which "
21533 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
21534 "online tools). Virt-resize will check this and give an error if it has not "
21539 #: ../resize/virt-resize.pod:468
21541 "The amount by which the overall disk must be shrunk (after carrying out all "
21542 "other operations requested by the user) is called the \"deficit\". For "
21543 "example, a straight copy (assume no other operations) from a 5GB disk image "
21544 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
21545 "would give an error unless the user specified a partition to shrink and that "
21546 "partition had more than a gigabyte of free space."
21550 #: ../resize/virt-resize.pod:488
21551 msgid "\"Partition 1 does not end on cylinder boundary.\""
21555 #: ../resize/virt-resize.pod:490
21557 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
21558 "means the partitions will not be aligned to the ancient CHS geometry. "
21559 "However CHS geometry is meaningless for disks manufactured since the early "
21560 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
21561 "cylinders is not required by any modern operating system."
21565 #: ../resize/virt-resize.pod:497
21566 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
21570 #: ../resize/virt-resize.pod:499
21572 "In Windows Vista and later versions, Microsoft switched to using a separate "
21573 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
21574 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
21575 "the boot partition. Doing so seems to break the guest completely. However "
21576 "expanding the second partition (ie. C: drive) should work."
21580 #: ../resize/virt-resize.pod:506
21582 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
21583 "NTFS partitions have been expanded. This is just a safety check and (unless "
21584 "it find errors) is nothing to worry about."
21588 #: ../resize/virt-resize.pod:510
21589 msgid "GUEST BOOT STUCK AT \"GRUB\""
21593 #: ../resize/virt-resize.pod:512
21595 "If a Linux guest does not boot after resizing, and the boot is stuck after "
21596 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
21597 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
21598 "although we think is to do with partition alignment."
21602 #: ../resize/virt-resize.pod:517
21605 " guestfish -i -a newdisk\n"
21606 " ><fs> cat /boot/grub/device.map\n"
21607 " # check the contents of this file are sensible or\n"
21608 " # edit the file if necessary\n"
21609 " ><fs> grub-install / /dev/vda\n"
21615 #: ../resize/virt-resize.pod:524
21617 "For more flexible guest reconfiguration, including if you need to specify "
21618 "other parameters to grub-install, use L<virt-rescue(1)>."
21622 #: ../resize/virt-resize.pod:527
21623 msgid "ALTERNATIVE TOOLS"
21627 #: ../resize/virt-resize.pod:529
21629 "There are several proprietary tools for resizing partitions. We won't "
21630 "mention any here."
21634 #: ../resize/virt-resize.pod:532
21636 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
21637 "operations on disk images. They can resize and move partitions, but I don't "
21638 "think they can do anything with the contents, and they certainly don't "
21643 #: ../resize/virt-resize.pod:537
21645 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
21646 "but at a much lower level. You will probably end up hand-calculating sector "
21647 "offsets, which is something that virt-resize was designed to avoid. If you "
21648 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
21653 #: ../resize/virt-resize.pod:552
21655 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
21656 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
21657 "L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, "
21658 "L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, L<http://libguestfs.org/>."
21662 #: ../ruby/examples/guestfs-ruby.pod:5
21663 msgid "guestfs-ruby - How to use libguestfs from Ruby"
21667 #: ../ruby/examples/guestfs-ruby.pod:9
21670 " require 'guestfs'\n"
21671 " g = Guestfs::Guestfs.new()\n"
21672 " g.add_drive_opts(\"disk.img\",\n"
21673 " :readonly => 1, :format => \"raw\")\n"
21679 #: ../ruby/examples/guestfs-ruby.pod:17
21681 "This manual page documents how to call libguestfs from the Ruby programming "
21682 "language. This page just documents the differences from the C API and gives "
21683 "some examples. If you are not familiar with using libguestfs, you also need "
21684 "to read L<guestfs(3)>."
21688 #: ../ruby/examples/guestfs-ruby.pod:24
21690 "Errors from libguestfs functions are mapped into the C<Error> exception. "
21691 "This has a single parameter which is the error message (a string)."
21695 #: ../ruby/examples/guestfs-ruby.pod:38
21697 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
21698 ">, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<http://"
21699 "libguestfs.org/>."
21703 #: ../src/guestfs-actions.pod:1
21704 msgid "guestfs_add_cdrom"
21708 #: ../src/guestfs-actions.pod:3
21712 " guestfs_add_cdrom (guestfs_h *g,\n"
21713 " const char *filename);\n"
21718 #: ../src/guestfs-actions.pod:17
21720 "This call checks for the existence of C<filename>. This stops you from "
21721 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21722 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
21727 #: ../src/guestfs-actions.pod:24
21729 "If you just want to add an ISO file (often you use this as an efficient way "
21730 "to transfer large files into the guest), then you should probably use "
21731 "C<guestfs_add_drive_ro> instead."
21735 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
21736 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
21737 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
21738 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
21739 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
21740 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
21741 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
21742 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
21743 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
21744 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
21745 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
21746 #: ../src/guestfs-actions.pod:858 ../src/guestfs-actions.pod:1041
21747 #: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1079
21748 #: ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1181
21749 #: ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1214
21750 #: ../src/guestfs-actions.pod:1234 ../src/guestfs-actions.pod:1304
21751 #: ../src/guestfs-actions.pod:1335 ../src/guestfs-actions.pod:1360
21752 #: ../src/guestfs-actions.pod:1402 ../src/guestfs-actions.pod:1508
21753 #: ../src/guestfs-actions.pod:1542 ../src/guestfs-actions.pod:1757
21754 #: ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1866
21755 #: ../src/guestfs-actions.pod:2341 ../src/guestfs-actions.pod:2485
21756 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2581
21757 #: ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3636
21758 #: ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:3850
21759 #: ../src/guestfs-actions.pod:3864 ../src/guestfs-actions.pod:3877
21760 #: ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:3906
21761 #: ../src/guestfs-actions.pod:3942 ../src/guestfs-actions.pod:4014
21762 #: ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4051
21763 #: ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:4097
21764 #: ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4151
21765 #: ../src/guestfs-actions.pod:4170 ../src/guestfs-actions.pod:4205
21766 #: ../src/guestfs-actions.pod:4217 ../src/guestfs-actions.pod:4253
21767 #: ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:4282
21768 #: ../src/guestfs-actions.pod:4297 ../src/guestfs-actions.pod:4314
21769 #: ../src/guestfs-actions.pod:4407 ../src/guestfs-actions.pod:4427
21770 #: ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4491
21771 #: ../src/guestfs-actions.pod:4509 ../src/guestfs-actions.pod:4527
21772 #: ../src/guestfs-actions.pod:4543 ../src/guestfs-actions.pod:4557
21773 #: ../src/guestfs-actions.pod:4571 ../src/guestfs-actions.pod:4588
21774 #: ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:4623
21775 #: ../src/guestfs-actions.pod:4693 ../src/guestfs-actions.pod:4766
21776 #: ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4816
21777 #: ../src/guestfs-actions.pod:4835 ../src/guestfs-actions.pod:4847
21778 #: ../src/guestfs-actions.pod:4864 ../src/guestfs-actions.pod:4877
21779 #: ../src/guestfs-actions.pod:4892 ../src/guestfs-actions.pod:4907
21780 #: ../src/guestfs-actions.pod:4942 ../src/guestfs-actions.pod:4975
21781 #: ../src/guestfs-actions.pod:5014 ../src/guestfs-actions.pod:5034
21782 #: ../src/guestfs-actions.pod:5048 ../src/guestfs-actions.pod:5065
21783 #: ../src/guestfs-actions.pod:5114 ../src/guestfs-actions.pod:5160
21784 #: ../src/guestfs-actions.pod:5214 ../src/guestfs-actions.pod:5250
21785 #: ../src/guestfs-actions.pod:5285 ../src/guestfs-actions.pod:5302
21786 #: ../src/guestfs-actions.pod:5320 ../src/guestfs-actions.pod:5460
21787 #: ../src/guestfs-actions.pod:5517 ../src/guestfs-actions.pod:5539
21788 #: ../src/guestfs-actions.pod:5557 ../src/guestfs-actions.pod:5589
21789 #: ../src/guestfs-actions.pod:5655 ../src/guestfs-actions.pod:5672
21790 #: ../src/guestfs-actions.pod:5685 ../src/guestfs-actions.pod:5699
21791 #: ../src/guestfs-actions.pod:5988 ../src/guestfs-actions.pod:6007
21792 #: ../src/guestfs-actions.pod:6026 ../src/guestfs-actions.pod:6040
21793 #: ../src/guestfs-actions.pod:6052 ../src/guestfs-actions.pod:6066
21794 #: ../src/guestfs-actions.pod:6078 ../src/guestfs-actions.pod:6092
21795 #: ../src/guestfs-actions.pod:6108 ../src/guestfs-actions.pod:6129
21796 #: ../src/guestfs-actions.pod:6148 ../src/guestfs-actions.pod:6167
21797 #: ../src/guestfs-actions.pod:6197 ../src/guestfs-actions.pod:6215
21798 #: ../src/guestfs-actions.pod:6238 ../src/guestfs-actions.pod:6256
21799 #: ../src/guestfs-actions.pod:6275 ../src/guestfs-actions.pod:6296
21800 #: ../src/guestfs-actions.pod:6315 ../src/guestfs-actions.pod:6332
21801 #: ../src/guestfs-actions.pod:6351 ../src/guestfs-actions.pod:6379
21802 #: ../src/guestfs-actions.pod:6403 ../src/guestfs-actions.pod:6422
21803 #: ../src/guestfs-actions.pod:6446 ../src/guestfs-actions.pod:6465
21804 #: ../src/guestfs-actions.pod:6480 ../src/guestfs-actions.pod:6499
21805 #: ../src/guestfs-actions.pod:6536 ../src/guestfs-actions.pod:6566
21806 #: ../src/guestfs-actions.pod:6599 ../src/guestfs-actions.pod:6721
21807 #: ../src/guestfs-actions.pod:6842 ../src/guestfs-actions.pod:6854
21808 #: ../src/guestfs-actions.pod:6867 ../src/guestfs-actions.pod:6880
21809 #: ../src/guestfs-actions.pod:6902 ../src/guestfs-actions.pod:6915
21810 #: ../src/guestfs-actions.pod:6928 ../src/guestfs-actions.pod:6941
21811 #: ../src/guestfs-actions.pod:6956 ../src/guestfs-actions.pod:7015
21812 #: ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7048
21813 #: ../src/guestfs-actions.pod:7064 ../src/guestfs-actions.pod:7081
21814 #: ../src/guestfs-actions.pod:7094 ../src/guestfs-actions.pod:7114
21815 #: ../src/guestfs-actions.pod:7150 ../src/guestfs-actions.pod:7164
21816 #: ../src/guestfs-actions.pod:7205 ../src/guestfs-actions.pod:7218
21817 #: ../src/guestfs-actions.pod:7236 ../src/guestfs-actions.pod:7270
21818 #: ../src/guestfs-actions.pod:7306 ../src/guestfs-actions.pod:7422
21819 #: ../src/guestfs-actions.pod:7437 ../src/guestfs-actions.pod:7451
21820 #: ../src/guestfs-actions.pod:7506 ../src/guestfs-actions.pod:7519
21821 #: ../src/guestfs-actions.pod:7564 ../src/guestfs-actions.pod:7597
21822 #: ../src/guestfs-actions.pod:7660 ../src/guestfs-actions.pod:7680
21823 #: ../src/guestfs-actions.pod:7706 ../src/guestfs-actions.pod:7773
21824 #: ../src/guestfs-actions.pod:7792 ../src/guestfs-actions.pod:7821
21825 msgid "This function returns 0 on success or -1 on error."
21829 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
21830 #: ../src/guestfs-actions.pod:1165 ../src/guestfs-actions.pod:1980
21831 #: ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2192
21832 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3643
21833 #: ../src/guestfs-actions.pod:4951 ../src/guestfs-actions.pod:6217
21834 #: ../src/guestfs-actions.pod:6334 ../src/guestfs-actions.pod:6467
21835 #: ../src/guestfs-actions.pod:6958 ../src/guestfs-actions.pod:7083
21836 #: ../src/guestfs-actions.pod:7606
21837 msgid "(Added in 0.3)"
21841 #: ../src/guestfs-actions.pod:41
21842 msgid "guestfs_add_domain"
21846 #: ../src/guestfs-actions.pod:43
21850 " guestfs_add_domain (guestfs_h *g,\n"
21851 " const char *dom,\n"
21857 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
21858 #: ../src/guestfs-actions.pod:832 ../src/guestfs-actions.pod:2826
21859 #: ../src/guestfs-actions.pod:4642 ../src/guestfs-actions.pod:4961
21860 #: ../src/guestfs-actions.pod:5178
21862 "You may supply a list of optional arguments to this call. Use zero or more "
21863 "of the following pairs of parameters, and terminate the list with C<-1> on "
21864 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
21868 #: ../src/guestfs-actions.pod:53
21871 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
21872 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
21873 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
21874 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
21875 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
21880 #: ../src/guestfs-actions.pod:59
21882 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21883 "It works by connecting to libvirt, requesting the domain and domain XML from "
21884 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
21889 #: ../src/guestfs-actions.pod:94
21891 "The other optional parameters are passed directly through to "
21892 "C<guestfs_add_drive_opts>."
21896 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
21897 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
21898 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
21899 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1380
21900 #: ../src/guestfs-actions.pod:1736 ../src/guestfs-actions.pod:1939
21901 #: ../src/guestfs-actions.pod:2050 ../src/guestfs-actions.pod:2101
21902 #: ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:2179
21903 #: ../src/guestfs-actions.pod:2472 ../src/guestfs-actions.pod:2944
21904 #: ../src/guestfs-actions.pod:2962 ../src/guestfs-actions.pod:5137
21905 #: ../src/guestfs-actions.pod:5357 ../src/guestfs-actions.pod:5769
21906 #: ../src/guestfs-actions.pod:5795 ../src/guestfs-actions.pod:7191
21907 #: ../src/guestfs-actions.pod:7617 ../src/guestfs-actions.pod:7630
21908 #: ../src/guestfs-actions.pod:7643
21909 msgid "On error this function returns -1."
21913 #: ../src/guestfs-actions.pod:99
21914 msgid "(Added in 1.7.4)"
21918 #: ../src/guestfs-actions.pod:101
21919 msgid "guestfs_add_domain_va"
21923 #: ../src/guestfs-actions.pod:103
21927 " guestfs_add_domain_va (guestfs_h *g,\n"
21928 " const char *dom,\n"
21929 " va_list args);\n"
21934 #: ../src/guestfs-actions.pod:108
21935 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
21939 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
21940 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
21941 #: ../src/guestfs-actions.pod:871 ../src/guestfs-actions.pod:882
21942 #: ../src/guestfs-actions.pod:2910 ../src/guestfs-actions.pod:2922
21943 #: ../src/guestfs-actions.pod:4707 ../src/guestfs-actions.pod:4719
21944 #: ../src/guestfs-actions.pod:4989 ../src/guestfs-actions.pod:5001
21945 #: ../src/guestfs-actions.pod:5227 ../src/guestfs-actions.pod:5238
21946 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
21950 #: ../src/guestfs-actions.pod:112
21951 msgid "guestfs_add_domain_argv"
21955 #: ../src/guestfs-actions.pod:114
21959 " guestfs_add_domain_argv (guestfs_h *g,\n"
21960 " const char *dom,\n"
21961 " const struct guestfs_add_domain_argv *optargs);\n"
21966 #: ../src/guestfs-actions.pod:119
21967 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
21971 #: ../src/guestfs-actions.pod:123
21972 msgid "guestfs_add_drive"
21976 #: ../src/guestfs-actions.pod:125
21980 " guestfs_add_drive (guestfs_h *g,\n"
21981 " const char *filename);\n"
21986 #: ../src/guestfs-actions.pod:129
21988 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
21989 "optional parameters, so the disk is added writable, with the format being "
21990 "detected automatically."
21994 #: ../src/guestfs-actions.pod:133
21996 "Automatic detection of the format opens you up to a potential security hole "
21997 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21998 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21999 "you should think about replacing calls to this function with calls to "
22000 "C<guestfs_add_drive_opts>, and specifying the format."
22004 #: ../src/guestfs-actions.pod:144
22005 msgid "guestfs_add_drive_opts"
22009 #: ../src/guestfs-actions.pod:146
22013 " guestfs_add_drive_opts (guestfs_h *g,\n"
22014 " const char *filename,\n"
22020 #: ../src/guestfs-actions.pod:156
22023 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
22024 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
22025 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
22030 #: ../src/guestfs-actions.pod:185
22032 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
22033 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
22034 "Possible formats include C<raw> and C<qcow2>."
22038 #: ../src/guestfs-actions.pod:196
22040 "This rarely-used option lets you emulate the behaviour of the deprecated "
22041 "C<guestfs_add_drive_with_if> call (q.v.)"
22045 #: ../src/guestfs-actions.pod:203
22046 msgid "(Added in 1.5.23)"
22050 #: ../src/guestfs-actions.pod:205
22051 msgid "guestfs_add_drive_opts_va"
22055 #: ../src/guestfs-actions.pod:207
22059 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
22060 " const char *filename,\n"
22061 " va_list args);\n"
22066 #: ../src/guestfs-actions.pod:212
22067 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
22071 #: ../src/guestfs-actions.pod:216
22072 msgid "guestfs_add_drive_opts_argv"
22076 #: ../src/guestfs-actions.pod:218
22080 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
22081 " const char *filename,\n"
22082 " const struct guestfs_add_drive_opts_argv *optargs);\n"
22087 #: ../src/guestfs-actions.pod:223
22088 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
22092 #: ../src/guestfs-actions.pod:227
22093 msgid "guestfs_add_drive_ro"
22097 #: ../src/guestfs-actions.pod:229
22101 " guestfs_add_drive_ro (guestfs_h *g,\n"
22102 " const char *filename);\n"
22107 #: ../src/guestfs-actions.pod:233
22109 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
22110 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
22111 "disk is added read-only, with the format being detected automatically."
22115 #: ../src/guestfs-actions.pod:240
22116 msgid "(Added in 1.0.38)"
22120 #: ../src/guestfs-actions.pod:242
22121 msgid "guestfs_add_drive_ro_with_if"
22125 #: ../src/guestfs-actions.pod:244
22129 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
22130 " const char *filename,\n"
22131 " const char *iface);\n"
22136 #: ../src/guestfs-actions.pod:249
22138 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
22139 "QEMU interface emulation to use at run time."
22143 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
22144 #: ../src/guestfs-actions.pod:2431
22145 msgid "(Added in 1.0.84)"
22149 #: ../src/guestfs-actions.pod:263
22150 msgid "guestfs_add_drive_with_if"
22154 #: ../src/guestfs-actions.pod:265
22158 " guestfs_add_drive_with_if (guestfs_h *g,\n"
22159 " const char *filename,\n"
22160 " const char *iface);\n"
22165 #: ../src/guestfs-actions.pod:270
22167 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
22168 "QEMU interface emulation to use at run time."
22172 #: ../src/guestfs-actions.pod:284
22173 msgid "guestfs_aug_clear"
22177 #: ../src/guestfs-actions.pod:286
22181 " guestfs_aug_clear (guestfs_h *g,\n"
22182 " const char *augpath);\n"
22187 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2181
22188 msgid "(Added in 1.3.4)"
22192 #: ../src/guestfs-actions.pod:297
22193 msgid "guestfs_aug_close"
22197 #: ../src/guestfs-actions.pod:299
22201 " guestfs_aug_close (guestfs_h *g);\n"
22206 #: ../src/guestfs-actions.pod:302
22208 "Close the current Augeas handle and free up any resources used by it. After "
22209 "calling this, you have to call C<guestfs_aug_init> again before you can use "
22210 "any other Augeas functions."
22214 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
22215 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
22216 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
22217 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
22218 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
22219 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
22220 #: ../src/guestfs-actions.pod:5846
22221 msgid "(Added in 0.7)"
22225 #: ../src/guestfs-actions.pod:311
22226 msgid "guestfs_aug_defnode"
22230 #: ../src/guestfs-actions.pod:313
22233 " struct guestfs_int_bool *\n"
22234 " guestfs_aug_defnode (guestfs_h *g,\n"
22235 " const char *name,\n"
22236 " const char *expr,\n"
22237 " const char *val);\n"
22242 #: ../src/guestfs-actions.pod:322
22244 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22245 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
22246 "containing that single node."
22250 #: ../src/guestfs-actions.pod:330
22252 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
22253 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
22257 #: ../src/guestfs-actions.pod:336
22258 msgid "guestfs_aug_defvar"
22262 #: ../src/guestfs-actions.pod:338
22266 " guestfs_aug_defvar (guestfs_h *g,\n"
22267 " const char *name,\n"
22268 " const char *expr);\n"
22273 #: ../src/guestfs-actions.pod:354
22274 msgid "guestfs_aug_get"
22278 #: ../src/guestfs-actions.pod:356
22282 " guestfs_aug_get (guestfs_h *g,\n"
22283 " const char *augpath);\n"
22288 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:922
22289 #: ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:1000
22290 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1119
22291 #: ../src/guestfs-actions.pod:1249 ../src/guestfs-actions.pod:1266
22292 #: ../src/guestfs-actions.pod:1285 ../src/guestfs-actions.pod:1419
22293 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1719
22294 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:1899
22295 #: ../src/guestfs-actions.pod:1966 ../src/guestfs-actions.pod:2002
22296 #: ../src/guestfs-actions.pod:2023 ../src/guestfs-actions.pod:2204
22297 #: ../src/guestfs-actions.pod:2396 ../src/guestfs-actions.pod:2600
22298 #: ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2794
22299 #: ../src/guestfs-actions.pod:2813 ../src/guestfs-actions.pod:3027
22300 #: ../src/guestfs-actions.pod:3055 ../src/guestfs-actions.pod:3076
22301 #: ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3169
22302 #: ../src/guestfs-actions.pod:3189 ../src/guestfs-actions.pod:3209
22303 #: ../src/guestfs-actions.pod:3836 ../src/guestfs-actions.pod:4189
22304 #: ../src/guestfs-actions.pod:4359 ../src/guestfs-actions.pod:4469
22305 #: ../src/guestfs-actions.pod:5375 ../src/guestfs-actions.pod:5574
22306 #: ../src/guestfs-actions.pod:5744 ../src/guestfs-actions.pod:5922
22307 #: ../src/guestfs-actions.pod:5971 ../src/guestfs-actions.pod:6627
22308 #: ../src/guestfs-actions.pod:6643 ../src/guestfs-actions.pod:6660
22309 #: ../src/guestfs-actions.pod:6691 ../src/guestfs-actions.pod:7365
22310 #: ../src/guestfs-actions.pod:7384 ../src/guestfs-actions.pod:7402
22311 #: ../src/guestfs-actions.pod:7576 ../src/guestfs-actions.pod:7878
22313 "This function returns a string, or NULL on error. I<The caller must free "
22314 "the returned string after use>."
22318 #: ../src/guestfs-actions.pod:368
22319 msgid "guestfs_aug_init"
22323 #: ../src/guestfs-actions.pod:370
22327 " guestfs_aug_init (guestfs_h *g,\n"
22328 " const char *root,\n"
22334 #: ../src/guestfs-actions.pod:379
22335 msgid "You must call this before using any other C<guestfs_aug_*> commands."
22339 #: ../src/guestfs-actions.pod:414
22340 msgid "Do not load the tree in C<guestfs_aug_init>."
22344 #: ../src/guestfs-actions.pod:418
22345 msgid "To close the handle, you can call C<guestfs_aug_close>."
22349 #: ../src/guestfs-actions.pod:426
22350 msgid "guestfs_aug_insert"
22354 #: ../src/guestfs-actions.pod:428
22358 " guestfs_aug_insert (guestfs_h *g,\n"
22359 " const char *augpath,\n"
22360 " const char *label,\n"
22366 #: ../src/guestfs-actions.pod:446
22367 msgid "guestfs_aug_load"
22371 #: ../src/guestfs-actions.pod:448
22375 " guestfs_aug_load (guestfs_h *g);\n"
22380 #: ../src/guestfs-actions.pod:460
22381 msgid "guestfs_aug_ls"
22385 #: ../src/guestfs-actions.pod:462
22389 " guestfs_aug_ls (guestfs_h *g,\n"
22390 " const char *augpath);\n"
22395 #: ../src/guestfs-actions.pod:466
22397 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
22398 "sorting the resulting nodes into alphabetical order."
22402 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
22403 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1138
22404 #: ../src/guestfs-actions.pod:1434 ../src/guestfs-actions.pod:1453
22405 #: ../src/guestfs-actions.pod:1556 ../src/guestfs-actions.pod:1575
22406 #: ../src/guestfs-actions.pod:1821 ../src/guestfs-actions.pod:2276
22407 #: ../src/guestfs-actions.pod:2292 ../src/guestfs-actions.pod:2311
22408 #: ../src/guestfs-actions.pod:2354 ../src/guestfs-actions.pod:2378
22409 #: ../src/guestfs-actions.pod:2449 ../src/guestfs-actions.pod:2498
22410 #: ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:3129
22411 #: ../src/guestfs-actions.pod:3405 ../src/guestfs-actions.pod:3719
22412 #: ../src/guestfs-actions.pod:3736 ../src/guestfs-actions.pod:3756
22413 #: ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3923
22414 #: ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:5098
22415 #: ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5842
22416 #: ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6707
22417 #: ../src/guestfs-actions.pod:6768 ../src/guestfs-actions.pod:6823
22418 #: ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:6993
22419 #: ../src/guestfs-actions.pod:7469 ../src/guestfs-actions.pod:7489
22420 #: ../src/guestfs-actions.pod:7536 ../src/guestfs-actions.pod:7730
22421 #: ../src/guestfs-actions.pod:7749 ../src/guestfs-actions.pod:7835
22422 #: ../src/guestfs-actions.pod:7854 ../src/guestfs-actions.pod:7900
22423 #: ../src/guestfs-actions.pod:7919
22425 "This function returns a NULL-terminated array of strings (like L<environ(3)"
22426 ">), or NULL if there was an error. I<The caller must free the strings and "
22427 "the array after use>."
22431 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1063
22432 #: ../src/guestfs-actions.pod:1081 ../src/guestfs-actions.pod:1491
22433 #: ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3514
22434 #: ../src/guestfs-actions.pod:4172 ../src/guestfs-actions.pod:4222
22435 #: ../src/guestfs-actions.pod:4409 ../src/guestfs-actions.pod:4442
22436 #: ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:5102
22437 #: ../src/guestfs-actions.pod:5657 ../src/guestfs-actions.pod:6054
22438 #: ../src/guestfs-actions.pod:6068 ../src/guestfs-actions.pod:6080
22439 #: ../src/guestfs-actions.pod:6548 ../src/guestfs-actions.pod:7207
22440 #: ../src/guestfs-actions.pod:7220 ../src/guestfs-actions.pod:7453
22441 #: ../src/guestfs-actions.pod:7718
22442 msgid "(Added in 0.8)"
22446 #: ../src/guestfs-actions.pod:475
22447 msgid "guestfs_aug_match"
22451 #: ../src/guestfs-actions.pod:477
22455 " guestfs_aug_match (guestfs_h *g,\n"
22456 " const char *augpath);\n"
22461 #: ../src/guestfs-actions.pod:491
22462 msgid "guestfs_aug_mv"
22466 #: ../src/guestfs-actions.pod:493
22470 " guestfs_aug_mv (guestfs_h *g,\n"
22471 " const char *src,\n"
22472 " const char *dest);\n"
22477 #: ../src/guestfs-actions.pod:505
22478 msgid "guestfs_aug_rm"
22482 #: ../src/guestfs-actions.pod:507
22486 " guestfs_aug_rm (guestfs_h *g,\n"
22487 " const char *augpath);\n"
22492 #: ../src/guestfs-actions.pod:519
22493 msgid "guestfs_aug_save"
22497 #: ../src/guestfs-actions.pod:521
22501 " guestfs_aug_save (guestfs_h *g);\n"
22506 #: ../src/guestfs-actions.pod:526
22508 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
22513 #: ../src/guestfs-actions.pod:533
22514 msgid "guestfs_aug_set"
22518 #: ../src/guestfs-actions.pod:535
22522 " guestfs_aug_set (guestfs_h *g,\n"
22523 " const char *augpath,\n"
22524 " const char *val);\n"
22529 #: ../src/guestfs-actions.pod:542
22531 "In the Augeas API, it is possible to clear a node by setting the value to "
22532 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22533 "this call. Instead you must use the C<guestfs_aug_clear> call."
22537 #: ../src/guestfs-actions.pod:551
22538 msgid "guestfs_available"
22542 #: ../src/guestfs-actions.pod:553
22546 " guestfs_available (guestfs_h *g,\n"
22547 " char *const *groups);\n"
22552 #: ../src/guestfs-actions.pod:561
22554 "The libguestfs groups, and the functions that those groups correspond to, "
22555 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22556 "runtime by calling C<guestfs_available_all_groups>."
22560 #: ../src/guestfs-actions.pod:585
22561 msgid "You must call C<guestfs_launch> before calling this function."
22565 #: ../src/guestfs-actions.pod:607
22567 "This call was added in version C<1.0.80>. In previous versions of "
22568 "libguestfs all you could do would be to speculatively execute a command to "
22569 "find out if the daemon implemented it. See also C<guestfs_version>."
22573 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1236
22574 msgid "(Added in 1.0.80)"
22578 #: ../src/guestfs-actions.pod:618
22579 msgid "guestfs_available_all_groups"
22583 #: ../src/guestfs-actions.pod:620
22587 " guestfs_available_all_groups (guestfs_h *g);\n"
22592 #: ../src/guestfs-actions.pod:623
22594 "This command returns a list of all optional groups that this daemon knows "
22595 "about. Note this returns both supported and unsupported groups. To find "
22596 "out which ones the daemon can actually support you have to call "
22597 "C<guestfs_available> on each member of the returned list."
22601 #: ../src/guestfs-actions.pod:629
22602 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
22606 #: ../src/guestfs-actions.pod:635
22607 msgid "(Added in 1.3.15)"
22611 #: ../src/guestfs-actions.pod:637
22612 msgid "guestfs_base64_in"
22616 #: ../src/guestfs-actions.pod:639
22620 " guestfs_base64_in (guestfs_h *g,\n"
22621 " const char *base64file,\n"
22622 " const char *filename);\n"
22627 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
22628 msgid "(Added in 1.3.5)"
22632 #: ../src/guestfs-actions.pod:651
22633 msgid "guestfs_base64_out"
22637 #: ../src/guestfs-actions.pod:653
22641 " guestfs_base64_out (guestfs_h *g,\n"
22642 " const char *filename,\n"
22643 " const char *base64file);\n"
22648 #: ../src/guestfs-actions.pod:665
22649 msgid "guestfs_blockdev_flushbufs"
22653 #: ../src/guestfs-actions.pod:667
22657 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
22658 " const char *device);\n"
22663 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
22664 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
22665 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
22666 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
22667 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
22668 msgid "(Added in 0.9.3)"
22672 #: ../src/guestfs-actions.pod:680
22673 msgid "guestfs_blockdev_getbsz"
22677 #: ../src/guestfs-actions.pod:682
22681 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
22682 " const char *device);\n"
22687 #: ../src/guestfs-actions.pod:697
22688 msgid "guestfs_blockdev_getro"
22692 #: ../src/guestfs-actions.pod:699
22696 " guestfs_blockdev_getro (guestfs_h *g,\n"
22697 " const char *device);\n"
22702 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1474
22703 #: ../src/guestfs-actions.pod:1489 ../src/guestfs-actions.pod:1978
22704 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2061
22705 #: ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2127
22706 #: ../src/guestfs-actions.pod:2142 ../src/guestfs-actions.pod:2167
22707 #: ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:3226
22708 #: ../src/guestfs-actions.pod:3242 ../src/guestfs-actions.pod:3260
22709 #: ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:3436
22710 #: ../src/guestfs-actions.pod:3451 ../src/guestfs-actions.pod:3465
22711 #: ../src/guestfs-actions.pod:3481 ../src/guestfs-actions.pod:3496
22712 #: ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3526
22713 #: ../src/guestfs-actions.pod:3539 ../src/guestfs-actions.pod:3553
22714 #: ../src/guestfs-actions.pod:3568 ../src/guestfs-actions.pod:3583
22715 #: ../src/guestfs-actions.pod:3596 ../src/guestfs-actions.pod:3610
22716 #: ../src/guestfs-actions.pod:5339
22717 msgid "This function returns a C truth value on success or -1 on error."
22721 #: ../src/guestfs-actions.pod:712
22722 msgid "guestfs_blockdev_getsize64"
22726 #: ../src/guestfs-actions.pod:714
22730 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
22731 " const char *device);\n"
22736 #: ../src/guestfs-actions.pod:720
22737 msgid "See also C<guestfs_blockdev_getsz>."
22741 #: ../src/guestfs-actions.pod:728
22742 msgid "guestfs_blockdev_getss"
22746 #: ../src/guestfs-actions.pod:730
22750 " guestfs_blockdev_getss (guestfs_h *g,\n"
22751 " const char *device);\n"
22756 #: ../src/guestfs-actions.pod:737
22758 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
22763 #: ../src/guestfs-actions.pod:746
22764 msgid "guestfs_blockdev_getsz"
22768 #: ../src/guestfs-actions.pod:748
22772 " guestfs_blockdev_getsz (guestfs_h *g,\n"
22773 " const char *device);\n"
22778 #: ../src/guestfs-actions.pod:755
22780 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
22781 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
22785 #: ../src/guestfs-actions.pod:765
22786 msgid "guestfs_blockdev_rereadpt"
22790 #: ../src/guestfs-actions.pod:767
22794 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
22795 " const char *device);\n"
22800 #: ../src/guestfs-actions.pod:779
22801 msgid "guestfs_blockdev_setbsz"
22805 #: ../src/guestfs-actions.pod:781
22809 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
22810 " const char *device,\n"
22811 " int blocksize);\n"
22816 #: ../src/guestfs-actions.pod:797
22817 msgid "guestfs_blockdev_setro"
22821 #: ../src/guestfs-actions.pod:799
22825 " guestfs_blockdev_setro (guestfs_h *g,\n"
22826 " const char *device);\n"
22831 #: ../src/guestfs-actions.pod:811
22832 msgid "guestfs_blockdev_setrw"
22836 #: ../src/guestfs-actions.pod:813
22840 " guestfs_blockdev_setrw (guestfs_h *g,\n"
22841 " const char *device);\n"
22846 #: ../src/guestfs-actions.pod:825
22847 msgid "guestfs_btrfs_filesystem_resize"
22851 #: ../src/guestfs-actions.pod:827
22855 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
22856 " const char *mountpoint,\n"
22862 #: ../src/guestfs-actions.pod:837
22865 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
22870 #: ../src/guestfs-actions.pod:860
22871 msgid "(Added in 1.11.17)"
22875 #: ../src/guestfs-actions.pod:862
22876 msgid "guestfs_btrfs_filesystem_resize_va"
22880 #: ../src/guestfs-actions.pod:864
22884 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
22885 " const char *mountpoint,\n"
22886 " va_list args);\n"
22891 #: ../src/guestfs-actions.pod:869
22892 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
22896 #: ../src/guestfs-actions.pod:873
22897 msgid "guestfs_btrfs_filesystem_resize_argv"
22901 #: ../src/guestfs-actions.pod:875
22905 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
22906 " const char *mountpoint,\n"
22907 " const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
22912 #: ../src/guestfs-actions.pod:880
22913 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
22917 #: ../src/guestfs-actions.pod:884
22918 msgid "guestfs_case_sensitive_path"
22922 #: ../src/guestfs-actions.pod:886
22926 " guestfs_case_sensitive_path (guestfs_h *g,\n"
22927 " const char *path);\n"
22932 #: ../src/guestfs-actions.pod:912
22934 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
22935 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
22936 "how the directories were originally created under Windows)."
22940 #: ../src/guestfs-actions.pod:920
22941 msgid "See also C<guestfs_realpath>."
22945 #: ../src/guestfs-actions.pod:925 ../src/guestfs-actions.pod:7387
22946 msgid "(Added in 1.0.75)"
22950 #: ../src/guestfs-actions.pod:927
22951 msgid "guestfs_cat"
22955 #: ../src/guestfs-actions.pod:929
22959 " guestfs_cat (guestfs_h *g,\n"
22960 " const char *path);\n"
22965 #: ../src/guestfs-actions.pod:935
22967 "Note that this function cannot correctly handle binary files (specifically, "
22968 "files containing C<\\0> character which is treated as end of string). For "
22969 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
22970 "functions which have a more complex interface."
22974 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:3740
22975 #: ../src/guestfs-actions.pod:3822 ../src/guestfs-actions.pod:3839
22976 #: ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:4335
22977 #: ../src/guestfs-actions.pod:4349 ../src/guestfs-actions.pod:5720
22978 #: ../src/guestfs-actions.pod:5734 ../src/guestfs-actions.pod:7540
22979 #: ../src/guestfs-actions.pod:7554
22980 msgid "(Added in 0.4)"
22984 #: ../src/guestfs-actions.pod:948
22985 msgid "guestfs_checksum"
22989 #: ../src/guestfs-actions.pod:950
22993 " guestfs_checksum (guestfs_h *g,\n"
22994 " const char *csumtype,\n"
22995 " const char *path);\n"
23000 #: ../src/guestfs-actions.pod:996
23001 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
23005 #: ../src/guestfs-actions.pod:998
23006 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
23010 #: ../src/guestfs-actions.pod:1003 ../src/guestfs-actions.pod:1311
23011 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:3438
23012 #: ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:3528
23013 #: ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:7243
23014 msgid "(Added in 1.0.2)"
23018 #: ../src/guestfs-actions.pod:1005
23019 msgid "guestfs_checksum_device"
23023 #: ../src/guestfs-actions.pod:1007
23027 " guestfs_checksum_device (guestfs_h *g,\n"
23028 " const char *csumtype,\n"
23029 " const char *device);\n"
23034 #: ../src/guestfs-actions.pod:1012
23036 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23037 "device named C<device>. For the types of checksums supported see the "
23038 "C<guestfs_checksum> command."
23042 #: ../src/guestfs-actions.pod:1019 ../src/guestfs-actions.pod:5169
23043 #: ../src/guestfs-actions.pod:5304 ../src/guestfs-actions.pod:5341
23044 #: ../src/guestfs-actions.pod:5359 ../src/guestfs-actions.pod:5541
23045 #: ../src/guestfs-actions.pod:7152 ../src/guestfs-actions.pod:7166
23046 #: ../src/guestfs-actions.pod:7566
23047 msgid "(Added in 1.3.2)"
23051 #: ../src/guestfs-actions.pod:1021
23052 msgid "guestfs_checksums_out"
23056 #: ../src/guestfs-actions.pod:1023
23060 " guestfs_checksums_out (guestfs_h *g,\n"
23061 " const char *csumtype,\n"
23062 " const char *directory,\n"
23063 " const char *sumsfile);\n"
23068 #: ../src/guestfs-actions.pod:1043
23069 msgid "(Added in 1.3.7)"
23073 #: ../src/guestfs-actions.pod:1045
23074 msgid "guestfs_chmod"
23078 #: ../src/guestfs-actions.pod:1047
23082 " guestfs_chmod (guestfs_h *g,\n"
23084 " const char *path);\n"
23089 #: ../src/guestfs-actions.pod:1065
23090 msgid "guestfs_chown"
23094 #: ../src/guestfs-actions.pod:1067
23098 " guestfs_chown (guestfs_h *g,\n"
23101 " const char *path);\n"
23106 #: ../src/guestfs-actions.pod:1083
23107 msgid "guestfs_command"
23111 #: ../src/guestfs-actions.pod:1085
23115 " guestfs_command (guestfs_h *g,\n"
23116 " char *const *arguments);\n"
23121 #: ../src/guestfs-actions.pod:1094
23123 "The single parameter is an argv-style list of arguments. The first element "
23124 "is the name of the program to run. Subsequent elements are parameters. The "
23125 "list must be non-empty (ie. must contain a program name). Note that the "
23126 "command runs directly, and is I<not> invoked via the shell (see "
23131 #: ../src/guestfs-actions.pod:1125 ../src/guestfs-actions.pod:1145
23132 #: ../src/guestfs-actions.pod:1610
23133 msgid "(Added in 0.9.1)"
23137 #: ../src/guestfs-actions.pod:1127
23138 msgid "guestfs_command_lines"
23142 #: ../src/guestfs-actions.pod:1129
23146 " guestfs_command_lines (guestfs_h *g,\n"
23147 " char *const *arguments);\n"
23152 #: ../src/guestfs-actions.pod:1133
23154 "This is the same as C<guestfs_command>, but splits the result into a list of "
23159 #: ../src/guestfs-actions.pod:1136
23160 msgid "See also: C<guestfs_sh_lines>"
23164 #: ../src/guestfs-actions.pod:1147
23165 msgid "guestfs_config"
23169 #: ../src/guestfs-actions.pod:1149
23173 " guestfs_config (guestfs_h *g,\n"
23174 " const char *qemuparam,\n"
23175 " const char *qemuvalue);\n"
23180 #: ../src/guestfs-actions.pod:1167
23181 msgid "guestfs_copy_size"
23185 #: ../src/guestfs-actions.pod:1169
23189 " guestfs_copy_size (guestfs_h *g,\n"
23190 " const char *src,\n"
23191 " const char *dest,\n"
23192 " int64_t size);\n"
23197 #: ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1306
23198 #: ../src/guestfs-actions.pod:1337 ../src/guestfs-actions.pod:1382
23199 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:1781
23200 #: ../src/guestfs-actions.pod:3638 ../src/guestfs-actions.pod:7238
23201 #: ../src/guestfs-actions.pod:7272 ../src/guestfs-actions.pod:7775
23202 #: ../src/guestfs-actions.pod:7794
23204 "This long-running command can generate progress notification messages so "
23205 "that the caller can display a progress bar or indicator. To receive these "
23206 "messages, the caller must register a progress event callback. See L<guestfs"
23207 "(3)/GUESTFS_EVENT_PROGRESS>."
23211 #: ../src/guestfs-actions.pod:1188 ../src/guestfs-actions.pod:4362
23212 #: ../src/guestfs-actions.pod:5747 ../src/guestfs-actions.pod:7473
23213 #: ../src/guestfs-actions.pod:7493 ../src/guestfs-actions.pod:7579
23214 msgid "(Added in 1.0.87)"
23218 #: ../src/guestfs-actions.pod:1190
23223 #: ../src/guestfs-actions.pod:1192
23227 " guestfs_cp (guestfs_h *g,\n"
23228 " const char *src,\n"
23229 " const char *dest);\n"
23234 #: ../src/guestfs-actions.pod:1202 ../src/guestfs-actions.pod:1216
23235 #: ../src/guestfs-actions.pod:1288 ../src/guestfs-actions.pod:1362
23236 #: ../src/guestfs-actions.pod:1476 ../src/guestfs-actions.pod:5116
23237 #: ../src/guestfs-actions.pod:5591
23238 msgid "(Added in 1.0.18)"
23242 #: ../src/guestfs-actions.pod:1204
23243 msgid "guestfs_cp_a"
23247 #: ../src/guestfs-actions.pod:1206
23251 " guestfs_cp_a (guestfs_h *g,\n"
23252 " const char *src,\n"
23253 " const char *dest);\n"
23258 #: ../src/guestfs-actions.pod:1218
23263 #: ../src/guestfs-actions.pod:1220
23267 " guestfs_dd (guestfs_h *g,\n"
23268 " const char *src,\n"
23269 " const char *dest);\n"
23274 #: ../src/guestfs-actions.pod:1230
23276 "If the destination is a device, it must be as large or larger than the "
23277 "source file or device, otherwise the copy will fail. This command cannot do "
23278 "partial copies (see C<guestfs_copy_size>)."
23282 #: ../src/guestfs-actions.pod:1238
23287 #: ../src/guestfs-actions.pod:1240
23291 " guestfs_df (guestfs_h *g);\n"
23296 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1262
23298 "This command is mostly useful for interactive sessions. It is I<not> "
23299 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
23304 #: ../src/guestfs-actions.pod:1252 ../src/guestfs-actions.pod:1269
23305 #: ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:2361
23306 #: ../src/guestfs-actions.pod:2385 ../src/guestfs-actions.pod:2453
23307 #: ../src/guestfs-actions.pod:4472 ../src/guestfs-actions.pod:5016
23308 #: ../src/guestfs-actions.pod:6976 ../src/guestfs-actions.pod:7000
23309 #: ../src/guestfs-actions.pod:7619 ../src/guestfs-actions.pod:7632
23310 #: ../src/guestfs-actions.pod:7645
23311 msgid "(Added in 1.0.54)"
23315 #: ../src/guestfs-actions.pod:1254
23316 msgid "guestfs_df_h"
23320 #: ../src/guestfs-actions.pod:1256
23324 " guestfs_df_h (guestfs_h *g);\n"
23329 #: ../src/guestfs-actions.pod:1271
23330 msgid "guestfs_dmesg"
23334 #: ../src/guestfs-actions.pod:1273
23338 " guestfs_dmesg (guestfs_h *g);\n"
23343 #: ../src/guestfs-actions.pod:1280
23345 "Another way to get the same information is to enable verbose messages with "
23346 "C<guestfs_set_verbose> or by setting the environment variable "
23347 "C<LIBGUESTFS_DEBUG=1> before running the program."
23351 #: ../src/guestfs-actions.pod:1290
23352 msgid "guestfs_download"
23356 #: ../src/guestfs-actions.pod:1292
23360 " guestfs_download (guestfs_h *g,\n"
23361 " const char *remotefilename,\n"
23362 " const char *filename);\n"
23367 #: ../src/guestfs-actions.pod:1302
23368 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
23372 #: ../src/guestfs-actions.pod:1313
23373 msgid "guestfs_download_offset"
23377 #: ../src/guestfs-actions.pod:1315
23381 " guestfs_download_offset (guestfs_h *g,\n"
23382 " const char *remotefilename,\n"
23383 " const char *filename,\n"
23384 " int64_t offset,\n"
23385 " int64_t size);\n"
23390 #: ../src/guestfs-actions.pod:1328
23392 "Note that there is no limit on the amount of data that can be downloaded "
23393 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
23394 "full amount unless an error occurs."
23398 #: ../src/guestfs-actions.pod:1333
23399 msgid "See also C<guestfs_download>, C<guestfs_pread>."
23403 #: ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:7277
23404 msgid "(Added in 1.5.17)"
23408 #: ../src/guestfs-actions.pod:1344
23409 msgid "guestfs_drop_caches"
23413 #: ../src/guestfs-actions.pod:1346
23417 " guestfs_drop_caches (guestfs_h *g,\n"
23418 " int whattodrop);\n"
23423 #: ../src/guestfs-actions.pod:1364
23428 #: ../src/guestfs-actions.pod:1366
23432 " guestfs_du (guestfs_h *g,\n"
23433 " const char *path);\n"
23438 #: ../src/guestfs-actions.pod:1389
23439 msgid "guestfs_e2fsck_f"
23443 #: ../src/guestfs-actions.pod:1391
23447 " guestfs_e2fsck_f (guestfs_h *g,\n"
23448 " const char *device);\n"
23453 #: ../src/guestfs-actions.pod:1399
23455 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
23456 "Normally you should use C<guestfs_fsck>."
23460 #: ../src/guestfs-actions.pod:1404
23461 msgid "(Added in 1.0.29)"
23465 #: ../src/guestfs-actions.pod:1406
23466 msgid "guestfs_echo_daemon"
23470 #: ../src/guestfs-actions.pod:1408
23474 " guestfs_echo_daemon (guestfs_h *g,\n"
23475 " char *const *words);\n"
23480 #: ../src/guestfs-actions.pod:1417
23481 msgid "See also C<guestfs_ping_daemon>."
23485 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:2169
23486 #: ../src/guestfs-actions.pod:6448
23487 msgid "(Added in 1.0.69)"
23491 #: ../src/guestfs-actions.pod:1424
23492 msgid "guestfs_egrep"
23496 #: ../src/guestfs-actions.pod:1426
23500 " guestfs_egrep (guestfs_h *g,\n"
23501 " const char *regex,\n"
23502 " const char *path);\n"
23507 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1460
23508 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:1563
23509 #: ../src/guestfs-actions.pod:1582 ../src/guestfs-actions.pod:2299
23510 #: ../src/guestfs-actions.pod:2318 ../src/guestfs-actions.pod:2474
23511 #: ../src/guestfs-actions.pod:2487 ../src/guestfs-actions.pod:2502
23512 #: ../src/guestfs-actions.pod:2548 ../src/guestfs-actions.pod:2570
23513 #: ../src/guestfs-actions.pod:2583 ../src/guestfs-actions.pod:3852
23514 #: ../src/guestfs-actions.pod:3866 ../src/guestfs-actions.pod:3879
23515 #: ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:4894
23516 #: ../src/guestfs-actions.pod:5925 ../src/guestfs-actions.pod:5974
23517 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6856
23518 #: ../src/guestfs-actions.pod:6869 ../src/guestfs-actions.pod:6882
23519 #: ../src/guestfs-actions.pod:6904 ../src/guestfs-actions.pod:6917
23520 #: ../src/guestfs-actions.pod:6930 ../src/guestfs-actions.pod:6943
23521 #: ../src/guestfs-actions.pod:7737 ../src/guestfs-actions.pod:7756
23522 #: ../src/guestfs-actions.pod:7842 ../src/guestfs-actions.pod:7861
23523 #: ../src/guestfs-actions.pod:7907 ../src/guestfs-actions.pod:7926
23524 msgid "(Added in 1.0.66)"
23528 #: ../src/guestfs-actions.pod:1443
23529 msgid "guestfs_egrepi"
23533 #: ../src/guestfs-actions.pod:1445
23537 " guestfs_egrepi (guestfs_h *g,\n"
23538 " const char *regex,\n"
23539 " const char *path);\n"
23544 #: ../src/guestfs-actions.pod:1462
23545 msgid "guestfs_equal"
23549 #: ../src/guestfs-actions.pod:1464
23553 " guestfs_equal (guestfs_h *g,\n"
23554 " const char *file1,\n"
23555 " const char *file2);\n"
23560 #: ../src/guestfs-actions.pod:1478
23561 msgid "guestfs_exists"
23565 #: ../src/guestfs-actions.pod:1480
23569 " guestfs_exists (guestfs_h *g,\n"
23570 " const char *path);\n"
23575 #: ../src/guestfs-actions.pod:1487
23576 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
23580 #: ../src/guestfs-actions.pod:1493
23581 msgid "guestfs_fallocate"
23585 #: ../src/guestfs-actions.pod:1495
23589 " guestfs_fallocate (guestfs_h *g,\n"
23590 " const char *path,\n"
23596 #: ../src/guestfs-actions.pod:1519
23597 msgid "guestfs_fallocate64"
23601 #: ../src/guestfs-actions.pod:1521
23605 " guestfs_fallocate64 (guestfs_h *g,\n"
23606 " const char *path,\n"
23612 #: ../src/guestfs-actions.pod:1530
23614 "Note that this call allocates disk blocks for the file. To create a sparse "
23615 "file use C<guestfs_truncate_size> instead."
23619 #: ../src/guestfs-actions.pod:1533
23621 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
23622 "oversight it only allowed 30 bit lengths to be specified, effectively "
23623 "limiting the maximum size of files created through that call to 1GB."
23627 #: ../src/guestfs-actions.pod:1544
23628 msgid "(Added in 1.3.17)"
23632 #: ../src/guestfs-actions.pod:1546
23633 msgid "guestfs_fgrep"
23637 #: ../src/guestfs-actions.pod:1548
23641 " guestfs_fgrep (guestfs_h *g,\n"
23642 " const char *pattern,\n"
23643 " const char *path);\n"
23648 #: ../src/guestfs-actions.pod:1565
23649 msgid "guestfs_fgrepi"
23653 #: ../src/guestfs-actions.pod:1567
23657 " guestfs_fgrepi (guestfs_h *g,\n"
23658 " const char *pattern,\n"
23659 " const char *path);\n"
23664 #: ../src/guestfs-actions.pod:1584
23665 msgid "guestfs_file"
23669 #: ../src/guestfs-actions.pod:1586
23673 " guestfs_file (guestfs_h *g,\n"
23674 " const char *path);\n"
23679 #: ../src/guestfs-actions.pod:1604
23681 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
23682 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
23686 #: ../src/guestfs-actions.pod:1612
23687 msgid "guestfs_file_architecture"
23691 #: ../src/guestfs-actions.pod:1614
23695 " guestfs_file_architecture (guestfs_h *g,\n"
23696 " const char *filename);\n"
23701 #: ../src/guestfs-actions.pod:1722 ../src/guestfs-actions.pod:1885
23702 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:2603
23703 #: ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2759
23704 #: ../src/guestfs-actions.pod:2946 ../src/guestfs-actions.pod:2964
23705 #: ../src/guestfs-actions.pod:3004 ../src/guestfs-actions.pod:3079
23706 #: ../src/guestfs-actions.pod:3172 ../src/guestfs-actions.pod:3409
23707 #: ../src/guestfs-actions.pod:3541
23708 msgid "(Added in 1.5.3)"
23712 #: ../src/guestfs-actions.pod:1724
23713 msgid "guestfs_filesize"
23717 #: ../src/guestfs-actions.pod:1726
23721 " guestfs_filesize (guestfs_h *g,\n"
23722 " const char *file);\n"
23727 #: ../src/guestfs-actions.pod:1732
23729 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
23730 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
23731 "devices, use C<guestfs_blockdev_getsize64>."
23735 #: ../src/guestfs-actions.pod:1738
23736 msgid "(Added in 1.0.82)"
23740 #: ../src/guestfs-actions.pod:1740
23741 msgid "guestfs_fill"
23745 #: ../src/guestfs-actions.pod:1742
23749 " guestfs_fill (guestfs_h *g,\n"
23752 " const char *path);\n"
23757 #: ../src/guestfs-actions.pod:1752
23759 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23760 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
23761 "bytes use C<guestfs_fill_pattern>."
23765 #: ../src/guestfs-actions.pod:1764
23766 msgid "(Added in 1.0.79)"
23770 #: ../src/guestfs-actions.pod:1766
23771 msgid "guestfs_fill_pattern"
23775 #: ../src/guestfs-actions.pod:1768
23779 " guestfs_fill_pattern (guestfs_h *g,\n"
23780 " const char *pattern,\n"
23782 " const char *path);\n"
23787 #: ../src/guestfs-actions.pod:1774
23789 "This function is like C<guestfs_fill> except that it creates a new file of "
23790 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
23791 "pattern is truncated if necessary to ensure the length of the file is "
23792 "exactly C<len> bytes."
23796 #: ../src/guestfs-actions.pod:1786
23797 msgid "(Added in 1.3.12)"
23801 #: ../src/guestfs-actions.pod:1788
23802 msgid "guestfs_find"
23806 #: ../src/guestfs-actions.pod:1790
23810 " guestfs_find (guestfs_h *g,\n"
23811 " const char *directory);\n"
23816 #: ../src/guestfs-actions.pod:1806
23818 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
23822 #: ../src/guestfs-actions.pod:1819
23823 msgid "See also C<guestfs_find0>."
23827 #: ../src/guestfs-actions.pod:1828 ../src/guestfs-actions.pod:4299
23828 #: ../src/guestfs-actions.pod:6009
23829 msgid "(Added in 1.0.27)"
23833 #: ../src/guestfs-actions.pod:1830
23834 msgid "guestfs_find0"
23838 #: ../src/guestfs-actions.pod:1832
23842 " guestfs_find0 (guestfs_h *g,\n"
23843 " const char *directory,\n"
23844 " const char *files);\n"
23849 #: ../src/guestfs-actions.pod:1841
23851 "This command works the same way as C<guestfs_find> with the following "
23856 #: ../src/guestfs-actions.pod:1868
23857 msgid "(Added in 1.0.74)"
23861 #: ../src/guestfs-actions.pod:1870
23862 msgid "guestfs_findfs_label"
23866 #: ../src/guestfs-actions.pod:1872
23870 " guestfs_findfs_label (guestfs_h *g,\n"
23871 " const char *label);\n"
23876 #: ../src/guestfs-actions.pod:1880
23877 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
23881 #: ../src/guestfs-actions.pod:1887
23882 msgid "guestfs_findfs_uuid"
23886 #: ../src/guestfs-actions.pod:1889
23890 " guestfs_findfs_uuid (guestfs_h *g,\n"
23891 " const char *uuid);\n"
23896 #: ../src/guestfs-actions.pod:1897
23897 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
23901 #: ../src/guestfs-actions.pod:1904
23902 msgid "guestfs_fsck"
23906 #: ../src/guestfs-actions.pod:1906
23910 " guestfs_fsck (guestfs_h *g,\n"
23911 " const char *fstype,\n"
23912 " const char *device);\n"
23917 #: ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:7780
23918 msgid "(Added in 1.0.16)"
23922 #: ../src/guestfs-actions.pod:1943
23923 msgid "guestfs_get_append"
23927 #: ../src/guestfs-actions.pod:1945
23931 " guestfs_get_append (guestfs_h *g);\n"
23936 #: ../src/guestfs-actions.pod:1953
23938 "This function returns a string which may be NULL. There is no way to return "
23939 "an error from this function. The string is owned by the guest handle and "
23940 "must I<not> be freed."
23944 #: ../src/guestfs-actions.pod:1957 ../src/guestfs-actions.pod:5687
23945 #: ../src/guestfs-actions.pod:6169 ../src/guestfs-actions.pod:6611
23946 #: ../src/guestfs-actions.pod:6630 ../src/guestfs-actions.pod:6646
23947 #: ../src/guestfs-actions.pod:6670 ../src/guestfs-actions.pod:7424
23948 #: ../src/guestfs-actions.pod:7439 ../src/guestfs-actions.pod:7823
23949 msgid "(Added in 1.0.26)"
23953 #: ../src/guestfs-actions.pod:1959
23954 msgid "guestfs_get_attach_method"
23958 #: ../src/guestfs-actions.pod:1961
23962 " guestfs_get_attach_method (guestfs_h *g);\n"
23967 #: ../src/guestfs-actions.pod:1964
23968 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
23972 #: ../src/guestfs-actions.pod:1969 ../src/guestfs-actions.pod:6199
23973 msgid "(Added in 1.9.8)"
23977 #: ../src/guestfs-actions.pod:1971
23978 msgid "guestfs_get_autosync"
23982 #: ../src/guestfs-actions.pod:1973
23986 " guestfs_get_autosync (guestfs_h *g);\n"
23991 #: ../src/guestfs-actions.pod:1982
23992 msgid "guestfs_get_direct"
23996 #: ../src/guestfs-actions.pod:1984
24000 " guestfs_get_direct (guestfs_h *g);\n"
24005 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:6240
24006 msgid "(Added in 1.0.72)"
24010 #: ../src/guestfs-actions.pod:1993
24011 msgid "guestfs_get_e2label"
24015 #: ../src/guestfs-actions.pod:1995
24019 " guestfs_get_e2label (guestfs_h *g,\n"
24020 " const char *device);\n"
24025 #: ../src/guestfs-actions.pod:2012 ../src/guestfs-actions.pod:2033
24026 #: ../src/guestfs-actions.pod:6258 ../src/guestfs-actions.pod:6277
24027 msgid "(Added in 1.0.15)"
24031 #: ../src/guestfs-actions.pod:2014
24032 msgid "guestfs_get_e2uuid"
24036 #: ../src/guestfs-actions.pod:2016
24040 " guestfs_get_e2uuid (guestfs_h *g,\n"
24041 " const char *device);\n"
24046 #: ../src/guestfs-actions.pod:2035
24047 msgid "guestfs_get_memsize"
24051 #: ../src/guestfs-actions.pod:2037
24055 " guestfs_get_memsize (guestfs_h *g);\n"
24060 #: ../src/guestfs-actions.pod:2043
24062 "If C<guestfs_set_memsize> was not called on this handle, and if "
24063 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
24064 "value for memsize."
24068 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:4590
24069 #: ../src/guestfs-actions.pod:4799 ../src/guestfs-actions.pod:4818
24070 #: ../src/guestfs-actions.pod:4837 ../src/guestfs-actions.pod:4849
24071 #: ../src/guestfs-actions.pod:4866 ../src/guestfs-actions.pod:4879
24072 #: ../src/guestfs-actions.pod:5912 ../src/guestfs-actions.pod:6298
24073 #: ../src/guestfs-actions.pod:6578 ../src/guestfs-actions.pod:7193
24074 msgid "(Added in 1.0.55)"
24078 #: ../src/guestfs-actions.pod:2054
24079 msgid "guestfs_get_network"
24083 #: ../src/guestfs-actions.pod:2056
24087 " guestfs_get_network (guestfs_h *g);\n"
24092 #: ../src/guestfs-actions.pod:2063 ../src/guestfs-actions.pod:6317
24093 msgid "(Added in 1.5.4)"
24097 #: ../src/guestfs-actions.pod:2065
24098 msgid "guestfs_get_path"
24102 #: ../src/guestfs-actions.pod:2067
24106 " guestfs_get_path (guestfs_h *g);\n"
24111 #: ../src/guestfs-actions.pod:2075 ../src/guestfs-actions.pod:2115
24113 "This function returns a string, or NULL on error. The string is owned by "
24114 "the guest handle and must I<not> be freed."
24118 #: ../src/guestfs-actions.pod:2080
24119 msgid "guestfs_get_pgroup"
24123 #: ../src/guestfs-actions.pod:2082
24127 " guestfs_get_pgroup (guestfs_h *g);\n"
24132 #: ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:6353
24133 #: ../src/guestfs-actions.pod:7685
24134 msgid "(Added in 1.11.18)"
24138 #: ../src/guestfs-actions.pod:2091
24139 msgid "guestfs_get_pid"
24143 #: ../src/guestfs-actions.pod:2093
24147 " guestfs_get_pid (guestfs_h *g);\n"
24152 #: ../src/guestfs-actions.pod:2103
24153 msgid "(Added in 1.0.56)"
24157 #: ../src/guestfs-actions.pod:2105
24158 msgid "guestfs_get_qemu"
24162 #: ../src/guestfs-actions.pod:2107
24166 " guestfs_get_qemu (guestfs_h *g);\n"
24171 #: ../src/guestfs-actions.pod:2118 ../src/guestfs-actions.pod:6381
24172 msgid "(Added in 1.0.6)"
24176 #: ../src/guestfs-actions.pod:2120
24177 msgid "guestfs_get_recovery_proc"
24181 #: ../src/guestfs-actions.pod:2122
24185 " guestfs_get_recovery_proc (guestfs_h *g);\n"
24190 #: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3663
24191 #: ../src/guestfs-actions.pod:3994 ../src/guestfs-actions.pod:4397
24192 #: ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:5617
24193 #: ../src/guestfs-actions.pod:5960 ../src/guestfs-actions.pod:6405
24194 #: ../src/guestfs-actions.pod:7096 ../src/guestfs-actions.pod:7116
24195 #: ../src/guestfs-actions.pod:7308
24196 msgid "(Added in 1.0.77)"
24200 #: ../src/guestfs-actions.pod:2131
24201 msgid "guestfs_get_selinux"
24205 #: ../src/guestfs-actions.pod:2133
24209 " guestfs_get_selinux (guestfs_h *g);\n"
24214 #: ../src/guestfs-actions.pod:2136
24216 "This returns the current setting of the selinux flag which is passed to the "
24217 "appliance at boot time. See C<guestfs_set_selinux>."
24221 #: ../src/guestfs-actions.pod:2144 ../src/guestfs-actions.pod:2207
24222 #: ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6482
24223 msgid "(Added in 1.0.67)"
24227 #: ../src/guestfs-actions.pod:2146
24228 msgid "guestfs_get_state"
24232 #: ../src/guestfs-actions.pod:2148
24236 " guestfs_get_state (guestfs_h *g);\n"
24241 #: ../src/guestfs-actions.pod:2160
24242 msgid "guestfs_get_trace"
24246 #: ../src/guestfs-actions.pod:2162
24250 " guestfs_get_trace (guestfs_h *g);\n"
24255 #: ../src/guestfs-actions.pod:2171
24256 msgid "guestfs_get_umask"
24260 #: ../src/guestfs-actions.pod:2173
24264 " guestfs_get_umask (guestfs_h *g);\n"
24269 #: ../src/guestfs-actions.pod:2176
24271 "Return the current umask. By default the umask is C<022> unless it has been "
24272 "set by calling C<guestfs_umask>."
24276 #: ../src/guestfs-actions.pod:2183
24277 msgid "guestfs_get_verbose"
24281 #: ../src/guestfs-actions.pod:2185
24285 " guestfs_get_verbose (guestfs_h *g);\n"
24290 #: ../src/guestfs-actions.pod:2194
24291 msgid "guestfs_getcon"
24295 #: ../src/guestfs-actions.pod:2196
24299 " guestfs_getcon (guestfs_h *g);\n"
24304 #: ../src/guestfs-actions.pod:2201
24306 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
24310 #: ../src/guestfs-actions.pod:2209
24311 msgid "guestfs_getxattr"
24315 #: ../src/guestfs-actions.pod:2211
24319 " guestfs_getxattr (guestfs_h *g,\n"
24320 " const char *path,\n"
24321 " const char *name,\n"
24322 " size_t *size_r);\n"
24327 #: ../src/guestfs-actions.pod:2217
24329 "Get a single extended attribute from file C<path> named C<name>. This call "
24330 "follows symlinks. If you want to lookup an extended attribute for the "
24331 "symlink itself, use C<guestfs_lgetxattr>."
24335 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:3677
24337 "Normally it is better to get all extended attributes from a file in one go "
24338 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
24339 "implementations are buggy and do not provide a way to list out attributes. "
24340 "For these filesystems (notably ntfs-3g) you have to know the names of the "
24341 "extended attributes you want in advance and call this function."
24345 #: ../src/guestfs-actions.pod:2231
24346 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
24350 #: ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:2424
24351 #: ../src/guestfs-actions.pod:2894 ../src/guestfs-actions.pod:3689
24352 #: ../src/guestfs-actions.pod:5610 ../src/guestfs-actions.pod:5636
24353 #: ../src/guestfs-actions.pod:5817
24355 "This function returns a buffer, or NULL on error. The size of the returned "
24356 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
24361 #: ../src/guestfs-actions.pod:2237 ../src/guestfs-actions.pod:3693
24362 msgid "(Added in 1.7.24)"
24366 #: ../src/guestfs-actions.pod:2239
24367 msgid "guestfs_getxattrs"
24371 #: ../src/guestfs-actions.pod:2241
24374 " struct guestfs_xattr_list *\n"
24375 " guestfs_getxattrs (guestfs_h *g,\n"
24376 " const char *path);\n"
24381 #: ../src/guestfs-actions.pod:2251
24382 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
24386 #: ../src/guestfs-actions.pod:2253 ../src/guestfs-actions.pod:3705
24387 #: ../src/guestfs-actions.pod:4393
24389 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
24390 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
24394 #: ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:3709
24395 #: ../src/guestfs-actions.pod:3908 ../src/guestfs-actions.pod:3944
24396 #: ../src/guestfs-actions.pod:5990 ../src/guestfs-actions.pod:6501
24397 #: ../src/guestfs-actions.pod:7888
24398 msgid "(Added in 1.0.59)"
24402 #: ../src/guestfs-actions.pod:2259
24403 msgid "guestfs_glob_expand"
24407 #: ../src/guestfs-actions.pod:2261
24411 " guestfs_glob_expand (guestfs_h *g,\n"
24412 " const char *pattern);\n"
24417 #: ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:6694
24418 #: ../src/guestfs-actions.pod:6711
24419 msgid "(Added in 1.0.50)"
24423 #: ../src/guestfs-actions.pod:2282
24424 msgid "guestfs_grep"
24428 #: ../src/guestfs-actions.pod:2284
24432 " guestfs_grep (guestfs_h *g,\n"
24433 " const char *regex,\n"
24434 " const char *path);\n"
24439 #: ../src/guestfs-actions.pod:2301
24440 msgid "guestfs_grepi"
24444 #: ../src/guestfs-actions.pod:2303
24448 " guestfs_grepi (guestfs_h *g,\n"
24449 " const char *regex,\n"
24450 " const char *path);\n"
24455 #: ../src/guestfs-actions.pod:2320
24456 msgid "guestfs_grub_install"
24460 #: ../src/guestfs-actions.pod:2322
24464 " guestfs_grub_install (guestfs_h *g,\n"
24465 " const char *root,\n"
24466 " const char *device);\n"
24471 #: ../src/guestfs-actions.pod:2343
24472 msgid "(Added in 1.0.17)"
24476 #: ../src/guestfs-actions.pod:2345
24477 msgid "guestfs_head"
24481 #: ../src/guestfs-actions.pod:2347
24485 " guestfs_head (guestfs_h *g,\n"
24486 " const char *path);\n"
24491 #: ../src/guestfs-actions.pod:2363
24492 msgid "guestfs_head_n"
24496 #: ../src/guestfs-actions.pod:2365
24500 " guestfs_head_n (guestfs_h *g,\n"
24502 " const char *path);\n"
24507 #: ../src/guestfs-actions.pod:2387
24508 msgid "guestfs_hexdump"
24512 #: ../src/guestfs-actions.pod:2389
24516 " guestfs_hexdump (guestfs_h *g,\n"
24517 " const char *path);\n"
24522 #: ../src/guestfs-actions.pod:2402 ../src/guestfs-actions.pod:6775
24523 #: ../src/guestfs-actions.pod:6830
24524 msgid "(Added in 1.0.22)"
24528 #: ../src/guestfs-actions.pod:2404
24529 msgid "guestfs_initrd_cat"
24533 #: ../src/guestfs-actions.pod:2406
24537 " guestfs_initrd_cat (guestfs_h *g,\n"
24538 " const char *initrdpath,\n"
24539 " const char *filename,\n"
24540 " size_t *size_r);\n"
24545 #: ../src/guestfs-actions.pod:2422
24546 msgid "See also C<guestfs_initrd_list>."
24550 #: ../src/guestfs-actions.pod:2433
24551 msgid "guestfs_initrd_list"
24555 #: ../src/guestfs-actions.pod:2435
24559 " guestfs_initrd_list (guestfs_h *g,\n"
24560 " const char *path);\n"
24565 #: ../src/guestfs-actions.pod:2455
24566 msgid "guestfs_inotify_add_watch"
24570 #: ../src/guestfs-actions.pod:2457
24574 " guestfs_inotify_add_watch (guestfs_h *g,\n"
24575 " const char *path,\n"
24581 #: ../src/guestfs-actions.pod:2476
24582 msgid "guestfs_inotify_close"
24586 #: ../src/guestfs-actions.pod:2478
24590 " guestfs_inotify_close (guestfs_h *g);\n"
24595 #: ../src/guestfs-actions.pod:2489
24596 msgid "guestfs_inotify_files"
24600 #: ../src/guestfs-actions.pod:2491
24604 " guestfs_inotify_files (guestfs_h *g);\n"
24609 #: ../src/guestfs-actions.pod:2494
24611 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
24612 "returns a list of pathnames of objects that were touched. The returned "
24613 "pathnames are sorted and deduplicated."
24617 #: ../src/guestfs-actions.pod:2504
24618 msgid "guestfs_inotify_init"
24622 #: ../src/guestfs-actions.pod:2506
24626 " guestfs_inotify_init (guestfs_h *g,\n"
24627 " int maxevents);\n"
24632 #: ../src/guestfs-actions.pod:2514
24634 "C<maxevents> is the maximum number of events which will be queued up between "
24635 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
24636 "passed as C<0>, then the kernel (or previously set) default is used. For "
24637 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
24638 "throws away events, but records the fact that it threw them away by setting "
24639 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
24640 "C<guestfs_inotify_read>)."
24644 #: ../src/guestfs-actions.pod:2524
24646 "Before any events are generated, you have to add some watches to the "
24647 "internal watch list. See: C<guestfs_inotify_add_watch>, "
24648 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
24652 #: ../src/guestfs-actions.pod:2530
24654 "Queued up events should be read periodically by calling "
24655 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
24656 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
24657 "often enough then you risk the internal queue overflowing."
24661 #: ../src/guestfs-actions.pod:2537
24663 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
24664 "This also removes any watches automatically."
24668 #: ../src/guestfs-actions.pod:2550
24669 msgid "guestfs_inotify_read"
24673 #: ../src/guestfs-actions.pod:2552
24676 " struct guestfs_inotify_event_list *\n"
24677 " guestfs_inotify_read (guestfs_h *g);\n"
24682 #: ../src/guestfs-actions.pod:2566
24684 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
24685 "there was an error. I<The caller must call "
24686 "C<guestfs_free_inotify_event_list> after use>."
24690 #: ../src/guestfs-actions.pod:2572
24691 msgid "guestfs_inotify_rm_watch"
24695 #: ../src/guestfs-actions.pod:2574
24699 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
24705 #: ../src/guestfs-actions.pod:2578
24707 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
24711 #: ../src/guestfs-actions.pod:2585
24712 msgid "guestfs_inspect_get_arch"
24716 #: ../src/guestfs-actions.pod:2587
24720 " guestfs_inspect_get_arch (guestfs_h *g,\n"
24721 " const char *root);\n"
24726 #: ../src/guestfs-actions.pod:2591
24728 "This returns the architecture of the inspected operating system. The "
24729 "possible return values are listed under C<guestfs_file_architecture>."
24733 #: ../src/guestfs-actions.pod:2605
24734 msgid "guestfs_inspect_get_distro"
24738 #: ../src/guestfs-actions.pod:2607
24742 " guestfs_inspect_get_distro (guestfs_h *g,\n"
24743 " const char *root);\n"
24748 #: ../src/guestfs-actions.pod:2695
24749 msgid "guestfs_inspect_get_drive_mappings"
24753 #: ../src/guestfs-actions.pod:2697
24757 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
24758 " const char *root);\n"
24763 #: ../src/guestfs-actions.pod:2726
24765 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24766 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
24770 #: ../src/guestfs-actions.pod:2730 ../src/guestfs-actions.pod:2998
24771 #: ../src/guestfs-actions.pod:3796 ../src/guestfs-actions.pod:5078
24772 #: ../src/guestfs-actions.pod:7132
24774 "This function returns a NULL-terminated array of strings, or NULL if there "
24775 "was an error. The array of strings will always have length C<2n+1>, where "
24776 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
24777 "caller must free the strings and the array after use>."
24781 #: ../src/guestfs-actions.pod:2736 ../src/guestfs-actions.pod:3192
24782 msgid "(Added in 1.9.17)"
24786 #: ../src/guestfs-actions.pod:2738
24787 msgid "guestfs_inspect_get_filesystems"
24791 #: ../src/guestfs-actions.pod:2740
24795 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
24796 " const char *root);\n"
24801 #: ../src/guestfs-actions.pod:2752
24803 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24804 "C<guestfs_inspect_get_mountpoints>."
24808 #: ../src/guestfs-actions.pod:2761
24809 msgid "guestfs_inspect_get_format"
24813 #: ../src/guestfs-actions.pod:2763
24817 " guestfs_inspect_get_format (guestfs_h *g,\n"
24818 " const char *root);\n"
24823 #: ../src/guestfs-actions.pod:2797 ../src/guestfs-actions.pod:3228
24824 #: ../src/guestfs-actions.pod:3244 ../src/guestfs-actions.pod:3262
24825 #: ../src/guestfs-actions.pod:6028
24826 msgid "(Added in 1.9.4)"
24830 #: ../src/guestfs-actions.pod:2799
24831 msgid "guestfs_inspect_get_hostname"
24835 #: ../src/guestfs-actions.pod:2801
24839 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
24840 " const char *root);\n"
24845 #: ../src/guestfs-actions.pod:2816
24846 msgid "(Added in 1.7.9)"
24850 #: ../src/guestfs-actions.pod:2818
24851 msgid "guestfs_inspect_get_icon"
24855 #: ../src/guestfs-actions.pod:2820
24859 " guestfs_inspect_get_icon (guestfs_h *g,\n"
24860 " const char *root,\n"
24861 " size_t *size_r,\n"
24867 #: ../src/guestfs-actions.pod:2831
24870 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
24871 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
24876 #: ../src/guestfs-actions.pod:2898 ../src/guestfs-actions.pod:3723
24877 #: ../src/guestfs-actions.pod:4977
24878 msgid "(Added in 1.11.12)"
24882 #: ../src/guestfs-actions.pod:2900
24883 msgid "guestfs_inspect_get_icon_va"
24887 #: ../src/guestfs-actions.pod:2902
24891 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
24892 " const char *root,\n"
24893 " size_t *size_r,\n"
24894 " va_list args);\n"
24899 #: ../src/guestfs-actions.pod:2908
24900 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
24904 #: ../src/guestfs-actions.pod:2912
24905 msgid "guestfs_inspect_get_icon_argv"
24909 #: ../src/guestfs-actions.pod:2914
24913 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
24914 " const char *root,\n"
24915 " size_t *size_r,\n"
24916 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
24921 #: ../src/guestfs-actions.pod:2920
24922 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
24926 #: ../src/guestfs-actions.pod:2924
24927 msgid "guestfs_inspect_get_major_version"
24931 #: ../src/guestfs-actions.pod:2926
24935 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
24936 " const char *root);\n"
24941 #: ../src/guestfs-actions.pod:2948
24942 msgid "guestfs_inspect_get_minor_version"
24946 #: ../src/guestfs-actions.pod:2950
24950 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
24951 " const char *root);\n"
24956 #: ../src/guestfs-actions.pod:2959
24958 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24959 "C<guestfs_inspect_get_major_version>."
24963 #: ../src/guestfs-actions.pod:2966
24964 msgid "guestfs_inspect_get_mountpoints"
24968 #: ../src/guestfs-actions.pod:2968
24972 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
24973 " const char *root);\n"
24978 #: ../src/guestfs-actions.pod:2989
24980 "For operating systems like Windows which still use drive letters, this call "
24981 "will only return an entry for the first drive \"mounted on\" C</>. For "
24982 "information about the mapping of drive letters to partitions, see "
24983 "C<guestfs_inspect_get_drive_mappings>."
24987 #: ../src/guestfs-actions.pod:2995
24989 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24990 "C<guestfs_inspect_get_filesystems>."
24994 #: ../src/guestfs-actions.pod:3006
24995 msgid "guestfs_inspect_get_package_format"
24999 #: ../src/guestfs-actions.pod:3008
25003 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
25004 " const char *root);\n"
25009 #: ../src/guestfs-actions.pod:3012
25011 "This function and C<guestfs_inspect_get_package_management> return the "
25012 "package format and package management tool used by the inspected operating "
25013 "system. For example for Fedora these functions would return C<rpm> (package "
25014 "format) and C<yum> (package management)."
25018 #: ../src/guestfs-actions.pod:3030 ../src/guestfs-actions.pod:3058
25019 msgid "(Added in 1.7.5)"
25023 #: ../src/guestfs-actions.pod:3032
25024 msgid "guestfs_inspect_get_package_management"
25028 #: ../src/guestfs-actions.pod:3034
25032 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
25033 " const char *root);\n"
25038 #: ../src/guestfs-actions.pod:3038
25040 "C<guestfs_inspect_get_package_format> and this function return the package "
25041 "format and package management tool used by the inspected operating system. "
25042 "For example for Fedora these functions would return C<rpm> (package format) "
25043 "and C<yum> (package management)."
25047 #: ../src/guestfs-actions.pod:3060
25048 msgid "guestfs_inspect_get_product_name"
25052 #: ../src/guestfs-actions.pod:3062
25056 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
25057 " const char *root);\n"
25062 #: ../src/guestfs-actions.pod:3081
25063 msgid "guestfs_inspect_get_product_variant"
25067 #: ../src/guestfs-actions.pod:3083
25071 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
25072 " const char *root);\n"
25077 #: ../src/guestfs-actions.pod:3106
25079 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25080 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
25084 #: ../src/guestfs-actions.pod:3113
25085 msgid "(Added in 1.9.13)"
25089 #: ../src/guestfs-actions.pod:3115
25090 msgid "guestfs_inspect_get_roots"
25094 #: ../src/guestfs-actions.pod:3117
25098 " guestfs_inspect_get_roots (guestfs_h *g);\n"
25103 #: ../src/guestfs-actions.pod:3120
25105 "This function is a convenient way to get the list of root devices, as "
25106 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
25107 "the whole inspection process."
25111 #: ../src/guestfs-actions.pod:3124
25113 "This returns an empty list if either no root devices were found or the "
25114 "caller has not called C<guestfs_inspect_os>."
25118 #: ../src/guestfs-actions.pod:3133
25119 msgid "(Added in 1.7.3)"
25123 #: ../src/guestfs-actions.pod:3135
25124 msgid "guestfs_inspect_get_type"
25128 #: ../src/guestfs-actions.pod:3137
25132 " guestfs_inspect_get_type (guestfs_h *g,\n"
25133 " const char *root);\n"
25138 #: ../src/guestfs-actions.pod:3174
25139 msgid "guestfs_inspect_get_windows_current_control_set"
25143 #: ../src/guestfs-actions.pod:3176
25147 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
25148 " const char *root);\n"
25153 #: ../src/guestfs-actions.pod:3194
25154 msgid "guestfs_inspect_get_windows_systemroot"
25158 #: ../src/guestfs-actions.pod:3196
25162 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
25163 " const char *root);\n"
25168 #: ../src/guestfs-actions.pod:3212
25169 msgid "(Added in 1.5.25)"
25173 #: ../src/guestfs-actions.pod:3214
25174 msgid "guestfs_inspect_is_live"
25178 #: ../src/guestfs-actions.pod:3216
25182 " guestfs_inspect_is_live (guestfs_h *g,\n"
25183 " const char *root);\n"
25188 #: ../src/guestfs-actions.pod:3220
25190 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25191 "disk), then this returns true if a live image was detected on the disk."
25195 #: ../src/guestfs-actions.pod:3230
25196 msgid "guestfs_inspect_is_multipart"
25200 #: ../src/guestfs-actions.pod:3232
25204 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
25205 " const char *root);\n"
25210 #: ../src/guestfs-actions.pod:3236
25212 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25213 "disk), then this returns true if the disk is part of a set."
25217 #: ../src/guestfs-actions.pod:3246
25218 msgid "guestfs_inspect_is_netinst"
25222 #: ../src/guestfs-actions.pod:3248
25226 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
25227 " const char *root);\n"
25232 #: ../src/guestfs-actions.pod:3252
25234 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25235 "disk), then this returns true if the disk is a network installer, ie. not a "
25236 "self-contained install CD but one which is likely to require network access "
25237 "to complete the install."
25241 #: ../src/guestfs-actions.pod:3264
25242 msgid "guestfs_inspect_list_applications"
25246 #: ../src/guestfs-actions.pod:3266
25249 " struct guestfs_application_list *\n"
25250 " guestfs_inspect_list_applications (guestfs_h *g,\n"
25251 " const char *root);\n"
25256 #: ../src/guestfs-actions.pod:3272
25258 "I<Note:> This call works differently from other parts of the inspection "
25259 "API. You have to call C<guestfs_inspect_os>, then "
25260 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
25261 "this. Listing applications is a significantly more difficult operation "
25262 "which requires access to the full filesystem. Also note that unlike the "
25263 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
25264 "the libguestfs handle, this call actually reads parts of the mounted "
25265 "filesystems during the call."
25269 #: ../src/guestfs-actions.pod:3362
25271 "This function returns a C<struct guestfs_application_list *>, or NULL if "
25272 "there was an error. I<The caller must call C<guestfs_free_application_list> "
25277 #: ../src/guestfs-actions.pod:3366
25278 msgid "(Added in 1.7.8)"
25282 #: ../src/guestfs-actions.pod:3368
25283 msgid "guestfs_inspect_os"
25287 #: ../src/guestfs-actions.pod:3370
25291 " guestfs_inspect_os (guestfs_h *g);\n"
25296 #: ../src/guestfs-actions.pod:3386
25298 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
25299 "functions in order to query further information about each operating system, "
25300 "such as the name and version."
25304 #: ../src/guestfs-actions.pod:3391
25306 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
25307 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
25308 "the contents. This should be called with no disks currently mounted. The "
25309 "function may also use Augeas, so any existing Augeas handle will be closed."
25313 #: ../src/guestfs-actions.pod:3403 ../src/guestfs-actions.pod:3734
25314 #: ../src/guestfs-actions.pod:3816
25315 msgid "See also C<guestfs_list_filesystems>."
25319 #: ../src/guestfs-actions.pod:3411
25320 msgid "guestfs_is_blockdev"
25324 #: ../src/guestfs-actions.pod:3413
25328 " guestfs_is_blockdev (guestfs_h *g,\n"
25329 " const char *path);\n"
25334 #: ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:3449
25335 #: ../src/guestfs-actions.pod:3479 ../src/guestfs-actions.pod:3494
25336 #: ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:3566
25337 #: ../src/guestfs-actions.pod:3581
25338 msgid "See also C<guestfs_stat>."
25342 #: ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:3453
25343 #: ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3570
25344 #: ../src/guestfs-actions.pod:3585
25345 msgid "(Added in 1.5.10)"
25349 #: ../src/guestfs-actions.pod:3426
25350 msgid "guestfs_is_busy"
25354 #: ../src/guestfs-actions.pod:3428
25358 " guestfs_is_busy (guestfs_h *g);\n"
25363 #: ../src/guestfs-actions.pod:3440
25364 msgid "guestfs_is_chardev"
25368 #: ../src/guestfs-actions.pod:3442
25372 " guestfs_is_chardev (guestfs_h *g,\n"
25373 " const char *path);\n"
25378 #: ../src/guestfs-actions.pod:3455
25379 msgid "guestfs_is_config"
25383 #: ../src/guestfs-actions.pod:3457
25387 " guestfs_is_config (guestfs_h *g);\n"
25392 #: ../src/guestfs-actions.pod:3469
25393 msgid "guestfs_is_dir"
25397 #: ../src/guestfs-actions.pod:3471
25401 " guestfs_is_dir (guestfs_h *g,\n"
25402 " const char *path);\n"
25407 #: ../src/guestfs-actions.pod:3485
25408 msgid "guestfs_is_fifo"
25412 #: ../src/guestfs-actions.pod:3487
25416 " guestfs_is_fifo (guestfs_h *g,\n"
25417 " const char *path);\n"
25422 #: ../src/guestfs-actions.pod:3500
25423 msgid "guestfs_is_file"
25427 #: ../src/guestfs-actions.pod:3502
25431 " guestfs_is_file (guestfs_h *g,\n"
25432 " const char *path);\n"
25437 #: ../src/guestfs-actions.pod:3516
25438 msgid "guestfs_is_launching"
25442 #: ../src/guestfs-actions.pod:3518
25446 " guestfs_is_launching (guestfs_h *g);\n"
25451 #: ../src/guestfs-actions.pod:3530
25452 msgid "guestfs_is_lv"
25456 #: ../src/guestfs-actions.pod:3532
25460 " guestfs_is_lv (guestfs_h *g,\n"
25461 " const char *device);\n"
25466 #: ../src/guestfs-actions.pod:3543
25467 msgid "guestfs_is_ready"
25471 #: ../src/guestfs-actions.pod:3545
25475 " guestfs_is_ready (guestfs_h *g);\n"
25480 #: ../src/guestfs-actions.pod:3557
25481 msgid "guestfs_is_socket"
25485 #: ../src/guestfs-actions.pod:3559
25489 " guestfs_is_socket (guestfs_h *g,\n"
25490 " const char *path);\n"
25495 #: ../src/guestfs-actions.pod:3572
25496 msgid "guestfs_is_symlink"
25500 #: ../src/guestfs-actions.pod:3574
25504 " guestfs_is_symlink (guestfs_h *g,\n"
25505 " const char *path);\n"
25510 #: ../src/guestfs-actions.pod:3587
25511 msgid "guestfs_is_zero"
25515 #: ../src/guestfs-actions.pod:3589
25519 " guestfs_is_zero (guestfs_h *g,\n"
25520 " const char *path);\n"
25525 #: ../src/guestfs-actions.pod:3598 ../src/guestfs-actions.pod:3612
25526 msgid "(Added in 1.11.8)"
25530 #: ../src/guestfs-actions.pod:3600
25531 msgid "guestfs_is_zero_device"
25535 #: ../src/guestfs-actions.pod:3602
25539 " guestfs_is_zero_device (guestfs_h *g,\n"
25540 " const char *device);\n"
25545 #: ../src/guestfs-actions.pod:3614
25546 msgid "guestfs_kill_subprocess"
25550 #: ../src/guestfs-actions.pod:3616
25554 " guestfs_kill_subprocess (guestfs_h *g);\n"
25559 #: ../src/guestfs-actions.pod:3625
25560 msgid "guestfs_launch"
25564 #: ../src/guestfs-actions.pod:3627
25568 " guestfs_launch (guestfs_h *g);\n"
25573 #: ../src/guestfs-actions.pod:3645
25574 msgid "guestfs_lchown"
25578 #: ../src/guestfs-actions.pod:3647
25582 " guestfs_lchown (guestfs_h *g,\n"
25585 " const char *path);\n"
25590 #: ../src/guestfs-actions.pod:3653
25592 "Change the file owner to C<owner> and group to C<group>. This is like "
25593 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
25594 "changed, not the target."
25598 #: ../src/guestfs-actions.pod:3665
25599 msgid "guestfs_lgetxattr"
25603 #: ../src/guestfs-actions.pod:3667
25607 " guestfs_lgetxattr (guestfs_h *g,\n"
25608 " const char *path,\n"
25609 " const char *name,\n"
25610 " size_t *size_r);\n"
25615 #: ../src/guestfs-actions.pod:3687
25616 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
25620 #: ../src/guestfs-actions.pod:3695
25621 msgid "guestfs_lgetxattrs"
25625 #: ../src/guestfs-actions.pod:3697
25628 " struct guestfs_xattr_list *\n"
25629 " guestfs_lgetxattrs (guestfs_h *g,\n"
25630 " const char *path);\n"
25635 #: ../src/guestfs-actions.pod:3701
25637 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
25638 "then it returns the extended attributes of the link itself."
25642 #: ../src/guestfs-actions.pod:3711
25643 msgid "guestfs_list_9p"
25647 #: ../src/guestfs-actions.pod:3713
25651 " guestfs_list_9p (guestfs_h *g);\n"
25656 #: ../src/guestfs-actions.pod:3725
25657 msgid "guestfs_list_devices"
25661 #: ../src/guestfs-actions.pod:3727
25665 " guestfs_list_devices (guestfs_h *g);\n"
25670 #: ../src/guestfs-actions.pod:3742
25671 msgid "guestfs_list_dm_devices"
25675 #: ../src/guestfs-actions.pod:3744
25679 " guestfs_list_dm_devices (guestfs_h *g);\n"
25684 #: ../src/guestfs-actions.pod:3749
25686 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
25687 "previous call to C<guestfs_luks_open>."
25691 #: ../src/guestfs-actions.pod:3752
25693 "Device mapper devices which correspond to logical volumes are I<not> "
25694 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
25699 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:5216
25700 msgid "(Added in 1.11.15)"
25704 #: ../src/guestfs-actions.pod:3762
25705 msgid "guestfs_list_filesystems"
25709 #: ../src/guestfs-actions.pod:3764
25713 " guestfs_list_filesystems (guestfs_h *g);\n"
25718 #: ../src/guestfs-actions.pod:3784
25720 "This command runs other libguestfs commands, which might include "
25721 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
25722 "soon after launch and only when nothing is mounted."
25726 #: ../src/guestfs-actions.pod:3788
25728 "Not all of the filesystems returned will be mountable. In particular, swap "
25729 "partitions are returned in the list. Also this command does not check that "
25730 "each filesystem found is valid and mountable, and some filesystems might be "
25731 "mountable but require special options. Filesystems may not all belong to a "
25732 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
25736 #: ../src/guestfs-actions.pod:3802 ../src/guestfs-actions.pod:5577
25737 msgid "(Added in 1.5.15)"
25741 #: ../src/guestfs-actions.pod:3804
25742 msgid "guestfs_list_partitions"
25746 #: ../src/guestfs-actions.pod:3806
25750 " guestfs_list_partitions (guestfs_h *g);\n"
25755 #: ../src/guestfs-actions.pod:3813
25757 "This does not return logical volumes. For that you will need to call "
25762 #: ../src/guestfs-actions.pod:3824
25767 #: ../src/guestfs-actions.pod:3826
25771 " guestfs_ll (guestfs_h *g,\n"
25772 " const char *directory);\n"
25777 #: ../src/guestfs-actions.pod:3841
25782 #: ../src/guestfs-actions.pod:3843
25786 " guestfs_ln (guestfs_h *g,\n"
25787 " const char *target,\n"
25788 " const char *linkname);\n"
25793 #: ../src/guestfs-actions.pod:3854
25794 msgid "guestfs_ln_f"
25798 #: ../src/guestfs-actions.pod:3856
25802 " guestfs_ln_f (guestfs_h *g,\n"
25803 " const char *target,\n"
25804 " const char *linkname);\n"
25809 #: ../src/guestfs-actions.pod:3868
25810 msgid "guestfs_ln_s"
25814 #: ../src/guestfs-actions.pod:3870
25818 " guestfs_ln_s (guestfs_h *g,\n"
25819 " const char *target,\n"
25820 " const char *linkname);\n"
25825 #: ../src/guestfs-actions.pod:3881
25826 msgid "guestfs_ln_sf"
25830 #: ../src/guestfs-actions.pod:3883
25834 " guestfs_ln_sf (guestfs_h *g,\n"
25835 " const char *target,\n"
25836 " const char *linkname);\n"
25841 #: ../src/guestfs-actions.pod:3895
25842 msgid "guestfs_lremovexattr"
25846 #: ../src/guestfs-actions.pod:3897
25850 " guestfs_lremovexattr (guestfs_h *g,\n"
25851 " const char *xattr,\n"
25852 " const char *path);\n"
25857 #: ../src/guestfs-actions.pod:3902
25859 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
25860 "link, then it removes an extended attribute of the link itself."
25864 #: ../src/guestfs-actions.pod:3910
25869 #: ../src/guestfs-actions.pod:3912
25873 " guestfs_ls (guestfs_h *g,\n"
25874 " const char *directory);\n"
25879 #: ../src/guestfs-actions.pod:3920
25881 "This command is mostly useful for interactive sessions. Programs should "
25882 "probably use C<guestfs_readdir> instead."
25886 #: ../src/guestfs-actions.pod:3929
25887 msgid "guestfs_lsetxattr"
25891 #: ../src/guestfs-actions.pod:3931
25895 " guestfs_lsetxattr (guestfs_h *g,\n"
25896 " const char *xattr,\n"
25897 " const char *val,\n"
25899 " const char *path);\n"
25904 #: ../src/guestfs-actions.pod:3938
25906 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
25907 "then it sets an extended attribute of the link itself."
25911 #: ../src/guestfs-actions.pod:3946
25912 msgid "guestfs_lstat"
25916 #: ../src/guestfs-actions.pod:3948
25919 " struct guestfs_stat *\n"
25920 " guestfs_lstat (guestfs_h *g,\n"
25921 " const char *path);\n"
25926 #: ../src/guestfs-actions.pod:3954
25928 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
25929 "link, then the link is stat-ed, not the file it refers to."
25933 #: ../src/guestfs-actions.pod:3960 ../src/guestfs-actions.pod:6735
25935 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
25936 "error. I<The caller must call C<guestfs_free_stat> after use>."
25940 #: ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:6739
25941 #: ../src/guestfs-actions.pod:6757 ../src/guestfs-actions.pod:7138
25942 msgid "(Added in 0.9.2)"
25946 #: ../src/guestfs-actions.pod:3966
25947 msgid "guestfs_lstatlist"
25951 #: ../src/guestfs-actions.pod:3968
25954 " struct guestfs_stat_list *\n"
25955 " guestfs_lstatlist (guestfs_h *g,\n"
25956 " const char *path,\n"
25957 " char *const *names);\n"
25962 #: ../src/guestfs-actions.pod:3973
25964 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
25965 "files, where all files are in the directory C<path>. C<names> is the list "
25966 "of files from this directory."
25970 #: ../src/guestfs-actions.pod:3982
25972 "This call is intended for programs that want to efficiently list a directory "
25973 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
25974 "for a similarly efficient call for getting extended attributes. Very long "
25975 "directory listings might cause the protocol message size to be exceeded, "
25976 "causing this call to fail. The caller must split up such requests into "
25977 "smaller groups of names."
25981 #: ../src/guestfs-actions.pod:3990
25983 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
25984 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
25988 #: ../src/guestfs-actions.pod:3996
25989 msgid "guestfs_luks_add_key"
25993 #: ../src/guestfs-actions.pod:3998
25997 " guestfs_luks_add_key (guestfs_h *g,\n"
25998 " const char *device,\n"
25999 " const char *key,\n"
26000 " const char *newkey,\n"
26006 #: ../src/guestfs-actions.pod:4010
26008 "Note that if C<keyslot> already contains a key, then this command will "
26009 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
26013 #: ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:4056
26014 #: ../src/guestfs-actions.pod:4079 ../src/guestfs-actions.pod:4099
26015 #: ../src/guestfs-actions.pod:4134 ../src/guestfs-actions.pod:4153
26017 "This function takes a key or passphrase parameter which could contain "
26018 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
26023 #: ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4060
26024 #: ../src/guestfs-actions.pod:4083 ../src/guestfs-actions.pod:4103
26025 msgid "(Added in 1.5.2)"
26029 #: ../src/guestfs-actions.pod:4022
26030 msgid "guestfs_luks_close"
26034 #: ../src/guestfs-actions.pod:4024
26038 " guestfs_luks_close (guestfs_h *g,\n"
26039 " const char *device);\n"
26044 #: ../src/guestfs-actions.pod:4028
26046 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
26047 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
26048 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
26049 "underlying block device."
26053 #: ../src/guestfs-actions.pod:4036 ../src/guestfs-actions.pod:4138
26054 #: ../src/guestfs-actions.pod:4157 ../src/guestfs-actions.pod:4207
26055 #: ../src/guestfs-actions.pod:4255
26056 msgid "(Added in 1.5.1)"
26060 #: ../src/guestfs-actions.pod:4038
26061 msgid "guestfs_luks_format"
26065 #: ../src/guestfs-actions.pod:4040
26069 " guestfs_luks_format (guestfs_h *g,\n"
26070 " const char *device,\n"
26071 " const char *key,\n"
26077 #: ../src/guestfs-actions.pod:4062
26078 msgid "guestfs_luks_format_cipher"
26082 #: ../src/guestfs-actions.pod:4064
26086 " guestfs_luks_format_cipher (guestfs_h *g,\n"
26087 " const char *device,\n"
26088 " const char *key,\n"
26090 " const char *cipher);\n"
26095 #: ../src/guestfs-actions.pod:4071
26097 "This command is the same as C<guestfs_luks_format> but it also allows you to "
26098 "set the C<cipher> used."
26102 #: ../src/guestfs-actions.pod:4085
26103 msgid "guestfs_luks_kill_slot"
26107 #: ../src/guestfs-actions.pod:4087
26111 " guestfs_luks_kill_slot (guestfs_h *g,\n"
26112 " const char *device,\n"
26113 " const char *key,\n"
26119 #: ../src/guestfs-actions.pod:4105
26120 msgid "guestfs_luks_open"
26124 #: ../src/guestfs-actions.pod:4107
26128 " guestfs_luks_open (guestfs_h *g,\n"
26129 " const char *device,\n"
26130 " const char *key,\n"
26131 " const char *mapname);\n"
26136 #: ../src/guestfs-actions.pod:4125
26138 "If this block device contains LVM volume groups, then calling "
26139 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
26144 #: ../src/guestfs-actions.pod:4129
26145 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
26149 #: ../src/guestfs-actions.pod:4140
26150 msgid "guestfs_luks_open_ro"
26154 #: ../src/guestfs-actions.pod:4142
26158 " guestfs_luks_open_ro (guestfs_h *g,\n"
26159 " const char *device,\n"
26160 " const char *key,\n"
26161 " const char *mapname);\n"
26166 #: ../src/guestfs-actions.pod:4148
26168 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
26173 #: ../src/guestfs-actions.pod:4159
26174 msgid "guestfs_lvcreate"
26178 #: ../src/guestfs-actions.pod:4161
26182 " guestfs_lvcreate (guestfs_h *g,\n"
26183 " const char *logvol,\n"
26184 " const char *volgroup,\n"
26190 #: ../src/guestfs-actions.pod:4174
26191 msgid "guestfs_lvm_canonical_lv_name"
26195 #: ../src/guestfs-actions.pod:4176
26199 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
26200 " const char *lvname);\n"
26205 #: ../src/guestfs-actions.pod:4187
26206 msgid "See also C<guestfs_is_lv>."
26210 #: ../src/guestfs-actions.pod:4192
26211 msgid "(Added in 1.5.24)"
26215 #: ../src/guestfs-actions.pod:4194
26216 msgid "guestfs_lvm_clear_filter"
26220 #: ../src/guestfs-actions.pod:4196
26224 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
26229 #: ../src/guestfs-actions.pod:4199
26231 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
26232 "see every block device."
26236 #: ../src/guestfs-actions.pod:4209
26237 msgid "guestfs_lvm_remove_all"
26241 #: ../src/guestfs-actions.pod:4211
26245 " guestfs_lvm_remove_all (guestfs_h *g);\n"
26250 #: ../src/guestfs-actions.pod:4224
26251 msgid "guestfs_lvm_set_filter"
26255 #: ../src/guestfs-actions.pod:4226
26259 " guestfs_lvm_set_filter (guestfs_h *g,\n"
26260 " char *const *devices);\n"
26265 #: ../src/guestfs-actions.pod:4257
26266 msgid "guestfs_lvremove"
26270 #: ../src/guestfs-actions.pod:4259
26274 " guestfs_lvremove (guestfs_h *g,\n"
26275 " const char *device);\n"
26280 #: ../src/guestfs-actions.pod:4271 ../src/guestfs-actions.pod:5674
26281 #: ../src/guestfs-actions.pod:7508
26282 msgid "(Added in 1.0.13)"
26286 #: ../src/guestfs-actions.pod:4273
26287 msgid "guestfs_lvrename"
26291 #: ../src/guestfs-actions.pod:4275
26295 " guestfs_lvrename (guestfs_h *g,\n"
26296 " const char *logvol,\n"
26297 " const char *newlogvol);\n"
26302 #: ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:7521
26303 msgid "(Added in 1.0.83)"
26307 #: ../src/guestfs-actions.pod:4286
26308 msgid "guestfs_lvresize"
26312 #: ../src/guestfs-actions.pod:4288
26316 " guestfs_lvresize (guestfs_h *g,\n"
26317 " const char *device,\n"
26323 #: ../src/guestfs-actions.pod:4301
26324 msgid "guestfs_lvresize_free"
26328 #: ../src/guestfs-actions.pod:4303
26332 " guestfs_lvresize_free (guestfs_h *g,\n"
26333 " const char *lv,\n"
26339 #: ../src/guestfs-actions.pod:4316
26340 msgid "(Added in 1.3.3)"
26344 #: ../src/guestfs-actions.pod:4318
26345 msgid "guestfs_lvs"
26349 #: ../src/guestfs-actions.pod:4320
26353 " guestfs_lvs (guestfs_h *g);\n"
26358 #: ../src/guestfs-actions.pod:4329
26359 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
26363 #: ../src/guestfs-actions.pod:4337
26364 msgid "guestfs_lvs_full"
26368 #: ../src/guestfs-actions.pod:4339
26371 " struct guestfs_lvm_lv_list *\n"
26372 " guestfs_lvs_full (guestfs_h *g);\n"
26377 #: ../src/guestfs-actions.pod:4345
26379 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
26380 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
26384 #: ../src/guestfs-actions.pod:4351
26385 msgid "guestfs_lvuuid"
26389 #: ../src/guestfs-actions.pod:4353
26393 " guestfs_lvuuid (guestfs_h *g,\n"
26394 " const char *device);\n"
26399 #: ../src/guestfs-actions.pod:4364
26400 msgid "guestfs_lxattrlist"
26404 #: ../src/guestfs-actions.pod:4366
26407 " struct guestfs_xattr_list *\n"
26408 " guestfs_lxattrlist (guestfs_h *g,\n"
26409 " const char *path,\n"
26410 " char *const *names);\n"
26415 #: ../src/guestfs-actions.pod:4385
26417 "This call is intended for programs that want to efficiently list a directory "
26418 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
26419 "a similarly efficient call for getting standard stats. Very long directory "
26420 "listings might cause the protocol message size to be exceeded, causing this "
26421 "call to fail. The caller must split up such requests into smaller groups of "
26426 #: ../src/guestfs-actions.pod:4399
26427 msgid "guestfs_mkdir"
26431 #: ../src/guestfs-actions.pod:4401
26435 " guestfs_mkdir (guestfs_h *g,\n"
26436 " const char *path);\n"
26441 #: ../src/guestfs-actions.pod:4411
26442 msgid "guestfs_mkdir_mode"
26446 #: ../src/guestfs-actions.pod:4413
26450 " guestfs_mkdir_mode (guestfs_h *g,\n"
26451 " const char *path,\n"
26457 #: ../src/guestfs-actions.pod:4425
26458 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
26462 #: ../src/guestfs-actions.pod:4431
26463 msgid "guestfs_mkdir_p"
26467 #: ../src/guestfs-actions.pod:4433
26471 " guestfs_mkdir_p (guestfs_h *g,\n"
26472 " const char *path);\n"
26477 #: ../src/guestfs-actions.pod:4444
26478 msgid "guestfs_mkdtemp"
26482 #: ../src/guestfs-actions.pod:4446
26486 " guestfs_mkdtemp (guestfs_h *g,\n"
26487 " const char *template);\n"
26492 #: ../src/guestfs-actions.pod:4474
26493 msgid "guestfs_mke2fs_J"
26497 #: ../src/guestfs-actions.pod:4476
26501 " guestfs_mke2fs_J (guestfs_h *g,\n"
26502 " const char *fstype,\n"
26503 " int blocksize,\n"
26504 " const char *device,\n"
26505 " const char *journal);\n"
26510 #: ../src/guestfs-actions.pod:4489
26511 msgid "See also C<guestfs_mke2journal>."
26515 #: ../src/guestfs-actions.pod:4493 ../src/guestfs-actions.pod:4511
26516 #: ../src/guestfs-actions.pod:4529 ../src/guestfs-actions.pod:4545
26517 #: ../src/guestfs-actions.pod:4559 ../src/guestfs-actions.pod:4573
26518 #: ../src/guestfs-actions.pod:4632 ../src/guestfs-actions.pod:4909
26519 msgid "(Added in 1.0.68)"
26523 #: ../src/guestfs-actions.pod:4495
26524 msgid "guestfs_mke2fs_JL"
26528 #: ../src/guestfs-actions.pod:4497
26532 " guestfs_mke2fs_JL (guestfs_h *g,\n"
26533 " const char *fstype,\n"
26534 " int blocksize,\n"
26535 " const char *device,\n"
26536 " const char *label);\n"
26541 #: ../src/guestfs-actions.pod:4507
26542 msgid "See also C<guestfs_mke2journal_L>."
26546 #: ../src/guestfs-actions.pod:4513
26547 msgid "guestfs_mke2fs_JU"
26551 #: ../src/guestfs-actions.pod:4515
26555 " guestfs_mke2fs_JU (guestfs_h *g,\n"
26556 " const char *fstype,\n"
26557 " int blocksize,\n"
26558 " const char *device,\n"
26559 " const char *uuid);\n"
26564 #: ../src/guestfs-actions.pod:4525
26565 msgid "See also C<guestfs_mke2journal_U>."
26569 #: ../src/guestfs-actions.pod:4531
26570 msgid "guestfs_mke2journal"
26574 #: ../src/guestfs-actions.pod:4533
26578 " guestfs_mke2journal (guestfs_h *g,\n"
26579 " int blocksize,\n"
26580 " const char *device);\n"
26585 #: ../src/guestfs-actions.pod:4547
26586 msgid "guestfs_mke2journal_L"
26590 #: ../src/guestfs-actions.pod:4549
26594 " guestfs_mke2journal_L (guestfs_h *g,\n"
26595 " int blocksize,\n"
26596 " const char *label,\n"
26597 " const char *device);\n"
26602 #: ../src/guestfs-actions.pod:4561
26603 msgid "guestfs_mke2journal_U"
26607 #: ../src/guestfs-actions.pod:4563
26611 " guestfs_mke2journal_U (guestfs_h *g,\n"
26612 " int blocksize,\n"
26613 " const char *uuid,\n"
26614 " const char *device);\n"
26619 #: ../src/guestfs-actions.pod:4575
26620 msgid "guestfs_mkfifo"
26624 #: ../src/guestfs-actions.pod:4577
26628 " guestfs_mkfifo (guestfs_h *g,\n"
26630 " const char *path);\n"
26635 #: ../src/guestfs-actions.pod:4582
26637 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26638 "is just a convenient wrapper around C<guestfs_mknod>."
26642 #: ../src/guestfs-actions.pod:4592
26643 msgid "guestfs_mkfs"
26647 #: ../src/guestfs-actions.pod:4594
26651 " guestfs_mkfs (guestfs_h *g,\n"
26652 " const char *fstype,\n"
26653 " const char *device);\n"
26658 #: ../src/guestfs-actions.pod:4607
26659 msgid "guestfs_mkfs_b"
26663 #: ../src/guestfs-actions.pod:4609
26667 " guestfs_mkfs_b (guestfs_h *g,\n"
26668 " const char *fstype,\n"
26669 " int blocksize,\n"
26670 " const char *device);\n"
26675 #: ../src/guestfs-actions.pod:4615
26677 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
26678 "block size of the resulting filesystem. Supported block sizes depend on the "
26679 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26683 #: ../src/guestfs-actions.pod:4634
26684 msgid "guestfs_mkfs_opts"
26688 #: ../src/guestfs-actions.pod:4636
26692 " guestfs_mkfs_opts (guestfs_h *g,\n"
26693 " const char *fstype,\n"
26694 " const char *device,\n"
26700 #: ../src/guestfs-actions.pod:4647
26703 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
26704 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
26705 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
26706 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
26711 #: ../src/guestfs-actions.pod:4695
26712 msgid "(Added in 1.7.19)"
26716 #: ../src/guestfs-actions.pod:4697
26717 msgid "guestfs_mkfs_opts_va"
26721 #: ../src/guestfs-actions.pod:4699
26725 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
26726 " const char *fstype,\n"
26727 " const char *device,\n"
26728 " va_list args);\n"
26733 #: ../src/guestfs-actions.pod:4705
26734 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
26738 #: ../src/guestfs-actions.pod:4709
26739 msgid "guestfs_mkfs_opts_argv"
26743 #: ../src/guestfs-actions.pod:4711
26747 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
26748 " const char *fstype,\n"
26749 " const char *device,\n"
26750 " const struct guestfs_mkfs_opts_argv *optargs);\n"
26755 #: ../src/guestfs-actions.pod:4717
26756 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
26760 #: ../src/guestfs-actions.pod:4721
26761 msgid "guestfs_mkmountpoint"
26765 #: ../src/guestfs-actions.pod:4723
26769 " guestfs_mkmountpoint (guestfs_h *g,\n"
26770 " const char *exemptpath);\n"
26775 #: ../src/guestfs-actions.pod:4727
26777 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
26778 "that can be used to create extra mountpoints before mounting the first "
26783 #: ../src/guestfs-actions.pod:4751
26785 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
26786 "may get unexpected errors if you try to mix these calls. It is safest to "
26787 "manually unmount filesystems and remove mountpoints after use."
26791 #: ../src/guestfs-actions.pod:4755
26793 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
26794 "first, so for this to work for manual mountpoints, you must ensure that the "
26795 "innermost mountpoints have the longest pathnames, as in the example code "
26800 #: ../src/guestfs-actions.pod:4762
26802 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
26803 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
26804 "can also trigger these issues."
26808 #: ../src/guestfs-actions.pod:4768 ../src/guestfs-actions.pod:5084
26809 #: ../src/guestfs-actions.pod:6094
26810 msgid "(Added in 1.0.62)"
26814 #: ../src/guestfs-actions.pod:4770
26815 msgid "guestfs_mknod"
26819 #: ../src/guestfs-actions.pod:4772
26823 " guestfs_mknod (guestfs_h *g,\n"
26827 " const char *path);\n"
26832 #: ../src/guestfs-actions.pod:4787
26834 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26835 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26836 "regular file). These constants are available in the standard Linux header "
26837 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
26838 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
26839 "the appropriate constant for you."
26843 #: ../src/guestfs-actions.pod:4801
26844 msgid "guestfs_mknod_b"
26848 #: ../src/guestfs-actions.pod:4803
26852 " guestfs_mknod_b (guestfs_h *g,\n"
26856 " const char *path);\n"
26861 #: ../src/guestfs-actions.pod:4810
26863 "This call creates a block device node called C<path> with mode C<mode> and "
26864 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26865 "wrapper around C<guestfs_mknod>."
26869 #: ../src/guestfs-actions.pod:4820
26870 msgid "guestfs_mknod_c"
26874 #: ../src/guestfs-actions.pod:4822
26878 " guestfs_mknod_c (guestfs_h *g,\n"
26882 " const char *path);\n"
26887 #: ../src/guestfs-actions.pod:4829
26889 "This call creates a char device node called C<path> with mode C<mode> and "
26890 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26891 "wrapper around C<guestfs_mknod>."
26895 #: ../src/guestfs-actions.pod:4839
26896 msgid "guestfs_mkswap"
26900 #: ../src/guestfs-actions.pod:4841
26904 " guestfs_mkswap (guestfs_h *g,\n"
26905 " const char *device);\n"
26910 #: ../src/guestfs-actions.pod:4851
26911 msgid "guestfs_mkswap_L"
26915 #: ../src/guestfs-actions.pod:4853
26919 " guestfs_mkswap_L (guestfs_h *g,\n"
26920 " const char *label,\n"
26921 " const char *device);\n"
26926 #: ../src/guestfs-actions.pod:4868
26927 msgid "guestfs_mkswap_U"
26931 #: ../src/guestfs-actions.pod:4870
26935 " guestfs_mkswap_U (guestfs_h *g,\n"
26936 " const char *uuid,\n"
26937 " const char *device);\n"
26942 #: ../src/guestfs-actions.pod:4881
26943 msgid "guestfs_mkswap_file"
26947 #: ../src/guestfs-actions.pod:4883
26951 " guestfs_mkswap_file (guestfs_h *g,\n"
26952 " const char *path);\n"
26957 #: ../src/guestfs-actions.pod:4889
26959 "This command just writes a swap file signature to an existing file. To "
26960 "create the file itself, use something like C<guestfs_fallocate>."
26964 #: ../src/guestfs-actions.pod:4896
26965 msgid "guestfs_modprobe"
26969 #: ../src/guestfs-actions.pod:4898
26973 " guestfs_modprobe (guestfs_h *g,\n"
26974 " const char *modulename);\n"
26979 #: ../src/guestfs-actions.pod:4911
26980 msgid "guestfs_mount"
26984 #: ../src/guestfs-actions.pod:4913
26988 " guestfs_mount (guestfs_h *g,\n"
26989 " const char *device,\n"
26990 " const char *mountpoint);\n"
26995 #: ../src/guestfs-actions.pod:4932
26997 "B<Important note:> When you use this call, the filesystem options C<sync> "
26998 "and C<noatime> are set implicitly. This was originally done because we "
26999 "thought it would improve reliability, but it turns out that I<-o sync> has a "
27000 "very large negative performance impact and negligible effect on "
27001 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
27002 "in any code that needs performance, and instead use C<guestfs_mount_options> "
27003 "(use an empty string for the first parameter if you don't want any options)."
27007 #: ../src/guestfs-actions.pod:4953
27008 msgid "guestfs_mount_9p"
27012 #: ../src/guestfs-actions.pod:4955
27016 " guestfs_mount_9p (guestfs_h *g,\n"
27017 " const char *mounttag,\n"
27018 " const char *mountpoint,\n"
27024 #: ../src/guestfs-actions.pod:4966
27027 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
27032 #: ../src/guestfs-actions.pod:4979
27033 msgid "guestfs_mount_9p_va"
27037 #: ../src/guestfs-actions.pod:4981
27041 " guestfs_mount_9p_va (guestfs_h *g,\n"
27042 " const char *mounttag,\n"
27043 " const char *mountpoint,\n"
27044 " va_list args);\n"
27049 #: ../src/guestfs-actions.pod:4987
27050 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
27054 #: ../src/guestfs-actions.pod:4991
27055 msgid "guestfs_mount_9p_argv"
27059 #: ../src/guestfs-actions.pod:4993
27063 " guestfs_mount_9p_argv (guestfs_h *g,\n"
27064 " const char *mounttag,\n"
27065 " const char *mountpoint,\n"
27066 " const struct guestfs_mount_9p_argv *optargs);\n"
27071 #: ../src/guestfs-actions.pod:4999
27072 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
27076 #: ../src/guestfs-actions.pod:5003
27077 msgid "guestfs_mount_loop"
27081 #: ../src/guestfs-actions.pod:5005
27085 " guestfs_mount_loop (guestfs_h *g,\n"
27086 " const char *file,\n"
27087 " const char *mountpoint);\n"
27092 #: ../src/guestfs-actions.pod:5018
27093 msgid "guestfs_mount_options"
27097 #: ../src/guestfs-actions.pod:5020
27101 " guestfs_mount_options (guestfs_h *g,\n"
27102 " const char *options,\n"
27103 " const char *device,\n"
27104 " const char *mountpoint);\n"
27109 #: ../src/guestfs-actions.pod:5026
27111 "This is the same as the C<guestfs_mount> command, but it allows you to set "
27112 "the mount options as for the L<mount(8)> I<-o> flag."
27116 #: ../src/guestfs-actions.pod:5036 ../src/guestfs-actions.pod:5050
27117 #: ../src/guestfs-actions.pod:5067
27118 msgid "(Added in 1.0.10)"
27122 #: ../src/guestfs-actions.pod:5038
27123 msgid "guestfs_mount_ro"
27127 #: ../src/guestfs-actions.pod:5040
27131 " guestfs_mount_ro (guestfs_h *g,\n"
27132 " const char *device,\n"
27133 " const char *mountpoint);\n"
27138 #: ../src/guestfs-actions.pod:5045
27140 "This is the same as the C<guestfs_mount> command, but it mounts the "
27141 "filesystem with the read-only (I<-o ro>) flag."
27145 #: ../src/guestfs-actions.pod:5052
27146 msgid "guestfs_mount_vfs"
27150 #: ../src/guestfs-actions.pod:5054
27154 " guestfs_mount_vfs (guestfs_h *g,\n"
27155 " const char *options,\n"
27156 " const char *vfstype,\n"
27157 " const char *device,\n"
27158 " const char *mountpoint);\n"
27163 #: ../src/guestfs-actions.pod:5061
27165 "This is the same as the C<guestfs_mount> command, but it allows you to set "
27166 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
27171 #: ../src/guestfs-actions.pod:5069
27172 msgid "guestfs_mountpoints"
27176 #: ../src/guestfs-actions.pod:5071
27180 " guestfs_mountpoints (guestfs_h *g);\n"
27185 #: ../src/guestfs-actions.pod:5074
27187 "This call is similar to C<guestfs_mounts>. That call returns a list of "
27188 "devices. This one returns a hash table (map) of device name to directory "
27189 "where the device is mounted."
27193 #: ../src/guestfs-actions.pod:5086
27194 msgid "guestfs_mounts"
27198 #: ../src/guestfs-actions.pod:5088
27202 " guestfs_mounts (guestfs_h *g);\n"
27207 #: ../src/guestfs-actions.pod:5096
27208 msgid "See also: C<guestfs_mountpoints>"
27212 #: ../src/guestfs-actions.pod:5104
27217 #: ../src/guestfs-actions.pod:5106
27221 " guestfs_mv (guestfs_h *g,\n"
27222 " const char *src,\n"
27223 " const char *dest);\n"
27228 #: ../src/guestfs-actions.pod:5118
27229 msgid "guestfs_ntfs_3g_probe"
27233 #: ../src/guestfs-actions.pod:5120
27237 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
27239 " const char *device);\n"
27244 #: ../src/guestfs-actions.pod:5139
27245 msgid "(Added in 1.0.43)"
27249 #: ../src/guestfs-actions.pod:5141
27250 msgid "guestfs_ntfsresize"
27254 #: ../src/guestfs-actions.pod:5143
27258 " guestfs_ntfsresize (guestfs_h *g,\n"
27259 " const char *device);\n"
27264 #: ../src/guestfs-actions.pod:5171
27265 msgid "guestfs_ntfsresize_opts"
27269 #: ../src/guestfs-actions.pod:5173
27273 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
27274 " const char *device,\n"
27280 #: ../src/guestfs-actions.pod:5183
27283 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
27284 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
27289 #: ../src/guestfs-actions.pod:5203
27291 "After the resize operation, the filesystem is always marked as requiring a "
27292 "consistency check (for safety). You have to boot into Windows to perform "
27293 "this check and clear this condition. If you I<don't> set the C<force> "
27294 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
27295 "times on a single filesystem without booting into Windows between each "
27300 #: ../src/guestfs-actions.pod:5218
27301 msgid "guestfs_ntfsresize_opts_va"
27305 #: ../src/guestfs-actions.pod:5220
27309 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
27310 " const char *device,\n"
27311 " va_list args);\n"
27316 #: ../src/guestfs-actions.pod:5225
27317 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
27321 #: ../src/guestfs-actions.pod:5229
27322 msgid "guestfs_ntfsresize_opts_argv"
27326 #: ../src/guestfs-actions.pod:5231
27330 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
27331 " const char *device,\n"
27332 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
27337 #: ../src/guestfs-actions.pod:5236
27338 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
27342 #: ../src/guestfs-actions.pod:5240
27343 msgid "guestfs_ntfsresize_size"
27347 #: ../src/guestfs-actions.pod:5242
27351 " guestfs_ntfsresize_size (guestfs_h *g,\n"
27352 " const char *device,\n"
27353 " int64_t size);\n"
27358 #: ../src/guestfs-actions.pod:5247
27360 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
27361 "to specify the new size (in bytes) explicitly."
27365 #: ../src/guestfs-actions.pod:5259 ../src/guestfs-actions.pod:5701
27366 #: ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:6042
27367 #: ../src/guestfs-actions.pod:7665
27368 msgid "(Added in 1.3.14)"
27372 #: ../src/guestfs-actions.pod:5261
27373 msgid "guestfs_part_add"
27377 #: ../src/guestfs-actions.pod:5263
27381 " guestfs_part_add (guestfs_h *g,\n"
27382 " const char *device,\n"
27383 " const char *prlogex,\n"
27384 " int64_t startsect,\n"
27385 " int64_t endsect);\n"
27390 #: ../src/guestfs-actions.pod:5270
27392 "This command adds a partition to C<device>. If there is no partition table "
27393 "on the device, call C<guestfs_part_init> first."
27397 #: ../src/guestfs-actions.pod:5282
27399 "Creating a partition which covers the whole disk is not so easy. Use "
27400 "C<guestfs_part_disk> to do that."
27404 #: ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5325
27405 #: ../src/guestfs-actions.pod:5378 ../src/guestfs-actions.pod:5462
27406 #: ../src/guestfs-actions.pod:5500 ../src/guestfs-actions.pod:5519
27407 #: ../src/guestfs-actions.pod:5559
27408 msgid "(Added in 1.0.78)"
27412 #: ../src/guestfs-actions.pod:5289
27413 msgid "guestfs_part_del"
27417 #: ../src/guestfs-actions.pod:5291
27421 " guestfs_part_del (guestfs_h *g,\n"
27422 " const char *device,\n"
27428 #: ../src/guestfs-actions.pod:5306
27429 msgid "guestfs_part_disk"
27433 #: ../src/guestfs-actions.pod:5308
27437 " guestfs_part_disk (guestfs_h *g,\n"
27438 " const char *device,\n"
27439 " const char *parttype);\n"
27444 #: ../src/guestfs-actions.pod:5313
27446 "This command is simply a combination of C<guestfs_part_init> followed by "
27447 "C<guestfs_part_add> to create a single primary partition covering the whole "
27452 #: ../src/guestfs-actions.pod:5317
27454 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
27455 "possible values are described in C<guestfs_part_init>."
27459 #: ../src/guestfs-actions.pod:5327
27460 msgid "guestfs_part_get_bootable"
27464 #: ../src/guestfs-actions.pod:5329
27468 " guestfs_part_get_bootable (guestfs_h *g,\n"
27469 " const char *device,\n"
27475 #: ../src/guestfs-actions.pod:5337
27476 msgid "See also C<guestfs_part_set_bootable>."
27480 #: ../src/guestfs-actions.pod:5343
27481 msgid "guestfs_part_get_mbr_id"
27485 #: ../src/guestfs-actions.pod:5345
27489 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
27490 " const char *device,\n"
27496 #: ../src/guestfs-actions.pod:5353 ../src/guestfs-actions.pod:5535
27498 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
27499 "undefined results for other partition table types (see "
27500 "C<guestfs_part_get_parttype>)."
27504 #: ../src/guestfs-actions.pod:5361
27505 msgid "guestfs_part_get_parttype"
27509 #: ../src/guestfs-actions.pod:5363
27513 " guestfs_part_get_parttype (guestfs_h *g,\n"
27514 " const char *device);\n"
27519 #: ../src/guestfs-actions.pod:5370
27521 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
27522 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
27523 "possible, although unusual. See C<guestfs_part_init> for a full list."
27527 #: ../src/guestfs-actions.pod:5380
27528 msgid "guestfs_part_init"
27532 #: ../src/guestfs-actions.pod:5382
27536 " guestfs_part_init (guestfs_h *g,\n"
27537 " const char *device,\n"
27538 " const char *parttype);\n"
27543 #: ../src/guestfs-actions.pod:5391
27545 "Initially there are no partitions. Following this, you should call "
27546 "C<guestfs_part_add> for each partition required."
27550 #: ../src/guestfs-actions.pod:5464
27551 msgid "guestfs_part_list"
27555 #: ../src/guestfs-actions.pod:5466
27558 " struct guestfs_partition_list *\n"
27559 " guestfs_part_list (guestfs_h *g,\n"
27560 " const char *device);\n"
27565 #: ../src/guestfs-actions.pod:5483
27567 "Start of the partition I<in bytes>. To get sectors you have to divide by "
27568 "the device's sector size, see C<guestfs_blockdev_getss>."
27572 #: ../src/guestfs-actions.pod:5496
27574 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
27575 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
27580 #: ../src/guestfs-actions.pod:5502
27581 msgid "guestfs_part_set_bootable"
27585 #: ../src/guestfs-actions.pod:5504
27589 " guestfs_part_set_bootable (guestfs_h *g,\n"
27590 " const char *device,\n"
27592 " int bootable);\n"
27597 #: ../src/guestfs-actions.pod:5521
27598 msgid "guestfs_part_set_mbr_id"
27602 #: ../src/guestfs-actions.pod:5523
27606 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
27607 " const char *device,\n"
27614 #: ../src/guestfs-actions.pod:5543
27615 msgid "guestfs_part_set_name"
27619 #: ../src/guestfs-actions.pod:5545
27623 " guestfs_part_set_name (guestfs_h *g,\n"
27624 " const char *device,\n"
27626 " const char *name);\n"
27631 #: ../src/guestfs-actions.pod:5561
27632 msgid "guestfs_part_to_dev"
27636 #: ../src/guestfs-actions.pod:5563
27640 " guestfs_part_to_dev (guestfs_h *g,\n"
27641 " const char *partition);\n"
27646 #: ../src/guestfs-actions.pod:5571
27648 "The named partition must exist, for example as a string returned from "
27649 "C<guestfs_list_partitions>."
27653 #: ../src/guestfs-actions.pod:5579
27654 msgid "guestfs_ping_daemon"
27658 #: ../src/guestfs-actions.pod:5581
27662 " guestfs_ping_daemon (guestfs_h *g);\n"
27667 #: ../src/guestfs-actions.pod:5593
27668 msgid "guestfs_pread"
27672 #: ../src/guestfs-actions.pod:5595
27676 " guestfs_pread (guestfs_h *g,\n"
27677 " const char *path,\n"
27679 " int64_t offset,\n"
27680 " size_t *size_r);\n"
27685 #: ../src/guestfs-actions.pod:5608
27686 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
27690 #: ../src/guestfs-actions.pod:5619
27691 msgid "guestfs_pread_device"
27695 #: ../src/guestfs-actions.pod:5621
27699 " guestfs_pread_device (guestfs_h *g,\n"
27700 " const char *device,\n"
27702 " int64_t offset,\n"
27703 " size_t *size_r);\n"
27708 #: ../src/guestfs-actions.pod:5634
27709 msgid "See also C<guestfs_pread>."
27713 #: ../src/guestfs-actions.pod:5643
27714 msgid "(Added in 1.5.21)"
27718 #: ../src/guestfs-actions.pod:5645
27719 msgid "guestfs_pvcreate"
27723 #: ../src/guestfs-actions.pod:5647
27727 " guestfs_pvcreate (guestfs_h *g,\n"
27728 " const char *device);\n"
27733 #: ../src/guestfs-actions.pod:5659
27734 msgid "guestfs_pvremove"
27738 #: ../src/guestfs-actions.pod:5661
27742 " guestfs_pvremove (guestfs_h *g,\n"
27743 " const char *device);\n"
27748 #: ../src/guestfs-actions.pod:5676
27749 msgid "guestfs_pvresize"
27753 #: ../src/guestfs-actions.pod:5678
27757 " guestfs_pvresize (guestfs_h *g,\n"
27758 " const char *device);\n"
27763 #: ../src/guestfs-actions.pod:5689
27764 msgid "guestfs_pvresize_size"
27768 #: ../src/guestfs-actions.pod:5691
27772 " guestfs_pvresize_size (guestfs_h *g,\n"
27773 " const char *device,\n"
27774 " int64_t size);\n"
27779 #: ../src/guestfs-actions.pod:5696
27781 "This command is the same as C<guestfs_pvresize> except that it allows you to "
27782 "specify the new size (in bytes) explicitly."
27786 #: ../src/guestfs-actions.pod:5703
27787 msgid "guestfs_pvs"
27791 #: ../src/guestfs-actions.pod:5705
27795 " guestfs_pvs (guestfs_h *g);\n"
27800 #: ../src/guestfs-actions.pod:5714
27801 msgid "See also C<guestfs_pvs_full>."
27805 #: ../src/guestfs-actions.pod:5722
27806 msgid "guestfs_pvs_full"
27810 #: ../src/guestfs-actions.pod:5724
27813 " struct guestfs_lvm_pv_list *\n"
27814 " guestfs_pvs_full (guestfs_h *g);\n"
27819 #: ../src/guestfs-actions.pod:5730
27821 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
27822 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
27826 #: ../src/guestfs-actions.pod:5736
27827 msgid "guestfs_pvuuid"
27831 #: ../src/guestfs-actions.pod:5738
27835 " guestfs_pvuuid (guestfs_h *g,\n"
27836 " const char *device);\n"
27841 #: ../src/guestfs-actions.pod:5749
27842 msgid "guestfs_pwrite"
27846 #: ../src/guestfs-actions.pod:5751
27850 " guestfs_pwrite (guestfs_h *g,\n"
27851 " const char *path,\n"
27852 " const char *content,\n"
27853 " size_t content_size,\n"
27854 " int64_t offset);\n"
27859 #: ../src/guestfs-actions.pod:5767
27860 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
27864 #: ../src/guestfs-actions.pod:5776
27865 msgid "guestfs_pwrite_device"
27869 #: ../src/guestfs-actions.pod:5778
27873 " guestfs_pwrite_device (guestfs_h *g,\n"
27874 " const char *device,\n"
27875 " const char *content,\n"
27876 " size_t content_size,\n"
27877 " int64_t offset);\n"
27882 #: ../src/guestfs-actions.pod:5793
27883 msgid "See also C<guestfs_pwrite>."
27887 #: ../src/guestfs-actions.pod:5800
27888 msgid "(Added in 1.5.20)"
27892 #: ../src/guestfs-actions.pod:5802
27893 msgid "guestfs_read_file"
27897 #: ../src/guestfs-actions.pod:5804
27901 " guestfs_read_file (guestfs_h *g,\n"
27902 " const char *path,\n"
27903 " size_t *size_r);\n"
27908 #: ../src/guestfs-actions.pod:5812
27910 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
27911 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
27912 "function is limited in the total size of file that can be handled."
27916 #: ../src/guestfs-actions.pod:5824
27917 msgid "(Added in 1.0.63)"
27921 #: ../src/guestfs-actions.pod:5826
27922 msgid "guestfs_read_lines"
27926 #: ../src/guestfs-actions.pod:5828
27930 " guestfs_read_lines (guestfs_h *g,\n"
27931 " const char *path);\n"
27936 #: ../src/guestfs-actions.pod:5837
27938 "Note that this function cannot correctly handle binary files (specifically, "
27939 "files containing C<\\0> character which is treated as end of line). For "
27940 "those you need to use the C<guestfs_read_file> function which has a more "
27941 "complex interface."
27945 #: ../src/guestfs-actions.pod:5848
27946 msgid "guestfs_readdir"
27950 #: ../src/guestfs-actions.pod:5850
27953 " struct guestfs_dirent_list *\n"
27954 " guestfs_readdir (guestfs_h *g,\n"
27955 " const char *dir);\n"
27960 #: ../src/guestfs-actions.pod:5904
27962 "This function is primarily intended for use by programs. To get a simple "
27963 "list of names, use C<guestfs_ls>. To get a printable directory for human "
27964 "consumption, use C<guestfs_ll>."
27968 #: ../src/guestfs-actions.pod:5908
27970 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
27971 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
27975 #: ../src/guestfs-actions.pod:5914
27976 msgid "guestfs_readlink"
27980 #: ../src/guestfs-actions.pod:5916
27984 " guestfs_readlink (guestfs_h *g,\n"
27985 " const char *path);\n"
27990 #: ../src/guestfs-actions.pod:5927
27991 msgid "guestfs_readlinklist"
27995 #: ../src/guestfs-actions.pod:5929
27999 " guestfs_readlinklist (guestfs_h *g,\n"
28000 " const char *path,\n"
28001 " char *const *names);\n"
28006 #: ../src/guestfs-actions.pod:5962
28007 msgid "guestfs_realpath"
28011 #: ../src/guestfs-actions.pod:5964
28015 " guestfs_realpath (guestfs_h *g,\n"
28016 " const char *path);\n"
28021 #: ../src/guestfs-actions.pod:5976
28022 msgid "guestfs_removexattr"
28026 #: ../src/guestfs-actions.pod:5978
28030 " guestfs_removexattr (guestfs_h *g,\n"
28031 " const char *xattr,\n"
28032 " const char *path);\n"
28037 #: ../src/guestfs-actions.pod:5986
28038 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
28042 #: ../src/guestfs-actions.pod:5992
28043 msgid "guestfs_resize2fs"
28047 #: ../src/guestfs-actions.pod:5994
28051 " guestfs_resize2fs (guestfs_h *g,\n"
28052 " const char *device);\n"
28057 #: ../src/guestfs-actions.pod:6001
28059 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
28060 "C<device> before calling this command. For unknown reasons C<resize2fs> "
28061 "sometimes gives an error about this and sometimes not. In any case, it is "
28062 "always safe to call C<guestfs_e2fsck_f> before calling this function."
28066 #: ../src/guestfs-actions.pod:6011
28067 msgid "guestfs_resize2fs_M"
28071 #: ../src/guestfs-actions.pod:6013
28075 " guestfs_resize2fs_M (guestfs_h *g,\n"
28076 " const char *device);\n"
28081 #: ../src/guestfs-actions.pod:6017
28083 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
28084 "resized to its minimum size. This works like the I<-M> option to the "
28085 "C<resize2fs> command."
28089 #: ../src/guestfs-actions.pod:6021
28091 "To get the resulting size of the filesystem you should call "
28092 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
28093 "These two numbers, multiplied together, give the resulting size of the "
28094 "minimal filesystem in bytes."
28098 #: ../src/guestfs-actions.pod:6030
28099 msgid "guestfs_resize2fs_size"
28103 #: ../src/guestfs-actions.pod:6032
28107 " guestfs_resize2fs_size (guestfs_h *g,\n"
28108 " const char *device,\n"
28109 " int64_t size);\n"
28114 #: ../src/guestfs-actions.pod:6037
28116 "This command is the same as C<guestfs_resize2fs> except that it allows you "
28117 "to specify the new size (in bytes) explicitly."
28121 #: ../src/guestfs-actions.pod:6044
28126 #: ../src/guestfs-actions.pod:6046
28130 " guestfs_rm (guestfs_h *g,\n"
28131 " const char *path);\n"
28136 #: ../src/guestfs-actions.pod:6056
28137 msgid "guestfs_rm_rf"
28141 #: ../src/guestfs-actions.pod:6058
28145 " guestfs_rm_rf (guestfs_h *g,\n"
28146 " const char *path);\n"
28151 #: ../src/guestfs-actions.pod:6070
28152 msgid "guestfs_rmdir"
28156 #: ../src/guestfs-actions.pod:6072
28160 " guestfs_rmdir (guestfs_h *g,\n"
28161 " const char *path);\n"
28166 #: ../src/guestfs-actions.pod:6082
28167 msgid "guestfs_rmmountpoint"
28171 #: ../src/guestfs-actions.pod:6084
28175 " guestfs_rmmountpoint (guestfs_h *g,\n"
28176 " const char *exemptpath);\n"
28181 #: ../src/guestfs-actions.pod:6088
28183 "This calls removes a mountpoint that was previously created with "
28184 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
28188 #: ../src/guestfs-actions.pod:6096
28189 msgid "guestfs_scrub_device"
28193 #: ../src/guestfs-actions.pod:6098
28197 " guestfs_scrub_device (guestfs_h *g,\n"
28198 " const char *device);\n"
28203 #: ../src/guestfs-actions.pod:6113 ../src/guestfs-actions.pod:6131
28204 #: ../src/guestfs-actions.pod:6150
28205 msgid "(Added in 1.0.52)"
28209 #: ../src/guestfs-actions.pod:6115
28210 msgid "guestfs_scrub_file"
28214 #: ../src/guestfs-actions.pod:6117
28218 " guestfs_scrub_file (guestfs_h *g,\n"
28219 " const char *file);\n"
28224 #: ../src/guestfs-actions.pod:6133
28225 msgid "guestfs_scrub_freespace"
28229 #: ../src/guestfs-actions.pod:6135
28233 " guestfs_scrub_freespace (guestfs_h *g,\n"
28234 " const char *dir);\n"
28239 #: ../src/guestfs-actions.pod:6139
28241 "This command creates the directory C<dir> and then fills it with files until "
28242 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
28243 "and deletes them. The intention is to scrub any free space on the partition "
28244 "containing C<dir>."
28248 #: ../src/guestfs-actions.pod:6152
28249 msgid "guestfs_set_append"
28253 #: ../src/guestfs-actions.pod:6154
28257 " guestfs_set_append (guestfs_h *g,\n"
28258 " const char *append);\n"
28263 #: ../src/guestfs-actions.pod:6171
28264 msgid "guestfs_set_attach_method"
28268 #: ../src/guestfs-actions.pod:6173
28272 " guestfs_set_attach_method (guestfs_h *g,\n"
28273 " const char *attachmethod);\n"
28278 #: ../src/guestfs-actions.pod:6201
28279 msgid "guestfs_set_autosync"
28283 #: ../src/guestfs-actions.pod:6203
28287 " guestfs_set_autosync (guestfs_h *g,\n"
28288 " int autosync);\n"
28293 #: ../src/guestfs-actions.pod:6219
28294 msgid "guestfs_set_direct"
28298 #: ../src/guestfs-actions.pod:6221
28302 " guestfs_set_direct (guestfs_h *g,\n"
28308 #: ../src/guestfs-actions.pod:6229
28310 "One consequence of this is that log messages aren't caught by the library "
28311 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
28316 #: ../src/guestfs-actions.pod:6242
28317 msgid "guestfs_set_e2label"
28321 #: ../src/guestfs-actions.pod:6244
28325 " guestfs_set_e2label (guestfs_h *g,\n"
28326 " const char *device,\n"
28327 " const char *label);\n"
28332 #: ../src/guestfs-actions.pod:6253
28334 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
28335 "the existing label on a filesystem."
28339 #: ../src/guestfs-actions.pod:6260
28340 msgid "guestfs_set_e2uuid"
28344 #: ../src/guestfs-actions.pod:6262
28348 " guestfs_set_e2uuid (guestfs_h *g,\n"
28349 " const char *device,\n"
28350 " const char *uuid);\n"
28355 #: ../src/guestfs-actions.pod:6272
28357 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
28358 "the existing UUID of a filesystem."
28362 #: ../src/guestfs-actions.pod:6279
28363 msgid "guestfs_set_memsize"
28367 #: ../src/guestfs-actions.pod:6281
28371 " guestfs_set_memsize (guestfs_h *g,\n"
28377 #: ../src/guestfs-actions.pod:6285
28379 "This sets the memory size in megabytes allocated to the qemu subprocess. "
28380 "This only has any effect if called before C<guestfs_launch>."
28384 #: ../src/guestfs-actions.pod:6300
28385 msgid "guestfs_set_network"
28389 #: ../src/guestfs-actions.pod:6302
28393 " guestfs_set_network (guestfs_h *g,\n"
28399 #: ../src/guestfs-actions.pod:6312
28401 "You must call this before calling C<guestfs_launch>, otherwise it has no "
28406 #: ../src/guestfs-actions.pod:6319
28407 msgid "guestfs_set_path"
28411 #: ../src/guestfs-actions.pod:6321
28415 " guestfs_set_path (guestfs_h *g,\n"
28416 " const char *searchpath);\n"
28421 #: ../src/guestfs-actions.pod:6336
28422 msgid "guestfs_set_pgroup"
28426 #: ../src/guestfs-actions.pod:6338
28430 " guestfs_set_pgroup (guestfs_h *g,\n"
28436 #: ../src/guestfs-actions.pod:6355
28437 msgid "guestfs_set_qemu"
28441 #: ../src/guestfs-actions.pod:6357
28445 " guestfs_set_qemu (guestfs_h *g,\n"
28446 " const char *qemu);\n"
28451 #: ../src/guestfs-actions.pod:6383
28452 msgid "guestfs_set_recovery_proc"
28456 #: ../src/guestfs-actions.pod:6385
28460 " guestfs_set_recovery_proc (guestfs_h *g,\n"
28461 " int recoveryproc);\n"
28466 #: ../src/guestfs-actions.pod:6389
28468 "If this is called with the parameter C<false> then C<guestfs_launch> does "
28469 "not create a recovery process. The purpose of the recovery process is to "
28470 "stop runaway qemu processes in the case where the main program aborts "
28475 #: ../src/guestfs-actions.pod:6394
28477 "This only has any effect if called before C<guestfs_launch>, and the default "
28482 #: ../src/guestfs-actions.pod:6407
28483 msgid "guestfs_set_selinux"
28487 #: ../src/guestfs-actions.pod:6409
28491 " guestfs_set_selinux (guestfs_h *g,\n"
28497 #: ../src/guestfs-actions.pod:6426
28498 msgid "guestfs_set_trace"
28502 #: ../src/guestfs-actions.pod:6428
28506 " guestfs_set_trace (guestfs_h *g,\n"
28512 #: ../src/guestfs-actions.pod:6442
28514 "Trace messages are normally sent to C<stderr>, unless you register a "
28515 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
28519 #: ../src/guestfs-actions.pod:6450
28520 msgid "guestfs_set_verbose"
28524 #: ../src/guestfs-actions.pod:6452
28528 " guestfs_set_verbose (guestfs_h *g,\n"
28534 #: ../src/guestfs-actions.pod:6461
28536 "Verbose messages are normally sent to C<stderr>, unless you register a "
28537 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
28541 #: ../src/guestfs-actions.pod:6469
28542 msgid "guestfs_setcon"
28546 #: ../src/guestfs-actions.pod:6471
28550 " guestfs_setcon (guestfs_h *g,\n"
28551 " const char *context);\n"
28556 #: ../src/guestfs-actions.pod:6484
28557 msgid "guestfs_setxattr"
28561 #: ../src/guestfs-actions.pod:6486
28565 " guestfs_setxattr (guestfs_h *g,\n"
28566 " const char *xattr,\n"
28567 " const char *val,\n"
28569 " const char *path);\n"
28574 #: ../src/guestfs-actions.pod:6497
28575 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
28579 #: ../src/guestfs-actions.pod:6503
28580 msgid "guestfs_sfdisk"
28584 #: ../src/guestfs-actions.pod:6505
28588 " guestfs_sfdisk (guestfs_h *g,\n"
28589 " const char *device,\n"
28593 " char *const *lines);\n"
28598 #: ../src/guestfs-actions.pod:6533
28600 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
28604 #: ../src/guestfs-actions.pod:6550
28605 msgid "guestfs_sfdiskM"
28609 #: ../src/guestfs-actions.pod:6552
28613 " guestfs_sfdiskM (guestfs_h *g,\n"
28614 " const char *device,\n"
28615 " char *const *lines);\n"
28620 #: ../src/guestfs-actions.pod:6557
28622 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
28623 "partition sizes are specified in megabytes only (rounded to the nearest "
28624 "cylinder) and you don't need to specify the cyls, heads and sectors "
28625 "parameters which were rarely if ever used anyway."
28629 #: ../src/guestfs-actions.pod:6563
28631 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
28632 "C<guestfs_part_disk>"
28636 #: ../src/guestfs-actions.pod:6580
28637 msgid "guestfs_sfdisk_N"
28641 #: ../src/guestfs-actions.pod:6582
28645 " guestfs_sfdisk_N (guestfs_h *g,\n"
28646 " const char *device,\n"
28651 " const char *line);\n"
28656 #: ../src/guestfs-actions.pod:6594
28658 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
28659 "for the cyls/heads/sectors parameters."
28663 #: ../src/guestfs-actions.pod:6597
28664 msgid "See also: C<guestfs_part_add>"
28668 #: ../src/guestfs-actions.pod:6613
28669 msgid "guestfs_sfdisk_disk_geometry"
28673 #: ../src/guestfs-actions.pod:6615
28677 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
28678 " const char *device);\n"
28683 #: ../src/guestfs-actions.pod:6619
28685 "This displays the disk geometry of C<device> read from the partition table. "
28686 "Especially in the case where the underlying block device has been resized, "
28687 "this can be different from the kernel's idea of the geometry (see "
28688 "C<guestfs_sfdisk_kernel_geometry>)."
28692 #: ../src/guestfs-actions.pod:6632
28693 msgid "guestfs_sfdisk_kernel_geometry"
28697 #: ../src/guestfs-actions.pod:6634
28701 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
28702 " const char *device);\n"
28707 #: ../src/guestfs-actions.pod:6648
28708 msgid "guestfs_sfdisk_l"
28712 #: ../src/guestfs-actions.pod:6650
28716 " guestfs_sfdisk_l (guestfs_h *g,\n"
28717 " const char *device);\n"
28722 #: ../src/guestfs-actions.pod:6658
28723 msgid "See also: C<guestfs_part_list>"
28727 #: ../src/guestfs-actions.pod:6672
28732 #: ../src/guestfs-actions.pod:6674
28736 " guestfs_sh (guestfs_h *g,\n"
28737 " const char *command);\n"
28742 #: ../src/guestfs-actions.pod:6681
28743 msgid "This is like C<guestfs_command>, but passes the command to:"
28747 #: ../src/guestfs-actions.pod:6689
28748 msgid "All the provisos about C<guestfs_command> apply to this call."
28752 #: ../src/guestfs-actions.pod:6696
28753 msgid "guestfs_sh_lines"
28757 #: ../src/guestfs-actions.pod:6698
28761 " guestfs_sh_lines (guestfs_h *g,\n"
28762 " const char *command);\n"
28767 #: ../src/guestfs-actions.pod:6702
28769 "This is the same as C<guestfs_sh>, but splits the result into a list of "
28774 #: ../src/guestfs-actions.pod:6705
28775 msgid "See also: C<guestfs_command_lines>"
28779 #: ../src/guestfs-actions.pod:6713
28780 msgid "guestfs_sleep"
28784 #: ../src/guestfs-actions.pod:6715
28788 " guestfs_sleep (guestfs_h *g,\n"
28794 #: ../src/guestfs-actions.pod:6723
28795 msgid "(Added in 1.0.41)"
28799 #: ../src/guestfs-actions.pod:6725 ../src/guestfs-structs.pod:109
28800 msgid "guestfs_stat"
28804 #: ../src/guestfs-actions.pod:6727
28807 " struct guestfs_stat *\n"
28808 " guestfs_stat (guestfs_h *g,\n"
28809 " const char *path);\n"
28814 #: ../src/guestfs-actions.pod:6741 ../src/guestfs-structs.pod:135
28815 msgid "guestfs_statvfs"
28819 #: ../src/guestfs-actions.pod:6743
28822 " struct guestfs_statvfs *\n"
28823 " guestfs_statvfs (guestfs_h *g,\n"
28824 " const char *path);\n"
28829 #: ../src/guestfs-actions.pod:6753
28831 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
28832 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
28836 #: ../src/guestfs-actions.pod:6759
28837 msgid "guestfs_strings"
28841 #: ../src/guestfs-actions.pod:6761
28845 " guestfs_strings (guestfs_h *g,\n"
28846 " const char *path);\n"
28851 #: ../src/guestfs-actions.pod:6777
28852 msgid "guestfs_strings_e"
28856 #: ../src/guestfs-actions.pod:6779
28860 " guestfs_strings_e (guestfs_h *g,\n"
28861 " const char *encoding,\n"
28862 " const char *path);\n"
28867 #: ../src/guestfs-actions.pod:6784
28869 "This is like the C<guestfs_strings> command, but allows you to specify the "
28870 "encoding of strings that are looked for in the source file C<path>."
28874 #: ../src/guestfs-actions.pod:6794
28876 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28877 "ISO-8859-X (this is what C<guestfs_strings> uses)."
28881 #: ../src/guestfs-actions.pod:6832
28882 msgid "guestfs_swapoff_device"
28886 #: ../src/guestfs-actions.pod:6834
28890 " guestfs_swapoff_device (guestfs_h *g,\n"
28891 " const char *device);\n"
28896 #: ../src/guestfs-actions.pod:6838
28898 "This command disables the libguestfs appliance swap device or partition "
28899 "named C<device>. See C<guestfs_swapon_device>."
28903 #: ../src/guestfs-actions.pod:6846
28904 msgid "guestfs_swapoff_file"
28908 #: ../src/guestfs-actions.pod:6848
28912 " guestfs_swapoff_file (guestfs_h *g,\n"
28913 " const char *file);\n"
28918 #: ../src/guestfs-actions.pod:6858
28919 msgid "guestfs_swapoff_label"
28923 #: ../src/guestfs-actions.pod:6860
28927 " guestfs_swapoff_label (guestfs_h *g,\n"
28928 " const char *label);\n"
28933 #: ../src/guestfs-actions.pod:6871
28934 msgid "guestfs_swapoff_uuid"
28938 #: ../src/guestfs-actions.pod:6873
28942 " guestfs_swapoff_uuid (guestfs_h *g,\n"
28943 " const char *uuid);\n"
28948 #: ../src/guestfs-actions.pod:6884
28949 msgid "guestfs_swapon_device"
28953 #: ../src/guestfs-actions.pod:6886
28957 " guestfs_swapon_device (guestfs_h *g,\n"
28958 " const char *device);\n"
28963 #: ../src/guestfs-actions.pod:6890
28965 "This command enables the libguestfs appliance to use the swap device or "
28966 "partition named C<device>. The increased memory is made available for all "
28967 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
28971 #: ../src/guestfs-actions.pod:6906
28972 msgid "guestfs_swapon_file"
28976 #: ../src/guestfs-actions.pod:6908
28980 " guestfs_swapon_file (guestfs_h *g,\n"
28981 " const char *file);\n"
28986 #: ../src/guestfs-actions.pod:6912
28988 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
28993 #: ../src/guestfs-actions.pod:6919
28994 msgid "guestfs_swapon_label"
28998 #: ../src/guestfs-actions.pod:6921
29002 " guestfs_swapon_label (guestfs_h *g,\n"
29003 " const char *label);\n"
29008 #: ../src/guestfs-actions.pod:6925
29010 "This command enables swap to a labeled swap partition. See "
29011 "C<guestfs_swapon_device> for other notes."
29015 #: ../src/guestfs-actions.pod:6932
29016 msgid "guestfs_swapon_uuid"
29020 #: ../src/guestfs-actions.pod:6934
29024 " guestfs_swapon_uuid (guestfs_h *g,\n"
29025 " const char *uuid);\n"
29030 #: ../src/guestfs-actions.pod:6938
29032 "This command enables swap to a swap partition with the given UUID. See "
29033 "C<guestfs_swapon_device> for other notes."
29037 #: ../src/guestfs-actions.pod:6945
29038 msgid "guestfs_sync"
29042 #: ../src/guestfs-actions.pod:6947
29046 " guestfs_sync (guestfs_h *g);\n"
29051 #: ../src/guestfs-actions.pod:6960
29052 msgid "guestfs_tail"
29056 #: ../src/guestfs-actions.pod:6962
29060 " guestfs_tail (guestfs_h *g,\n"
29061 " const char *path);\n"
29066 #: ../src/guestfs-actions.pod:6978
29067 msgid "guestfs_tail_n"
29071 #: ../src/guestfs-actions.pod:6980
29075 " guestfs_tail_n (guestfs_h *g,\n"
29077 " const char *path);\n"
29082 #: ../src/guestfs-actions.pod:7002
29083 msgid "guestfs_tar_in"
29087 #: ../src/guestfs-actions.pod:7004
29091 " guestfs_tar_in (guestfs_h *g,\n"
29092 " const char *tarfile,\n"
29093 " const char *directory);\n"
29098 #: ../src/guestfs-actions.pod:7012
29100 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
29104 #: ../src/guestfs-actions.pod:7017 ../src/guestfs-actions.pod:7034
29105 #: ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7066
29106 msgid "(Added in 1.0.3)"
29110 #: ../src/guestfs-actions.pod:7019
29111 msgid "guestfs_tar_out"
29115 #: ../src/guestfs-actions.pod:7021
29119 " guestfs_tar_out (guestfs_h *g,\n"
29120 " const char *directory,\n"
29121 " const char *tarfile);\n"
29126 #: ../src/guestfs-actions.pod:7029
29128 "To download a compressed tarball, use C<guestfs_tgz_out> or "
29129 "C<guestfs_txz_out>."
29133 #: ../src/guestfs-actions.pod:7036
29134 msgid "guestfs_tgz_in"
29138 #: ../src/guestfs-actions.pod:7038
29142 " guestfs_tgz_in (guestfs_h *g,\n"
29143 " const char *tarball,\n"
29144 " const char *directory);\n"
29149 #: ../src/guestfs-actions.pod:7046
29150 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
29154 #: ../src/guestfs-actions.pod:7052
29155 msgid "guestfs_tgz_out"
29159 #: ../src/guestfs-actions.pod:7054
29163 " guestfs_tgz_out (guestfs_h *g,\n"
29164 " const char *directory,\n"
29165 " const char *tarball);\n"
29170 #: ../src/guestfs-actions.pod:7062
29171 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
29175 #: ../src/guestfs-actions.pod:7068
29176 msgid "guestfs_touch"
29180 #: ../src/guestfs-actions.pod:7070
29184 " guestfs_touch (guestfs_h *g,\n"
29185 " const char *path);\n"
29190 #: ../src/guestfs-actions.pod:7085
29191 msgid "guestfs_truncate"
29195 #: ../src/guestfs-actions.pod:7087
29199 " guestfs_truncate (guestfs_h *g,\n"
29200 " const char *path);\n"
29205 #: ../src/guestfs-actions.pod:7098
29206 msgid "guestfs_truncate_size"
29210 #: ../src/guestfs-actions.pod:7100
29214 " guestfs_truncate_size (guestfs_h *g,\n"
29215 " const char *path,\n"
29216 " int64_t size);\n"
29221 #: ../src/guestfs-actions.pod:7108
29223 "If the current file size is less than C<size> then the file is extended to "
29224 "the required size with zero bytes. This creates a sparse file (ie. disk "
29225 "blocks are not allocated for the file until you write to it). To create a "
29226 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
29230 #: ../src/guestfs-actions.pod:7118
29231 msgid "guestfs_tune2fs_l"
29235 #: ../src/guestfs-actions.pod:7120
29239 " guestfs_tune2fs_l (guestfs_h *g,\n"
29240 " const char *device);\n"
29245 #: ../src/guestfs-actions.pod:7140
29246 msgid "guestfs_txz_in"
29250 #: ../src/guestfs-actions.pod:7142
29254 " guestfs_txz_in (guestfs_h *g,\n"
29255 " const char *tarball,\n"
29256 " const char *directory);\n"
29261 #: ../src/guestfs-actions.pod:7154
29262 msgid "guestfs_txz_out"
29266 #: ../src/guestfs-actions.pod:7156
29270 " guestfs_txz_out (guestfs_h *g,\n"
29271 " const char *directory,\n"
29272 " const char *tarball);\n"
29277 #: ../src/guestfs-actions.pod:7168
29278 msgid "guestfs_umask"
29282 #: ../src/guestfs-actions.pod:7170
29286 " guestfs_umask (guestfs_h *g,\n"
29292 #: ../src/guestfs-actions.pod:7186
29294 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
29295 "C<guestfs_mkdir>."
29299 #: ../src/guestfs-actions.pod:7195
29300 msgid "guestfs_umount"
29304 #: ../src/guestfs-actions.pod:7197
29308 " guestfs_umount (guestfs_h *g,\n"
29309 " const char *pathordevice);\n"
29314 #: ../src/guestfs-actions.pod:7209
29315 msgid "guestfs_umount_all"
29319 #: ../src/guestfs-actions.pod:7211
29323 " guestfs_umount_all (guestfs_h *g);\n"
29328 #: ../src/guestfs-actions.pod:7222
29329 msgid "guestfs_upload"
29333 #: ../src/guestfs-actions.pod:7224
29337 " guestfs_upload (guestfs_h *g,\n"
29338 " const char *filename,\n"
29339 " const char *remotefilename);\n"
29344 #: ../src/guestfs-actions.pod:7234
29345 msgid "See also C<guestfs_download>."
29349 #: ../src/guestfs-actions.pod:7245
29350 msgid "guestfs_upload_offset"
29354 #: ../src/guestfs-actions.pod:7247
29358 " guestfs_upload_offset (guestfs_h *g,\n"
29359 " const char *filename,\n"
29360 " const char *remotefilename,\n"
29361 " int64_t offset);\n"
29366 #: ../src/guestfs-actions.pod:7263
29368 "Note that there is no limit on the amount of data that can be uploaded with "
29369 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
29370 "full amount unless an error occurs."
29374 #: ../src/guestfs-actions.pod:7268
29375 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
29379 #: ../src/guestfs-actions.pod:7279
29380 msgid "guestfs_utimens"
29384 #: ../src/guestfs-actions.pod:7281
29388 " guestfs_utimens (guestfs_h *g,\n"
29389 " const char *path,\n"
29390 " int64_t atsecs,\n"
29391 " int64_t atnsecs,\n"
29392 " int64_t mtsecs,\n"
29393 " int64_t mtnsecs);\n"
29398 #: ../src/guestfs-actions.pod:7310 ../src/guestfs-structs.pod:175
29399 msgid "guestfs_version"
29403 #: ../src/guestfs-actions.pod:7312
29406 " struct guestfs_version *\n"
29407 " guestfs_version (guestfs_h *g);\n"
29412 #: ../src/guestfs-actions.pod:7340
29414 "I<Note:> Don't use this call to test for availability of features. In "
29415 "enterprise distributions we backport features from later versions into "
29416 "earlier versions, making this an unreliable way to test for features. Use "
29417 "C<guestfs_available> instead."
29421 #: ../src/guestfs-actions.pod:7346
29423 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
29424 "error. I<The caller must call C<guestfs_free_version> after use>."
29428 #: ../src/guestfs-actions.pod:7350
29429 msgid "(Added in 1.0.58)"
29433 #: ../src/guestfs-actions.pod:7352
29434 msgid "guestfs_vfs_label"
29438 #: ../src/guestfs-actions.pod:7354
29442 " guestfs_vfs_label (guestfs_h *g,\n"
29443 " const char *device);\n"
29448 #: ../src/guestfs-actions.pod:7363
29449 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
29453 #: ../src/guestfs-actions.pod:7368 ../src/guestfs-actions.pod:7405
29454 msgid "(Added in 1.3.18)"
29458 #: ../src/guestfs-actions.pod:7370
29459 msgid "guestfs_vfs_type"
29463 #: ../src/guestfs-actions.pod:7372
29467 " guestfs_vfs_type (guestfs_h *g,\n"
29468 " const char *device);\n"
29473 #: ../src/guestfs-actions.pod:7389
29474 msgid "guestfs_vfs_uuid"
29478 #: ../src/guestfs-actions.pod:7391
29482 " guestfs_vfs_uuid (guestfs_h *g,\n"
29483 " const char *device);\n"
29488 #: ../src/guestfs-actions.pod:7400
29489 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
29493 #: ../src/guestfs-actions.pod:7407
29494 msgid "guestfs_vg_activate"
29498 #: ../src/guestfs-actions.pod:7409
29502 " guestfs_vg_activate (guestfs_h *g,\n"
29504 " char *const *volgroups);\n"
29509 #: ../src/guestfs-actions.pod:7426
29510 msgid "guestfs_vg_activate_all"
29514 #: ../src/guestfs-actions.pod:7428
29518 " guestfs_vg_activate_all (guestfs_h *g,\n"
29519 " int activate);\n"
29524 #: ../src/guestfs-actions.pod:7441
29525 msgid "guestfs_vgcreate"
29529 #: ../src/guestfs-actions.pod:7443
29533 " guestfs_vgcreate (guestfs_h *g,\n"
29534 " const char *volgroup,\n"
29535 " char *const *physvols);\n"
29540 #: ../src/guestfs-actions.pod:7455
29541 msgid "guestfs_vglvuuids"
29545 #: ../src/guestfs-actions.pod:7457
29549 " guestfs_vglvuuids (guestfs_h *g,\n"
29550 " const char *vgname);\n"
29555 #: ../src/guestfs-actions.pod:7464
29557 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
29558 "associate logical volumes and volume groups."
29562 #: ../src/guestfs-actions.pod:7467
29563 msgid "See also C<guestfs_vgpvuuids>."
29567 #: ../src/guestfs-actions.pod:7475
29568 msgid "guestfs_vgpvuuids"
29572 #: ../src/guestfs-actions.pod:7477
29576 " guestfs_vgpvuuids (guestfs_h *g,\n"
29577 " const char *vgname);\n"
29582 #: ../src/guestfs-actions.pod:7484
29584 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
29585 "associate physical volumes and volume groups."
29589 #: ../src/guestfs-actions.pod:7487
29590 msgid "See also C<guestfs_vglvuuids>."
29594 #: ../src/guestfs-actions.pod:7495
29595 msgid "guestfs_vgremove"
29599 #: ../src/guestfs-actions.pod:7497
29603 " guestfs_vgremove (guestfs_h *g,\n"
29604 " const char *vgname);\n"
29609 #: ../src/guestfs-actions.pod:7510
29610 msgid "guestfs_vgrename"
29614 #: ../src/guestfs-actions.pod:7512
29618 " guestfs_vgrename (guestfs_h *g,\n"
29619 " const char *volgroup,\n"
29620 " const char *newvolgroup);\n"
29625 #: ../src/guestfs-actions.pod:7523
29626 msgid "guestfs_vgs"
29630 #: ../src/guestfs-actions.pod:7525
29634 " guestfs_vgs (guestfs_h *g);\n"
29639 #: ../src/guestfs-actions.pod:7534
29640 msgid "See also C<guestfs_vgs_full>."
29644 #: ../src/guestfs-actions.pod:7542
29645 msgid "guestfs_vgs_full"
29649 #: ../src/guestfs-actions.pod:7544
29652 " struct guestfs_lvm_vg_list *\n"
29653 " guestfs_vgs_full (guestfs_h *g);\n"
29658 #: ../src/guestfs-actions.pod:7550
29660 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
29661 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
29665 #: ../src/guestfs-actions.pod:7556
29666 msgid "guestfs_vgscan"
29670 #: ../src/guestfs-actions.pod:7558
29674 " guestfs_vgscan (guestfs_h *g);\n"
29679 #: ../src/guestfs-actions.pod:7568
29680 msgid "guestfs_vguuid"
29684 #: ../src/guestfs-actions.pod:7570
29688 " guestfs_vguuid (guestfs_h *g,\n"
29689 " const char *vgname);\n"
29694 #: ../src/guestfs-actions.pod:7581
29695 msgid "guestfs_wait_ready"
29699 #: ../src/guestfs-actions.pod:7583
29703 " guestfs_wait_ready (guestfs_h *g);\n"
29708 #: ../src/guestfs-actions.pod:7586
29709 msgid "This function is a no op."
29713 #: ../src/guestfs-actions.pod:7588
29715 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
29716 "calling C<guestfs_launch> to wait for the launch to complete. However this "
29717 "is no longer necessary because C<guestfs_launch> now does the waiting."
29721 #: ../src/guestfs-actions.pod:7593
29723 "If you see any calls to this function in code then you can just remove them, "
29724 "unless you want to retain compatibility with older versions of the API."
29728 #: ../src/guestfs-actions.pod:7599
29730 "This function is deprecated. In new code, use the C<launch> call instead."
29734 #: ../src/guestfs-actions.pod:7608
29735 msgid "guestfs_wc_c"
29739 #: ../src/guestfs-actions.pod:7610
29743 " guestfs_wc_c (guestfs_h *g,\n"
29744 " const char *path);\n"
29749 #: ../src/guestfs-actions.pod:7621
29750 msgid "guestfs_wc_l"
29754 #: ../src/guestfs-actions.pod:7623
29758 " guestfs_wc_l (guestfs_h *g,\n"
29759 " const char *path);\n"
29764 #: ../src/guestfs-actions.pod:7634
29765 msgid "guestfs_wc_w"
29769 #: ../src/guestfs-actions.pod:7636
29773 " guestfs_wc_w (guestfs_h *g,\n"
29774 " const char *path);\n"
29779 #: ../src/guestfs-actions.pod:7647
29780 msgid "guestfs_write"
29784 #: ../src/guestfs-actions.pod:7649
29788 " guestfs_write (guestfs_h *g,\n"
29789 " const char *path,\n"
29790 " const char *content,\n"
29791 " size_t content_size);\n"
29796 #: ../src/guestfs-actions.pod:7658
29797 msgid "See also C<guestfs_write_append>."
29801 #: ../src/guestfs-actions.pod:7667
29802 msgid "guestfs_write_append"
29806 #: ../src/guestfs-actions.pod:7669
29810 " guestfs_write_append (guestfs_h *g,\n"
29811 " const char *path,\n"
29812 " const char *content,\n"
29813 " size_t content_size);\n"
29818 #: ../src/guestfs-actions.pod:7678
29819 msgid "See also C<guestfs_write>."
29823 #: ../src/guestfs-actions.pod:7687
29824 msgid "guestfs_write_file"
29828 #: ../src/guestfs-actions.pod:7689
29832 " guestfs_write_file (guestfs_h *g,\n"
29833 " const char *path,\n"
29834 " const char *content,\n"
29840 #: ../src/guestfs-actions.pod:7720
29841 msgid "guestfs_zegrep"
29845 #: ../src/guestfs-actions.pod:7722
29849 " guestfs_zegrep (guestfs_h *g,\n"
29850 " const char *regex,\n"
29851 " const char *path);\n"
29856 #: ../src/guestfs-actions.pod:7739
29857 msgid "guestfs_zegrepi"
29861 #: ../src/guestfs-actions.pod:7741
29865 " guestfs_zegrepi (guestfs_h *g,\n"
29866 " const char *regex,\n"
29867 " const char *path);\n"
29872 #: ../src/guestfs-actions.pod:7758
29873 msgid "guestfs_zero"
29877 #: ../src/guestfs-actions.pod:7760
29881 " guestfs_zero (guestfs_h *g,\n"
29882 " const char *device);\n"
29887 #: ../src/guestfs-actions.pod:7770
29889 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
29890 "C<guestfs_is_zero_device>"
29894 #: ../src/guestfs-actions.pod:7782
29895 msgid "guestfs_zero_device"
29899 #: ../src/guestfs-actions.pod:7784
29903 " guestfs_zero_device (guestfs_h *g,\n"
29904 " const char *device);\n"
29909 #: ../src/guestfs-actions.pod:7788
29911 "This command writes zeroes over the entire C<device>. Compare with "
29912 "C<guestfs_zero> which just zeroes the first few blocks of a device."
29916 #: ../src/guestfs-actions.pod:7802
29917 msgid "(Added in 1.3.1)"
29921 #: ../src/guestfs-actions.pod:7804
29922 msgid "guestfs_zerofree"
29926 #: ../src/guestfs-actions.pod:7806
29930 " guestfs_zerofree (guestfs_h *g,\n"
29931 " const char *device);\n"
29936 #: ../src/guestfs-actions.pod:7825
29937 msgid "guestfs_zfgrep"
29941 #: ../src/guestfs-actions.pod:7827
29945 " guestfs_zfgrep (guestfs_h *g,\n"
29946 " const char *pattern,\n"
29947 " const char *path);\n"
29952 #: ../src/guestfs-actions.pod:7844
29953 msgid "guestfs_zfgrepi"
29957 #: ../src/guestfs-actions.pod:7846
29961 " guestfs_zfgrepi (guestfs_h *g,\n"
29962 " const char *pattern,\n"
29963 " const char *path);\n"
29968 #: ../src/guestfs-actions.pod:7863
29969 msgid "guestfs_zfile"
29973 #: ../src/guestfs-actions.pod:7865
29977 " guestfs_zfile (guestfs_h *g,\n"
29978 " const char *meth,\n"
29979 " const char *path);\n"
29984 #: ../src/guestfs-actions.pod:7875
29986 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
29991 #: ../src/guestfs-actions.pod:7890
29992 msgid "guestfs_zgrep"
29996 #: ../src/guestfs-actions.pod:7892
30000 " guestfs_zgrep (guestfs_h *g,\n"
30001 " const char *regex,\n"
30002 " const char *path);\n"
30007 #: ../src/guestfs-actions.pod:7909
30008 msgid "guestfs_zgrepi"
30012 #: ../src/guestfs-actions.pod:7911
30016 " guestfs_zgrepi (guestfs_h *g,\n"
30017 " const char *regex,\n"
30018 " const char *path);\n"
30023 #: ../src/guestfs-availability.pod:3
30028 #: ../src/guestfs-availability.pod:5
30030 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
30031 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
30032 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
30033 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
30034 "L</guestfs_aug_save> L</guestfs_aug_set>"
30038 #: ../src/guestfs-availability.pod:21
30043 #: ../src/guestfs-availability.pod:23
30044 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
30048 #: ../src/guestfs-availability.pod:26
30053 #: ../src/guestfs-availability.pod:28
30055 "The following functions: L</guestfs_inotify_add_watch> L</"
30056 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
30057 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
30061 #: ../src/guestfs-availability.pod:36
30062 msgid "B<linuxfsuuid>"
30066 #: ../src/guestfs-availability.pod:38
30068 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
30069 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
30073 #: ../src/guestfs-availability.pod:45
30074 msgid "B<linuxmodules>"
30078 #: ../src/guestfs-availability.pod:47
30079 msgid "The following functions: L</guestfs_modprobe>"
30083 #: ../src/guestfs-availability.pod:50
30084 msgid "B<linuxxattrs>"
30088 #: ../src/guestfs-availability.pod:52
30090 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
30091 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
30092 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
30093 "guestfs_setxattr>"
30097 #: ../src/guestfs-availability.pod:63
30102 #: ../src/guestfs-availability.pod:65
30104 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
30105 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
30106 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
30110 #: ../src/guestfs-availability.pod:74
30115 #: ../src/guestfs-availability.pod:76
30117 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
30118 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
30119 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
30120 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
30121 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
30122 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
30123 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
30127 #: ../src/guestfs-availability.pod:99
30132 #: ../src/guestfs-availability.pod:101
30134 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
30135 "guestfs_mknod_b> L</guestfs_mknod_c>"
30139 #: ../src/guestfs-availability.pod:107
30144 #: ../src/guestfs-availability.pod:109
30145 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
30149 #: ../src/guestfs-availability.pod:112
30150 msgid "B<ntfsprogs>"
30154 #: ../src/guestfs-availability.pod:114
30156 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
30157 "L</guestfs_ntfsresize_size>"
30161 #: ../src/guestfs-availability.pod:119
30162 msgid "B<realpath>"
30166 #: ../src/guestfs-availability.pod:121
30167 msgid "The following functions: L</guestfs_realpath>"
30171 #: ../src/guestfs-availability.pod:124
30176 #: ../src/guestfs-availability.pod:126
30178 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
30179 "guestfs_scrub_freespace>"
30183 #: ../src/guestfs-availability.pod:131
30188 #: ../src/guestfs-availability.pod:133
30189 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
30193 #: ../src/guestfs-availability.pod:137
30198 #: ../src/guestfs-availability.pod:139
30199 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
30203 #: ../src/guestfs-availability.pod:143
30204 msgid "B<zerofree>"
30208 #: ../src/guestfs-availability.pod:145
30209 msgid "The following functions: L</guestfs_zerofree>"
30213 #: ../src/guestfs-structs.pod:1
30214 msgid "guestfs_int_bool"
30218 #: ../src/guestfs-structs.pod:3
30221 " struct guestfs_int_bool {\n"
30229 #: ../src/guestfs-structs.pod:8
30232 " struct guestfs_int_bool_list {\n"
30233 " uint32_t len; /* Number of elements in list. */\n"
30234 " struct guestfs_int_bool *val; /* Elements. */\n"
30240 #: ../src/guestfs-structs.pod:13
30243 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
30244 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
30249 #: ../src/guestfs-structs.pod:16
30250 msgid "guestfs_lvm_pv"
30254 #: ../src/guestfs-structs.pod:18
30257 " struct guestfs_lvm_pv {\n"
30258 " char *pv_name;\n"
30259 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30260 " char pv_uuid[32];\n"
30262 " uint64_t pv_size;\n"
30263 " uint64_t dev_size;\n"
30264 " uint64_t pv_free;\n"
30265 " uint64_t pv_used;\n"
30266 " char *pv_attr;\n"
30267 " int64_t pv_pe_count;\n"
30268 " int64_t pv_pe_alloc_count;\n"
30269 " char *pv_tags;\n"
30270 " uint64_t pe_start;\n"
30271 " int64_t pv_mda_count;\n"
30272 " uint64_t pv_mda_free;\n"
30278 #: ../src/guestfs-structs.pod:36
30281 " struct guestfs_lvm_pv_list {\n"
30282 " uint32_t len; /* Number of elements in list. */\n"
30283 " struct guestfs_lvm_pv *val; /* Elements. */\n"
30289 #: ../src/guestfs-structs.pod:41
30292 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
30293 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
30298 #: ../src/guestfs-structs.pod:44
30299 msgid "guestfs_lvm_vg"
30303 #: ../src/guestfs-structs.pod:46
30306 " struct guestfs_lvm_vg {\n"
30307 " char *vg_name;\n"
30308 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30309 " char vg_uuid[32];\n"
30311 " char *vg_attr;\n"
30312 " uint64_t vg_size;\n"
30313 " uint64_t vg_free;\n"
30314 " char *vg_sysid;\n"
30315 " uint64_t vg_extent_size;\n"
30316 " int64_t vg_extent_count;\n"
30317 " int64_t vg_free_count;\n"
30318 " int64_t max_lv;\n"
30319 " int64_t max_pv;\n"
30320 " int64_t pv_count;\n"
30321 " int64_t lv_count;\n"
30322 " int64_t snap_count;\n"
30323 " int64_t vg_seqno;\n"
30324 " char *vg_tags;\n"
30325 " int64_t vg_mda_count;\n"
30326 " uint64_t vg_mda_free;\n"
30332 #: ../src/guestfs-structs.pod:69
30335 " struct guestfs_lvm_vg_list {\n"
30336 " uint32_t len; /* Number of elements in list. */\n"
30337 " struct guestfs_lvm_vg *val; /* Elements. */\n"
30343 #: ../src/guestfs-structs.pod:74
30346 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
30347 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
30352 #: ../src/guestfs-structs.pod:77
30353 msgid "guestfs_lvm_lv"
30357 #: ../src/guestfs-structs.pod:79
30360 " struct guestfs_lvm_lv {\n"
30361 " char *lv_name;\n"
30362 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30363 " char lv_uuid[32];\n"
30364 " char *lv_attr;\n"
30365 " int64_t lv_major;\n"
30366 " int64_t lv_minor;\n"
30367 " int64_t lv_kernel_major;\n"
30368 " int64_t lv_kernel_minor;\n"
30369 " uint64_t lv_size;\n"
30370 " int64_t seg_count;\n"
30372 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
30373 " float snap_percent;\n"
30374 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
30375 " float copy_percent;\n"
30376 " char *move_pv;\n"
30377 " char *lv_tags;\n"
30378 " char *mirror_log;\n"
30379 " char *modules;\n"
30385 #: ../src/guestfs-structs.pod:101
30388 " struct guestfs_lvm_lv_list {\n"
30389 " uint32_t len; /* Number of elements in list. */\n"
30390 " struct guestfs_lvm_lv *val; /* Elements. */\n"
30396 #: ../src/guestfs-structs.pod:106
30399 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
30400 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
30405 #: ../src/guestfs-structs.pod:111
30408 " struct guestfs_stat {\n"
30412 " int64_t nlink;\n"
30417 " int64_t blksize;\n"
30418 " int64_t blocks;\n"
30419 " int64_t atime;\n"
30420 " int64_t mtime;\n"
30421 " int64_t ctime;\n"
30427 #: ../src/guestfs-structs.pod:127
30430 " struct guestfs_stat_list {\n"
30431 " uint32_t len; /* Number of elements in list. */\n"
30432 " struct guestfs_stat *val; /* Elements. */\n"
30438 #: ../src/guestfs-structs.pod:132
30441 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
30442 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
30447 #: ../src/guestfs-structs.pod:137
30450 " struct guestfs_statvfs {\n"
30451 " int64_t bsize;\n"
30452 " int64_t frsize;\n"
30453 " int64_t blocks;\n"
30454 " int64_t bfree;\n"
30455 " int64_t bavail;\n"
30456 " int64_t files;\n"
30457 " int64_t ffree;\n"
30458 " int64_t favail;\n"
30461 " int64_t namemax;\n"
30467 #: ../src/guestfs-structs.pod:151
30470 " struct guestfs_statvfs_list {\n"
30471 " uint32_t len; /* Number of elements in list. */\n"
30472 " struct guestfs_statvfs *val; /* Elements. */\n"
30478 #: ../src/guestfs-structs.pod:156
30481 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
30482 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
30487 #: ../src/guestfs-structs.pod:159
30488 msgid "guestfs_dirent"
30492 #: ../src/guestfs-structs.pod:161
30495 " struct guestfs_dirent {\n"
30504 #: ../src/guestfs-structs.pod:167
30507 " struct guestfs_dirent_list {\n"
30508 " uint32_t len; /* Number of elements in list. */\n"
30509 " struct guestfs_dirent *val; /* Elements. */\n"
30515 #: ../src/guestfs-structs.pod:172
30518 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
30519 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
30524 #: ../src/guestfs-structs.pod:177
30527 " struct guestfs_version {\n"
30528 " int64_t major;\n"
30529 " int64_t minor;\n"
30530 " int64_t release;\n"
30537 #: ../src/guestfs-structs.pod:184
30540 " struct guestfs_version_list {\n"
30541 " uint32_t len; /* Number of elements in list. */\n"
30542 " struct guestfs_version *val; /* Elements. */\n"
30548 #: ../src/guestfs-structs.pod:189
30551 " void guestfs_free_version (struct guestfs_free_version *);\n"
30552 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
30557 #: ../src/guestfs-structs.pod:192
30558 msgid "guestfs_xattr"
30562 #: ../src/guestfs-structs.pod:194
30565 " struct guestfs_xattr {\n"
30566 " char *attrname;\n"
30567 " /* The next two fields describe a byte array. */\n"
30568 " uint32_t attrval_len;\n"
30569 " char *attrval;\n"
30575 #: ../src/guestfs-structs.pod:201
30578 " struct guestfs_xattr_list {\n"
30579 " uint32_t len; /* Number of elements in list. */\n"
30580 " struct guestfs_xattr *val; /* Elements. */\n"
30586 #: ../src/guestfs-structs.pod:206
30589 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
30590 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
30595 #: ../src/guestfs-structs.pod:209
30596 msgid "guestfs_inotify_event"
30600 #: ../src/guestfs-structs.pod:211
30603 " struct guestfs_inotify_event {\n"
30604 " int64_t in_wd;\n"
30605 " uint32_t in_mask;\n"
30606 " uint32_t in_cookie;\n"
30607 " char *in_name;\n"
30613 #: ../src/guestfs-structs.pod:218
30616 " struct guestfs_inotify_event_list {\n"
30617 " uint32_t len; /* Number of elements in list. */\n"
30618 " struct guestfs_inotify_event *val; /* Elements. */\n"
30624 #: ../src/guestfs-structs.pod:223
30627 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
30628 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
30633 #: ../src/guestfs-structs.pod:226
30634 msgid "guestfs_partition"
30638 #: ../src/guestfs-structs.pod:228
30641 " struct guestfs_partition {\n"
30642 " int32_t part_num;\n"
30643 " uint64_t part_start;\n"
30644 " uint64_t part_end;\n"
30645 " uint64_t part_size;\n"
30651 #: ../src/guestfs-structs.pod:235
30654 " struct guestfs_partition_list {\n"
30655 " uint32_t len; /* Number of elements in list. */\n"
30656 " struct guestfs_partition *val; /* Elements. */\n"
30662 #: ../src/guestfs-structs.pod:240
30665 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
30666 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
30671 #: ../src/guestfs-structs.pod:243
30672 msgid "guestfs_application"
30676 #: ../src/guestfs-structs.pod:245
30679 " struct guestfs_application {\n"
30680 " char *app_name;\n"
30681 " char *app_display_name;\n"
30682 " int32_t app_epoch;\n"
30683 " char *app_version;\n"
30684 " char *app_release;\n"
30685 " char *app_install_path;\n"
30686 " char *app_trans_path;\n"
30687 " char *app_publisher;\n"
30688 " char *app_url;\n"
30689 " char *app_source_package;\n"
30690 " char *app_summary;\n"
30691 " char *app_description;\n"
30697 #: ../src/guestfs-structs.pod:260
30700 " struct guestfs_application_list {\n"
30701 " uint32_t len; /* Number of elements in list. */\n"
30702 " struct guestfs_application *val; /* Elements. */\n"
30708 #: ../src/guestfs-structs.pod:265
30711 " void guestfs_free_application (struct guestfs_free_application *);\n"
30712 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
30717 #: ../src/guestfs.pod:5
30718 msgid "guestfs - Library for accessing and modifying virtual machine images"
30722 #: ../src/guestfs.pod:11
30725 " guestfs_h *g = guestfs_create ();\n"
30726 " guestfs_add_drive (g, \"guest.img\");\n"
30727 " guestfs_launch (g);\n"
30728 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30729 " guestfs_touch (g, \"/hello\");\n"
30730 " guestfs_umount (g, \"/\");\n"
30731 " guestfs_close (g);\n"
30736 #: ../src/guestfs.pod:25
30738 "Libguestfs is a library for accessing and modifying guest disk images. "
30739 "Amongst the things this is good for: making batch configuration changes to "
30740 "guests, getting disk used/free statistics (see also: virt-df), migrating "
30741 "between virtualization systems (see also: virt-p2v), performing partial "
30742 "backups, performing partial guest clones, cloning guests and changing "
30743 "registry/UUID/hostname info, and much else besides."
30747 #: ../src/guestfs.pod:33
30749 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
30750 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
30751 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
30756 #: ../src/guestfs.pod:38
30758 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
30759 "what filesystem is in each LV, etc.). It can also run commands in the "
30760 "context of the guest. Also you can access filesystems over FUSE."
30764 #: ../src/guestfs.pod:43
30766 "Libguestfs is a library that can be linked with C and C++ management "
30767 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
30768 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
30773 #: ../src/guestfs.pod:48
30775 "You don't need to be root to use libguestfs, although obviously you do need "
30776 "enough permissions to access the disk images."
30780 #: ../src/guestfs.pod:51
30782 "Libguestfs is a large API because it can do many things. For a gentle "
30783 "introduction, please read the L</API OVERVIEW> section next."
30787 #: ../src/guestfs.pod:54
30789 "There are also some example programs in the L<guestfs-examples(3)> manual "
30794 #: ../src/guestfs.pod:57
30795 msgid "API OVERVIEW"
30799 #: ../src/guestfs.pod:59
30801 "This section provides a gentler overview of the libguestfs API. We also try "
30802 "to group API calls together, where that may not be obvious from reading "
30803 "about the individual calls in the main section of this manual."
30807 #: ../src/guestfs.pod:64
30812 #: ../src/guestfs.pod:66
30814 "Before you can use libguestfs calls, you have to create a handle. Then you "
30815 "must add at least one disk image to the handle, followed by launching the "
30816 "handle, then performing whatever operations you want, and finally closing "
30817 "the handle. By convention we use the single letter C<g> for the name of the "
30818 "handle variable, although of course you can use any name you want."
30822 #: ../src/guestfs.pod:73
30823 msgid "The general structure of all libguestfs-using programs looks like this:"
30827 #: ../src/guestfs.pod:76
30830 " guestfs_h *g = guestfs_create ();\n"
30835 #: ../src/guestfs.pod:78
30838 " /* Call guestfs_add_drive additional times if there are\n"
30839 " * multiple disk images.\n"
30841 " guestfs_add_drive (g, \"guest.img\");\n"
30846 #: ../src/guestfs.pod:83
30849 " /* Most manipulation calls won't work until you've launched\n"
30850 " * the handle 'g'. You have to do this _after_ adding drives\n"
30851 " * and _before_ other commands.\n"
30853 " guestfs_launch (g);\n"
30858 #: ../src/guestfs.pod:89
30861 " /* Now you can examine what partitions, LVs etc are available.\n"
30863 " char **partitions = guestfs_list_partitions (g);\n"
30864 " char **logvols = guestfs_lvs (g);\n"
30869 #: ../src/guestfs.pod:94
30872 " /* To access a filesystem in the image, you must mount it.\n"
30874 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30879 #: ../src/guestfs.pod:98
30882 " /* Now you can perform filesystem actions on the guest\n"
30885 " guestfs_touch (g, \"/hello\");\n"
30890 #: ../src/guestfs.pod:103
30893 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
30894 " * it is done automatically when you close the handle. See\n"
30895 " * discussion of autosync in this page.\n"
30897 " guestfs_sync (g);\n"
30902 #: ../src/guestfs.pod:109
30905 " /* Close the handle 'g'. */\n"
30906 " guestfs_close (g);\n"
30911 #: ../src/guestfs.pod:112
30913 "The code above doesn't include any error checking. In real code you should "
30914 "check return values carefully for errors. In general all functions that "
30915 "return integers return C<-1> on error, and all functions that return "
30916 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
30917 "how to handle errors, and consult the documentation for each function call "
30918 "below to see precisely how they return error indications. See L<guestfs-"
30919 "examples(3)> for fully worked examples."
30923 #: ../src/guestfs.pod:121
30924 msgid "DISK IMAGES"
30928 #: ../src/guestfs.pod:123
30930 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
30931 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
30932 "actual block device, or simply an empty file of zeroes that you have created "
30933 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
30938 #: ../src/guestfs.pod:129
30940 "The call you should use in modern code for adding drives is L</"
30941 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
30942 "specifying that the format is raw, do:"
30946 #: ../src/guestfs.pod:133
30949 " guestfs_add_drive_opts (g, filename,\n"
30950 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30956 #: ../src/guestfs.pod:137
30957 msgid "You can add a disk read-only using:"
30961 #: ../src/guestfs.pod:139
30964 " guestfs_add_drive_opts (g, filename,\n"
30965 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30966 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
30972 #: ../src/guestfs.pod:144
30974 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
30975 "libguestfs won't modify the file."
30979 #: ../src/guestfs.pod:147
30981 "Be extremely cautious if the disk image is in use, eg. if it is being used "
30982 "by a virtual machine. Adding it read-write will almost certainly cause disk "
30983 "corruption, but adding it read-only is safe."
30987 #: ../src/guestfs.pod:151
30989 "You must add at least one disk image, and you may add multiple disk images. "
30990 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
30991 "first one you added), C</dev/sdb> (for the second one you added), etc."
30995 #: ../src/guestfs.pod:156
30997 "Once L</guestfs_launch> has been called you cannot add any more images. You "
30998 "can call L</guestfs_list_devices> to get a list of the device names, in the "
30999 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
31003 #: ../src/guestfs.pod:161
31008 #: ../src/guestfs.pod:163
31010 "Before you can read or write files, create directories and so on in a disk "
31011 "image that contains filesystems, you have to mount those filesystems using "
31012 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
31013 "a disk image contains (for example) one partition with a filesystem on that "
31014 "partition, then you can mount it directly:"
31018 #: ../src/guestfs.pod:170
31021 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
31026 #: ../src/guestfs.pod:172
31028 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
31029 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
31030 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
31031 "that these are libguestfs virtual devices, and are nothing to do with host "
31036 #: ../src/guestfs.pod:178
31038 "If you are given a disk image and you don't know what it contains then you "
31039 "have to find out. Libguestfs can do that too: use L</"
31040 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
31041 "LVs, and either try mounting each to see what is mountable, or else examine "
31042 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
31043 "filesystems, use L</guestfs_list_filesystems>."
31047 #: ../src/guestfs.pod:186
31049 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
31050 "L</INSPECTION> below). But you might find it easier to look at higher level "
31051 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
31055 #: ../src/guestfs.pod:191
31057 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
31058 "several other variations of the C<guestfs_mount_*> call."
31062 #: ../src/guestfs.pod:194
31063 msgid "FILESYSTEM ACCESS AND MODIFICATION"
31067 #: ../src/guestfs.pod:196
31069 "The majority of the libguestfs API consists of fairly low-level calls for "
31070 "accessing and modifying the files, directories, symlinks etc on mounted "
31071 "filesystems. There are over a hundred such calls which you can find listed "
31072 "in detail below in this man page, and we don't even pretend to cover them "
31073 "all in this overview."
31077 #: ../src/guestfs.pod:202
31079 "Specify filenames as full paths, starting with C<\"/\"> and including the "
31084 #: ../src/guestfs.pod:205
31086 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
31087 "the file called C<\"etc/passwd\"> then you could do:"
31091 #: ../src/guestfs.pod:208
31094 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
31099 #: ../src/guestfs.pod:210
31101 "This would return C<data> as a newly allocated buffer containing the full "
31102 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
31103 "or C<NULL> if there was an error."
31107 #: ../src/guestfs.pod:214
31109 "As another example, to create a top-level directory on that filesystem "
31110 "called C<\"var\"> you would do:"
31114 #: ../src/guestfs.pod:217
31117 " guestfs_mkdir (g, \"/var\");\n"
31122 #: ../src/guestfs.pod:219
31123 msgid "To create a symlink you could do:"
31127 #: ../src/guestfs.pod:221
31130 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
31131 " \"/etc/rc3.d/S30portmap\");\n"
31136 #: ../src/guestfs.pod:224
31138 "Libguestfs will reject attempts to use relative paths and there is no "
31139 "concept of a current working directory."
31143 #: ../src/guestfs.pod:227
31145 "Libguestfs can return errors in many situations: for example if the "
31146 "filesystem isn't writable, or if a file or directory that you requested "
31147 "doesn't exist. If you are using the C API (documented here) you have to "
31148 "check for those error conditions after each call. (Other language bindings "
31149 "turn these errors into exceptions)."
31153 #: ../src/guestfs.pod:233
31155 "File writes are affected by the per-handle umask, set by calling L</"
31156 "guestfs_umask> and defaulting to 022. See L</UMASK>."
31160 #: ../src/guestfs.pod:236
31161 msgid "PARTITIONING"
31165 #: ../src/guestfs.pod:238
31167 "Libguestfs contains API calls to read, create and modify partition tables on "
31172 #: ../src/guestfs.pod:241
31174 "In the common case where you want to create a single partition covering the "
31175 "whole disk, you should use the L</guestfs_part_disk> call:"
31179 #: ../src/guestfs.pod:245
31182 " const char *parttype = \"mbr\";\n"
31183 " if (disk_is_larger_than_2TB)\n"
31184 " parttype = \"gpt\";\n"
31185 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
31190 #: ../src/guestfs.pod:250
31192 "Obviously this effectively wipes anything that was on that disk image before."
31196 #: ../src/guestfs.pod:253
31201 #: ../src/guestfs.pod:255
31203 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
31204 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
31205 "you familiarize yourself with the concepts of physical volumes, volume "
31206 "groups and logical volumes."
31210 #: ../src/guestfs.pod:260
31212 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
31213 "tldp.org/HOWTO/LVM-HOWTO/>."
31217 #: ../src/guestfs.pod:263
31218 msgid "DOWNLOADING"
31222 #: ../src/guestfs.pod:265
31224 "Use L</guestfs_cat> to download small, text only files. This call is "
31225 "limited to files which are less than 2 MB and which cannot contain any ASCII "
31226 "NUL (C<\\0>) characters. However the API is very simple to use."
31230 #: ../src/guestfs.pod:269
31232 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
31233 "bit data, since it returns a (pointer, size) pair. However it is still "
31234 "limited to \"small\" files, less than 2 MB."
31238 #: ../src/guestfs.pod:273
31240 "L</guestfs_download> can be used to download any file, with no limits on "
31241 "content or size (even files larger than 4 GB)."
31245 #: ../src/guestfs.pod:276
31247 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
31251 #: ../src/guestfs.pod:279
31256 #: ../src/guestfs.pod:281
31258 "It's often the case that you want to write a file or files to the disk image."
31262 #: ../src/guestfs.pod:284
31264 "To write a small file with fixed content, use L</guestfs_write>. To create "
31265 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
31266 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
31267 "of other functions for creating test files, for example L</guestfs_fill> and "
31268 "L</guestfs_fill_pattern>."
31272 #: ../src/guestfs.pod:290
31274 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
31275 "file content or size (even files larger than 4 GB)."
31279 #: ../src/guestfs.pod:293
31281 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
31285 #: ../src/guestfs.pod:295
31287 "However the fastest way to upload I<large numbers of arbitrary files> is to "
31288 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
31289 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
31290 "in a predictable way (eg. adding it last after all other drives) then you "
31291 "can get the device name from L</guestfs_list_devices> and mount it directly "
31292 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
31293 "portable between kernel versions, and they don't support labels or UUIDs. "
31294 "If you want to pre-build an image or you need to mount it using a label or "
31295 "UUID, use an ISO image instead."
31299 #: ../src/guestfs.pod:306
31304 #: ../src/guestfs.pod:308
31306 "There are various different commands for copying between files and devices "
31307 "and in and out of the guest filesystem. These are summarised in the table "
31312 #: ../src/guestfs.pod:314
31313 msgid "B<file> to B<file>"
31317 #: ../src/guestfs.pod:316
31319 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
31320 "directories recursively."
31324 #: ../src/guestfs.pod:319
31325 msgid "B<file or device> to B<file or device>"
31329 #: ../src/guestfs.pod:321
31331 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
31332 "devices in the guest."
31336 #: ../src/guestfs.pod:324
31337 msgid "Example: duplicate the contents of an LV:"
31341 #: ../src/guestfs.pod:326
31344 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
31349 #: ../src/guestfs.pod:328
31351 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
31352 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
31353 "guestfs_copy_size>."
31357 #: ../src/guestfs.pod:332
31358 msgid "B<file on the host> to B<file or device>"
31362 #: ../src/guestfs.pod:334
31363 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
31367 #: ../src/guestfs.pod:336
31368 msgid "B<file or device> to B<file on the host>"
31372 #: ../src/guestfs.pod:338
31373 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
31377 #: ../src/guestfs.pod:342
31378 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
31382 #: ../src/guestfs.pod:344
31384 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
31385 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
31386 "appears you can only upload and download to files. However many Un*x-like "
31387 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
31388 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
31389 "and arbitrary file descriptor N."
31393 #: ../src/guestfs.pod:352
31394 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
31398 #: ../src/guestfs.pod:355
31401 " guestfs_download (g, filename, \"/dev/stdout\");\n"
31406 #: ../src/guestfs.pod:357
31407 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
31411 #: ../src/guestfs.pod:359
31414 " char devfd[64];\n"
31415 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
31416 " guestfs_tar_out (g, \"/\", devfd);\n"
31421 #: ../src/guestfs.pod:363
31422 msgid "LISTING FILES"
31426 #: ../src/guestfs.pod:365
31428 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
31429 "L<guestfish(1)>-equivalent command C<ll>)."
31433 #: ../src/guestfs.pod:368
31435 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
31436 "programs, as a flat list of strings."
31440 #: ../src/guestfs.pod:371
31442 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
31443 "directory, plus additional information about each one. It is more "
31444 "equivalent to using the L<readdir(3)> call on a local filesystem."
31448 #: ../src/guestfs.pod:375
31450 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
31454 #: ../src/guestfs.pod:378
31455 msgid "RUNNING COMMANDS"
31459 #: ../src/guestfs.pod:380
31461 "Although libguestfs is primarily an API for manipulating files inside guest "
31462 "images, we also provide some limited facilities for running commands inside "
31467 #: ../src/guestfs.pod:384
31468 msgid "There are many limitations to this:"
31472 #: ../src/guestfs.pod:390
31474 "The kernel version that the command runs under will be different from what "
31479 #: ../src/guestfs.pod:395
31481 "If the command needs to communicate with daemons, then most likely they "
31482 "won't be running."
31486 #: ../src/guestfs.pod:400
31487 msgid "The command will be running in limited memory."
31491 #: ../src/guestfs.pod:404
31493 "The network may not be available unless you enable it (see L</"
31494 "guestfs_set_network>)."
31498 #: ../src/guestfs.pod:409
31499 msgid "Only supports Linux guests (not Windows, BSD, etc)."
31503 #: ../src/guestfs.pod:413
31505 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
31509 #: ../src/guestfs.pod:418
31511 "For SELinux guests, you may need to enable SELinux and load policy first. "
31512 "See L</SELINUX> in this manpage."
31516 #: ../src/guestfs.pod:423
31518 "I<Security:> It is not safe to run commands from untrusted, possibly "
31519 "malicious guests. These commands may attempt to exploit your program by "
31520 "sending unexpected output. They could also try to exploit the Linux kernel "
31521 "or qemu provided by the libguestfs appliance. They could use the network "
31522 "provided by the libguestfs appliance to bypass ordinary network partitions "
31523 "and firewalls. They could use the elevated privileges or different SELinux "
31524 "context of your program to their advantage."
31528 #: ../src/guestfs.pod:432
31530 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
31531 "(a script which runs when the guest next boots normally), and to have this "
31532 "script run the commands you want in the normal context of the running guest, "
31533 "network security and so on. For information about other security issues, "
31534 "see L</SECURITY>."
31538 #: ../src/guestfs.pod:440
31540 "The two main API calls to run commands are L</guestfs_command> and L</"
31541 "guestfs_sh> (there are also variations)."
31545 #: ../src/guestfs.pod:443
31547 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
31548 "shell globs, redirections, etc will work."
31552 #: ../src/guestfs.pod:446
31553 msgid "CONFIGURATION FILES"
31557 #: ../src/guestfs.pod:448
31559 "To read and write configuration files in Linux guest filesystems, we "
31560 "strongly recommend using Augeas. For example, Augeas understands how to "
31561 "read and write, say, a Linux shadow password file or X.org configuration "
31562 "file, and so avoids you having to write that code."
31566 #: ../src/guestfs.pod:453
31568 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
31569 "document Augeas itself here because there is excellent documentation on the "
31570 "L<http://augeas.net/> website."
31574 #: ../src/guestfs.pod:457
31576 "If you don't want to use Augeas (you fool!) then try calling L</"
31577 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
31582 #: ../src/guestfs.pod:461
31587 #: ../src/guestfs.pod:463
31589 "We support SELinux guests. To ensure that labeling happens correctly in "
31590 "SELinux guests, you need to enable SELinux and load the guest's policy:"
31594 #: ../src/guestfs.pod:471
31595 msgid "Before launching, do:"
31599 #: ../src/guestfs.pod:473
31602 " guestfs_set_selinux (g, 1);\n"
31607 #: ../src/guestfs.pod:477
31609 "After mounting the guest's filesystem(s), load the policy. This is best "
31610 "done by running the L<load_policy(8)> command in the guest itself:"
31614 #: ../src/guestfs.pod:481
31617 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
31622 #: ../src/guestfs.pod:483
31624 "(Older versions of C<load_policy> require you to specify the name of the "
31629 #: ../src/guestfs.pod:488
31631 "Optionally, set the security context for the API. The correct security "
31632 "context to use can only be known by inspecting the guest. As an example:"
31636 #: ../src/guestfs.pod:492
31639 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
31644 #: ../src/guestfs.pod:496
31645 msgid "This will work for running commands and editing existing files."
31649 #: ../src/guestfs.pod:498
31651 "When new files are created, you may need to label them explicitly, for "
31652 "example by running the external command C<restorecon pathname>."
31656 #: ../src/guestfs.pod:502
31661 #: ../src/guestfs.pod:504
31663 "Certain calls are affected by the current file mode creation mask (the "
31664 "\"umask\"). In particular ones which create files or directories, such as "
31665 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
31666 "either the default mode that the file is created with or modifies the mode "
31671 #: ../src/guestfs.pod:510
31673 "The default umask is C<022>, so files are created with modes such as C<0644> "
31674 "and directories with C<0755>."
31678 #: ../src/guestfs.pod:513
31680 "There are two ways to avoid being affected by umask. Either set umask to 0 "
31681 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
31682 "guestfs_chmod> after creating each file or directory."
31686 #: ../src/guestfs.pod:517
31687 msgid "For more information about umask, see L<umask(2)>."
31691 #: ../src/guestfs.pod:521
31693 "Libguestfs allows you to access Linux guests which have been encrypted using "
31694 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
31695 "standard. This includes nearly all whole disk encryption systems used by "
31696 "modern Linux guests."
31700 #: ../src/guestfs.pod:527
31702 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
31703 "returns the string C<crypto_LUKS>)."
31707 #: ../src/guestfs.pod:530
31709 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
31710 "will require the passphrase!"
31714 #: ../src/guestfs.pod:533
31716 "Opening a LUKS device creates a new device mapper device called C</dev/"
31717 "mapper/mapname> (where C<mapname> is the string you supply to L</"
31718 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
31719 "from and encrypted to the underlying block device respectively."
31723 #: ../src/guestfs.pod:539
31725 "LVM volume groups on the device can be made visible by calling L</"
31726 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
31727 "(s) can now be mounted in the usual way."
31731 #: ../src/guestfs.pod:543
31733 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
31734 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
31735 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
31736 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
31737 "underlying encrypted block device)."
31741 #: ../src/guestfs.pod:550
31746 #: ../src/guestfs.pod:552
31748 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
31749 "contains operating systems, an install CD or a live CD. (These APIs used to "
31750 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
31751 "version 1.5.3 the most frequently used part of this library has been "
31752 "rewritten in C and moved into the core code)."
31756 #: ../src/guestfs.pod:559
31758 "Add all disks belonging to the unknown virtual machine and call L</"
31759 "guestfs_launch> in the usual way."
31763 #: ../src/guestfs.pod:562
31765 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
31766 "and certain heuristics, and returns a list of operating systems that were "
31767 "found. An empty list means none were found. A single element is the root "
31768 "filesystem of the operating system. For dual- or multi-boot guests, "
31769 "multiple roots can be returned, each one corresponding to a separate "
31770 "operating system. (Multi-boot virtual machines are extremely rare in the "
31771 "world of virtualization, but since this scenario can happen, we have built "
31772 "libguestfs to deal with it.)"
31776 #: ../src/guestfs.pod:571
31778 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
31779 "to get additional details about that operating system. For example, call L</"
31780 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
31781 "Windows and Linux-based operating systems respectively."
31785 #: ../src/guestfs.pod:577
31787 "Un*x-like and Linux-based operating systems usually consist of several "
31788 "filesystems which are mounted at boot time (for example, a separate boot "
31789 "partition mounted on C</boot>). The inspection rules are able to detect how "
31790 "filesystems correspond to mount points. Call "
31791 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
31792 "hash table like this example:"
31796 #: ../src/guestfs.pod:584
31799 " /boot => /dev/sda1\n"
31800 " / => /dev/vg_guest/lv_root\n"
31801 " /usr => /dev/vg_guest/lv_usr\n"
31806 #: ../src/guestfs.pod:588
31808 "The caller can then make calls to L</guestfs_mount_options> to mount the "
31809 "filesystems as suggested."
31813 #: ../src/guestfs.pod:591
31815 "Be careful to mount filesystems in the right order (eg. C</> before C</"
31816 "usr>). Sorting the keys of the hash by length, shortest first, should work."
31820 #: ../src/guestfs.pod:595
31822 "Inspection currently only works for some common operating systems. "
31823 "Contributors are welcome to send patches for other operating systems that we "
31824 "currently cannot detect."
31828 #: ../src/guestfs.pod:599
31830 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
31831 "for more details. The L</guestfs_inspect_os> function just ignores any "
31832 "encrypted devices."
31836 #: ../src/guestfs.pod:603
31838 "A note on the implementation: The call L</guestfs_inspect_os> performs "
31839 "inspection and caches the results in the guest handle. Subsequent calls to "
31840 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
31841 "read the disks. If you change the content of the guest disks, you can redo "
31842 "inspection by calling L</guestfs_inspect_os> again. (L</"
31843 "guestfs_inspect_list_applications> works a little differently from the other "
31844 "calls and does read the disks. See documentation for that function for "
31849 #: ../src/guestfs.pod:612
31850 msgid "INSPECTING INSTALL DISKS"
31854 #: ../src/guestfs.pod:614
31856 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
31861 #: ../src/guestfs.pod:617
31863 "Call L</guestfs_inspect_get_format> to return the format of the operating "
31864 "system, which currently can be C<installed> (a regular operating system) or "
31865 "C<installer> (some sort of install disk)."
31869 #: ../src/guestfs.pod:621
31871 "Further information is available about the operating system that can be "
31872 "installed using the regular inspection APIs like L</"
31873 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
31877 #: ../src/guestfs.pod:626
31879 "Some additional information specific to installer disks is also available "
31880 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
31881 "guestfs_inspect_is_multipart> calls."
31885 #: ../src/guestfs.pod:631
31886 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
31890 #: ../src/guestfs.pod:633
31892 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
31893 "ntfs-3g.org/> driver."
31897 #: ../src/guestfs.pod:636
31898 msgid "DRIVE LETTERS AND PATHS"
31902 #: ../src/guestfs.pod:638
31904 "DOS and Windows still use drive letters, and the filesystems are always "
31905 "treated as case insensitive by Windows itself, and therefore you might find "
31906 "a Windows configuration file referring to a path like C<c:\\windows"
31907 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
31908 "might be referred to as C</WINDOWS/System32>."
31912 #: ../src/guestfs.pod:644
31914 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
31915 "L</guestfs_inspect_get_drive_mappings>)"
31919 #: ../src/guestfs.pod:647
31921 "Dealing with separator characters (backslash vs forward slash) is outside "
31922 "the scope of libguestfs, but usually a simple character replacement will "
31927 #: ../src/guestfs.pod:651
31929 "To resolve the case insensitivity of paths, call L</"
31930 "guestfs_case_sensitive_path>."
31934 #: ../src/guestfs.pod:654
31935 msgid "ACCESSING THE WINDOWS REGISTRY"
31939 #: ../src/guestfs.pod:656
31941 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
31942 "files, through the library C<hivex> which is part of the libguestfs project "
31943 "although ships as a separate tarball. You have to locate and download the "
31944 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
31945 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
31946 "reg(1)> for more help on this issue."
31950 #: ../src/guestfs.pod:664
31951 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
31955 #: ../src/guestfs.pod:666
31957 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
31958 "provide something which looks like a Linux symlink. The way it tries to do "
31959 "the rewriting is described here:"
31963 #: ../src/guestfs.pod:670
31965 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
31970 #: ../src/guestfs.pod:672
31972 "The essential problem is that ntfs-3g simply does not have enough "
31973 "information to do a correct job. NTFS links can contain drive letters and "
31974 "references to external device GUIDs that ntfs-3g has no way of resolving. "
31975 "It is almost certainly the case that libguestfs callers should ignore what "
31976 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
31980 #: ../src/guestfs.pod:679
31982 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
31983 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
31984 "attribute, and read the raw reparse data from that (you can find the format "
31985 "documented in various places around the web)."
31989 #: ../src/guestfs.pod:684
31990 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
31994 #: ../src/guestfs.pod:686
31996 "There are other useful extended attributes that can be read from ntfs-3g "
31997 "filesystems (using L</guestfs_getxattr>). See:"
32001 #: ../src/guestfs.pod:689
32003 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
32007 #: ../src/guestfs.pod:691
32008 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
32012 #: ../src/guestfs.pod:693
32014 "Although we don't want to discourage you from using the C API, we will "
32015 "mention here that the same API is also available in other languages."
32019 #: ../src/guestfs.pod:696
32021 "The API is broadly identical in all supported languages. This means that "
32022 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
32023 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
32024 "OCaml. In other words, a straightforward, predictable isomorphism between "
32029 #: ../src/guestfs.pod:702
32031 "Error messages are automatically transformed into exceptions if the language "
32036 #: ../src/guestfs.pod:705
32038 "We don't try to \"object orientify\" parts of the API in OO languages, "
32039 "although contributors are welcome to write higher level APIs above what we "
32040 "provide in their favourite languages if they wish."
32044 #: ../src/guestfs.pod:711
32049 #: ../src/guestfs.pod:713
32051 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
32052 "identical to the C API. C++ classes and exceptions are not used."
32056 #: ../src/guestfs.pod:717
32061 #: ../src/guestfs.pod:719
32063 "The C# bindings are highly experimental. Please read the warnings at the "
32064 "top of C<csharp/Libguestfs.cs>."
32068 #: ../src/guestfs.pod:722
32073 #: ../src/guestfs.pod:724
32075 "This is the only language binding that is working but incomplete. Only "
32076 "calls which return simple integers have been bound in Haskell, and we are "
32077 "looking for help to complete this binding."
32081 #: ../src/guestfs.pod:728
32086 #: ../src/guestfs.pod:730
32088 "Full documentation is contained in the Javadoc which is distributed with "
32089 "libguestfs. For examples, see L<guestfs-java(3)>."
32093 #: ../src/guestfs.pod:733
32098 #: ../src/guestfs.pod:735
32099 msgid "See L<guestfs-ocaml(3)>."
32103 #: ../src/guestfs.pod:737
32108 #: ../src/guestfs.pod:739
32109 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
32113 #: ../src/guestfs.pod:741
32118 #: ../src/guestfs.pod:743
32120 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
32121 "the php-libguestfs package for your distribution."
32125 #: ../src/guestfs.pod:746
32126 msgid "The PHP binding only works correctly on 64 bit machines."
32130 #: ../src/guestfs.pod:748
32135 #: ../src/guestfs.pod:750
32136 msgid "See L<guestfs-python(3)>."
32140 #: ../src/guestfs.pod:752
32145 #: ../src/guestfs.pod:754
32146 msgid "See L<guestfs-ruby(3)>."
32150 #: ../src/guestfs.pod:756
32151 msgid "B<shell scripts>"
32155 #: ../src/guestfs.pod:758
32156 msgid "See L<guestfish(1)>."
32160 #: ../src/guestfs.pod:762
32161 msgid "LIBGUESTFS GOTCHAS"
32165 #: ../src/guestfs.pod:764
32167 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
32168 "system [...] that works in the way it is documented but is counterintuitive "
32169 "and almost invites mistakes.\""
32173 #: ../src/guestfs.pod:768
32175 "Since we developed libguestfs and the associated tools, there are several "
32176 "things we would have designed differently, but are now stuck with for "
32177 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
32178 "release, you can expect these to change. Beware of them."
32182 #: ../src/guestfs.pod:776
32183 msgid "Autosync / forgetting to sync."
32187 #: ../src/guestfs.pod:778
32189 "I<Update:> Autosync is enabled by default for all API users starting from "
32190 "libguestfs 1.5.24. This section only applies to older versions."
32194 #: ../src/guestfs.pod:781
32196 "When modifying a filesystem from C or another language, you B<must> unmount "
32197 "all filesystems and call L</guestfs_sync> explicitly before you close the "
32198 "libguestfs handle. You can also call:"
32202 #: ../src/guestfs.pod:785
32205 " guestfs_set_autosync (g, 1);\n"
32210 #: ../src/guestfs.pod:787
32212 "to have the unmount/sync done automatically for you when the handle 'g' is "
32213 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
32217 #: ../src/guestfs.pod:791
32219 "If you forget to do this, then it is entirely possible that your changes "
32220 "won't be written out, or will be partially written, or (very rarely) that "
32221 "you'll get disk corruption."
32225 #: ../src/guestfs.pod:795
32227 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
32228 "guestfish scripts that forget to sync will work just fine, which can make "
32229 "this very puzzling if you are trying to debug a problem."
32233 #: ../src/guestfs.pod:799
32234 msgid "Mount option C<-o sync> should not be the default."
32238 #: ../src/guestfs.pod:801
32240 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
32241 "However C<-o sync> does not add any reliability benefit, but does have a "
32242 "very large performance impact."
32246 #: ../src/guestfs.pod:805
32248 "The work around is to use L</guestfs_mount_options> and set the mount "
32249 "options that you actually want to use."
32253 #: ../src/guestfs.pod:808
32254 msgid "Read-only should be the default."
32258 #: ../src/guestfs.pod:810
32260 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
32261 "specify I<--rw> if you want to make changes to the image."
32265 #: ../src/guestfs.pod:813
32266 msgid "This would reduce the potential to corrupt live VM images."
32270 #: ../src/guestfs.pod:815
32272 "Note that many filesystems change the disk when you just mount and unmount, "
32273 "even if you didn't perform any writes. You need to use L</"
32274 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
32278 #: ../src/guestfs.pod:819
32279 msgid "guestfish command line is hard to use."
32283 #: ../src/guestfs.pod:821
32285 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
32286 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
32287 "exist, so it fails. In earlier versions of guestfish the error message was "
32288 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
32289 "we should have used C<guestfish -c command> to run commands."
32293 #: ../src/guestfs.pod:828
32294 msgid "guestfish megabyte modifiers don't work right on all commands"
32298 #: ../src/guestfs.pod:830
32300 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
32301 "other modifiers). What guestfish actually does is to multiply the number "
32302 "part by the modifier part and pass the result to the C API. However this "
32303 "doesn't work for a few APIs which aren't expecting bytes, but are already "
32304 "expecting some other unit (eg. megabytes)."
32308 #: ../src/guestfs.pod:837
32309 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
32313 #: ../src/guestfs.pod:839
32316 " lvcreate LV VG 100M\n"
32321 #: ../src/guestfs.pod:841
32323 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
32324 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
32325 "megabytes * megabytes) logical volume. The error message you get from this "
32326 "is also a little obscure."
32330 #: ../src/guestfs.pod:846
32332 "This could be fixed in the generator by specially marking parameters and "
32333 "return values which take bytes or other units."
32337 #: ../src/guestfs.pod:849
32338 msgid "Ambiguity between devices and paths"
32342 #: ../src/guestfs.pod:851
32344 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
32345 "sdb2>) and a similar pathname. A file might just happen to be called "
32346 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
32350 #: ../src/guestfs.pod:856
32352 "In the current API we usually resolve this ambiguity by having two separate "
32353 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
32354 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
32355 "detecting if the path supplied begins with C</dev/>."
32359 #: ../src/guestfs.pod:862
32361 "To avoid both the ambiguity and the need to duplicate some calls, we could "
32362 "make paths/devices into structured names. One way to do this would be to "
32363 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
32364 "aspect of grub. Another way would be to use a structured type, equivalent "
32365 "to this OCaml type:"
32369 #: ../src/guestfs.pod:868
32372 " type path = Path of string | Device of int | Partition of int * int\n"
32377 #: ../src/guestfs.pod:870
32378 msgid "which would allow you to pass arguments like:"
32382 #: ../src/guestfs.pod:872
32385 " Path \"/foo/bar\"\n"
32386 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
32387 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
32388 " Path \"/dev/sdb2\" (* not a device *)\n"
32393 #: ../src/guestfs.pod:877
32395 "As you can see there are still problems to resolve even with this "
32396 "representation. Also consider how it might work in guestfish."
32400 #: ../src/guestfs.pod:882
32401 msgid "KEYS AND PASSPHRASES"
32405 #: ../src/guestfs.pod:884
32407 "Certain libguestfs calls take a parameter that contains sensitive key "
32408 "material, passed in as a C string."
32412 #: ../src/guestfs.pod:887
32414 "In the future we would hope to change the libguestfs implementation so that "
32415 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
32416 "swap. However this is I<not> done at the moment, because of the complexity "
32417 "of such an implementation."
32421 #: ../src/guestfs.pod:892
32423 "Therefore you should be aware that any key parameter you pass to libguestfs "
32424 "might end up being written out to the swap partition. If this is a concern, "
32425 "scrub the swap partition or don't use libguestfs on encrypted devices."
32429 #: ../src/guestfs.pod:897
32430 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
32434 #: ../src/guestfs.pod:899
32436 "All high-level libguestfs actions are synchronous. If you want to use "
32437 "libguestfs asynchronously then you must create a thread."
32441 #: ../src/guestfs.pod:902
32443 "Only use the handle from a single thread. Either use the handle exclusively "
32444 "from one thread, or provide your own mutex so that two threads cannot issue "
32445 "calls on the same handle at the same time."
32449 #: ../src/guestfs.pod:906
32451 "See the graphical program guestfs-browser for one possible architecture for "
32452 "multithreaded programs using libvirt and libguestfs."
32456 #: ../src/guestfs.pod:909
32461 #: ../src/guestfs.pod:911
32463 "Libguestfs needs a supermin appliance, which it finds by looking along an "
32468 #: ../src/guestfs.pod:914
32470 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
32471 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
32475 #: ../src/guestfs.pod:917
32477 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
32478 "to change the directories that libguestfs will search in. The value is a "
32479 "colon-separated list of paths. The current directory is I<not> searched "
32480 "unless the path contains an empty element or C<.>. For example "
32481 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
32482 "then C</usr/lib/guestfs>."
32486 #: ../src/guestfs.pod:924
32487 msgid "QEMU WRAPPERS"
32491 #: ../src/guestfs.pod:926
32493 "If you want to compile your own qemu, run qemu from a non-standard location, "
32494 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
32499 #: ../src/guestfs.pod:930
32501 "There is one important rule to remember: you I<must C<exec qemu>> as the "
32502 "last command in the shell script (so that qemu replaces the shell and "
32503 "becomes the direct child of the libguestfs-using program). If you don't do "
32504 "this, then the qemu process won't be cleaned up correctly."
32508 #: ../src/guestfs.pod:935
32510 "Here is an example of a wrapper, where I have built my own copy of qemu from "
32515 #: ../src/guestfs.pod:938
32519 " qemudir=/home/rjones/d/qemu\n"
32520 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
32525 #: ../src/guestfs.pod:942
32527 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
32528 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
32533 #: ../src/guestfs.pod:946
32536 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
32541 #: ../src/guestfs.pod:948
32543 "Note that libguestfs also calls qemu with the -help and -version options in "
32544 "order to determine features."
32548 #: ../src/guestfs.pod:951
32549 msgid "ATTACHING TO RUNNING DAEMONS"
32553 #: ../src/guestfs.pod:953
32555 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
32556 "babies. Use with caution."
32560 #: ../src/guestfs.pod:956
32562 "I<Note (2):> This section explains how to attach to a running daemon from a "
32563 "low level perspective. For most users, simply using virt tools such as "
32564 "L<guestfish(1)> with the I<--live> option will \"just work\"."
32568 #: ../src/guestfs.pod:960
32569 msgid "Using guestfs_set_attach_method"
32573 #: ../src/guestfs.pod:962
32575 "By calling L</guestfs_set_attach_method> you can change how the library "
32576 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
32577 "ARCHITECTURE> for some background)."
32581 #: ../src/guestfs.pod:966
32583 "The normal attach method is C<appliance>, where a small appliance is created "
32584 "containing the daemon, and then the library connects to this."
32588 #: ../src/guestfs.pod:969
32590 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
32591 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
32592 "daemon over the Unix domain socket."
32596 #: ../src/guestfs.pod:973
32598 "The normal use for this is to connect to a running virtual machine that "
32599 "contains a C<guestfsd> daemon, and send commands so you can read and write "
32600 "files inside the live virtual machine."
32604 #: ../src/guestfs.pod:977
32605 msgid "Using guestfs_add_domain with live flag"
32609 #: ../src/guestfs.pod:979
32611 "L</guestfs_add_domain> provides some help for getting the correct attach "
32612 "method. If you pass the C<live> option to this function, then (if the "
32613 "virtual machine is running) it will examine the libvirt XML looking for a "
32614 "virtio-serial channel to connect to:"
32618 #: ../src/guestfs.pod:985
32625 " <channel type='unix'>\n"
32626 " <source mode='bind' path='/path/to/socket'/>\n"
32627 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
32636 #: ../src/guestfs.pod:997
32638 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
32639 "method to C<unix:/path/to/socket>."
32643 #: ../src/guestfs.pod:1000
32645 "Some of the libguestfs tools (including guestfish) support a I<--live> "
32646 "option which is passed through to L</guestfs_add_domain> thus allowing you "
32647 "to attach to and modify live virtual machines."
32651 #: ../src/guestfs.pod:1004
32653 "The virtual machine needs to have been set up beforehand so that it has the "
32654 "virtio-serial channel and so that guestfsd is running inside it."
32658 #: ../src/guestfs.pod:1008
32659 msgid "ABI GUARANTEE"
32663 #: ../src/guestfs.pod:1010
32665 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
32666 "actions as outlined in this section. Although we will deprecate some "
32667 "actions, for example if they get replaced by newer calls, we will keep the "
32668 "old actions forever. This allows you the developer to program in confidence "
32669 "against the libguestfs API."
32673 #: ../src/guestfs.pod:1016
32674 msgid "BLOCK DEVICE NAMING"
32678 #: ../src/guestfs.pod:1018
32680 "In the kernel there is now quite a profusion of schemata for naming block "
32681 "devices (in this context, by I<block device> I mean a physical or virtual "
32682 "hard drive). The original Linux IDE driver used names starting with C</dev/"
32683 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
32684 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
32685 "for the old IDE driver (particularly for SATA devices) those devices also "
32686 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
32687 "paravirtualized drivers. This has created several different naming systems, "
32688 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
32692 #: ../src/guestfs.pod:1030
32694 "As discussed above, libguestfs uses a qemu appliance running an embedded "
32695 "Linux kernel to access block devices. We can run a variety of appliances "
32696 "based on a variety of Linux kernels."
32700 #: ../src/guestfs.pod:1034
32702 "This causes a problem for libguestfs because many API calls use device or "
32703 "partition names. Working scripts and the recipe (example) scripts that we "
32704 "make available over the internet could fail if the naming scheme changes."
32708 #: ../src/guestfs.pod:1039
32710 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
32711 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
32712 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
32713 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
32717 #: ../src/guestfs.pod:1045
32719 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
32720 "L</guestfs_list_partitions> and similar calls return the true names of the "
32721 "devices and partitions as known to the appliance."
32725 #: ../src/guestfs.pod:1050
32726 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
32730 #: ../src/guestfs.pod:1052
32732 "Usually this translation is transparent. However in some (very rare) cases "
32733 "you may need to know the exact algorithm. Such cases include where you use "
32734 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
32735 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
32739 #: ../src/guestfs.pod:1058
32741 "The algorithm is applied only to I<parameters> which are known to be either "
32742 "device or partition names. Return values from functions such as L</"
32743 "guestfs_list_devices> are never changed."
32747 #: ../src/guestfs.pod:1066
32748 msgid "Is the string a parameter which is a device or partition name?"
32752 #: ../src/guestfs.pod:1070
32753 msgid "Does the string begin with C</dev/sd>?"
32757 #: ../src/guestfs.pod:1074
32759 "Does the named device exist? If so, we use that device. However if I<not> "
32760 "then we continue with this algorithm."
32764 #: ../src/guestfs.pod:1079
32765 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
32769 #: ../src/guestfs.pod:1081
32770 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
32774 #: ../src/guestfs.pod:1083
32775 msgid "If that named device exists, use it. If not, continue."
32779 #: ../src/guestfs.pod:1087
32780 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
32784 #: ../src/guestfs.pod:1089
32785 msgid "If that named device exists, use it. If not, return an error."
32789 #: ../src/guestfs.pod:1093
32790 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
32794 #: ../src/guestfs.pod:1095
32796 "Although the standard naming scheme and automatic translation is useful for "
32797 "simple programs and guestfish scripts, for larger programs it is best not to "
32798 "rely on this mechanism."
32802 #: ../src/guestfs.pod:1099
32804 "Where possible for maximum future portability programs using libguestfs "
32805 "should use these future-proof techniques:"
32809 #: ../src/guestfs.pod:1106
32811 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
32812 "device names, and then use those names directly."
32816 #: ../src/guestfs.pod:1109
32818 "Since those device names exist by definition, they will never be translated."
32822 #: ../src/guestfs.pod:1114
32824 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
32825 "filesystem labels."
32829 #: ../src/guestfs.pod:1119
32834 #: ../src/guestfs.pod:1121
32836 "This section discusses security implications of using libguestfs, "
32837 "particularly with untrusted or malicious guests or disk images."
32841 #: ../src/guestfs.pod:1124
32842 msgid "GENERAL SECURITY CONSIDERATIONS"
32846 #: ../src/guestfs.pod:1126
32848 "Be careful with any files or data that you download from a guest (by "
32849 "\"download\" we mean not just the L</guestfs_download> command but any "
32850 "command that reads files, filenames, directories or anything else from a "
32851 "disk image). An attacker could manipulate the data to fool your program "
32852 "into doing the wrong thing. Consider cases such as:"
32856 #: ../src/guestfs.pod:1136
32857 msgid "the data (file etc) not being present"
32861 #: ../src/guestfs.pod:1140
32862 msgid "being present but empty"
32866 #: ../src/guestfs.pod:1144
32867 msgid "being much larger than normal"
32871 #: ../src/guestfs.pod:1148
32872 msgid "containing arbitrary 8 bit data"
32876 #: ../src/guestfs.pod:1152
32877 msgid "being in an unexpected character encoding"
32881 #: ../src/guestfs.pod:1156
32882 msgid "containing homoglyphs."
32886 #: ../src/guestfs.pod:1160
32887 msgid "SECURITY OF MOUNTING FILESYSTEMS"
32891 #: ../src/guestfs.pod:1162
32893 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
32894 "(VFS) module can sometimes be escalated into exploits by deliberately "
32895 "creating a malicious, malformed filesystem. These exploits are very severe "
32896 "for two reasons. Firstly there are very many filesystem drivers in the "
32897 "kernel, and many of them are infrequently used and not much developer "
32898 "attention has been paid to the code. Linux userspace helps potential "
32899 "crackers by detecting the filesystem type and automatically choosing the "
32900 "right VFS driver, even if that filesystem type is obscure or unexpected for "
32901 "the administrator. Secondly, a kernel-level exploit is like a local root "
32902 "exploit (worse in some ways), giving immediate and total access to the "
32903 "system right down to the hardware level."
32907 #: ../src/guestfs.pod:1175
32909 "That explains why you should never mount a filesystem from an untrusted "
32910 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
32911 "inside a qemu virtual machine, usually running as a non-root user. The "
32912 "attacker would need to write a filesystem which first exploited the kernel, "
32913 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
32914 "the libguestfs protocol, and finally to be as serious as the host kernel "
32915 "exploit it would need to escalate its privileges to root. This multi-step "
32916 "escalation, performed by a static piece of data, is thought to be extremely "
32917 "hard to do, although we never say 'never' about security issues."
32921 #: ../src/guestfs.pod:1186
32923 "In any case callers can reduce the attack surface by forcing the filesystem "
32924 "type when mounting (use L</guestfs_mount_vfs>)."
32928 #: ../src/guestfs.pod:1189
32929 msgid "PROTOCOL SECURITY"
32933 #: ../src/guestfs.pod:1191
32935 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
32936 "defined upper message size. However a program that uses libguestfs must "
32937 "also take care - for example you can write a program that downloads a binary "
32938 "from a disk image and executes it locally, and no amount of protocol "
32939 "security will save you from the consequences."
32943 #: ../src/guestfs.pod:1197
32944 msgid "INSPECTION SECURITY"
32948 #: ../src/guestfs.pod:1199
32950 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
32951 "directly from the guest, and these could contain any 8 bit data. Callers "
32952 "should be careful to escape these before printing them to a structured file "
32953 "(for example, use HTML escaping if creating a web page)."
32957 #: ../src/guestfs.pod:1205
32959 "Guest configuration may be altered in unusual ways by the administrator of "
32960 "the virtual machine, and may not reflect reality (particularly for untrusted "
32961 "or actively malicious guests). For example we parse the hostname from "
32962 "configuration files like C</etc/sysconfig/network> that we find in the "
32963 "guest, but the guest administrator can easily manipulate these files to "
32964 "provide the wrong hostname."
32968 #: ../src/guestfs.pod:1213
32970 "The inspection API parses guest configuration using two external libraries: "
32971 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
32972 "designed to be robust in the face of malicious data, although denial of "
32973 "service attacks are still possible, for example with oversized configuration "
32978 #: ../src/guestfs.pod:1219
32979 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
32983 #: ../src/guestfs.pod:1221
32985 "Be very cautious about running commands from the guest. By running a "
32986 "command in the guest, you are giving CPU time to a binary that you do not "
32987 "control, under the same user account as the library, albeit wrapped in qemu "
32988 "virtualization. More information and alternatives can be found in the "
32989 "section L</RUNNING COMMANDS>."
32993 #: ../src/guestfs.pod:1227
32994 msgid "CVE-2010-3851"
32998 #: ../src/guestfs.pod:1229
32999 msgid "https://bugzilla.redhat.com/642934"
33003 #: ../src/guestfs.pod:1231
33005 "This security bug concerns the automatic disk format detection that qemu "
33006 "does on disk images."
33010 #: ../src/guestfs.pod:1234
33012 "A raw disk image is just the raw bytes, there is no header. Other disk "
33013 "images like qcow2 contain a special header. Qemu deals with this by looking "
33014 "for one of the known headers, and if none is found then assuming the disk "
33015 "image must be raw."
33019 #: ../src/guestfs.pod:1239
33021 "This allows a guest which has been given a raw disk image to write some "
33022 "other header. At next boot (or when the disk image is accessed by "
33023 "libguestfs) qemu would do autodetection and think the disk image format was, "
33024 "say, qcow2 based on the header written by the guest."
33028 #: ../src/guestfs.pod:1244
33030 "This in itself would not be a problem, but qcow2 offers many features, one "
33031 "of which is to allow a disk image to refer to another image (called the "
33032 "\"backing disk\"). It does this by placing the path to the backing disk "
33033 "into the qcow2 header. This path is not validated and could point to any "
33034 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
33035 "\"holes\" in the qcow2 disk image, which of course is completely under the "
33036 "control of the attacker."
33040 #: ../src/guestfs.pod:1252
33042 "In libguestfs this is rather hard to exploit except under two circumstances:"
33046 #: ../src/guestfs.pod:1259
33047 msgid "You have enabled the network or have opened the disk in write mode."
33051 #: ../src/guestfs.pod:1263
33053 "You are also running untrusted code from the guest (see L</RUNNING "
33058 #: ../src/guestfs.pod:1268
33060 "The way to avoid this is to specify the expected disk format when adding "
33061 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
33062 "should always do this if the disk is raw format, and it's a good idea for "
33067 #: ../src/guestfs.pod:1273
33069 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
33070 "format is fetched from libvirt and passed through."
33074 #: ../src/guestfs.pod:1276
33076 "For libguestfs tools, use the I<--format> command line parameter as "
33081 #: ../src/guestfs.pod:1279
33082 msgid "CONNECTION MANAGEMENT"
33086 #: ../src/guestfs.pod:1281
33087 msgid "guestfs_h *"
33091 #: ../src/guestfs.pod:1283
33093 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
33094 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
33095 "handle and release all resources used."
33099 #: ../src/guestfs.pod:1287
33101 "For information on using multiple handles and threads, see the section L</"
33102 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
33106 #: ../src/guestfs.pod:1290
33107 msgid "guestfs_create"
33111 #: ../src/guestfs.pod:1292
33114 " guestfs_h *guestfs_create (void);\n"
33119 #: ../src/guestfs.pod:1294
33120 msgid "Create a connection handle."
33124 #: ../src/guestfs.pod:1296
33126 "On success this returns a non-NULL pointer to a handle. On error it returns "
33131 #: ../src/guestfs.pod:1299
33133 "You have to \"configure\" the handle after creating it. This includes "
33134 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
33135 "handle at least once."
33139 #: ../src/guestfs.pod:1303
33140 msgid "After configuring the handle, you have to call L</guestfs_launch>."
33144 #: ../src/guestfs.pod:1305
33146 "You may also want to configure error handling for the handle. See the L</"
33147 "ERROR HANDLING> section below."
33151 #: ../src/guestfs.pod:1308
33152 msgid "guestfs_close"
33156 #: ../src/guestfs.pod:1310
33159 " void guestfs_close (guestfs_h *g);\n"
33164 #: ../src/guestfs.pod:1312
33165 msgid "This closes the connection handle and frees up all resources used."
33169 #: ../src/guestfs.pod:1314
33171 "If autosync was set on the handle and the handle was launched, then this "
33172 "implicitly calls various functions to unmount filesystems and sync the "
33173 "disk. See L</guestfs_set_autosync> for more details."
33177 #: ../src/guestfs.pod:1318
33178 msgid "If a close callback was set on the handle, then it is called."
33182 #: ../src/guestfs.pod:1320
33183 msgid "ERROR HANDLING"
33187 #: ../src/guestfs.pod:1322
33189 "API functions can return errors. For example, almost all functions that "
33190 "return C<int> will return C<-1> to indicate an error."
33194 #: ../src/guestfs.pod:1325
33196 "Additional information is available for errors: an error message string and "
33197 "optionally an error number (errno) if the thing that failed was a system "
33202 #: ../src/guestfs.pod:1329
33204 "You can get at the additional information about the last error on the handle "
33205 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
33206 "up an error handler with L</guestfs_set_error_handler>."
33210 #: ../src/guestfs.pod:1334
33212 "When the handle is created, a default error handler is installed which "
33213 "prints the error message string to C<stderr>. For small short-running "
33214 "command line programs it is sufficient to do:"
33218 #: ../src/guestfs.pod:1338
33221 " if (guestfs_launch (g) == -1)\n"
33222 " exit (EXIT_FAILURE);\n"
33227 #: ../src/guestfs.pod:1341
33229 "since the default error handler will ensure that an error message has been "
33230 "printed to C<stderr> before the program exits."
33234 #: ../src/guestfs.pod:1344
33236 "For other programs the caller will almost certainly want to install an "
33237 "alternate error handler or do error handling in-line like this:"
33241 #: ../src/guestfs.pod:1347
33244 " g = guestfs_create ();\n"
33249 #: ../src/guestfs.pod:1349
33252 " /* This disables the default behaviour of printing errors\n"
33254 " guestfs_set_error_handler (g, NULL, NULL);\n"
33259 #: ../src/guestfs.pod:1353
33262 " if (guestfs_launch (g) == -1) {\n"
33263 " /* Examine the error message and print it etc. */\n"
33264 " char *msg = guestfs_last_error (g);\n"
33265 " int errnum = guestfs_last_errno (g);\n"
33266 " fprintf (stderr, \"%s\\n\", msg);\n"
33273 #: ../src/guestfs.pod:1361
33275 "Out of memory errors are handled differently. The default action is to call "
33276 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
33277 "guestfs_set_out_of_memory_handler>."
33281 #: ../src/guestfs.pod:1365
33283 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
33284 "because there is no handle if this happens there is no way to get additional "
33285 "error information. However L</guestfs_create> is supposed to be a "
33286 "lightweight operation which can only fail because of insufficient memory (it "
33287 "returns NULL in this case)."
33291 #: ../src/guestfs.pod:1371
33292 msgid "guestfs_last_error"
33296 #: ../src/guestfs.pod:1373
33299 " const char *guestfs_last_error (guestfs_h *g);\n"
33304 #: ../src/guestfs.pod:1375
33306 "This returns the last error message that happened on C<g>. If there has not "
33307 "been an error since the handle was created, then this returns C<NULL>."
33311 #: ../src/guestfs.pod:1379
33313 "The lifetime of the returned string is until the next error occurs, or L</"
33314 "guestfs_close> is called."
33318 #: ../src/guestfs.pod:1382
33319 msgid "guestfs_last_errno"
33323 #: ../src/guestfs.pod:1384
33326 " int guestfs_last_errno (guestfs_h *g);\n"
33331 #: ../src/guestfs.pod:1386
33332 msgid "This returns the last error number (errno) that happened on C<g>."
33336 #: ../src/guestfs.pod:1388
33337 msgid "If successful, an errno integer not equal to zero is returned."
33341 #: ../src/guestfs.pod:1390
33343 "If no error, this returns 0. This call can return 0 in three situations:"
33347 #: ../src/guestfs.pod:1397
33348 msgid "There has not been any error on the handle."
33352 #: ../src/guestfs.pod:1401
33354 "There has been an error but the errno was meaningless. This corresponds to "
33355 "the case where the error did not come from a failed system call, but for "
33356 "some other reason."
33360 #: ../src/guestfs.pod:1407
33362 "There was an error from a failed system call, but for some reason the errno "
33363 "was not captured and returned. This usually indicates a bug in libguestfs."
33367 #: ../src/guestfs.pod:1413
33369 "Libguestfs tries to convert the errno from inside the applicance into a "
33370 "corresponding errno for the caller (not entirely trivial: the appliance "
33371 "might be running a completely different operating system from the library "
33372 "and error numbers are not standardized across Un*xen). If this could not be "
33373 "done, then the error is translated to C<EINVAL>. In practice this should "
33374 "only happen in very rare circumstances."
33378 #: ../src/guestfs.pod:1421
33379 msgid "guestfs_set_error_handler"
33383 #: ../src/guestfs.pod:1423
33386 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
33388 " const char *msg);\n"
33389 " void guestfs_set_error_handler (guestfs_h *g,\n"
33390 " guestfs_error_handler_cb cb,\n"
33391 " void *opaque);\n"
33396 #: ../src/guestfs.pod:1430
33398 "The callback C<cb> will be called if there is an error. The parameters "
33399 "passed to the callback are an opaque data pointer and the error message "
33404 #: ../src/guestfs.pod:1434
33406 "C<errno> is not passed to the callback. To get that the callback must call "
33407 "L</guestfs_last_errno>."
33411 #: ../src/guestfs.pod:1437
33413 "Note that the message string C<msg> is freed as soon as the callback "
33414 "function returns, so if you want to stash it somewhere you must make your "
33419 #: ../src/guestfs.pod:1441
33420 msgid "The default handler prints messages on C<stderr>."
33424 #: ../src/guestfs.pod:1443
33425 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
33429 #: ../src/guestfs.pod:1445
33430 msgid "guestfs_get_error_handler"
33434 #: ../src/guestfs.pod:1447
33437 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
33438 " void **opaque_rtn);\n"
33443 #: ../src/guestfs.pod:1450
33444 msgid "Returns the current error handler callback."
33448 #: ../src/guestfs.pod:1452
33449 msgid "guestfs_set_out_of_memory_handler"
33453 #: ../src/guestfs.pod:1454
33456 " typedef void (*guestfs_abort_cb) (void);\n"
33457 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
33458 " guestfs_abort_cb);\n"
33463 #: ../src/guestfs.pod:1458
33465 "The callback C<cb> will be called if there is an out of memory situation. "
33466 "I<Note this callback must not return>."
33470 #: ../src/guestfs.pod:1461
33471 msgid "The default is to call L<abort(3)>."
33475 #: ../src/guestfs.pod:1463
33477 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
33481 #: ../src/guestfs.pod:1466
33482 msgid "guestfs_get_out_of_memory_handler"
33486 #: ../src/guestfs.pod:1468
33489 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
33494 #: ../src/guestfs.pod:1470
33495 msgid "This returns the current out of memory handler."
33499 #: ../src/guestfs.pod:1472
33504 #: ../src/guestfs.pod:1476
33509 #: ../src/guestfs.pod:1478
33514 #: ../src/guestfs.pod:1480
33515 msgid "AVAILABILITY"
33519 #: ../src/guestfs.pod:1482
33520 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
33524 #: ../src/guestfs.pod:1484
33526 "Using L</guestfs_available> you can test availability of the following "
33527 "groups of functions. This test queries the appliance to see if the "
33528 "appliance you are currently using supports the functionality."
33532 #: ../src/guestfs.pod:1489
33533 msgid "@AVAILABILITY@"
33537 #: ../src/guestfs.pod:1491
33538 msgid "GUESTFISH supported COMMAND"
33542 #: ../src/guestfs.pod:1493
33544 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
33545 "prints out the available groups and whether they are supported by this build "
33546 "of libguestfs. Note however that you have to do C<run> first."
33550 #: ../src/guestfs.pod:1498
33551 msgid "SINGLE CALLS AT COMPILE TIME"
33555 #: ../src/guestfs.pod:1500
33557 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
33558 "function, such as:"
33562 #: ../src/guestfs.pod:1503
33565 " #define LIBGUESTFS_HAVE_DD 1\n"
33570 #: ../src/guestfs.pod:1505
33571 msgid "if L</guestfs_dd> is available."
33575 #: ../src/guestfs.pod:1507
33577 "Before version 1.5.8, if you needed to test whether a single libguestfs "
33578 "function is available at compile time, we recommended using build tools such "
33579 "as autoconf or cmake. For example in autotools you could use:"
33583 #: ../src/guestfs.pod:1512
33586 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
33587 " AC_CHECK_FUNCS([guestfs_dd])\n"
33592 #: ../src/guestfs.pod:1515
33594 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
33599 #: ../src/guestfs.pod:1518
33600 msgid "SINGLE CALLS AT RUN TIME"
33604 #: ../src/guestfs.pod:1520
33606 "Testing at compile time doesn't guarantee that a function really exists in "
33607 "the library. The reason is that you might be dynamically linked against a "
33608 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
33609 "This situation unfortunately results in a segmentation fault, which is a "
33610 "shortcoming of the C dynamic linking system itself."
33614 #: ../src/guestfs.pod:1527
33616 "You can use L<dlopen(3)> to test if a function is available at run time, as "
33617 "in this example program (note that you still need the compile time check as "
33622 #: ../src/guestfs.pod:1531
33625 " #include <stdio.h>\n"
33626 " #include <stdlib.h>\n"
33627 " #include <unistd.h>\n"
33628 " #include <dlfcn.h>\n"
33629 " #include <guestfs.h>\n"
33634 #: ../src/guestfs.pod:1537
33639 " #ifdef LIBGUESTFS_HAVE_DD\n"
33641 " int has_function;\n"
33646 #: ../src/guestfs.pod:1543
33649 " /* Test if the function guestfs_dd is really available. */\n"
33650 " dl = dlopen (NULL, RTLD_LAZY);\n"
33652 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
33653 " exit (EXIT_FAILURE);\n"
33655 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
33661 #: ../src/guestfs.pod:1552
33664 " if (!has_function)\n"
33665 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
33667 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
33668 " /* Now it's safe to call\n"
33669 " guestfs_dd (g, \"foo\", \"bar\");\n"
33673 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
33680 #: ../src/guestfs.pod:1565
33682 "You may think the above is an awful lot of hassle, and it is. There are "
33683 "other ways outside of the C linking system to ensure that this kind of "
33684 "incompatibility never arises, such as using package versioning:"
33688 #: ../src/guestfs.pod:1570
33691 " Requires: libguestfs >= 1.0.80\n"
33696 #: ../src/guestfs.pod:1572
33697 msgid "CALLS WITH OPTIONAL ARGUMENTS"
33701 #: ../src/guestfs.pod:1574
33703 "A recent feature of the API is the introduction of calls which take optional "
33704 "arguments. In C these are declared 3 ways. The main way is as a call which "
33705 "takes variable arguments (ie. C<...>), as in this example:"
33709 #: ../src/guestfs.pod:1579
33712 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
33717 #: ../src/guestfs.pod:1581
33719 "Call this with a list of optional arguments, terminated by C<-1>. So to "
33720 "call with no optional arguments specified:"
33724 #: ../src/guestfs.pod:1584
33727 " guestfs_add_drive_opts (g, filename, -1);\n"
33732 #: ../src/guestfs.pod:1586
33733 msgid "With a single optional argument:"
33737 #: ../src/guestfs.pod:1588
33740 " guestfs_add_drive_opts (g, filename,\n"
33741 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33747 #: ../src/guestfs.pod:1592
33752 #: ../src/guestfs.pod:1594
33755 " guestfs_add_drive_opts (g, filename,\n"
33756 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33757 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
33763 #: ../src/guestfs.pod:1599
33765 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
33770 #: ../src/guestfs.pod:1602
33771 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
33775 #: ../src/guestfs.pod:1604
33777 "The second variant has the same name with the suffix C<_va>, which works the "
33778 "same way but takes a C<va_list>. See the C manual for details. For the "
33779 "example function, this is declared:"
33783 #: ../src/guestfs.pod:1608
33786 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
33787 " va_list args);\n"
33792 #: ../src/guestfs.pod:1611
33793 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
33797 #: ../src/guestfs.pod:1613
33799 "The third variant is useful where you need to construct these calls. You "
33800 "pass in a structure where you fill in the optional fields. The structure "
33801 "has a bitmask as the first element which you must set to indicate which "
33802 "fields you have filled in. For our example function the structure and call "
33807 #: ../src/guestfs.pod:1619
33810 " struct guestfs_add_drive_opts_argv {\n"
33811 " uint64_t bitmask;\n"
33813 " const char *format;\n"
33816 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
33817 " const struct guestfs_add_drive_opts_argv *optargs);\n"
33822 #: ../src/guestfs.pod:1628
33823 msgid "You could call it like this:"
33827 #: ../src/guestfs.pod:1630
33830 " struct guestfs_add_drive_opts_argv optargs = {\n"
33831 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
33832 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
33833 " .readonly = 1,\n"
33834 " .format = \"qcow2\"\n"
33840 #: ../src/guestfs.pod:1637
33843 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
33848 #: ../src/guestfs.pod:1645
33849 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
33853 #: ../src/guestfs.pod:1650
33854 msgid "You do not need to fill in all fields of the structure."
33858 #: ../src/guestfs.pod:1654
33860 "There must be a one-to-one correspondence between fields of the structure "
33861 "that are filled in, and bits set in the bitmask."
33865 #: ../src/guestfs.pod:1659
33866 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
33870 #: ../src/guestfs.pod:1661
33872 "In other languages, optional arguments are expressed in the way that is "
33873 "natural for that language. We refer you to the language-specific "
33874 "documentation for more details on that."
33878 #: ../src/guestfs.pod:1665
33879 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
33883 #: ../src/guestfs.pod:1667
33884 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
33888 #: ../src/guestfs.pod:1669
33890 "B<Note:> This section documents the generic event mechanism introduced in "
33891 "libguestfs 1.10, which you should use in new code if possible. The old "
33892 "functions C<guestfs_set_log_message_callback>, "
33893 "C<guestfs_set_subprocess_quit_callback>, "
33894 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
33895 "C<guestfs_set_progress_callback> are no longer documented in this manual "
33896 "page. Because of the ABI guarantee, the old functions continue to work."
33900 #: ../src/guestfs.pod:1678
33902 "Handles generate events when certain things happen, such as log messages "
33903 "being generated, progress messages during long-running operations, or the "
33904 "handle being closed. The API calls described below let you register a "
33905 "callback to be called when events happen. You can register multiple "
33906 "callbacks (for the same, different or overlapping sets of events), and "
33907 "individually remove callbacks. If callbacks are not removed, then they "
33908 "remain in force until the handle is closed."
33912 #: ../src/guestfs.pod:1686
33914 "In the current implementation, events are only generated synchronously: that "
33915 "means that events (and hence callbacks) can only happen while you are in the "
33916 "middle of making another libguestfs call. The callback is called in the "
33921 #: ../src/guestfs.pod:1691
33923 "Events may contain a payload, usually nothing (void), an array of 64 bit "
33924 "unsigned integers, or a message buffer. Payloads are discussed later on."
33928 #: ../src/guestfs.pod:1695
33929 msgid "CLASSES OF EVENTS"
33933 #: ../src/guestfs.pod:1699
33934 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
33938 #: ../src/guestfs.pod:1702
33940 "The callback function will be called while the handle is being closed "
33941 "(synchronously from L</guestfs_close>)."
33945 #: ../src/guestfs.pod:1705
33947 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
33948 "handles that are open when the program exits. This means that this callback "
33949 "might be called indirectly from L<exit(3)>, which can cause unexpected "
33950 "problems in higher-level languages (eg. if your HLL interpreter has already "
33951 "been cleaned up by the time this is called, and if your callback then jumps "
33952 "into some HLL function)."
33956 #: ../src/guestfs.pod:1712
33958 "If no callback is registered: the handle is closed without any callback "
33963 #: ../src/guestfs.pod:1715
33964 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
33968 #: ../src/guestfs.pod:1718
33970 "The callback function will be called when the child process quits, either "
33971 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
33972 "corresponds to a transition from any state to the CONFIG state)."
33976 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
33977 msgid "If no callback is registered: the event is ignored."
33981 #: ../src/guestfs.pod:1724
33982 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
33986 #: ../src/guestfs.pod:1727
33988 "The callback function will be called when the child process becomes ready "
33989 "first time after it has been launched. (This corresponds to a transition "
33990 "from LAUNCHING to the READY state)."
33994 #: ../src/guestfs.pod:1733
33995 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
33999 #: ../src/guestfs.pod:1736
34001 "Some long-running operations can generate progress messages. If this "
34002 "callback is registered, then it will be called each time a progress message "
34003 "is generated (usually two seconds after the operation started, and three "
34004 "times per second thereafter until it completes, although the frequency may "
34005 "change in future versions)."
34009 #: ../src/guestfs.pod:1742
34011 "The callback receives in the payload four unsigned 64 bit numbers which are "
34012 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
34016 #: ../src/guestfs.pod:1745
34018 "The units of C<total> are not defined, although for some operations C<total> "
34019 "may relate in some way to the amount of data to be transferred (eg. in bytes "
34020 "or megabytes), and C<position> may be the portion which has been transferred."
34024 #: ../src/guestfs.pod:1750
34025 msgid "The only defined and stable parts of the API are:"
34029 #: ../src/guestfs.pod:1756
34031 "The callback can display to the user some type of progress bar or indicator "
34032 "which shows the ratio of C<position>:C<total>."
34036 #: ../src/guestfs.pod:1761
34037 msgid "0 E<lt>= C<position> E<lt>= C<total>"
34041 #: ../src/guestfs.pod:1765
34043 "If any progress notification is sent during a call, then a final progress "
34044 "notification is always sent when C<position> = C<total> (I<unless> the call "
34045 "fails with an error)."
34049 #: ../src/guestfs.pod:1769
34051 "This is to simplify caller code, so callers can easily set the progress "
34052 "indicator to \"100%\" at the end of the operation, without requiring special "
34053 "code to detect this case."
34057 #: ../src/guestfs.pod:1775
34059 "For some calls we are unable to estimate the progress of the call, but we "
34060 "can still generate progress messages to indicate activity. This is known as "
34061 "\"pulse mode\", and is directly supported by certain progress bar "
34062 "implementations (eg. GtkProgressBar)."
34066 #: ../src/guestfs.pod:1780
34068 "For these calls, zero or more progress messages are generated with "
34069 "C<position = 0> and C<total = 1>, followed by a final message with "
34070 "C<position = total = 1>."
34074 #: ../src/guestfs.pod:1784
34076 "As noted above, if the call fails with an error then the final message may "
34077 "not be generated."
34081 #: ../src/guestfs.pod:1789
34083 "The callback also receives the procedure number (C<proc_nr>) and serial "
34084 "number (C<serial>) of the call. These are only useful for debugging "
34085 "protocol issues, and the callback can normally ignore them. The callback "
34086 "may want to print these numbers in error messages or debugging messages."
34090 #: ../src/guestfs.pod:1795
34091 msgid "If no callback is registered: progress messages are discarded."
34095 #: ../src/guestfs.pod:1797
34096 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
34100 #: ../src/guestfs.pod:1800
34102 "The callback function is called whenever a log message is generated by qemu, "
34103 "the appliance kernel, guestfsd (daemon), or utility programs."
34107 #: ../src/guestfs.pod:1803
34109 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
34110 "guestfs_launch>) then additional debug messages are generated."
34114 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
34116 "If no callback is registered: the messages are discarded unless the verbose "
34117 "flag is set in which case they are sent to stderr. You can override the "
34118 "printing of verbose messages to stderr by setting up a callback."
34122 #: ../src/guestfs.pod:1811
34123 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
34127 #: ../src/guestfs.pod:1814
34129 "The callback function is called whenever a log message is generated by the "
34130 "library part of libguestfs."
34134 #: ../src/guestfs.pod:1817
34136 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
34137 "messages are generated."
34141 #: ../src/guestfs.pod:1825
34142 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
34146 #: ../src/guestfs.pod:1828
34148 "The callback function is called whenever a trace message is generated. This "
34149 "only applies if the trace flag (L</guestfs_set_trace>) is set."
34153 #: ../src/guestfs.pod:1831
34155 "If no callback is registered: the messages are sent to stderr. You can "
34156 "override the printing of trace messages to stderr by setting up a callback."
34160 #: ../src/guestfs.pod:1837
34161 msgid "guestfs_set_event_callback"
34165 #: ../src/guestfs.pod:1839
34168 " int guestfs_set_event_callback (guestfs_h *g,\n"
34169 " guestfs_event_callback cb,\n"
34170 " uint64_t event_bitmask,\n"
34172 " void *opaque);\n"
34177 #: ../src/guestfs.pod:1845
34179 "This function registers a callback (C<cb>) for all event classes in the "
34180 "C<event_bitmask>."
34184 #: ../src/guestfs.pod:1848
34186 "For example, to register for all log message events, you could call this "
34187 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
34188 "To register a single callback for all possible classes of events, use "
34189 "C<GUESTFS_EVENT_ALL>."
34193 #: ../src/guestfs.pod:1854
34194 msgid "C<flags> should always be passed as 0."
34198 #: ../src/guestfs.pod:1856
34200 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
34201 "it for any purpose."
34205 #: ../src/guestfs.pod:1859
34207 "The return value is the event handle (an integer) which you can use to "
34208 "delete the callback (see below)."
34212 #: ../src/guestfs.pod:1862
34214 "If there is an error, this function returns C<-1>, and sets the error in the "
34215 "handle in the usual way (see L</guestfs_last_error> etc.)"
34219 #: ../src/guestfs.pod:1865
34221 "Callbacks remain in effect until they are deleted, or until the handle is "
34226 #: ../src/guestfs.pod:1868
34228 "In the case where multiple callbacks are registered for a particular event "
34229 "class, all of the callbacks are called. The order in which multiple "
34230 "callbacks are called is not defined."
34234 #: ../src/guestfs.pod:1872
34235 msgid "guestfs_delete_event_callback"
34239 #: ../src/guestfs.pod:1874
34242 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
34247 #: ../src/guestfs.pod:1876
34249 "Delete a callback that was previously registered. C<event_handle> should be "
34250 "the integer that was returned by a previous call to "
34251 "C<guestfs_set_event_callback> on the same handle."
34255 #: ../src/guestfs.pod:1880
34256 msgid "guestfs_event_callback"
34260 #: ../src/guestfs.pod:1882
34263 " typedef void (*guestfs_event_callback) (\n"
34266 " uint64_t event,\n"
34267 " int event_handle,\n"
34269 " const char *buf, size_t buf_len,\n"
34270 " const uint64_t *array, size_t array_len);\n"
34275 #: ../src/guestfs.pod:1891
34277 "This is the type of the event callback function that you have to provide."
34281 #: ../src/guestfs.pod:1894
34283 "The basic parameters are: the handle (C<g>), the opaque user pointer "
34284 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
34285 "handle, and C<flags> which in the current API you should ignore."
34289 #: ../src/guestfs.pod:1898
34291 "The remaining parameters contain the event payload (if any). Each event may "
34292 "contain a payload, which usually relates to the event class, but for future "
34293 "proofing your code should be written to handle any payload for any event "
34298 #: ../src/guestfs.pod:1903
34300 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
34301 "there is no message buffer). Note that this message buffer can contain "
34302 "arbitrary 8 bit data, including NUL bytes."
34306 #: ../src/guestfs.pod:1907
34308 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
34309 "moment this is only used for progress messages."
34313 #: ../src/guestfs.pod:1910
34314 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
34318 #: ../src/guestfs.pod:1912
34320 "One motivation for the generic event API was to allow GUI programs to "
34321 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
34322 "unconditionally to C<stderr>."
34326 #: ../src/guestfs.pod:1916
34328 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
34329 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
34330 "messages are not events; you must capture error messages separately)."
34334 #: ../src/guestfs.pod:1921
34336 "Programs have to set up a callback to capture the classes of events of "
34341 #: ../src/guestfs.pod:1924
34345 " guestfs_set_event_callback\n"
34346 " (g, message_callback,\n"
34347 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
34348 " GUESTFS_EVENT_TRACE,\n"
34349 " 0, NULL) == -1)\n"
34350 " if (eh == -1) {\n"
34351 " // handle error in the usual way\n"
34357 #: ../src/guestfs.pod:1934
34359 "The callback can then direct messages to the appropriate place. In this "
34360 "example, messages are directed to syslog:"
34364 #: ../src/guestfs.pod:1937
34368 " message_callback (\n"
34371 " uint64_t event,\n"
34372 " int event_handle,\n"
34374 " const char *buf, size_t buf_len,\n"
34375 " const uint64_t *array, size_t array_len)\n"
34377 " const int priority = LOG_USER|LOG_INFO;\n"
34378 " if (buf_len > 0)\n"
34379 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
34385 #: ../src/guestfs.pod:1952
34386 msgid "CANCELLING LONG TRANSFERS"
34390 #: ../src/guestfs.pod:1954
34392 "Some operations can be cancelled by the caller while they are in progress. "
34393 "Currently only operations that involve uploading or downloading data can be "
34394 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
34395 "parameters in the generator)."
34399 #: ../src/guestfs.pod:1959
34400 msgid "guestfs_user_cancel"
34404 #: ../src/guestfs.pod:1961
34407 " void guestfs_user_cancel (guestfs_h *g);\n"
34412 #: ../src/guestfs.pod:1963
34414 "C<guestfs_user_cancel> cancels the current upload or download operation."
34418 #: ../src/guestfs.pod:1966
34420 "Unlike most other libguestfs calls, this function is signal safe and thread "
34421 "safe. You can call it from a signal handler or from another thread, without "
34422 "needing to do any locking."
34426 #: ../src/guestfs.pod:1970
34428 "The transfer that was in progress (if there is one) will stop shortly "
34429 "afterwards, and will return an error. The errno (see L</"
34430 "guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
34431 "out if the operation was cancelled or failed because of another error."
34435 #: ../src/guestfs.pod:1976
34437 "No cleanup is performed: for example, if a file was being uploaded then "
34438 "after cancellation there may be a partially uploaded file. It is the "
34439 "caller's responsibility to clean up if necessary."
34443 #: ../src/guestfs.pod:1980
34444 msgid "There are two common places that you might call C<guestfs_user_cancel>."
34448 #: ../src/guestfs.pod:1982
34450 "In an interactive text-based program, you might call it from a C<SIGINT> "
34451 "signal handler so that pressing C<^C> cancels the current operation. (You "
34452 "also need to call L</guestfs_set_pgroup> so that child processes don't "
34453 "receive the C<^C> signal)."
34457 #: ../src/guestfs.pod:1987
34459 "In a graphical program, when the main thread is displaying a progress bar "
34460 "with a cancel button, wire up the cancel button to call this function."
34464 #: ../src/guestfs.pod:1991
34465 msgid "PRIVATE DATA AREA"
34469 #: ../src/guestfs.pod:1993
34471 "You can attach named pieces of private data to the libguestfs handle, fetch "
34472 "them by name, and walk over them, for the lifetime of the handle. This is "
34473 "called the private data area and is only available from the C API."
34477 #: ../src/guestfs.pod:1998
34478 msgid "To attach a named piece of data, use the following call:"
34482 #: ../src/guestfs.pod:2000
34485 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
34490 #: ../src/guestfs.pod:2002
34492 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
34493 "pointer (which can be C<NULL>). Any previous item with the same key is "
34498 #: ../src/guestfs.pod:2006
34500 "You can use any C<key> you want, but your key should I<not> start with an "
34501 "underscore character. Keys beginning with an underscore character are "
34502 "reserved for internal libguestfs purposes (eg. for implementing language "
34503 "bindings). It is recommended that you prefix the key with some unique "
34504 "string to avoid collisions with other users."
34508 #: ../src/guestfs.pod:2012
34509 msgid "To retrieve the pointer, use:"
34513 #: ../src/guestfs.pod:2014
34516 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
34521 #: ../src/guestfs.pod:2016
34523 "This function returns C<NULL> if either no data is found associated with "
34524 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
34529 #: ../src/guestfs.pod:2020
34531 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
34532 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
34533 "all. In particular, libguestfs does I<not> try to free the data when the "
34534 "handle is closed. If the data must be freed, then the caller must either "
34535 "free it before calling L</guestfs_close> or must set up a close callback to "
34536 "do it (see L</GUESTFS_EVENT_CLOSE>)."
34540 #: ../src/guestfs.pod:2027
34541 msgid "To walk over all entries, use these two functions:"
34545 #: ../src/guestfs.pod:2029
34548 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
34553 #: ../src/guestfs.pod:2031
34556 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
34561 #: ../src/guestfs.pod:2033
34563 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
34564 "not have any particular meaning -- keys are not returned in any defined "
34565 "order). A pointer to the key is returned in C<*key_rtn> and the "
34566 "corresponding data pointer is returned from the function. C<NULL> is "
34567 "returned if there are no keys stored in the handle."
34571 #: ../src/guestfs.pod:2039
34573 "C<guestfs_next_private> returns the next key, pointer pair. The return "
34574 "value of this function is also C<NULL> is there are no further entries to "
34579 #: ../src/guestfs.pod:2043
34580 msgid "Notes about walking over entries:"
34584 #: ../src/guestfs.pod:2049
34586 "You must not call C<guestfs_set_private> while walking over the entries."
34590 #: ../src/guestfs.pod:2054
34592 "The handle maintains an internal iterator which is reset when you call "
34593 "C<guestfs_first_private>. This internal iterator is invalidated when you "
34594 "call C<guestfs_set_private>."
34598 #: ../src/guestfs.pod:2060
34599 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
34603 #: ../src/guestfs.pod:2062
34606 " guestfs_set_private (g, key, NULL);\n"
34611 #: ../src/guestfs.pod:2064
34612 msgid "then that C<key> is not returned when walking."
34616 #: ../src/guestfs.pod:2068
34618 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
34619 "C<guestfs_next_private> or C<guestfs_set_private>."
34623 #: ../src/guestfs.pod:2074
34625 "The following example code shows how to print all keys and data pointers "
34626 "that are associated with the handle C<g>:"
34630 #: ../src/guestfs.pod:2077
34633 " const char *key;\n"
34634 " void *data = guestfs_first_private (g, &key);\n"
34635 " while (data != NULL)\n"
34637 " printf (\"key = %s, data = %p\\n\", key, data);\n"
34638 " data = guestfs_next_private (g, &key);\n"
34644 #: ../src/guestfs.pod:2085
34646 "More commonly you are only interested in keys that begin with an application-"
34647 "specific prefix C<foo_>. Modify the loop like so:"
34651 #: ../src/guestfs.pod:2088
34654 " const char *key;\n"
34655 " void *data = guestfs_first_private (g, &key);\n"
34656 " while (data != NULL)\n"
34658 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34659 " printf (\"key = %s, data = %p\\n\", key, data);\n"
34660 " data = guestfs_next_private (g, &key);\n"
34666 #: ../src/guestfs.pod:2097
34668 "If you need to modify keys while walking, then you have to jump back to the "
34669 "beginning of the loop. For example, to delete all keys prefixed with "
34674 #: ../src/guestfs.pod:2101
34677 " const char *key;\n"
34680 " data = guestfs_first_private (g, &key);\n"
34681 " while (data != NULL)\n"
34683 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34685 " guestfs_set_private (g, key, NULL);\n"
34686 " /* note that 'key' pointer is now invalid, and so is\n"
34687 " the internal iterator */\n"
34690 " data = guestfs_next_private (g, &key);\n"
34696 #: ../src/guestfs.pod:2117
34698 "Note that the above loop is guaranteed to terminate because the keys are "
34699 "being deleted, but other manipulations of keys within the loop might not "
34700 "terminate unless you also maintain an indication of which keys have been "
34705 #: ../src/guestfs.pod:2122 ../src/guestfs.pod:2127
34710 #: ../src/guestfs.pod:2124
34712 "<!-- old anchor for the next section --> <a name="
34713 "\"state_machine_and_low_level_event_api\"/>"
34717 #: ../src/guestfs.pod:2129
34718 msgid "ARCHITECTURE"
34722 #: ../src/guestfs.pod:2131
34724 "Internally, libguestfs is implemented by running an appliance (a special "
34725 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
34726 "process of the main program."
34730 #: ../src/guestfs.pod:2135
34733 " ___________________\n"
34735 " | main program |\n"
34737 " | | child process / appliance\n"
34738 " | | __________________________\n"
34740 " +-------------------+ RPC | +-----------------+ |\n"
34741 " | libguestfs <--------------------> guestfsd | |\n"
34742 " | | | +-----------------+ |\n"
34743 " \\___________________/ | | Linux kernel | |\n"
34744 " | +--^--------------+ |\n"
34745 " \\_________|________________/\n"
34747 " _______v______\n"
34750 " | disk image |\n"
34751 " \\______________/\n"
34756 #: ../src/guestfs.pod:2155
34758 "The library, linked to the main program, creates the child process and hence "
34759 "the appliance in the L</guestfs_launch> function."
34763 #: ../src/guestfs.pod:2158
34765 "Inside the appliance is a Linux kernel and a complete stack of userspace "
34766 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
34767 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
34768 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
34769 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
34770 "attached to the qemu process which translates device access by the "
34771 "appliance's Linux kernel into accesses to the image."
34775 #: ../src/guestfs.pod:2167
34777 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
34778 "Although the disk image you are attached to might also be used by some "
34779 "virtual machine, libguestfs doesn't know or care about this. (But you will "
34780 "care if both libguestfs's qemu process and your virtual machine are trying "
34781 "to update the disk image at the same time, since these usually results in "
34782 "massive disk corruption)."
34786 #: ../src/guestfs.pod:2174
34787 msgid "STATE MACHINE"
34791 #: ../src/guestfs.pod:2176
34792 msgid "libguestfs uses a state machine to model the child process:"
34796 #: ../src/guestfs.pod:2178
34800 " guestfs_create\n"
34808 " / | \\ \\ guestfs_launch\n"
34809 " / | _\\__V______\n"
34811 " / | | LAUNCHING |\n"
34812 " / | \\___________/\n"
34814 " / | guestfs_launch\n"
34816 " ______ / __|____V\n"
34817 " / \\ ------> / \\\n"
34818 " | BUSY | | READY |\n"
34819 " \\______/ <------ \\________/\n"
34824 #: ../src/guestfs.pod:2200
34826 "The normal transitions are (1) CONFIG (when the handle is created, but there "
34827 "is no child process), (2) LAUNCHING (when the child process is booting up), "
34828 "(3) alternating between READY and BUSY as commands are issued to, and "
34829 "carried out by, the child process."
34833 #: ../src/guestfs.pod:2205
34835 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
34836 "asynchronously at any time (eg. due to some internal error), and that causes "
34837 "the state to transition back to CONFIG."
34841 #: ../src/guestfs.pod:2209
34843 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
34844 "issued when in the CONFIG state."
34848 #: ../src/guestfs.pod:2212
34850 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
34851 "L</guestfs_launch> blocks until the child process is READY to accept "
34852 "commands (or until some failure or timeout). L</guestfs_launch> internally "
34853 "moves the state from CONFIG to LAUNCHING while it is running."
34857 #: ../src/guestfs.pod:2218
34859 "API actions such as L</guestfs_mount> can only be issued when in the READY "
34860 "state. These API calls block waiting for the command to be carried out (ie. "
34861 "the state to transition to BUSY and then back to READY). There are no non-"
34862 "blocking versions, and no way to issue more than one command per handle at "
34867 #: ../src/guestfs.pod:2224
34869 "Finally, the child process sends asynchronous messages back to the main "
34870 "program, such as kernel log messages. You can register a callback to "
34871 "receive these messages."
34875 #: ../src/guestfs.pod:2228
34880 #: ../src/guestfs.pod:2230
34881 msgid "COMMUNICATION PROTOCOL"
34885 #: ../src/guestfs.pod:2232
34887 "Don't rely on using this protocol directly. This section documents how it "
34888 "currently works, but it may change at any time."
34892 #: ../src/guestfs.pod:2235
34894 "The protocol used to talk between the library and the daemon running inside "
34895 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
34896 "1014, RFC 1832, RFC 4506)."
34900 #: ../src/guestfs.pod:2239
34902 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
34903 "this file is automatically generated)."
34907 #: ../src/guestfs.pod:2242
34909 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
34910 "and C<FileOut> parameters, which are handled with very simple request/reply "
34911 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
34912 "parameters, which use the same request and reply messages, but they may also "
34913 "be followed by files sent using a chunked encoding."
34917 #: ../src/guestfs.pod:2249
34918 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
34922 #: ../src/guestfs.pod:2251
34923 msgid "For ordinary functions, the request message is:"
34927 #: ../src/guestfs.pod:2253
34930 " total length (header + arguments,\n"
34931 " but not including the length word itself)\n"
34932 " struct guestfs_message_header (encoded as XDR)\n"
34933 " struct guestfs_<foo>_args (encoded as XDR)\n"
34938 #: ../src/guestfs.pod:2258
34940 "The total length field allows the daemon to allocate a fixed size buffer "
34941 "into which it slurps the rest of the message. As a result, the total length "
34942 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
34943 "effective size of any request is limited to somewhere under this size."
34947 #: ../src/guestfs.pod:2264
34949 "Note also that many functions don't take any arguments, in which case the "
34950 "C<guestfs_I<foo>_args> is completely omitted."
34954 #: ../src/guestfs.pod:2267
34956 "The header contains the procedure number (C<guestfs_proc>) which is how the "
34957 "receiver knows what type of args structure to expect, or none at all."
34961 #: ../src/guestfs.pod:2271
34963 "For functions that take optional arguments, the optional arguments are "
34964 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
34965 "arguments. A bitmask in the header indicates which optional arguments are "
34966 "meaningful. The bitmask is also checked to see if it contains bits set "
34967 "which the daemon does not know about (eg. if more optional arguments were "
34968 "added in a later version of the library), and this causes the call to be "
34973 #: ../src/guestfs.pod:2279
34974 msgid "The reply message for ordinary functions is:"
34978 #: ../src/guestfs.pod:2281
34981 " total length (header + ret,\n"
34982 " but not including the length word itself)\n"
34983 " struct guestfs_message_header (encoded as XDR)\n"
34984 " struct guestfs_<foo>_ret (encoded as XDR)\n"
34989 #: ../src/guestfs.pod:2286
34991 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
34992 "functions that return no formal return values."
34996 #: ../src/guestfs.pod:2289
34998 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
35002 #: ../src/guestfs.pod:2292
35004 "In the case of an error, a flag is set in the header, and the reply message "
35005 "is slightly changed:"
35009 #: ../src/guestfs.pod:2295
35012 " total length (header + error,\n"
35013 " but not including the length word itself)\n"
35014 " struct guestfs_message_header (encoded as XDR)\n"
35015 " struct guestfs_message_error (encoded as XDR)\n"
35020 #: ../src/guestfs.pod:2300
35022 "The C<guestfs_message_error> structure contains the error message as a "
35027 #: ../src/guestfs.pod:2303
35028 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
35032 #: ../src/guestfs.pod:2305
35034 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
35035 "The normal request message is sent (see above). However this is followed by "
35036 "a sequence of file chunks."
35040 #: ../src/guestfs.pod:2309
35043 " total length (header + arguments,\n"
35044 " but not including the length word itself,\n"
35045 " and not including the chunks)\n"
35046 " struct guestfs_message_header (encoded as XDR)\n"
35047 " struct guestfs_<foo>_args (encoded as XDR)\n"
35048 " sequence of chunks for FileIn param #0\n"
35049 " sequence of chunks for FileIn param #1 etc.\n"
35054 #: ../src/guestfs.pod:2317
35055 msgid "The \"sequence of chunks\" is:"
35059 #: ../src/guestfs.pod:2319
35062 " length of chunk (not including length word itself)\n"
35063 " struct guestfs_chunk (encoded as XDR)\n"
35064 " length of chunk\n"
35065 " struct guestfs_chunk (encoded as XDR)\n"
35067 " length of chunk\n"
35068 " struct guestfs_chunk (with data.data_len == 0)\n"
35073 #: ../src/guestfs.pod:2327
35075 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
35076 "is set in the final chunk to indicate either successful completion or early "
35081 #: ../src/guestfs.pod:2331
35083 "At time of writing there are no functions that have more than one FileIn "
35084 "parameter. However this is (theoretically) supported, by sending the "
35085 "sequence of chunks for each FileIn parameter one after another (from left to "
35090 #: ../src/guestfs.pod:2336
35092 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
35093 "transfer. The library does this by sending a chunk with a special flag set "
35094 "to indicate cancellation. When the daemon sees this, it cancels the whole "
35095 "RPC, does I<not> send any reply, and goes back to reading the next request."
35099 #: ../src/guestfs.pod:2342
35101 "The daemon may also cancel. It does this by writing a special word "
35102 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
35103 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
35104 "cancel chunk). The special word is chosen so that even if cancellation "
35105 "happens right at the end of the transfer (after the library has finished "
35106 "writing and has started listening for the reply), the \"spurious\" cancel "
35107 "flag will not be confused with the reply message."
35111 #: ../src/guestfs.pod:2351
35113 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
35114 "limit), and also files where the size is not known in advance (eg. from "
35115 "pipes or sockets). However the chunks are rather small "
35116 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
35117 "to keep much in memory."
35121 #: ../src/guestfs.pod:2357
35122 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
35126 #: ../src/guestfs.pod:2359
35128 "The protocol for FileOut parameters is exactly the same as for FileIn "
35129 "parameters, but with the roles of daemon and library reversed."
35133 #: ../src/guestfs.pod:2362
35136 " total length (header + ret,\n"
35137 " but not including the length word itself,\n"
35138 " and not including the chunks)\n"
35139 " struct guestfs_message_header (encoded as XDR)\n"
35140 " struct guestfs_<foo>_ret (encoded as XDR)\n"
35141 " sequence of chunks for FileOut param #0\n"
35142 " sequence of chunks for FileOut param #1 etc.\n"
35147 #: ../src/guestfs.pod:2370
35148 msgid "INITIAL MESSAGE"
35152 #: ../src/guestfs.pod:2372
35154 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
35155 "which indicates that the guest and daemon is alive. This is what L</"
35156 "guestfs_launch> waits for."
35160 #: ../src/guestfs.pod:2376
35161 msgid "PROGRESS NOTIFICATION MESSAGES"
35165 #: ../src/guestfs.pod:2378
35167 "The daemon may send progress notification messages at any time. These are "
35168 "distinguished by the normal length word being replaced by "
35169 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
35173 #: ../src/guestfs.pod:2382
35175 "The library turns them into progress callbacks (see L</"
35176 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
35181 #: ../src/guestfs.pod:2386
35183 "The daemon self-limits the frequency of progress messages it sends (see "
35184 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
35189 #: ../src/guestfs.pod:2390
35190 msgid "LIBGUESTFS VERSION NUMBERS"
35194 #: ../src/guestfs.pod:2392
35196 "Since April 2010, libguestfs has started to make separate development and "
35197 "stable releases, along with corresponding branches in our git repository. "
35198 "These separate releases can be identified by version number:"
35202 #: ../src/guestfs.pod:2397
35205 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
35206 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
35212 " | `-------- sub-version\n"
35214 " `------ always '1' because we don't change the ABI\n"
35219 #: ../src/guestfs.pod:2408
35220 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
35224 #: ../src/guestfs.pod:2410
35226 "As time passes we cherry pick fixes from the development branch and backport "
35227 "those into the stable branch, the effect being that the stable branch should "
35228 "get more stable and less buggy over time. So the stable releases are ideal "
35229 "for people who don't need new features but would just like the software to "
35234 #: ../src/guestfs.pod:2416
35235 msgid "Our criteria for backporting changes are:"
35239 #: ../src/guestfs.pod:2422
35241 "Documentation changes which don't affect any code are backported unless the "
35242 "documentation refers to a future feature which is not in stable."
35246 #: ../src/guestfs.pod:2428
35248 "Bug fixes which are not controversial, fix obvious problems, and have been "
35249 "well tested are backported."
35253 #: ../src/guestfs.pod:2433
35255 "Simple rearrangements of code which shouldn't affect how it works get "
35256 "backported. This is so that the code in the two branches doesn't get too "
35257 "far out of step, allowing us to backport future fixes more easily."
35261 #: ../src/guestfs.pod:2439
35263 "We I<don't> backport new features, new APIs, new tools etc, except in one "
35264 "exceptional case: the new feature is required in order to implement an "
35265 "important bug fix."
35269 #: ../src/guestfs.pod:2445
35271 "A new stable branch starts when we think the new features in development are "
35272 "substantial and compelling enough over the current stable branch to warrant "
35273 "it. When that happens we create new stable and development versions 1.N.0 "
35274 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
35275 "stable at this point, but by backporting fixes from development, that branch "
35276 "will stabilize over time."
35280 #: ../src/guestfs.pod:2453
35281 msgid "EXTENDING LIBGUESTFS"
35285 #: ../src/guestfs.pod:2455
35286 msgid "ADDING A NEW API ACTION"
35290 #: ../src/guestfs.pod:2457
35292 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
35293 "documentation) are generated, and this makes it easy to extend the "
35298 #: ../src/guestfs.pod:2461
35299 msgid "To add a new API action there are two changes:"
35303 #: ../src/guestfs.pod:2467
35305 "You need to add a description of the call (name, parameters, return type, "
35306 "tests, documentation) to C<generator/generator_actions.ml>."
35310 #: ../src/guestfs.pod:2470
35312 "There are two sorts of API action, depending on whether the call goes "
35313 "through to the daemon in the appliance, or is serviced entirely by the "
35314 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
35315 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
35316 "an example of the latter, since a trace flag is maintained in the handle and "
35317 "all tracing is done on the library side."
35321 #: ../src/guestfs.pod:2478
35323 "Most new actions are of the first type, and get added to the "
35324 "C<daemon_functions> list. Each function has a unique procedure number used "
35325 "in the RPC protocol which is assigned to that action when we publish "
35326 "libguestfs and cannot be reused. Take the latest procedure number and "
35331 #: ../src/guestfs.pod:2484
35333 "For library-only actions of the second type, add to the "
35334 "C<non_daemon_functions> list. Since these functions are serviced by the "
35335 "library and do not travel over the RPC mechanism to the daemon, these "
35336 "functions do not need a procedure number, and so the procedure number is set "
35341 #: ../src/guestfs.pod:2492
35342 msgid "Implement the action (in C):"
35346 #: ../src/guestfs.pod:2494
35348 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
35349 "C<daemon/> directory."
35353 #: ../src/guestfs.pod:2497
35355 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
35356 "(note: double underscore) in the C<src/> directory."
35360 #: ../src/guestfs.pod:2500
35361 msgid "In either case, use another function as an example of what to do."
35365 #: ../src/guestfs.pod:2504
35366 msgid "After making these changes, use C<make> to compile."
35370 #: ../src/guestfs.pod:2506
35372 "Note that you don't need to implement the RPC, language bindings, manual "
35373 "pages or anything else. It's all automatically generated from the OCaml "
35378 #: ../src/guestfs.pod:2510
35379 msgid "ADDING TESTS FOR AN API ACTION"
35383 #: ../src/guestfs.pod:2512
35385 "You can supply zero or as many tests as you want per API call. The tests "
35386 "can either be added as part of the API description (C<generator/"
35387 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
35388 "into C<regressions/>. Note that adding a script to C<regressions/> is "
35389 "slower, so if possible use the first method."
35393 #: ../src/guestfs.pod:2518
35395 "The following describes the test environment used when you add an API test "
35396 "in C<generator_actions.ml>."
35400 #: ../src/guestfs.pod:2521
35401 msgid "The test environment has 4 block devices:"
35405 #: ../src/guestfs.pod:2525
35406 msgid "C</dev/sda> 500MB"
35410 #: ../src/guestfs.pod:2527
35411 msgid "General block device for testing."
35415 #: ../src/guestfs.pod:2529
35416 msgid "C</dev/sdb> 50MB"
35420 #: ../src/guestfs.pod:2531
35422 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
35427 #: ../src/guestfs.pod:2534
35428 msgid "C</dev/sdc> 10MB"
35432 #: ../src/guestfs.pod:2536
35433 msgid "Used in a few tests where two block devices are needed."
35437 #: ../src/guestfs.pod:2538
35438 msgid "C</dev/sdd>"
35442 #: ../src/guestfs.pod:2540
35443 msgid "ISO with fixed content (see C<images/test.iso>)."
35447 #: ../src/guestfs.pod:2544
35449 "To be able to run the tests in a reasonable amount of time, the libguestfs "
35450 "appliance and block devices are reused between tests. So don't try testing "
35451 "L</guestfs_kill_subprocess> :-x"
35455 #: ../src/guestfs.pod:2548
35457 "Each test starts with an initial scenario, selected using one of the "
35458 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
35459 "initialize the disks mentioned above in a particular way as documented in "
35460 "C<generator_types.ml>. You should not assume anything about the previous "
35461 "contents of other disks that are not initialized."
35465 #: ../src/guestfs.pod:2554
35467 "You can add a prerequisite clause to any individual test. This is a run-"
35468 "time check, which, if it fails, causes the test to be skipped. Useful if "
35469 "testing a command which might not work on all variations of libguestfs "
35470 "builds. A test that has prerequisite of C<Always> means to run "
35475 #: ../src/guestfs.pod:2560
35477 "In addition, packagers can skip individual tests by setting environment "
35478 "variables before running C<make check>."
35482 #: ../src/guestfs.pod:2563
35485 " SKIP_TEST_<CMD>_<NUM>=1\n"
35490 #: ../src/guestfs.pod:2565
35491 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
35495 #: ../src/guestfs.pod:2567
35500 #: ../src/guestfs.pod:2569
35503 " SKIP_TEST_<CMD>=1\n"
35508 #: ../src/guestfs.pod:2571
35509 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
35513 #: ../src/guestfs.pod:2573
35514 msgid "Packagers can run only certain tests by setting for example:"
35518 #: ../src/guestfs.pod:2575
35521 " TEST_ONLY=\"vfs_type zerofree\"\n"
35526 #: ../src/guestfs.pod:2577
35528 "See C<capitests/tests.c> for more details of how these environment variables "
35533 #: ../src/guestfs.pod:2580
35534 msgid "DEBUGGING NEW API ACTIONS"
35538 #: ../src/guestfs.pod:2582
35539 msgid "Test new actions work before submitting them."
35543 #: ../src/guestfs.pod:2584
35544 msgid "You can use guestfish to try out new commands."
35548 #: ../src/guestfs.pod:2586
35550 "Debugging the daemon is a problem because it runs inside a minimal "
35551 "environment. However you can fprintf messages in the daemon to stderr, and "
35552 "they will show up if you use C<guestfish -v>."
35556 #: ../src/guestfs.pod:2590
35557 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
35561 #: ../src/guestfs.pod:2592
35563 "Our C source code generally adheres to some basic code-formatting "
35564 "conventions. The existing code base is not totally consistent on this "
35565 "front, but we do prefer that contributed code be formatted similarly. In "
35566 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
35567 "indentation level, and other than that, follow the K&R style."
35571 #: ../src/guestfs.pod:2598
35573 "If you use Emacs, add the following to one of one of your start-up files (e."
35574 "g., ~/.emacs), to help ensure that you get indentation right:"
35578 #: ../src/guestfs.pod:2601
35581 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
35582 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
35583 " (add-hook 'find-file-hook\n"
35584 " '(lambda () (if (and buffer-file-name\n"
35585 " (string-match \"/libguestfs\\\\>\"\n"
35586 " (buffer-file-name))\n"
35587 " (not (string-equal mode-name \"Change Log\"))\n"
35588 " (not (string-equal mode-name \"Makefile\")))\n"
35589 " (setq indent-tabs-mode nil))))\n"
35594 #: ../src/guestfs.pod:2611
35597 " ;;; When editing C sources in libguestfs, use this style.\n"
35598 " (defun libguestfs-c-mode ()\n"
35599 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
35601 " (c-set-style \"K&R\")\n"
35602 " (setq c-indent-level 2)\n"
35603 " (setq c-basic-offset 2))\n"
35604 " (add-hook 'c-mode-hook\n"
35605 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
35606 " (buffer-file-name))\n"
35607 " (libguestfs-c-mode))))\n"
35612 #: ../src/guestfs.pod:2623
35613 msgid "Enable warnings when compiling (and fix any problems this finds):"
35617 #: ../src/guestfs.pod:2626
35620 " ./configure --enable-gcc-warnings\n"
35625 #: ../src/guestfs.pod:2628
35626 msgid "Useful targets are:"
35630 #: ../src/guestfs.pod:2630
35633 " make syntax-check # checks the syntax of the C code\n"
35634 " make check # runs the test suite\n"
35639 #: ../src/guestfs.pod:2633
35640 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
35644 #: ../src/guestfs.pod:2635
35646 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
35647 "which are used to do shell quoting."
35651 #: ../src/guestfs.pod:2640
35656 #: ../src/guestfs.pod:2642
35658 "Simple shell quoted string. Any spaces or other shell characters are "
35663 #: ../src/guestfs.pod:2645
35668 #: ../src/guestfs.pod:2647
35670 "Same as C<%Q> except the string is treated as a path which is prefixed by "
35675 #: ../src/guestfs.pod:2654
35678 " asprintf (&cmd, \"cat %R\", path);\n"
35683 #: ../src/guestfs.pod:2656
35684 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
35688 #: ../src/guestfs.pod:2658
35690 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
35691 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
35692 "they are not passed via the shell (instead, straight to exec). You probably "
35693 "want to use the C<sysroot_path()> function however."
35697 #: ../src/guestfs.pod:2664
35698 msgid "SUBMITTING YOUR NEW API ACTIONS"
35702 #: ../src/guestfs.pod:2666
35704 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
35705 "libguestfs> and CC to L<rjones@redhat.com>."
35709 #: ../src/guestfs.pod:2670
35710 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
35714 #: ../src/guestfs.pod:2672
35715 msgid "We support i18n (gettext anyhow) in the library."
35719 #: ../src/guestfs.pod:2674
35721 "However many messages come from the daemon, and we don't translate those at "
35722 "the moment. One reason is that the appliance generally has all locale files "
35723 "removed from it, because they take up a lot of space. So we'd have to readd "
35724 "some of those, as well as copying our PO files into the appliance."
35728 #: ../src/guestfs.pod:2680
35730 "Debugging messages are never translated, since they are intended for the "
35735 #: ../src/guestfs.pod:2683
35736 msgid "SOURCE CODE SUBDIRECTORIES"
35740 #: ../src/guestfs.pod:2689
35741 msgid "The libguestfs appliance, build scripts and so on."
35745 #: ../src/guestfs.pod:2691
35746 msgid "C<capitests>"
35750 #: ../src/guestfs.pod:2693
35751 msgid "Automated tests of the C API."
35755 #: ../src/guestfs.pod:2695
35760 #: ../src/guestfs.pod:2697
35762 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
35767 #: ../src/guestfs.pod:2700
35772 #: ../src/guestfs.pod:2702
35774 "Safety and liveness tests of components that libguestfs depends upon (not of "
35775 "libguestfs itself). Mainly this is for qemu and the kernel."
35779 #: ../src/guestfs.pod:2705
35784 #: ../src/guestfs.pod:2707
35785 msgid "Outside contributions, experimental parts."
35789 #: ../src/guestfs.pod:2709
35794 #: ../src/guestfs.pod:2711
35796 "The daemon that runs inside the libguestfs appliance and carries out actions."
35800 #: ../src/guestfs.pod:2714
35805 #: ../src/guestfs.pod:2716
35806 msgid "L<virt-df(1)> command and documentation."
35810 #: ../src/guestfs.pod:2718
35815 #: ../src/guestfs.pod:2720
35816 msgid "L<virt-edit(1)> command and documentation."
35820 #: ../src/guestfs.pod:2722
35821 msgid "C<examples>"
35825 #: ../src/guestfs.pod:2724
35826 msgid "C API example code."
35830 #: ../src/guestfs.pod:2726
35835 #: ../src/guestfs.pod:2728
35837 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
35838 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
35839 "L<virt-tar-out(1)>."
35843 #: ../src/guestfs.pod:2732
35848 #: ../src/guestfs.pod:2734
35850 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
35854 #: ../src/guestfs.pod:2736
35855 msgid "C<generator>"
35859 #: ../src/guestfs.pod:2738
35861 "The crucially important generator, used to automatically generate large "
35862 "amounts of boilerplate C code for things like RPC and bindings."
35866 #: ../src/guestfs.pod:2741
35871 #: ../src/guestfs.pod:2743
35872 msgid "Files used by the test suite."
35876 #: ../src/guestfs.pod:2745
35877 msgid "Some \"phony\" guest images which we test against."
35881 #: ../src/guestfs.pod:2747
35882 msgid "C<inspector>"
35886 #: ../src/guestfs.pod:2749
35887 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
35891 #: ../src/guestfs.pod:2751
35896 #: ../src/guestfs.pod:2753
35897 msgid "Logo used on the website. The fish is called Arthur by the way."
35901 #: ../src/guestfs.pod:2755
35906 #: ../src/guestfs.pod:2757
35907 msgid "M4 macros used by autoconf."
35911 #: ../src/guestfs.pod:2759
35916 #: ../src/guestfs.pod:2761
35917 msgid "Translations of simple gettext strings."
35921 #: ../src/guestfs.pod:2763
35926 #: ../src/guestfs.pod:2765
35928 "The build infrastructure and PO files for translations of manpages and POD "
35929 "files. Eventually this will be combined with the C<po> directory, but that "
35930 "is rather complicated."
35934 #: ../src/guestfs.pod:2769
35935 msgid "C<regressions>"
35939 #: ../src/guestfs.pod:2771
35940 msgid "Regression tests."
35944 #: ../src/guestfs.pod:2773
35949 #: ../src/guestfs.pod:2775
35950 msgid "L<virt-rescue(1)> command and documentation."
35954 #: ../src/guestfs.pod:2777
35959 #: ../src/guestfs.pod:2779
35960 msgid "Source code to the C library."
35964 #: ../src/guestfs.pod:2781
35969 #: ../src/guestfs.pod:2783
35970 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
35974 #: ../src/guestfs.pod:2785
35975 msgid "C<test-tool>"
35979 #: ../src/guestfs.pod:2787
35981 "Test tool for end users to test if their qemu/kernel combination will work "
35986 #: ../src/guestfs.pod:2790
35991 #: ../src/guestfs.pod:2792
35996 #: ../src/guestfs.pod:2794
36001 #: ../src/guestfs.pod:2796
36006 #: ../src/guestfs.pod:2798
36011 #: ../src/guestfs.pod:2800
36016 #: ../src/guestfs.pod:2802
36021 #: ../src/guestfs.pod:2804
36026 #: ../src/guestfs.pod:2806
36027 msgid "Language bindings."
36031 #: ../src/guestfs.pod:2810
36032 msgid "MAKING A STABLE RELEASE"
36036 #: ../src/guestfs.pod:2812
36038 "When we make a stable release, there are several steps documented here. See "
36039 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
36044 #: ../src/guestfs.pod:2820
36046 "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
36050 #: ../src/guestfs.pod:2825
36051 msgid "Finalize RELEASE-NOTES."
36055 #: ../src/guestfs.pod:2829
36056 msgid "Update ROADMAP."
36060 #: ../src/guestfs.pod:2833
36061 msgid "Run C<src/api-support/update-from-tarballs.sh>."
36065 #: ../src/guestfs.pod:2837
36066 msgid "Push and pull from Transifex."
36070 #: ../src/guestfs.pod:2839
36075 #: ../src/guestfs.pod:2841
36083 #: ../src/guestfs.pod:2843
36084 msgid "to push the latest POT files to Transifex. Then run:"
36088 #: ../src/guestfs.pod:2845
36096 #: ../src/guestfs.pod:2847
36097 msgid "which is a wrapper to pull the latest translated C<*.po> files."
36101 #: ../src/guestfs.pod:2851
36103 "Create new stable and development directories under L<http://libguestfs.org/"
36108 #: ../src/guestfs.pod:2856
36109 msgid "Create the branch in git:"
36113 #: ../src/guestfs.pod:2858
36116 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
36117 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
36118 " git branch stable-1.XX\n"
36119 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
36124 #: ../src/guestfs.pod:2865
36129 #: ../src/guestfs.pod:2867
36130 msgid "PROTOCOL LIMITS"
36134 #: ../src/guestfs.pod:2869
36136 "Internally libguestfs uses a message-based protocol to pass API calls and "
36137 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
36138 "plenty more detail about this). The maximum message size used by the "
36139 "protocol is slightly less than 4 MB. For some API calls you may need to be "
36140 "aware of this limit. The API calls which may be affected are individually "
36141 "documented, with a link back to this section of the documentation."
36145 #: ../src/guestfs.pod:2877
36147 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
36148 "a simple string. Because this string is at some point internally encoded as "
36149 "a message, the maximum size that it can return is slightly under 4 MB. If "
36150 "the requested file is larger than this then you will get an error."
36154 #: ../src/guestfs.pod:2883
36156 "In order to transfer large files into and out of the guest filesystem, you "
36157 "need to use particular calls that support this. The sections L</UPLOADING> "
36158 "and L</DOWNLOADING> document how to do this."
36162 #: ../src/guestfs.pod:2887
36164 "You might also consider mounting the disk image using our FUSE filesystem "
36165 "support (L<guestmount(1)>)."
36169 #: ../src/guestfs.pod:2890
36170 msgid "MAXIMUM NUMBER OF DISKS"
36174 #: ../src/guestfs.pod:2892
36175 msgid "When using virtio disks (the default) the current limit is B<25> disks."
36179 #: ../src/guestfs.pod:2895
36181 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
36182 "slots. However febootstrap only understands disks with names C</dev/vda> "
36183 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
36188 #: ../src/guestfs.pod:2900
36190 "We are working to substantially raise this limit in future versions but it "
36191 "requires complex changes to qemu."
36195 #: ../src/guestfs.pod:2903
36197 "In future versions of libguestfs it should also be possible to \"hot plug\" "
36198 "disks (add and remove disks after calling L</guestfs_launch>). This also "
36199 "requires changes to qemu."
36203 #: ../src/guestfs.pod:2907
36204 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
36208 #: ../src/guestfs.pod:2909
36209 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
36213 #: ../src/guestfs.pod:2911
36215 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
36216 "vda>, and C</dev/vda1> through C</dev/vda15>)."
36220 #: ../src/guestfs.pod:2914
36222 "If you attach a disk with more than 15 partitions, the extra partitions are "
36223 "ignored by libguestfs."
36227 #: ../src/guestfs.pod:2917
36228 msgid "MAXIMUM SIZE OF A DISK"
36232 #: ../src/guestfs.pod:2919
36233 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
36237 #: ../src/guestfs.pod:2921
36239 "We have tested block devices up to 1 exabyte (2**60 or "
36240 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
36245 #: ../src/guestfs.pod:2925
36247 "Although libguestfs probably does not impose any limit, the underlying host "
36248 "storage will. If you store disk images on a host ext4 filesystem, then the "
36249 "maximum size will be limited by the maximum ext4 file size (currently 16 "
36250 "TB). If you store disk images as host logical volumes then you are limited "
36251 "by the maximum size of an LV."
36255 #: ../src/guestfs.pod:2931
36257 "For the hugest disk image files, we recommend using XFS on the host for "
36262 #: ../src/guestfs.pod:2934
36263 msgid "MAXIMUM SIZE OF A PARTITION"
36267 #: ../src/guestfs.pod:2936
36269 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
36270 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
36271 "address a partition located beyond 2 TB on the disk."
36275 #: ../src/guestfs.pod:2940
36277 "It is recommended that you use GPT partitions on disks which are larger than "
36278 "this size. GPT uses 64 bit sector numbers and so can address partitions "
36279 "which are theoretically larger than the largest disk we could support."
36283 #: ../src/guestfs.pod:2945
36284 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
36288 #: ../src/guestfs.pod:2947
36290 "This depends on the filesystem type. libguestfs itself does not impose any "
36291 "known limit. Consult Wikipedia or the filesystem documentation to find out "
36292 "what these limits are."
36296 #: ../src/guestfs.pod:2951
36297 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
36301 #: ../src/guestfs.pod:2953
36303 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
36304 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
36305 "uploads and downloads."
36309 #: ../src/guestfs.pod:2957
36310 msgid "INSPECTION LIMITS"
36314 #: ../src/guestfs.pod:2959
36316 "The inspection code has several arbitrary limits on things like the size of "
36317 "Windows Registry hive it will read, and the length of product name. These "
36318 "are intended to stop a malicious guest from consuming arbitrary amounts of "
36319 "memory and disk space on the host, and should not be reached in practice. "
36320 "See the source code for more information."
36324 #: ../src/guestfs.pod:2975
36326 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
36327 "effect as calling C<guestfs_set_verbose (g, 1)>."
36331 #: ../src/guestfs.pod:2987
36333 "Set the path that libguestfs uses to search for a supermin appliance. See "
36334 "the discussion of paths in section L</PATH> above."
36338 #: ../src/guestfs.pod:2996
36339 msgid "See also L</QEMU WRAPPERS> above."
36343 #: ../src/guestfs.pod:3000
36345 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
36346 "effect as calling C<guestfs_set_trace (g, 1)>."
36350 #: ../src/guestfs.pod:3018
36352 "L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-"
36353 "perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, L<guestfish(1)>, "
36354 "L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
36355 "L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)"
36356 ">, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
36357 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
36358 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
36359 "L<hivex(3)>, L<http://libguestfs.org/>."
36363 #: ../src/guestfs.pod:3047
36365 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
36366 "(8)>, L<disktype(1)>."
36370 #: ../src/guestfs.pod:3054 ../tools/virt-make-fs.pl:553
36371 #: ../tools/virt-win-reg.pl:761
36376 #: ../src/guestfs.pod:3056
36377 msgid "To get a list of bugs against libguestfs use this link:"
36381 #: ../src/guestfs.pod:3058
36383 "L<https://bugzilla.redhat.com/buglist.cgi?"
36384 "component=libguestfs&product=Virtualization+Tools>"
36388 #: ../src/guestfs.pod:3060
36389 msgid "To report a new bug against libguestfs use this link:"
36393 #: ../src/guestfs.pod:3062
36395 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
36396 "component=libguestfs&product=Virtualization+Tools>"
36400 #: ../src/guestfs.pod:3064
36401 msgid "When reporting a bug, please check:"
36405 #: ../src/guestfs.pod:3070
36406 msgid "That the bug hasn't been reported already."
36410 #: ../src/guestfs.pod:3074
36411 msgid "That you are testing a recent version."
36415 #: ../src/guestfs.pod:3078
36416 msgid "Describe the bug accurately, and give a way to reproduce it."
36420 #: ../src/guestfs.pod:3082
36422 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
36427 #: ../test-tool/libguestfs-test-tool.pod:5
36428 msgid "libguestfs-test-tool - End user tests for libguestfs"
36432 #: ../test-tool/libguestfs-test-tool.pod:9
36435 " libguestfs-test-tool [--options]\n"
36440 #: ../test-tool/libguestfs-test-tool.pod:13
36442 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
36443 "and developers, to allow them to check basic libguestfs functionality is "
36444 "working. This is needed because libguestfs occasionally breaks for reasons "
36445 "beyond our control: usually because of changes in the underlying qemu or "
36446 "kernel packages, or the host environment."
36450 #: ../test-tool/libguestfs-test-tool.pod:20
36451 msgid "If you suspect a problem in libguestfs, then just run:"
36455 #: ../test-tool/libguestfs-test-tool.pod:22
36458 " libguestfs-test-tool\n"
36463 #: ../test-tool/libguestfs-test-tool.pod:24
36464 msgid "It will print lots of diagnostic messages."
36468 #: ../test-tool/libguestfs-test-tool.pod:26
36469 msgid "If it runs to completion successfully, you will see this near the end:"
36473 #: ../test-tool/libguestfs-test-tool.pod:28
36476 " ===== TEST FINISHED OK =====\n"
36481 #: ../test-tool/libguestfs-test-tool.pod:30
36482 msgid "and the test tool will exit with code 0."
36486 #: ../test-tool/libguestfs-test-tool.pod:32
36488 "If it fails (and/or exits with non-zero error code), please paste the "
36489 "B<complete, unedited> output of the test tool into a bug report. More "
36490 "information about reporting bugs can be found on the L<http://libguestfs.org/"
36495 #: ../test-tool/libguestfs-test-tool.pod:41
36500 #: ../test-tool/libguestfs-test-tool.pod:43
36501 msgid "Display short usage information and exit."
36505 #: ../test-tool/libguestfs-test-tool.pod:45
36506 msgid "I<--qemu qemu_binary>"
36510 #: ../test-tool/libguestfs-test-tool.pod:47
36512 "If you have downloaded another qemu binary, point this option at the full "
36513 "path of the binary to try it."
36517 #: ../test-tool/libguestfs-test-tool.pod:50
36518 msgid "I<--qemudir qemu_source_dir>"
36522 #: ../test-tool/libguestfs-test-tool.pod:52
36524 "If you have compiled qemu from source, point this option at the source "
36525 "directory to try it."
36529 #: ../test-tool/libguestfs-test-tool.pod:55
36530 msgid "I<--timeout N>"
36534 #: ../test-tool/libguestfs-test-tool.pod:57
36536 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
36537 "does not usually need to be adjusted unless your machine is very slow."
36541 #: ../test-tool/libguestfs-test-tool.pod:63
36542 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
36546 #: ../test-tool/libguestfs-test-tool.pod:65
36548 "If you have compiled another version of qemu from source and would like to "
36549 "try that, then you can use the I<--qemudir> option to point to the qemu "
36550 "source directory."
36554 #: ../test-tool/libguestfs-test-tool.pod:69
36556 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
36557 "option to point to the binary."
36561 #: ../test-tool/libguestfs-test-tool.pod:72
36563 "When using an alternate qemu with libguestfs, usually you would need to "
36564 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
36565 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
36566 "use either of the I<--qemudir> or I<--qemu> options."
36570 #: ../test-tool/libguestfs-test-tool.pod:79
36572 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
36573 "I<1> if there was an error."
36577 #: ../test-tool/libguestfs-test-tool.pod:84
36579 "For the full list of environment variables which may affect libguestfs, "
36580 "please see the L<guestfs(3)> manual page."
36584 #: ../test-tool/libguestfs-test-tool.pod:89
36585 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
36589 #: ../tools/virt-list-filesystems.pl:32
36591 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
36595 #: ../tools/virt-list-filesystems.pl:36
36598 " virt-list-filesystems [--options] domname\n"
36603 #: ../tools/virt-list-filesystems.pl:38
36606 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
36611 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
36613 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
36618 #: ../tools/virt-list-filesystems.pl:45
36620 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
36621 "are contained in a virtual machine or disk image."
36625 #: ../tools/virt-list-filesystems.pl:49
36627 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
36628 "functionality. For more complex cases you should look at the L<guestfish(1)"
36633 #: ../tools/virt-list-filesystems.pl:112
36635 "With this option, C<virt-list-filesystems> displays the type of each "
36636 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
36640 #: ../tools/virt-list-filesystems.pl:119
36645 #: ../tools/virt-list-filesystems.pl:123
36647 "Normally we only show mountable filesystems. If this option is given then "
36648 "swap devices are shown too."
36652 #: ../tools/virt-list-filesystems.pl:197
36654 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
36655 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
36656 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36660 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
36661 msgid "Copyright (C) 2009 Red Hat Inc."
36665 #: ../tools/virt-list-partitions.pl:32
36667 "virt-list-partitions - List partitions in a virtual machine or disk image"
36671 #: ../tools/virt-list-partitions.pl:36
36674 " virt-list-partitions [--options] domname\n"
36679 #: ../tools/virt-list-partitions.pl:38
36682 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
36687 #: ../tools/virt-list-partitions.pl:45
36689 "C<virt-list-partitions> is a command line tool to list the partitions that "
36690 "are contained in a virtual machine or disk image. It is mainly useful as a "
36691 "first step to using L<virt-resize(1)>."
36695 #: ../tools/virt-list-partitions.pl:50
36697 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
36698 "functionality. For more complex cases you should look at the L<guestfish(1)"
36703 #: ../tools/virt-list-partitions.pl:113
36704 msgid "Show sizes in human-readable form (eg. \"1G\")."
36708 #: ../tools/virt-list-partitions.pl:123
36710 "With this option, C<virt-list-partitions> displays the type and size of each "
36711 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
36715 #: ../tools/virt-list-partitions.pl:130
36720 #: ../tools/virt-list-partitions.pl:132
36725 #: ../tools/virt-list-partitions.pl:134
36727 "Display the total size of each block device (as a separate row or rows)."
36731 #: ../tools/virt-list-partitions.pl:267
36733 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
36734 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
36735 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36739 #: ../tools/virt-list-partitions.pl:283
36740 msgid "Copyright (C) 2009-2010 Red Hat Inc."
36744 #: ../tools/virt-make-fs.pl:37
36745 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
36749 #: ../tools/virt-make-fs.pl:41
36752 " virt-make-fs [--options] input.tar output.img\n"
36757 #: ../tools/virt-make-fs.pl:43
36760 " virt-make-fs [--options] input.tar.gz output.img\n"
36765 #: ../tools/virt-make-fs.pl:45
36768 " virt-make-fs [--options] directory output.img\n"
36773 #: ../tools/virt-make-fs.pl:49
36775 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
36776 "archive or some files in a directory. It is similar to tools like L<mkisofs"
36777 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
36778 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
36779 "you want to attach these filesystems to existing virtual machines (eg. to "
36780 "import large amounts of read-only data to a VM)."
36784 #: ../tools/virt-make-fs.pl:57
36785 msgid "Basic usage is:"
36789 #: ../tools/virt-make-fs.pl:59
36792 " virt-make-fs input output\n"
36797 #: ../tools/virt-make-fs.pl:61
36799 "where C<input> is either a directory containing files that you want to add, "
36800 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
36801 "C<output> is a disk image. The input type is detected automatically. The "
36802 "output disk image defaults to a raw ext2 image unless you specify extra "
36803 "flags (see L</OPTIONS> below)."
36807 #: ../tools/virt-make-fs.pl:67
36808 msgid "EXTRA SPACE"
36812 #: ../tools/virt-make-fs.pl:69
36814 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
36815 "the files that it contains, but might have extra space. Depending on how "
36816 "you are going to use the output, you might think this extra space is wasted "
36817 "and want to minimize it, or you might want to leave space so that more files "
36818 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
36819 "but you can use the I<--size> flag to leave space in the filesystem if you "
36824 #: ../tools/virt-make-fs.pl:77
36826 "An alternative way to leave extra space but not make the output image any "
36827 "bigger is to use an alternative disk image format (instead of the default "
36828 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
36829 "image format (check your hypervisor supports this before using it). This "
36830 "allows you to choose a large I<--size> but the extra space won't actually be "
36831 "allocated in the image until you try to store something in it."
36835 #: ../tools/virt-make-fs.pl:85
36837 "Don't forget that you can also use local commands including L<resize2fs(8)> "
36838 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
36839 "to build another image from scratch."
36843 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
36844 #: ../tools/virt-make-fs.pl:142
36849 #: ../tools/virt-make-fs.pl:91
36852 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
36857 #: ../tools/virt-make-fs.pl:93
36858 msgid "FILESYSTEM TYPE"
36862 #: ../tools/virt-make-fs.pl:95
36864 "The default filesystem type is C<ext2>. Just about any filesystem type that "
36865 "libguestfs supports can be used (but I<not> read-only formats like "
36866 "ISO9660). Here are some of the more common choices:"
36870 #: ../tools/virt-make-fs.pl:101
36875 #: ../tools/virt-make-fs.pl:103
36877 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
36878 "you are not going to use the filesystem in a way that requires the journal, "
36879 "then this is just wasted overhead."
36883 #: ../tools/virt-make-fs.pl:107
36884 msgid "I<ntfs> or I<vfat>"
36888 #: ../tools/virt-make-fs.pl:109
36889 msgid "Useful if exporting data to a Windows guest."
36893 #: ../tools/virt-make-fs.pl:111
36895 "I<Note for vfat>: The tar archive or local directory must only contain files "
36896 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
36897 "program running within libguestfs is unable to change the ownership of non-"
36898 "root files, since vfat itself does not support this."
36902 #: ../tools/virt-make-fs.pl:116
36907 #: ../tools/virt-make-fs.pl:118
36909 "Lower overhead than C<ext2>, but certain limitations on filename length and "
36910 "total filesystem size."
36914 #: ../tools/virt-make-fs.pl:125
36917 " virt-make-fs --type=minix input minixfs.img\n"
36922 #: ../tools/virt-make-fs.pl:127
36923 msgid "TO PARTITION OR NOT TO PARTITION"
36927 #: ../tools/virt-make-fs.pl:129
36928 msgid "Optionally virt-make-fs can add a partition table to the output disk."
36932 #: ../tools/virt-make-fs.pl:131
36934 "Adding a partition can make the disk image more compatible with certain "
36935 "virtualized operating systems which don't expect to see a filesystem "
36936 "directly located on a block device (Linux doesn't care and will happily "
36937 "handle both types)."
36941 #: ../tools/virt-make-fs.pl:136
36943 "On the other hand, if you have a partition table then the output image is no "
36944 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
36945 "directly on a partitioned disk image. (However libguestfs tools such as "
36946 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
36950 #: ../tools/virt-make-fs.pl:144
36951 msgid "Add an MBR partition:"
36955 #: ../tools/virt-make-fs.pl:146
36958 " virt-make-fs --partition -- input disk.img\n"
36963 #: ../tools/virt-make-fs.pl:148
36965 "If the output disk image could be terabyte-sized or larger, it's better to "
36966 "use an EFI/GPT-compatible partition table:"
36970 #: ../tools/virt-make-fs.pl:151
36973 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
36978 #: ../tools/virt-make-fs.pl:179
36979 msgid "Enable debugging information."
36983 #: ../tools/virt-make-fs.pl:185
36984 msgid "B<--size=E<lt>NE<gt>>"
36988 #: ../tools/virt-make-fs.pl:187
36989 msgid "B<--size=+E<lt>NE<gt>>"
36993 #: ../tools/virt-make-fs.pl:189
36994 msgid "B<-s E<lt>NE<gt>>"
36998 #: ../tools/virt-make-fs.pl:191
36999 msgid "B<-s +E<lt>NE<gt>>"
37003 #: ../tools/virt-make-fs.pl:193
37005 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
37009 #: ../tools/virt-make-fs.pl:196
37011 "If this option is I<not> given, then the output image will be just large "
37012 "enough to contain all the files, with not much wasted space."
37016 #: ../tools/virt-make-fs.pl:199
37018 "To choose a fixed size output disk, specify an absolute number followed by b/"
37019 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
37020 "Petabytes or Exabytes. This must be large enough to contain all the input "
37021 "files, else you will get an error."
37025 #: ../tools/virt-make-fs.pl:204
37027 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
37028 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
37029 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
37030 "the input files, and (approximately) an extra 200 MB free space."
37034 #: ../tools/virt-make-fs.pl:210
37036 "Note that virt-make-fs estimates free space, and therefore will not produce "
37037 "filesystems containing precisely the free space requested. (It is much more "
37038 "expensive and time-consuming to produce a filesystem which has precisely the "
37039 "desired free space)."
37043 #: ../tools/virt-make-fs.pl:219
37044 msgid "B<--format=E<lt>fmtE<gt>>"
37048 #: ../tools/virt-make-fs.pl:221
37049 msgid "B<-F E<lt>fmtE<gt>>"
37053 #: ../tools/virt-make-fs.pl:223
37054 msgid "Choose the output disk image format."
37058 #: ../tools/virt-make-fs.pl:225
37059 msgid "The default is C<raw> (raw disk image)."
37063 #: ../tools/virt-make-fs.pl:227
37065 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
37066 "that would really make sense here is C<qcow2>."
37070 #: ../tools/virt-make-fs.pl:234
37071 msgid "B<--type=E<lt>fsE<gt>>"
37075 #: ../tools/virt-make-fs.pl:236
37076 msgid "B<-t E<lt>fsE<gt>>"
37080 #: ../tools/virt-make-fs.pl:238
37081 msgid "Choose the output filesystem type."
37085 #: ../tools/virt-make-fs.pl:240
37086 msgid "The default is C<ext2>."
37090 #: ../tools/virt-make-fs.pl:242
37092 "Any filesystem which is supported read-write by libguestfs can be used here."
37096 #: ../tools/virt-make-fs.pl:249
37097 msgid "B<--partition>"
37101 #: ../tools/virt-make-fs.pl:251
37102 msgid "B<--partition=E<lt>parttypeE<gt>>"
37106 #: ../tools/virt-make-fs.pl:253
37108 "If specified, this flag adds an MBR partition table to the output disk image."
37112 #: ../tools/virt-make-fs.pl:256
37114 "You can change the partition table type, eg. I<--partition=gpt> for large "
37119 #: ../tools/virt-make-fs.pl:259
37121 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
37122 "might consider the next parameter to be the partition type. For example:"
37126 #: ../tools/virt-make-fs.pl:263
37129 " virt-make-fs --partition input.tar ...\n"
37134 #: ../tools/virt-make-fs.pl:265
37136 "would cause virt-make-fs to think you wanted to use a partition type of "
37137 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
37138 "dash) between options and the input file argument:"
37142 #: ../tools/virt-make-fs.pl:269
37145 " virt-make-fs --partition -- input.tar ...\n"
37150 #: ../tools/virt-make-fs.pl:541
37152 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
37153 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
37154 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
37158 #: ../tools/virt-make-fs.pl:555 ../tools/virt-win-reg.pl:763
37160 "When reporting bugs, please enable debugging and capture the I<complete> "
37165 #: ../tools/virt-make-fs.pl:558
37168 " export LIBGUESTFS_DEBUG=1\n"
37169 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
37174 #: ../tools/virt-make-fs.pl:561
37176 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
37181 #: ../tools/virt-tar.pl:33
37182 msgid "virt-tar - Extract or upload files to a virtual machine"
37186 #: ../tools/virt-tar.pl:37
37189 " virt-tar [--options] -x domname directory tarball\n"
37194 #: ../tools/virt-tar.pl:39
37197 " virt-tar [--options] -u domname tarball directory\n"
37202 #: ../tools/virt-tar.pl:41
37205 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
37210 #: ../tools/virt-tar.pl:43
37213 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
37218 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
37223 #: ../tools/virt-tar.pl:47
37225 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
37226 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
37230 #: ../tools/virt-tar.pl:52
37231 msgid "Download C</home> from the VM into a local tarball:"
37235 #: ../tools/virt-tar.pl:54
37238 " virt-tar -x domname /home home.tar\n"
37243 #: ../tools/virt-tar.pl:56
37246 " virt-tar -zx domname /home home.tar.gz\n"
37251 #: ../tools/virt-tar.pl:58
37252 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
37256 #: ../tools/virt-tar.pl:60
37259 " virt-tar -u domname uploadstuff.tar /tmp\n"
37264 #: ../tools/virt-tar.pl:62
37267 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
37272 #: ../tools/virt-tar.pl:66
37274 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
37275 "virtual machines. If you do this, you risk disk corruption in the VM. "
37276 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
37280 #: ../tools/virt-tar.pl:71
37282 "You can use I<-x> (extract) on live virtual machines, but you might get "
37283 "inconsistent results or errors if there is filesystem activity inside the "
37284 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
37285 "work, but the only way to guarantee consistent results is if the virtual "
37286 "machine is shut down."
37290 #: ../tools/virt-tar.pl:79
37292 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
37293 "parts of a guest filesystem. There are many possibilities: making backups, "
37294 "uploading data files, snooping on guest activity, fixing or customizing "
37299 #: ../tools/virt-tar.pl:84
37301 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
37302 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
37303 "should look at the L<guestfish(1)> tool."
37307 #: ../tools/virt-tar.pl:88
37309 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
37310 "its contents (recursively) from the virtual machine into a local tarball. "
37311 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
37312 "virtual machine. You cannot use these two options together."
37316 #: ../tools/virt-tar.pl:94
37318 "In addition, you may need to use the I<-z> (gZip) option to enable "
37319 "compression. When uploading, you have to specify I<-z> if the upload file "
37320 "is compressed because virt-tar won't detect this on its own."
37324 #: ../tools/virt-tar.pl:98
37326 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
37327 "example it cannot do PKZip files or bzip2 compression. If you want that "
37328 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
37329 "the L<libguestfs(3)> API)."
37333 #: ../tools/virt-tar.pl:160
37334 msgid "B<--extract>"
37338 #: ../tools/virt-tar.pl:162
37339 msgid "B<--download>"
37343 #: ../tools/virt-tar.pl:164
37348 #: ../tools/virt-tar.pl:166
37349 msgid "B<--upload>"
37353 #: ../tools/virt-tar.pl:168
37355 "Use I<-x> to extract (download) a directory from a virtual machine to a "
37360 #: ../tools/virt-tar.pl:171
37362 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
37363 "Please read the L</WARNING> section above before using this option."
37367 #: ../tools/virt-tar.pl:175
37368 msgid "You must specify exactly one of these options."
37372 #: ../tools/virt-tar.pl:181
37377 #: ../tools/virt-tar.pl:183
37382 #: ../tools/virt-tar.pl:185
37383 msgid "Specify that the input or output tarball is gzip-compressed."
37387 #: ../tools/virt-tar.pl:298
37389 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
37390 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
37391 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
37396 #: ../tools/virt-win-reg.pl:37
37398 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
37402 #: ../tools/virt-win-reg.pl:41
37405 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
37410 #: ../tools/virt-win-reg.pl:43
37413 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
37418 #: ../tools/virt-win-reg.pl:45
37421 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
37426 #: ../tools/virt-win-reg.pl:47
37429 " virt-win-reg --merge domname [input.reg ...]\n"
37434 #: ../tools/virt-win-reg.pl:49
37437 " virt-win-reg [--options] disk.img ... # instead of domname\n"
37442 #: ../tools/virt-win-reg.pl:53
37444 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
37445 "virtual machines. If you do this, you I<will> get irreversible disk "
37446 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
37447 "but doesn't catch all cases."
37451 #: ../tools/virt-win-reg.pl:58
37453 "Modifying the Windows Registry is an inherently risky operation. The format "
37454 "is deliberately obscure and undocumented, and Registry changes can leave the "
37455 "system unbootable. Therefore when using the I<--merge> option, make sure "
37456 "you have a reliable backup first."
37460 #: ../tools/virt-win-reg.pl:65
37462 "This program can export and merge Windows Registry entries from a Windows "
37467 #: ../tools/virt-win-reg.pl:68
37469 "The first parameter is the libvirt guest name or the raw disk image of a "
37474 #: ../tools/virt-win-reg.pl:71
37476 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
37477 "exported (recursively). For example:"
37481 #: ../tools/virt-win-reg.pl:74
37484 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
37489 #: ../tools/virt-win-reg.pl:76
37491 "You can also display single values from within registry keys, for example:"
37495 #: ../tools/virt-win-reg.pl:79
37498 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
37499 " $ virt-win-reg Windows7 $cvkey ProductName\n"
37500 " Windows 7 Enterprise\n"
37505 #: ../tools/virt-win-reg.pl:83
37507 "With I<--merge>, you can merge a textual regedit file into the Windows "
37512 #: ../tools/virt-win-reg.pl:86
37515 " $ virt-win-reg --merge Windows7 changes.reg\n"
37520 #: ../tools/virt-win-reg.pl:90
37522 "This program is only meant for simple access to the registry. If you want "
37523 "to do complicated things with the registry, we suggest you download the "
37524 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
37525 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
37526 "L<hivexregedit(1)>."
37530 #: ../tools/virt-win-reg.pl:159
37535 #: ../tools/virt-win-reg.pl:161
37537 "In merge mode, this merges a textual regedit file into the Windows Registry "
37538 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
37539 "displays or exports Registry entries instead."
37543 #: ../tools/virt-win-reg.pl:165
37545 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
37546 "result in disk corruption. However exporting (without this flag) is always "
37551 #: ../tools/virt-win-reg.pl:173
37552 msgid "B<--encoding> UTF-16LE|ASCII"
37556 #: ../tools/virt-win-reg.pl:175
37558 "When merging (only), you may need to specify the encoding for strings to be "
37559 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
37560 "(3)/ENCODING STRINGS>."
37564 #: ../tools/virt-win-reg.pl:179
37566 "The default is to use UTF-16LE, which should work with recent versions of "
37571 #: ../tools/virt-win-reg.pl:186
37572 msgid "B<--unsafe-printable-strings>"
37576 #: ../tools/virt-win-reg.pl:188
37578 "When exporting (only), assume strings are UTF-16LE and print them as strings "
37579 "instead of hex sequences. Remove the final zero codepoint from strings if "
37584 #: ../tools/virt-win-reg.pl:192
37586 "This is unsafe and does not preserve the fidelity of strings in the original "
37587 "Registry for various reasons:"
37591 #: ../tools/virt-win-reg.pl:199
37593 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
37594 "other encodings will be corrupted by this transformation."
37598 #: ../tools/virt-win-reg.pl:204
37600 "Assumes that everything which has type 1 or 2 is really a string and that "
37601 "everything else is not a string, but the type field in real Registries is "
37606 #: ../tools/virt-win-reg.pl:210
37608 "Loses information about whether a zero codepoint followed the string in the "
37613 #: ../tools/virt-win-reg.pl:215
37615 "This all happens because the Registry itself contains no information about "
37616 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
37620 #: ../tools/virt-win-reg.pl:219
37622 "You should only use this option for quick hacking and debugging of the "
37623 "Registry contents, and I<never> use it if the output is going to be passed "
37624 "into another program or stored in another Registry."
37628 #: ../tools/virt-win-reg.pl:556
37629 msgid "SUPPORTED SYSTEMS"
37633 #: ../tools/virt-win-reg.pl:558
37635 "The program currently supports Windows NT-derived guests starting with "
37636 "Windows XP through to at least Windows 7."
37640 #: ../tools/virt-win-reg.pl:561
37641 msgid "The following Registry keys are supported:"
37645 #: ../tools/virt-win-reg.pl:565
37646 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
37650 #: ../tools/virt-win-reg.pl:567
37651 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
37655 #: ../tools/virt-win-reg.pl:569
37656 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
37660 #: ../tools/virt-win-reg.pl:571
37661 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
37665 #: ../tools/virt-win-reg.pl:573
37666 msgid "C<HKEY_USERS\\.DEFAULT>"
37670 #: ../tools/virt-win-reg.pl:575
37671 msgid "C<HKEY_USERS\\I<SID>>"
37675 #: ../tools/virt-win-reg.pl:577
37676 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
37680 #: ../tools/virt-win-reg.pl:579
37681 msgid "C<HKEY_USERS\\I<username>>"
37685 #: ../tools/virt-win-reg.pl:581
37687 "where I<username> is a local user name (this is a libguestfs extension)."
37691 #: ../tools/virt-win-reg.pl:585
37693 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
37698 #: ../tools/virt-win-reg.pl:588
37700 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
37701 "supported (there is no \"current user\")."
37705 #: ../tools/virt-win-reg.pl:591
37710 #: ../tools/virt-win-reg.pl:593
37712 "C<virt-win-reg> expects that regedit files have already been reencoded in "
37713 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
37714 "style line endings. Since Windows regedit files are often in UTF-16LE with "
37715 "Windows-style line endings, you may need to reencode the whole file before "
37716 "or after processing."
37720 #: ../tools/virt-win-reg.pl:599
37722 "To reencode a file from Windows format to Linux (before processing it with "
37723 "the I<--merge> option), you would do something like this:"
37727 #: ../tools/virt-win-reg.pl:602
37730 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
37735 #: ../tools/virt-win-reg.pl:604
37737 "To go in the opposite direction, after exporting and before sending the file "
37738 "to a Windows user, do something like this:"
37742 #: ../tools/virt-win-reg.pl:607
37745 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
37750 #: ../tools/virt-win-reg.pl:609
37751 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
37755 #: ../tools/virt-win-reg.pl:611
37757 "If you are unsure about the current encoding, use the L<file(1)> command. "
37758 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
37759 "style (CRLF) line endings, like this:"
37763 #: ../tools/virt-win-reg.pl:615
37766 " $ file software.reg\n"
37767 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
37768 " with CRLF line terminators\n"
37773 #: ../tools/virt-win-reg.pl:619
37774 msgid "This file would need conversion before you could I<--merge> it."
37778 #: ../tools/virt-win-reg.pl:621
37779 msgid "CurrentControlSet etc."
37783 #: ../tools/virt-win-reg.pl:623
37785 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
37786 "Registry at the level of the hive file, and therefore you cannot modify "
37791 #: ../tools/virt-win-reg.pl:627
37793 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
37794 "circumstances it might refer to another control set. The way to find out is "
37795 "to look at the C<HKLM\\SYSTEM\\Select> key:"
37799 #: ../tools/virt-win-reg.pl:631
37802 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
37803 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
37804 " \"Current\"=dword:00000001\n"
37805 " \"Default\"=dword:00000001\n"
37806 " \"Failed\"=dword:00000000\n"
37807 " \"LastKnownGood\"=dword:00000002\n"
37812 #: ../tools/virt-win-reg.pl:638
37813 msgid "\"Current\" is the one which Windows will choose when it boots."
37817 #: ../tools/virt-win-reg.pl:640
37819 "Similarly, other C<Current...> keys in the path may need to be replaced."
37823 #: ../tools/virt-win-reg.pl:643
37824 msgid "WINDOWS TIPS"
37828 #: ../tools/virt-win-reg.pl:645
37830 "Note that some of these tips modify the guest disk image. The guest I<must> "
37831 "be shut off, else you will get disk corruption."
37835 #: ../tools/virt-win-reg.pl:648
37836 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
37840 #: ../tools/virt-win-reg.pl:650
37842 "Prepare a DOS batch script, VBScript or executable. Upload this using "
37843 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
37844 "is uploaded into C<C:\\>:"
37848 #: ../tools/virt-win-reg.pl:654
37851 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
37856 #: ../tools/virt-win-reg.pl:656
37857 msgid "Prepare a regedit file containing the registry change:"
37861 #: ../tools/virt-win-reg.pl:658
37864 " cat > test.reg <<'EOF'\n"
37865 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
37866 " \"Test\"=\"c:\\\\test.bat\"\n"
37872 #: ../tools/virt-win-reg.pl:663
37874 "In this example we use the key C<RunOnce> which means that the script will "
37875 "run precisely once when the first user logs in. If you want it to run every "
37876 "time a user logs in, replace C<RunOnce> with C<Run>."
37880 #: ../tools/virt-win-reg.pl:667
37881 msgid "Now update the registry:"
37885 #: ../tools/virt-win-reg.pl:669
37888 " virt-win-reg --merge WindowsGuest test.reg\n"
37893 #: ../tools/virt-win-reg.pl:671
37894 msgid "INSTALLING A SERVICE"
37898 #: ../tools/virt-win-reg.pl:673
37900 "This section assumes you are familiar with Windows services, and you either "
37901 "have a program which handles the Windows Service Control Protocol directly "
37902 "or you want to run any program using a service wrapper like SrvAny or the "
37907 #: ../tools/virt-win-reg.pl:678
37909 "First upload the program and optionally the service wrapper. In this case "
37910 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
37914 #: ../tools/virt-win-reg.pl:682
37917 " guestfish -i -d WindowsGuest <<EOF\n"
37918 " upload rhsrvany.exe /rhsrvany.exe\n"
37919 " upload test.exe /test.exe\n"
37925 #: ../tools/virt-win-reg.pl:687
37927 "Prepare a regedit file containing the registry changes. In this example, "
37928 "the first registry change is needed for the service itself or the service "
37929 "wrapper (if used). The second registry change is only needed because I am "
37930 "using the RHSrvAny service wrapper."
37934 #: ../tools/virt-win-reg.pl:692
37937 " cat > service.reg <<'EOF'\n"
37938 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
37939 " \"Type\"=dword:00000010\n"
37940 " \"Start\"=dword:00000002\n"
37941 " \"ErrorControl\"=dword:00000001\n"
37942 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
37943 " \"DisplayName\"=\"RHSrvAny\"\n"
37944 " \"ObjectName\"=\"NetworkService\"\n"
37949 #: ../tools/virt-win-reg.pl:701
37952 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
37953 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
37954 " \"PWD\"=\"c:\\\\Temp\"\n"
37960 #: ../tools/virt-win-reg.pl:712
37962 "For use of C<ControlSet001> see the section above in this manual page. You "
37963 "may need to adjust this according to the control set that is in use by the "
37968 #: ../tools/virt-win-reg.pl:718
37970 "C<\"ObjectName\"> controls the privileges that the service will have. An "
37971 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
37972 "privileged account."
37976 #: ../tools/virt-win-reg.pl:724
37978 "For the meaning of the magic numbers, see this Microsoft KB article: "
37979 "L<http://support.microsoft.com/kb/103000>."
37983 #: ../tools/virt-win-reg.pl:729
37984 msgid "Update the registry:"
37988 #: ../tools/virt-win-reg.pl:731
37991 " virt-win-reg --merge WindowsGuest service.reg\n"
37996 #: ../tools/virt-win-reg.pl:735
37998 "Be careful when passing parameters containing C<\\> (backslash) in the "
37999 "shell. Usually you will have to use 'single quotes' or double backslashes "
38000 "(but not both) to protect them from the shell."
38004 #: ../tools/virt-win-reg.pl:739
38005 msgid "Paths and value names are case-insensitive."
38009 #: ../tools/virt-win-reg.pl:748
38011 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
38012 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
38013 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
38017 #: ../tools/virt-win-reg.pl:766
38020 " export LIBGUESTFS_DEBUG=1\n"
38021 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
38026 #: ../tools/virt-win-reg.pl:769
38028 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."