1 # SOME DESCRIPTIVE TITLE.
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: PACKAGE VERSION\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2010-11-12 22:55+0000\n"
11 "PO-Revision-Date: 2010-09-02 14:46+0100\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: ../src/guestfs.pod:1 ../fish/guestfish.pod:1
21 #: ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1
22 #: ../inspector/virt-inspector.pl:31 ../tools/virt-edit.pl:30
23 #: ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:30
24 #: ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28
25 #: ../tools/virt-tar.pl:29 ../tools/virt-rescue.pl:29
26 #: ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28
31 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
32 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
33 #: ../inspector/virt-inspector.pl:33 ../tools/virt-edit.pl:32
34 #: ../tools/virt-win-reg.pl:35 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:32
35 #: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30
36 #: ../tools/virt-tar.pl:31 ../tools/virt-rescue.pl:31
37 #: ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
42 #: ../src/guestfs.pod:5
43 msgid "guestfs - Library for accessing and modifying virtual machine images"
47 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
48 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
49 #: ../inspector/virt-inspector.pl:37 ../tools/virt-edit.pl:36
50 #: ../tools/virt-win-reg.pl:39 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:36
51 #: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34
52 #: ../tools/virt-tar.pl:35 ../tools/virt-rescue.pl:35
53 #: ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
58 #: ../src/guestfs.pod:9
61 " #include <guestfs.h>\n"
66 #: ../src/guestfs.pod:11
69 " guestfs_h *g = guestfs_create ();\n"
70 " guestfs_add_drive (g, \"guest.img\");\n"
71 " guestfs_launch (g);\n"
72 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
73 " guestfs_touch (g, \"/hello\");\n"
74 " guestfs_umount (g, \"/\");\n"
75 " guestfs_sync (g);\n"
76 " guestfs_close (g);\n"
81 #: ../src/guestfs.pod:20
84 " cc prog.c -o prog -lguestfs\n"
86 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
91 #: ../src/guestfs.pod:24 ../fish/guestfish.pod:30
92 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
93 #: ../inspector/virt-inspector.pl:43 ../tools/virt-edit.pl:50
94 #: ../tools/virt-win-reg.pl:63 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:42
95 #: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40
96 #: ../tools/virt-tar.pl:72 ../tools/virt-rescue.pl:51
97 #: ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
102 #: ../src/guestfs.pod:26
104 "Libguestfs is a library for accessing and modifying guest disk images. "
105 "Amongst the things this is good for: making batch configuration changes to "
106 "guests, getting disk used/free statistics (see also: virt-df), migrating "
107 "between virtualization systems (see also: virt-p2v), performing partial "
108 "backups, performing partial guest clones, cloning guests and changing "
109 "registry/UUID/hostname info, and much else besides."
113 #: ../src/guestfs.pod:34
115 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
116 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
117 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
122 #: ../src/guestfs.pod:39
124 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
125 "what filesystem is in each LV, etc.). It can also run commands in the "
126 "context of the guest. Also you can access filesystems over FUSE."
130 #: ../src/guestfs.pod:44
132 "Libguestfs is a library that can be linked with C and C++ management "
133 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
134 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
139 #: ../src/guestfs.pod:49
141 "You don't need to be root to use libguestfs, although obviously you do need "
142 "enough permissions to access the disk images."
146 #: ../src/guestfs.pod:52
148 "Libguestfs is a large API because it can do many things. For a gentle "
149 "introduction, please read the L</API OVERVIEW> section next."
153 #: ../src/guestfs.pod:55
158 #: ../src/guestfs.pod:57
160 "This section provides a gentler overview of the libguestfs API. We also try "
161 "to group API calls together, where that may not be obvious from reading "
162 "about the individual calls in the main section of this manual."
166 #: ../src/guestfs.pod:62
171 #: ../src/guestfs.pod:64
173 "Before you can use libguestfs calls, you have to create a handle. Then you "
174 "must add at least one disk image to the handle, followed by launching the "
175 "handle, then performing whatever operations you want, and finally closing "
176 "the handle. By convention we use the single letter C<g> for the name of the "
177 "handle variable, although of course you can use any name you want."
181 #: ../src/guestfs.pod:71
182 msgid "The general structure of all libguestfs-using programs looks like this:"
186 #: ../src/guestfs.pod:74
189 " guestfs_h *g = guestfs_create ();\n"
194 #: ../src/guestfs.pod:76
197 " /* Call guestfs_add_drive additional times if there are\n"
198 " * multiple disk images.\n"
200 " guestfs_add_drive (g, \"guest.img\");\n"
205 #: ../src/guestfs.pod:81
208 " /* Most manipulation calls won't work until you've launched\n"
209 " * the handle 'g'. You have to do this _after_ adding drives\n"
210 " * and _before_ other commands.\n"
212 " guestfs_launch (g);\n"
217 #: ../src/guestfs.pod:87
220 " /* Now you can examine what partitions, LVs etc are available.\n"
222 " char **partitions = guestfs_list_partitions (g);\n"
223 " char **logvols = guestfs_lvs (g);\n"
228 #: ../src/guestfs.pod:92
231 " /* To access a filesystem in the image, you must mount it.\n"
233 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
238 #: ../src/guestfs.pod:96
241 " /* Now you can perform filesystem actions on the guest\n"
244 " guestfs_touch (g, \"/hello\");\n"
249 #: ../src/guestfs.pod:101
252 " /* You only need to call guestfs_sync if you have made\n"
253 " * changes to the guest image. (But if you've made changes\n"
254 " * then you *must* sync). See also: guestfs_umount and\n"
255 " * guestfs_umount_all calls.\n"
257 " guestfs_sync (g);\n"
262 #: ../src/guestfs.pod:108
265 " /* Close the handle 'g'. */\n"
266 " guestfs_close (g);\n"
271 #: ../src/guestfs.pod:111
273 "The code above doesn't include any error checking. In real code you should "
274 "check return values carefully for errors. In general all functions that "
275 "return integers return C<-1> on error, and all functions that return "
276 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
277 "how to handle errors, and consult the documentation for each function call "
278 "below to see precisely how they return error indications."
282 #: ../src/guestfs.pod:119
287 #: ../src/guestfs.pod:121
289 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
290 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
291 "actual block device, or simply an empty file of zeroes that you have created "
292 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
297 #: ../src/guestfs.pod:127
299 "The call you should use in modern code for adding drives is L</"
300 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
301 "specifying that the format is raw, do:"
305 #: ../src/guestfs.pod:131
308 " guestfs_add_drive_opts (g, filename,\n"
309 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
315 #: ../src/guestfs.pod:135
316 msgid "You can add a disk read-only using:"
320 #: ../src/guestfs.pod:137
323 " guestfs_add_drive_opts (g, filename,\n"
324 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
325 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
331 #: ../src/guestfs.pod:142
333 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
334 "libguestfs won't modify the file."
338 #: ../src/guestfs.pod:145
340 "Be extremely cautious if the disk image is in use, eg. if it is being used "
341 "by a virtual machine. Adding it read-write will almost certainly cause disk "
342 "corruption, but adding it read-only is safe."
346 #: ../src/guestfs.pod:149
348 "You must add at least one disk image, and you may add multiple disk images. "
349 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
350 "first one you added), C</dev/sdb> (for the second one you added), etc."
354 #: ../src/guestfs.pod:154
356 "Once L</guestfs_launch> has been called you cannot add any more images. You "
357 "can call L</guestfs_list_devices> to get a list of the device names, in the "
358 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
362 #: ../src/guestfs.pod:159
367 #: ../src/guestfs.pod:161
369 "Before you can read or write files, create directories and so on in a disk "
370 "image that contains filesystems, you have to mount those filesystems using "
371 "L</guestfs_mount>. If you already know that a disk image contains (for "
372 "example) one partition with a filesystem on that partition, then you can "
377 #: ../src/guestfs.pod:167
380 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
385 #: ../src/guestfs.pod:169
387 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
388 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
389 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
393 #: ../src/guestfs.pod:173
395 "If you are given a disk image and you don't know what it contains then you "
396 "have to find out. Libguestfs can do that too: use L</"
397 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
398 "LVs, and either try mounting each to see what is mountable, or else examine "
399 "them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also has a "
400 "set of APIs for inspection of disk images (see L</INSPECTION> below). But "
401 "you might find it easier to look at higher level programs built on top of "
402 "libguestfs, in particular L<virt-inspector(1)>."
406 #: ../src/guestfs.pod:183
408 "To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
409 "several other variations of the C<guestfs_mount_*> call."
413 #: ../src/guestfs.pod:186
414 msgid "FILESYSTEM ACCESS AND MODIFICATION"
418 #: ../src/guestfs.pod:188
420 "The majority of the libguestfs API consists of fairly low-level calls for "
421 "accessing and modifying the files, directories, symlinks etc on mounted "
422 "filesystems. There are over a hundred such calls which you can find listed "
423 "in detail below in this man page, and we don't even pretend to cover them "
424 "all in this overview."
428 #: ../src/guestfs.pod:194
430 "Specify filenames as full paths, starting with C<\"/\"> and including the "
435 #: ../src/guestfs.pod:197
437 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
438 "the file called C<\"etc/passwd\"> then you could do:"
442 #: ../src/guestfs.pod:200
445 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
450 #: ../src/guestfs.pod:202
452 "This would return C<data> as a newly allocated buffer containing the full "
453 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
454 "or C<NULL> if there was an error."
458 #: ../src/guestfs.pod:206
460 "As another example, to create a top-level directory on that filesystem "
461 "called C<\"var\"> you would do:"
465 #: ../src/guestfs.pod:209
468 " guestfs_mkdir (g, \"/var\");\n"
473 #: ../src/guestfs.pod:211
474 msgid "To create a symlink you could do:"
478 #: ../src/guestfs.pod:213
481 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
482 " \"/etc/rc3.d/S30portmap\");\n"
487 #: ../src/guestfs.pod:216
489 "Libguestfs will reject attempts to use relative paths and there is no "
490 "concept of a current working directory."
494 #: ../src/guestfs.pod:219
496 "Libguestfs can return errors in many situations: for example if the "
497 "filesystem isn't writable, or if a file or directory that you requested "
498 "doesn't exist. If you are using the C API (documented here) you have to "
499 "check for those error conditions after each call. (Other language bindings "
500 "turn these errors into exceptions)."
504 #: ../src/guestfs.pod:225
506 "File writes are affected by the per-handle umask, set by calling L</"
507 "guestfs_umask> and defaulting to 022. See L</UMASK>."
511 #: ../src/guestfs.pod:228
516 #: ../src/guestfs.pod:230
518 "Libguestfs contains API calls to read, create and modify partition tables on "
523 #: ../src/guestfs.pod:233
525 "In the common case where you want to create a single partition covering the "
526 "whole disk, you should use the L</guestfs_part_disk> call:"
530 #: ../src/guestfs.pod:237
533 " const char *parttype = \"mbr\";\n"
534 " if (disk_is_larger_than_2TB)\n"
535 " parttype = \"gpt\";\n"
536 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
541 #: ../src/guestfs.pod:242
543 "Obviously this effectively wipes anything that was on that disk image before."
547 #: ../src/guestfs.pod:245
552 #: ../src/guestfs.pod:247
554 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
555 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
556 "you familiarize yourself with the concepts of physical volumes, volume "
557 "groups and logical volumes."
561 #: ../src/guestfs.pod:252
563 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
564 "tldp.org/HOWTO/LVM-HOWTO/>."
568 #: ../src/guestfs.pod:255
573 #: ../src/guestfs.pod:257
575 "Use L</guestfs_cat> to download small, text only files. This call is "
576 "limited to files which are less than 2 MB and which cannot contain any ASCII "
577 "NUL (C<\\0>) characters. However it has a very simple to use API."
581 #: ../src/guestfs.pod:262
583 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
584 "bit data, since it returns a (pointer, size) pair. However it is still "
585 "limited to \"small\" files, less than 2 MB."
589 #: ../src/guestfs.pod:266
591 "L</guestfs_download> can be used to download any file, with no limits on "
592 "content or size (even files larger than 4 GB)."
596 #: ../src/guestfs.pod:269
598 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
602 #: ../src/guestfs.pod:272
607 #: ../src/guestfs.pod:274
609 "It's often the case that you want to write a file or files to the disk image."
613 #: ../src/guestfs.pod:277
615 "To write a small file with fixed content, use L</guestfs_write>. To create "
616 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
617 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
618 "of other functions for creating test files, for example L</guestfs_fill> and "
619 "L</guestfs_fill_pattern>."
623 #: ../src/guestfs.pod:283
625 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
626 "file content or size (even files larger than 4 GB)."
630 #: ../src/guestfs.pod:286
632 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
636 #: ../src/guestfs.pod:288
638 "However the fastest way to upload I<large numbers of arbitrary files> is to "
639 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
640 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
641 "in a predictable way (eg. adding it last after all other drives) then you "
642 "can get the device name from L</guestfs_list_devices> and mount it directly "
643 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
644 "portable between kernel versions, and they don't support labels or UUIDs. "
645 "If you want to pre-build an image or you need to mount it using a label or "
646 "UUID, use an ISO image instead."
650 #: ../src/guestfs.pod:299
655 #: ../src/guestfs.pod:301
657 "There are various different commands for copying between files and devices "
658 "and in and out of the guest filesystem. These are summarised in the table "
663 #: ../src/guestfs.pod:307
664 msgid "B<file> to B<file>"
668 #: ../src/guestfs.pod:309
670 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
671 "directories recursively."
675 #: ../src/guestfs.pod:312
676 msgid "B<file or device> to B<file or device>"
680 #: ../src/guestfs.pod:314
682 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
683 "devices in the guest."
687 #: ../src/guestfs.pod:317
688 msgid "Example: duplicate the contents of an LV:"
692 #: ../src/guestfs.pod:319
695 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
700 #: ../src/guestfs.pod:321
702 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
703 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
704 "guestfs_copy_size>."
708 #: ../src/guestfs.pod:325
709 msgid "B<file on the host> to B<file or device>"
713 #: ../src/guestfs.pod:327
714 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
718 #: ../src/guestfs.pod:329
719 msgid "B<file or device> to B<file on the host>"
723 #: ../src/guestfs.pod:331
724 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
728 #: ../src/guestfs.pod:335
729 msgid "LISTING FILES"
733 #: ../src/guestfs.pod:337
735 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
736 "L<guestfish(1)>-equivalent command C<ll>)."
740 #: ../src/guestfs.pod:340
742 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
743 "programs, as a flat list of strings."
747 #: ../src/guestfs.pod:343
749 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
750 "directory, plus additional information about each one. It is more "
751 "equivalent to using the L<readdir(3)> call on a local filesystem."
755 #: ../src/guestfs.pod:347
757 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
761 #: ../src/guestfs.pod:350
762 msgid "RUNNING COMMANDS"
766 #: ../src/guestfs.pod:352
768 "Although libguestfs is primarily an API for manipulating files inside guest "
769 "images, we also provide some limited facilities for running commands inside "
774 #: ../src/guestfs.pod:356
775 msgid "There are many limitations to this:"
779 #: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370
780 #: ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383
781 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:1224
782 #: ../src/guestfs.pod:1229 ../src/guestfs.pod:1233 ../src/guestfs.pod:1449
783 #: ../src/guestfs.pod:1454 ../src/guestfs.pod:1458 ../src/guestfs.pod:1560
784 #: ../src/guestfs.pod:1564 ../src/guestfs.pod:1568 ../src/guestfs.pod:1573
785 #: ../src/guestfs.pod:1581 ../src/guestfs.pod:1600 ../src/guestfs.pod:1608
786 #: ../src/guestfs.pod:1838 ../src/guestfs.pod:1844 ../src/guestfs.pod:1849
787 #: ../src/guestfs.pod:1855 ../src/guestfs.pod:1962 ../src/guestfs.pod:1966
788 #: ../src/guestfs.pod:1970 ../src/guestfs.pod:1974
789 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
790 #: ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577
791 #: ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591
792 #: ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591
793 #: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599
794 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611
795 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625
796 #: ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633
797 #: ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775
798 #: ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785
799 #: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850
800 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:376
801 #: ../fish/guestfish.pod:380 ../fish/guestfish.pod:384
802 #: ../fish/guestfish.pod:388 ../fish/guestfish-actions.pod:13
803 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:375
804 #: ../fish/guestfish-actions.pod:383 ../fish/guestfish-actions.pod:390
805 #: ../fish/guestfish-actions.pod:397 ../fish/guestfish-actions.pod:1067
806 #: ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075
807 #: ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087
808 #: ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095
809 #: ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109
810 #: ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203
811 #: ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212
812 #: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259
813 #: ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268
814 #: ../inspector/virt-inspector.pl:550 ../inspector/virt-inspector.pl:554
815 #: ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348
816 #: ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363
821 #: ../src/guestfs.pod:362
823 "The kernel version that the command runs under will be different from what "
828 #: ../src/guestfs.pod:367
830 "If the command needs to communicate with daemons, then most likely they "
835 #: ../src/guestfs.pod:372
836 msgid "The command will be running in limited memory."
840 #: ../src/guestfs.pod:376
842 "The network may not be available unless you enable it (see L</"
843 "guestfs_set_network>)."
847 #: ../src/guestfs.pod:381
848 msgid "Only supports Linux guests (not Windows, BSD, etc)."
852 #: ../src/guestfs.pod:385
854 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
858 #: ../src/guestfs.pod:390
860 "For SELinux guests, you may need to enable SELinux and load policy first. "
861 "See L</SELINUX> in this manpage."
865 #: ../src/guestfs.pod:395
867 "I<Security:> It is not safe to run commands from untrusted, possibly "
868 "malicious guests. These commands may attempt to exploit your program by "
869 "sending unexpected output. They could also try to exploit the Linux kernel "
870 "or qemu provided by the libguestfs appliance. They could use the network "
871 "provided by the libguestfs appliance to bypass ordinary network partitions "
872 "and firewalls. They could use the elevated privileges or different SELinux "
873 "context of your program to their advantage."
877 #: ../src/guestfs.pod:404
879 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
880 "(a script which runs when the guest next boots normally), and to have this "
881 "script run the commands you want in the normal context of the running guest, "
882 "network security and so on."
886 #: ../src/guestfs.pod:411
888 "The two main API calls to run commands are L</guestfs_command> and L</"
889 "guestfs_sh> (there are also variations)."
893 #: ../src/guestfs.pod:414
895 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
896 "shell globs, redirections, etc will work."
900 #: ../src/guestfs.pod:417
901 msgid "CONFIGURATION FILES"
905 #: ../src/guestfs.pod:419
907 "To read and write configuration files in Linux guest filesystems, we "
908 "strongly recommend using Augeas. For example, Augeas understands how to "
909 "read and write, say, a Linux shadow password file or X.org configuration "
910 "file, and so avoids you having to write that code."
914 #: ../src/guestfs.pod:424
916 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
917 "document Augeas itself here because there is excellent documentation on the "
918 "L<http://augeas.net/> website."
922 #: ../src/guestfs.pod:428
924 "If you don't want to use Augeas (you fool!) then try calling L</"
925 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
930 #: ../src/guestfs.pod:432
935 #: ../src/guestfs.pod:434
937 "We support SELinux guests. To ensure that labeling happens correctly in "
938 "SELinux guests, you need to enable SELinux and load the guest's policy:"
942 #: ../src/guestfs.pod:440 ../src/guestfs.pod:953
947 #: ../src/guestfs.pod:442
948 msgid "Before launching, do:"
952 #: ../src/guestfs.pod:444
955 " guestfs_set_selinux (g, 1);\n"
960 #: ../src/guestfs.pod:446 ../src/guestfs.pod:957
965 #: ../src/guestfs.pod:448
967 "After mounting the guest's filesystem(s), load the policy. This is best "
968 "done by running the L<load_policy(8)> command in the guest itself:"
972 #: ../src/guestfs.pod:452
975 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
980 #: ../src/guestfs.pod:454
982 "(Older versions of C<load_policy> require you to specify the name of the "
987 #: ../src/guestfs.pod:457 ../src/guestfs.pod:963
992 #: ../src/guestfs.pod:459
994 "Optionally, set the security context for the API. The correct security "
995 "context to use can only be known by inspecting the guest. As an example:"
999 #: ../src/guestfs.pod:463
1002 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1007 #: ../src/guestfs.pod:467
1008 msgid "This will work for running commands and editing existing files."
1012 #: ../src/guestfs.pod:469
1014 "When new files are created, you may need to label them explicitly, for "
1015 "example by running the external command C<restorecon pathname>."
1019 #: ../src/guestfs.pod:473
1024 #: ../src/guestfs.pod:475
1026 "Certain calls are affected by the current file mode creation mask (the "
1027 "\"umask\"). In particular ones which create files or directories, such as "
1028 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1029 "either the default mode that the file is created with or modifies the mode "
1034 #: ../src/guestfs.pod:481
1036 "The default umask is C<022>, so files are created with modes such as C<0644> "
1037 "and directories with C<0755>."
1041 #: ../src/guestfs.pod:484
1043 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1044 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1045 "guestfs_chmod> after creating each file or directory."
1049 #: ../src/guestfs.pod:488
1050 msgid "For more information about umask, see L<umask(2)>."
1054 #: ../src/guestfs.pod:490 ../fish/guestfish.pod:669
1055 msgid "ENCRYPTED DISKS"
1059 #: ../src/guestfs.pod:492
1061 "Libguestfs allows you to access Linux guests which have been encrypted using "
1062 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1063 "standard. This includes nearly all whole disk encryption systems used by "
1064 "modern Linux guests."
1068 #: ../src/guestfs.pod:498
1070 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1071 "returns the string C<crypto_LUKS>)."
1075 #: ../src/guestfs.pod:501
1077 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1078 "will require the passphrase!"
1082 #: ../src/guestfs.pod:504
1084 "Opening a LUKS device creates a new device mapper device called C</dev/"
1085 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1086 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1087 "from and encrypted to the underlying block device respectively."
1091 #: ../src/guestfs.pod:510
1093 "LVM volume groups on the device can be made visible by calling L</"
1094 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1095 "(s) can now be mounted in the usual way."
1099 #: ../src/guestfs.pod:514
1101 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1102 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1103 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1104 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1105 "underlying encrypted block device)."
1109 #: ../src/guestfs.pod:521
1114 #: ../src/guestfs.pod:523
1116 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1117 "contains operating systems. (These APIs used to be in a separate Perl-only "
1118 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1119 "frequently used part of this library has been rewritten in C and moved into "
1124 #: ../src/guestfs.pod:529
1126 "Add all disks belonging to the unknown virtual machine and call L</"
1127 "guestfs_launch> in the usual way."
1131 #: ../src/guestfs.pod:532
1133 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1134 "and certain heuristics, and returns a list of operating systems that were "
1135 "found. An empty list means none were found. A single element is the root "
1136 "filesystem of the operating system. For dual- or multi-boot guests, "
1137 "multiple roots can be returned, each one corresponding to a separate "
1138 "operating system. (Multi-boot virtual machines are extremely rare in the "
1139 "world of virtualization, but since this scenario can happen, we have built "
1140 "libguestfs to deal with it.)"
1144 #: ../src/guestfs.pod:541
1146 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1147 "to get additional details about that operating system. For example, call L</"
1148 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1149 "Windows and Linux-based operating systems respectively."
1153 #: ../src/guestfs.pod:547
1155 "Un*x-like and Linux-based operating systems usually consist of several "
1156 "filesystems which are mounted at boot time (for example, a separate boot "
1157 "partition mounted on C</boot>). The inspection rules are able to detect how "
1158 "filesystems correspond to mount points. Call "
1159 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1160 "hash table like this example:"
1164 #: ../src/guestfs.pod:554
1167 " /boot => /dev/sda1\n"
1168 " / => /dev/vg_guest/lv_root\n"
1169 " /usr => /dev/vg_guest/lv_usr\n"
1174 #: ../src/guestfs.pod:558
1176 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1177 "filesystems as suggested."
1181 #: ../src/guestfs.pod:561
1183 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1184 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1188 #: ../src/guestfs.pod:565
1190 "Inspection currently only works for some common operating systems. "
1191 "Contributors are welcome to send patches for other operating systems that we "
1192 "currently cannot detect."
1196 #: ../src/guestfs.pod:569
1198 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1199 "for more details. The L</guestfs_inspect_os> function just ignores any "
1200 "encrypted devices."
1204 #: ../src/guestfs.pod:573
1206 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1207 "inspection and caches the results in the guest handle. Subsequent calls to "
1208 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1209 "read the disks. If you change the content of the guest disks, you can redo "
1210 "inspection by calling L</guestfs_inspect_os> again."
1214 #: ../src/guestfs.pod:580
1215 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1219 #: ../src/guestfs.pod:582
1221 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1222 "ntfs-3g.org/> driver."
1226 #: ../src/guestfs.pod:585
1228 "DOS and Windows still use drive letters, and the filesystems are always "
1229 "treated as case insensitive by Windows itself, and therefore you might find "
1230 "a Windows configuration file referring to a path like C<c:\\windows"
1231 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1232 "might be referred to as C</WINDOWS/System32>."
1236 #: ../src/guestfs.pod:591
1238 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1239 "libguestfs to read the appropriate Windows Registry and configuration files, "
1240 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1245 #: ../src/guestfs.pod:596
1247 "Replacing backslash characters with forward slash characters is also outside "
1248 "the scope of libguestfs, but something that you can easily do."
1252 #: ../src/guestfs.pod:599
1254 "Where we can help is in resolving the case insensitivity of paths. For "
1255 "this, call L</guestfs_case_sensitive_path>."
1259 #: ../src/guestfs.pod:602
1261 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1262 "files, through the library C<hivex> which is part of the libguestfs project "
1263 "although ships as a separate tarball. You have to locate and download the "
1264 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1265 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1266 "reg(1)> for more help on this issue."
1270 #: ../src/guestfs.pod:610
1271 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1275 #: ../src/guestfs.pod:612
1277 "Although we don't want to discourage you from using the C API, we will "
1278 "mention here that the same API is also available in other languages."
1282 #: ../src/guestfs.pod:615
1284 "The API is broadly identical in all supported languages. This means that "
1285 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, C<g."
1286 "mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1287 "words, a straightforward, predictable isomorphism between each language."
1291 #: ../src/guestfs.pod:621
1293 "Error messages are automatically transformed into exceptions if the language "
1298 #: ../src/guestfs.pod:624
1300 "We don't try to \"object orientify\" parts of the API in OO languages, "
1301 "although contributors are welcome to write higher level APIs above what we "
1302 "provide in their favourite languages if they wish."
1306 #: ../src/guestfs.pod:630
1311 #: ../src/guestfs.pod:632
1313 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1314 "identical to the C API. C++ classes and exceptions are not used."
1318 #: ../src/guestfs.pod:636
1323 #: ../src/guestfs.pod:638
1325 "The C# bindings are highly experimental. Please read the warnings at the "
1326 "top of C<csharp/Libguestfs.cs>."
1330 #: ../src/guestfs.pod:641
1335 #: ../src/guestfs.pod:643
1337 "This is the only language binding that is working but incomplete. Only "
1338 "calls which return simple integers have been bound in Haskell, and we are "
1339 "looking for help to complete this binding."
1343 #: ../src/guestfs.pod:647
1348 #: ../src/guestfs.pod:649
1350 "Full documentation is contained in the Javadoc which is distributed with "
1355 #: ../src/guestfs.pod:652
1360 #: ../src/guestfs.pod:654
1361 msgid "For documentation see the file C<guestfs.mli>."
1365 #: ../src/guestfs.pod:656
1370 #: ../src/guestfs.pod:658
1371 msgid "For documentation see L<Sys::Guestfs(3)>."
1375 #: ../src/guestfs.pod:660
1380 #: ../src/guestfs.pod:662
1382 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1383 "the php-libguestfs package for your distribution."
1387 #: ../src/guestfs.pod:665
1388 msgid "The PHP binding only works correctly on 64 bit machines."
1392 #: ../src/guestfs.pod:667
1397 #: ../src/guestfs.pod:669
1398 msgid "For documentation do:"
1402 #: ../src/guestfs.pod:671
1406 " >>> import guestfs\n"
1407 " >>> help (guestfs)\n"
1412 #: ../src/guestfs.pod:675
1417 #: ../src/guestfs.pod:677
1419 "Use the Guestfs module. There is no Ruby-specific documentation, but you "
1420 "can find examples written in Ruby in the libguestfs source."
1424 #: ../src/guestfs.pod:680
1425 msgid "B<shell scripts>"
1429 #: ../src/guestfs.pod:682
1430 msgid "For documentation see L<guestfish(1)>."
1434 #: ../src/guestfs.pod:686
1435 msgid "LIBGUESTFS GOTCHAS"
1439 #: ../src/guestfs.pod:688
1441 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1442 "system [...] that works in the way it is documented but is counterintuitive "
1443 "and almost invites mistakes.\""
1447 #: ../src/guestfs.pod:692
1449 "Since we developed libguestfs and the associated tools, there are several "
1450 "things we would have designed differently, but are now stuck with for "
1451 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1452 "release, you can expect these to change. Beware of them."
1456 #: ../src/guestfs.pod:700
1457 msgid "Autosync / forgetting to sync."
1461 #: ../src/guestfs.pod:702
1463 "When modifying a filesystem from C or another language, you B<must> unmount "
1464 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1465 "libguestfs handle. You can also call:"
1469 #: ../src/guestfs.pod:706
1472 " guestfs_set_autosync (g, 1);\n"
1477 #: ../src/guestfs.pod:708
1479 "to have the unmount/sync done automatically for you when the handle 'g' is "
1480 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1484 #: ../src/guestfs.pod:712
1486 "If you forget to do this, then it is entirely possible that your changes "
1487 "won't be written out, or will be partially written, or (very rarely) that "
1488 "you'll get disk corruption."
1492 #: ../src/guestfs.pod:716
1494 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1495 "guestfish scripts that forget to sync will work just fine, which can make "
1496 "this very puzzling if you are trying to debug a problem."
1500 #: ../src/guestfs.pod:720
1502 "Update: Autosync is enabled by default for all API users starting from "
1503 "libguestfs 1.5.24."
1507 #: ../src/guestfs.pod:723
1508 msgid "Mount option C<-o sync> should not be the default."
1512 #: ../src/guestfs.pod:725
1514 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1515 "However C<-o sync> does not add any reliability benefit, but does have a "
1516 "very large performance impact."
1520 #: ../src/guestfs.pod:729
1522 "The work around is to use L</guestfs_mount_options> and set the mount "
1523 "options that you actually want to use."
1527 #: ../src/guestfs.pod:732
1528 msgid "Read-only should be the default."
1532 #: ../src/guestfs.pod:734
1534 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1535 "specify I<--rw> if you want to make changes to the image."
1539 #: ../src/guestfs.pod:737
1540 msgid "This would reduce the potential to corrupt live VM images."
1544 #: ../src/guestfs.pod:739
1546 "Note that many filesystems change the disk when you just mount and unmount, "
1547 "even if you didn't perform any writes. You need to use L</"
1548 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1552 #: ../src/guestfs.pod:743
1553 msgid "guestfish command line is hard to use."
1557 #: ../src/guestfs.pod:745
1559 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1560 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1561 "exist, so it fails. In earlier versions of guestfish the error message was "
1562 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1563 "we should have used C<guestfish -c command> to run commands."
1567 #: ../src/guestfs.pod:752
1568 msgid "guestfish megabyte modifiers don't work right on all commands"
1572 #: ../src/guestfs.pod:754
1574 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1575 "other modifiers). What guestfish actually does is to multiply the number "
1576 "part by the modifier part and pass the result to the C API. However this "
1577 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1578 "expecting some other unit (eg. megabytes)."
1582 #: ../src/guestfs.pod:761
1583 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1587 #: ../src/guestfs.pod:763
1590 " lvcreate LV VG 100M\n"
1595 #: ../src/guestfs.pod:765
1597 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1598 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1599 "megabytes * megabytes) logical volume. The error message you get from this "
1600 "is also a little obscure."
1604 #: ../src/guestfs.pod:770
1606 "This could be fixed in the generator by specially marking parameters and "
1607 "return values which take bytes or other units."
1611 #: ../src/guestfs.pod:773
1612 msgid "Ambiguity between devices and paths"
1616 #: ../src/guestfs.pod:775
1618 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1619 "sdb2>) and a similar pathname. A file might just happen to be called "
1620 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1624 #: ../src/guestfs.pod:780
1626 "In the current API we usually resolve this ambiguity by having two separate "
1627 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1628 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1629 "detecting if the path supplied begins with C</dev/>."
1633 #: ../src/guestfs.pod:786
1635 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1636 "make paths/devices into structured names. One way to do this would be to "
1637 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1638 "aspect of grub. Another way would be to use a structured type, equivalent "
1639 "to this OCaml type:"
1643 #: ../src/guestfs.pod:792
1646 " type path = Path of string | Device of int | Partition of int * int\n"
1651 #: ../src/guestfs.pod:794
1652 msgid "which would allow you to pass arguments like:"
1656 #: ../src/guestfs.pod:796
1659 " Path \"/foo/bar\"\n"
1660 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1661 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1662 " Path \"/dev/sdb2\" (* not a device *)\n"
1667 #: ../src/guestfs.pod:801
1669 "As you can see there are still problems to resolve even with this "
1670 "representation. Also consider how it might work in guestfish."
1674 #: ../src/guestfs.pod:806
1675 msgid "PROTOCOL LIMITS"
1679 #: ../src/guestfs.pod:808
1681 "Internally libguestfs uses a message-based protocol to pass API calls and "
1682 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1683 "plenty more detail about this). The maximum message size used by the "
1684 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1685 "aware of this limit. The API calls which may be affected are individually "
1686 "documented, with a link back to this section of the documentation."
1690 #: ../src/guestfs.pod:816
1692 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1693 "a simple string. Because this string is at some point internally encoded as "
1694 "a message, the maximum size that it can return is slightly under 4 MB. If "
1695 "the requested file is larger than this then you will get an error."
1699 #: ../src/guestfs.pod:822
1701 "In order to transfer large files into and out of the guest filesystem, you "
1702 "need to use particular calls that support this. The sections L</UPLOADING> "
1703 "and L</DOWNLOADING> document how to do this."
1707 #: ../src/guestfs.pod:826
1709 "You might also consider mounting the disk image using our FUSE filesystem "
1710 "support (L<guestmount(1)>)."
1714 #: ../src/guestfs.pod:829
1715 msgid "KEYS AND PASSPHRASES"
1719 #: ../src/guestfs.pod:831
1721 "Certain libguestfs calls take a parameter that contains sensitive key "
1722 "material, passed in as a C string."
1726 #: ../src/guestfs.pod:834
1728 "In the future we would hope to change the libguestfs implementation so that "
1729 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1730 "swap. However this is I<not> done at the moment, because of the complexity "
1731 "of such an implementation."
1735 #: ../src/guestfs.pod:839
1737 "Therefore you should be aware that any key parameter you pass to libguestfs "
1738 "might end up being written out to the swap partition. If this is a concern, "
1739 "scrub the swap partition or don't use libguestfs on encrypted devices."
1743 #: ../src/guestfs.pod:844
1744 msgid "CONNECTION MANAGEMENT"
1748 #: ../src/guestfs.pod:846
1753 #: ../src/guestfs.pod:848
1755 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
1756 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
1757 "handle and release all resources used."
1761 #: ../src/guestfs.pod:852
1763 "For information on using multiple handles and threads, see the section L</"
1764 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
1768 #: ../src/guestfs.pod:855
1769 msgid "guestfs_create"
1773 #: ../src/guestfs.pod:857
1776 " guestfs_h *guestfs_create (void);\n"
1781 #: ../src/guestfs.pod:859
1782 msgid "Create a connection handle."
1786 #: ../src/guestfs.pod:861
1788 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
1789 "on the handle at least once."
1793 #: ../src/guestfs.pod:864
1795 "This function returns a non-NULL pointer to a handle on success or NULL on "
1800 #: ../src/guestfs.pod:867
1801 msgid "After configuring the handle, you have to call L</guestfs_launch>."
1805 #: ../src/guestfs.pod:869
1807 "You may also want to configure error handling for the handle. See L</ERROR "
1808 "HANDLING> section below."
1812 #: ../src/guestfs.pod:872
1813 msgid "guestfs_close"
1817 #: ../src/guestfs.pod:874
1820 " void guestfs_close (guestfs_h *g);\n"
1825 #: ../src/guestfs.pod:876
1826 msgid "This closes the connection handle and frees up all resources used."
1830 #: ../src/guestfs.pod:878
1831 msgid "ERROR HANDLING"
1835 #: ../src/guestfs.pod:880
1837 "API functions can return errors. For example, almost all functions that "
1838 "return C<int> will return C<-1> to indicate an error."
1842 #: ../src/guestfs.pod:883
1844 "Additional information is available for errors: an error message string and "
1845 "optionally an error number (errno) if the thing that failed was a system "
1850 #: ../src/guestfs.pod:887
1852 "You can get at the additional information about the last error on the handle "
1853 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
1854 "up an error handler with L</guestfs_set_error_handler>."
1858 #: ../src/guestfs.pod:892
1860 "When the handle is created, a default error handler is installed which "
1861 "prints the error message string to C<stderr>. For small short-running "
1862 "command line programs it is sufficient to do:"
1866 #: ../src/guestfs.pod:896
1869 " if (guestfs_launch (g) == -1)\n"
1870 " exit (EXIT_FAILURE);\n"
1875 #: ../src/guestfs.pod:899
1877 "since the default error handler will ensure that an error message has been "
1878 "printed to C<stderr> before the program exits."
1882 #: ../src/guestfs.pod:902
1884 "For other programs the caller will almost certainly want to install an "
1885 "alternate error handler or do error handling in-line like this:"
1889 #: ../src/guestfs.pod:905
1892 " g = guestfs_create ();\n"
1897 #: ../src/guestfs.pod:907
1900 " /* This disables the default behaviour of printing errors\n"
1902 " guestfs_set_error_handler (g, NULL, NULL);\n"
1907 #: ../src/guestfs.pod:911
1910 " if (guestfs_launch (g) == -1) {\n"
1911 " /* Examine the error message and print it etc. */\n"
1912 " char *msg = guestfs_last_error (g);\n"
1913 " int errnum = guestfs_last_errno (g);\n"
1914 " fprintf (stderr, \"%s\\n\", msg);\n"
1921 #: ../src/guestfs.pod:919
1923 "Out of memory errors are handled differently. The default action is to call "
1924 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
1925 "guestfs_set_out_of_memory_handler>."
1929 #: ../src/guestfs.pod:923
1931 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
1932 "because there is no handle if this happens there is no way to get additional "
1933 "error information. However L</guestfs_create> is supposed to be a "
1934 "lightweight operation which can only fail because of insufficient memory (it "
1935 "returns NULL in this case)."
1939 #: ../src/guestfs.pod:929
1940 msgid "guestfs_last_error"
1944 #: ../src/guestfs.pod:931
1947 " const char *guestfs_last_error (guestfs_h *g);\n"
1952 #: ../src/guestfs.pod:933
1954 "This returns the last error message that happened on C<g>. If there has not "
1955 "been an error since the handle was created, then this returns C<NULL>."
1959 #: ../src/guestfs.pod:937
1961 "The lifetime of the returned string is until the next error occurs, or L</"
1962 "guestfs_close> is called."
1966 #: ../src/guestfs.pod:940
1967 msgid "guestfs_last_errno"
1971 #: ../src/guestfs.pod:942
1974 " int guestfs_last_errno (guestfs_h *g);\n"
1979 #: ../src/guestfs.pod:944
1980 msgid "This returns the last error number (errno) that happened on C<g>."
1984 #: ../src/guestfs.pod:946
1985 msgid "If successful, an errno integer not equal to zero is returned."
1989 #: ../src/guestfs.pod:948
1991 "If no error, this returns 0. This call can return 0 in three situations:"
1995 #: ../src/guestfs.pod:955
1996 msgid "There has not been any error on the handle."
2000 #: ../src/guestfs.pod:959
2002 "There has been an error but the errno was meaningless. This corresponds to "
2003 "the case where the error did not come from a failed system call, but for "
2004 "some other reason."
2008 #: ../src/guestfs.pod:965
2010 "There was an error from a failed system call, but for some reason the errno "
2011 "was not captured and returned. This usually indicates a bug in libguestfs."
2015 #: ../src/guestfs.pod:971
2017 "Libguestfs tries to convert the errno from inside the applicance into a "
2018 "corresponding errno for the caller (not entirely trivial: the appliance "
2019 "might be running a completely different operating system from the library "
2020 "and error numbers are not standardized across Un*xen). If this could not be "
2021 "done, then the error is translated to C<EINVAL>. In practice this should "
2022 "only happen in very rare circumstances."
2026 #: ../src/guestfs.pod:979
2027 msgid "guestfs_set_error_handler"
2031 #: ../src/guestfs.pod:981
2034 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2036 " const char *msg);\n"
2037 " void guestfs_set_error_handler (guestfs_h *g,\n"
2038 " guestfs_error_handler_cb cb,\n"
2044 #: ../src/guestfs.pod:988
2046 "The callback C<cb> will be called if there is an error. The parameters "
2047 "passed to the callback are an opaque data pointer and the error message "
2052 #: ../src/guestfs.pod:992
2054 "C<errno> is not passed to the callback. To get that the callback must call "
2055 "L</guestfs_last_errno>."
2059 #: ../src/guestfs.pod:995
2061 "Note that the message string C<msg> is freed as soon as the callback "
2062 "function returns, so if you want to stash it somewhere you must make your "
2067 #: ../src/guestfs.pod:999
2068 msgid "The default handler prints messages on C<stderr>."
2072 #: ../src/guestfs.pod:1001
2073 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2077 #: ../src/guestfs.pod:1003
2078 msgid "guestfs_get_error_handler"
2082 #: ../src/guestfs.pod:1005
2085 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2086 " void **opaque_rtn);\n"
2091 #: ../src/guestfs.pod:1008
2092 msgid "Returns the current error handler callback."
2096 #: ../src/guestfs.pod:1010
2097 msgid "guestfs_set_out_of_memory_handler"
2101 #: ../src/guestfs.pod:1012
2104 " typedef void (*guestfs_abort_cb) (void);\n"
2105 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2106 " guestfs_abort_cb);\n"
2111 #: ../src/guestfs.pod:1016
2113 "The callback C<cb> will be called if there is an out of memory situation. "
2114 "I<Note this callback must not return>."
2118 #: ../src/guestfs.pod:1019
2119 msgid "The default is to call L<abort(3)>."
2123 #: ../src/guestfs.pod:1021
2125 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2129 #: ../src/guestfs.pod:1024
2130 msgid "guestfs_get_out_of_memory_handler"
2134 #: ../src/guestfs.pod:1026
2137 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2142 #: ../src/guestfs.pod:1028
2143 msgid "This returns the current out of memory handler."
2147 #: ../src/guestfs.pod:1030
2152 #: ../src/guestfs.pod:1032
2154 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
2159 #: ../src/guestfs.pod:1035
2161 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2162 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2166 #: ../src/guestfs.pod:1038
2168 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2169 "to change the directories that libguestfs will search in. The value is a "
2170 "colon-separated list of paths. The current directory is I<not> searched "
2171 "unless the path contains an empty element or C<.>. For example "
2172 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2173 "then C</usr/lib/guestfs>."
2177 #: ../src/guestfs.pod:1045
2178 msgid "HIGH-LEVEL API ACTIONS"
2182 #: ../src/guestfs.pod:1047
2183 msgid "ABI GUARANTEE"
2187 #: ../src/guestfs.pod:1049
2189 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2190 "actions as outlined in this section. Although we will deprecate some "
2191 "actions, for example if they get replaced by newer calls, we will keep the "
2192 "old actions forever. This allows you the developer to program in confidence "
2193 "against the libguestfs API."
2197 #: ../src/guestfs.pod:1055 ../fish/guestfish.pod:907
2202 #: ../src/guestfs.pod:1057
2207 #: ../src/guestfs.pod:1059
2212 #: ../src/guestfs.pod:1061
2213 msgid "AVAILABILITY"
2217 #: ../src/guestfs.pod:1063
2218 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2222 #: ../src/guestfs.pod:1065
2224 "Using L</guestfs_available> you can test availability of the following "
2225 "groups of functions. This test queries the appliance to see if the "
2226 "appliance you are currently using supports the functionality."
2230 #: ../src/guestfs.pod:1070
2231 msgid "@AVAILABILITY@"
2235 #: ../src/guestfs.pod:1072
2236 msgid "GUESTFISH supported COMMAND"
2240 #: ../src/guestfs.pod:1074
2242 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2243 "prints out the available groups and whether they are supported by this build "
2244 "of libguestfs. Note however that you have to do C<run> first."
2248 #: ../src/guestfs.pod:1079
2249 msgid "SINGLE CALLS AT COMPILE TIME"
2253 #: ../src/guestfs.pod:1081
2255 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2256 "function, such as:"
2260 #: ../src/guestfs.pod:1084
2263 " #define LIBGUESTFS_HAVE_DD 1\n"
2268 #: ../src/guestfs.pod:1086
2269 msgid "if L</guestfs_dd> is available."
2273 #: ../src/guestfs.pod:1088
2275 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2276 "function is available at compile time, we recommended using build tools such "
2277 "as autoconf or cmake. For example in autotools you could use:"
2281 #: ../src/guestfs.pod:1093
2284 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2285 " AC_CHECK_FUNCS([guestfs_dd])\n"
2290 #: ../src/guestfs.pod:1096
2292 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2297 #: ../src/guestfs.pod:1099
2298 msgid "SINGLE CALLS AT RUN TIME"
2302 #: ../src/guestfs.pod:1101
2304 "Testing at compile time doesn't guarantee that a function really exists in "
2305 "the library. The reason is that you might be dynamically linked against a "
2306 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2307 "This situation unfortunately results in a segmentation fault, which is a "
2308 "shortcoming of the C dynamic linking system itself."
2312 #: ../src/guestfs.pod:1108
2314 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2315 "in this example program (note that you still need the compile time check as "
2320 #: ../src/guestfs.pod:1112
2323 " #include <stdio.h>\n"
2324 " #include <stdlib.h>\n"
2325 " #include <unistd.h>\n"
2326 " #include <dlfcn.h>\n"
2327 " #include <guestfs.h>\n"
2332 #: ../src/guestfs.pod:1118
2337 " #ifdef LIBGUESTFS_HAVE_DD\n"
2339 " int has_function;\n"
2344 #: ../src/guestfs.pod:1124
2347 " /* Test if the function guestfs_dd is really available. */\n"
2348 " dl = dlopen (NULL, RTLD_LAZY);\n"
2350 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2351 " exit (EXIT_FAILURE);\n"
2353 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2359 #: ../src/guestfs.pod:1133
2362 " if (!has_function)\n"
2363 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2365 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2366 " /* Now it's safe to call\n"
2367 " guestfs_dd (g, \"foo\", \"bar\");\n"
2371 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2378 #: ../src/guestfs.pod:1146
2380 "You may think the above is an awful lot of hassle, and it is. There are "
2381 "other ways outside of the C linking system to ensure that this kind of "
2382 "incompatibility never arises, such as using package versioning:"
2386 #: ../src/guestfs.pod:1151
2389 " Requires: libguestfs >= 1.0.80\n"
2394 #: ../src/guestfs.pod:1153
2395 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2399 #: ../src/guestfs.pod:1155
2401 "A recent feature of the API is the introduction of calls which take optional "
2402 "arguments. In C these are declared 3 ways. The main way is as a call which "
2403 "takes variable arguments (ie. C<...>), as in this example:"
2407 #: ../src/guestfs.pod:1160
2410 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2415 #: ../src/guestfs.pod:1162
2417 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2418 "call with no optional arguments specified:"
2422 #: ../src/guestfs.pod:1165
2425 " guestfs_add_drive_opts (g, filename, -1);\n"
2430 #: ../src/guestfs.pod:1167
2431 msgid "With a single optional argument:"
2435 #: ../src/guestfs.pod:1169
2438 " guestfs_add_drive_opts (g, filename,\n"
2439 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2445 #: ../src/guestfs.pod:1173
2450 #: ../src/guestfs.pod:1175
2453 " guestfs_add_drive_opts (g, filename,\n"
2454 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2455 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2461 #: ../src/guestfs.pod:1180
2463 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2468 #: ../src/guestfs.pod:1183
2469 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2473 #: ../src/guestfs.pod:1185
2475 "The second variant has the same name with the suffix C<_va>, which works the "
2476 "same way but takes a C<va_list>. See the C manual for details. For the "
2477 "example function, this is declared:"
2481 #: ../src/guestfs.pod:1189
2484 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2490 #: ../src/guestfs.pod:1192
2491 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2495 #: ../src/guestfs.pod:1194
2497 "The third variant is useful where you need to construct these calls. You "
2498 "pass in a structure where you fill in the optional fields. The structure "
2499 "has a bitmask as the first element which you must set to indicate which "
2500 "fields you have filled in. For our example function the structure and call "
2505 #: ../src/guestfs.pod:1200
2508 " struct guestfs_add_drive_opts_argv {\n"
2509 " uint64_t bitmask;\n"
2511 " const char *format;\n"
2514 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
2515 " const struct guestfs_add_drive_opts_argv *optargs);\n"
2520 #: ../src/guestfs.pod:1209
2521 msgid "You could call it like this:"
2525 #: ../src/guestfs.pod:1211
2528 " struct guestfs_add_drive_opts_argv optargs = {\n"
2529 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
2530 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
2532 " .format = \"qcow2\"\n"
2538 #: ../src/guestfs.pod:1218
2541 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
2546 #: ../src/guestfs.pod:1220 ../src/guestfs-actions.pod:11
2547 #: ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9
2548 #: ../fish/guestfish-actions.pod:1255
2553 #: ../src/guestfs.pod:1226
2554 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
2558 #: ../src/guestfs.pod:1231
2559 msgid "You do not need to fill in all fields of the structure."
2563 #: ../src/guestfs.pod:1235
2565 "There must be a one-to-one correspondence between fields of the structure "
2566 "that are filled in, and bits set in the bitmask."
2570 #: ../src/guestfs.pod:1240
2571 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
2575 #: ../src/guestfs.pod:1242
2577 "In other languages, optional arguments are expressed in the way that is "
2578 "natural for that language. We refer you to the language-specific "
2579 "documentation for more details on that."
2583 #: ../src/guestfs.pod:1246
2584 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
2588 #: ../src/guestfs.pod:1248 ../src/guestfs.pod:1253
2593 #: ../src/guestfs.pod:1250
2595 "<!-- old anchor for the next section --> <a name="
2596 "\"state_machine_and_low_level_event_api\"/>"
2600 #: ../src/guestfs.pod:1255
2601 msgid "ARCHITECTURE"
2605 #: ../src/guestfs.pod:1257
2607 "Internally, libguestfs is implemented by running an appliance (a special "
2608 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
2609 "process of the main program."
2613 #: ../src/guestfs.pod:1261
2616 " ___________________\n"
2618 " | main program |\n"
2620 " | | child process / appliance\n"
2621 " | | __________________________\n"
2623 " +-------------------+ RPC | +-----------------+ |\n"
2624 " | libguestfs <--------------------> guestfsd | |\n"
2625 " | | | +-----------------+ |\n"
2626 " \\___________________/ | | Linux kernel | |\n"
2627 " | +--^--------------+ |\n"
2628 " \\_________|________________/\n"
2634 " \\______________/\n"
2639 #: ../src/guestfs.pod:1281
2641 "The library, linked to the main program, creates the child process and hence "
2642 "the appliance in the L</guestfs_launch> function."
2646 #: ../src/guestfs.pod:1284
2648 "Inside the appliance is a Linux kernel and a complete stack of userspace "
2649 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
2650 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
2651 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
2652 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
2653 "attached to the qemu process which translates device access by the "
2654 "appliance's Linux kernel into accesses to the image."
2658 #: ../src/guestfs.pod:1293
2660 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
2661 "Although the disk image you are attached to might also be used by some "
2662 "virtual machine, libguestfs doesn't know or care about this. (But you will "
2663 "care if both libguestfs's qemu process and your virtual machine are trying "
2664 "to update the disk image at the same time, since these usually results in "
2665 "massive disk corruption)."
2669 #: ../src/guestfs.pod:1300
2670 msgid "STATE MACHINE"
2674 #: ../src/guestfs.pod:1302
2675 msgid "libguestfs uses a state machine to model the child process:"
2679 #: ../src/guestfs.pod:1304
2691 " / | \\ \\ guestfs_launch\n"
2692 " / | _\\__V______\n"
2694 " / | | LAUNCHING |\n"
2695 " / | \\___________/\n"
2697 " / | guestfs_launch\n"
2699 " ______ / __|____V\n"
2700 " / \\ ------> / \\\n"
2701 " | BUSY | | READY |\n"
2702 " \\______/ <------ \\________/\n"
2707 #: ../src/guestfs.pod:1326
2709 "The normal transitions are (1) CONFIG (when the handle is created, but there "
2710 "is no child process), (2) LAUNCHING (when the child process is booting up), "
2711 "(3) alternating between READY and BUSY as commands are issued to, and "
2712 "carried out by, the child process."
2716 #: ../src/guestfs.pod:1331
2718 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
2719 "asynchronously at any time (eg. due to some internal error), and that causes "
2720 "the state to transition back to CONFIG."
2724 #: ../src/guestfs.pod:1335
2726 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
2727 "issued when in the CONFIG state."
2731 #: ../src/guestfs.pod:1338
2733 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
2734 "L</guestfs_launch> blocks until the child process is READY to accept "
2735 "commands (or until some failure or timeout). L</guestfs_launch> internally "
2736 "moves the state from CONFIG to LAUNCHING while it is running."
2740 #: ../src/guestfs.pod:1344
2742 "API actions such as L</guestfs_mount> can only be issued when in the READY "
2743 "state. These API calls block waiting for the command to be carried out (ie. "
2744 "the state to transition to BUSY and then back to READY). There are no non-"
2745 "blocking versions, and no way to issue more than one command per handle at "
2750 #: ../src/guestfs.pod:1350
2752 "Finally, the child process sends asynchronous messages back to the main "
2753 "program, such as kernel log messages. You can register a callback to "
2754 "receive these messages."
2758 #: ../src/guestfs.pod:1354
2759 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
2763 #: ../src/guestfs.pod:1356
2765 "The child process generates events in some situations. Current events "
2766 "include: receiving a log message, the child process exits."
2770 #: ../src/guestfs.pod:1359
2772 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
2777 #: ../src/guestfs.pod:1362
2779 "Only I<one callback of each type> can be registered for each handle. "
2780 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
2781 "that type. Cancel all callbacks of this type by calling this function with "
2782 "C<cb> set to C<NULL>."
2786 #: ../src/guestfs.pod:1367
2787 msgid "guestfs_set_log_message_callback"
2791 #: ../src/guestfs.pod:1369
2794 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
2795 " char *buf, int len);\n"
2796 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
2797 " guestfs_log_message_cb cb,\n"
2803 #: ../src/guestfs.pod:1375
2805 "The callback function C<cb> will be called whenever qemu or the guest writes "
2806 "anything to the console."
2810 #: ../src/guestfs.pod:1378
2811 msgid "Use this function to capture kernel messages and similar."
2815 #: ../src/guestfs.pod:1380
2817 "Normally there is no log message handler, and log messages are just "
2822 #: ../src/guestfs.pod:1383
2823 msgid "guestfs_set_subprocess_quit_callback"
2827 #: ../src/guestfs.pod:1385
2830 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
2831 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
2832 " guestfs_subprocess_quit_cb cb,\n"
2838 #: ../src/guestfs.pod:1390
2840 "The callback function C<cb> will be called when the child process quits, "
2841 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
2842 "corresponds to a transition from any state to the CONFIG state)."
2846 #: ../src/guestfs.pod:1395
2847 msgid "guestfs_set_launch_done_callback"
2851 #: ../src/guestfs.pod:1397
2854 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
2855 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
2856 " guestfs_launch_done_cb cb,\n"
2862 #: ../src/guestfs.pod:1402
2864 "The callback function C<cb> will be called when the child process becomes "
2865 "ready first time after it has been launched. (This corresponds to a "
2866 "transition from LAUNCHING to the READY state)."
2870 #: ../src/guestfs.pod:1406
2871 msgid "guestfs_set_close_callback"
2875 #: ../src/guestfs.pod:1408
2878 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
2879 " void guestfs_set_close_callback (guestfs_h *g,\n"
2880 " guestfs_close_cb cb,\n"
2886 #: ../src/guestfs.pod:1413
2888 "The callback function C<cb> will be called while the handle is being closed "
2889 "(synchronously from L</guestfs_close>)."
2893 #: ../src/guestfs.pod:1416
2895 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
2896 "handles that are open when the program exits. This means that this callback "
2897 "might be called indirectly from L<exit(3)>, which can cause unexpected "
2898 "problems in higher-level languages (eg. if your HLL interpreter has already "
2899 "been cleaned up by the time this is called, and if your callback then jumps "
2900 "into some HLL function)."
2904 #: ../src/guestfs.pod:1424
2905 msgid "guestfs_set_progress_callback"
2909 #: ../src/guestfs.pod:1426
2912 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
2913 " int proc_nr, int serial,\n"
2914 " uint64_t position, uint64_t total);\n"
2915 " void guestfs_set_progress_callback (guestfs_h *g,\n"
2916 " guestfs_progress_cb cb,\n"
2922 #: ../src/guestfs.pod:1433
2924 "Some long-running operations can generate progress messages. If this "
2925 "callback is registered, then it will be called each time a progress message "
2926 "is generated (usually two seconds after the operation started, and three "
2927 "times per second thereafter until it completes, although the frequency may "
2928 "change in future versions)."
2932 #: ../src/guestfs.pod:1439
2934 "The callback receives two numbers: C<position> and C<total>. The units of "
2935 "C<total> are not defined, although for some operations C<total> may relate "
2936 "in some way to the amount of data to be transferred (eg. in bytes or "
2937 "megabytes), and C<position> may be the portion which has been transferred."
2941 #: ../src/guestfs.pod:1445
2942 msgid "The only defined and stable parts of the API are:"
2946 #: ../src/guestfs.pod:1451
2948 "The callback can display to the user some type of progress bar or indicator "
2949 "which shows the ratio of C<position>:C<total>."
2953 #: ../src/guestfs.pod:1456
2954 msgid "0 E<lt>= C<position> E<lt>= C<total>"
2958 #: ../src/guestfs.pod:1460
2960 "If any progress notification is sent during a call, then a final progress "
2961 "notification is always sent when C<position> = C<total>."
2965 #: ../src/guestfs.pod:1463
2967 "This is to simplify caller code, so callers can easily set the progress "
2968 "indicator to \"100%\" at the end of the operation, without requiring special "
2969 "code to detect this case."
2973 #: ../src/guestfs.pod:1469
2975 "The callback also receives the procedure number and serial number of the "
2976 "call. These are only useful for debugging protocol issues, and the callback "
2977 "can normally ignore them. The callback may want to print these numbers in "
2978 "error messages or debugging messages."
2982 #: ../src/guestfs.pod:1474
2983 msgid "PRIVATE DATA AREA"
2987 #: ../src/guestfs.pod:1476
2989 "You can attach named pieces of private data to the libguestfs handle, and "
2990 "fetch them by name for the lifetime of the handle. This is called the "
2991 "private data area and is only available from the C API."
2995 #: ../src/guestfs.pod:1480
2996 msgid "To attach a named piece of data, use the following call:"
3000 #: ../src/guestfs.pod:1482
3003 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3008 #: ../src/guestfs.pod:1484
3010 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3011 "pointer (which can be C<NULL>). Any previous item with the same name is "
3016 #: ../src/guestfs.pod:1488
3018 "You can use any C<key> you want, but names beginning with an underscore "
3019 "character are reserved for internal libguestfs purposes (for implementing "
3020 "language bindings). It is recommended to prefix the name with some unique "
3021 "string to avoid collisions with other users."
3025 #: ../src/guestfs.pod:1493
3026 msgid "To retrieve the pointer, use:"
3030 #: ../src/guestfs.pod:1495
3033 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3038 #: ../src/guestfs.pod:1497
3040 "This function returns C<NULL> if either no data is found associated with "
3041 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3046 #: ../src/guestfs.pod:1501
3048 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3049 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3050 "all. In particular, libguestfs does I<not> try to free the data when the "
3051 "handle is closed. If the data must be freed, then the caller must either "
3052 "free it before calling L</guestfs_close> or must set up a close callback to "
3053 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3054 "can be registered for a handle)."
3058 #: ../src/guestfs.pod:1509
3060 "The private data area is implemented using a hash table, and should be "
3061 "reasonably efficient for moderate numbers of keys."
3065 #: ../src/guestfs.pod:1512
3066 msgid "BLOCK DEVICE NAMING"
3070 #: ../src/guestfs.pod:1514
3072 "In the kernel there is now quite a profusion of schemata for naming block "
3073 "devices (in this context, by I<block device> I mean a physical or virtual "
3074 "hard drive). The original Linux IDE driver used names starting with C</dev/"
3075 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
3076 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
3077 "for the old IDE driver (particularly for SATA devices) those devices also "
3078 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
3079 "paravirtualized drivers. This has created several different naming systems, "
3080 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
3084 #: ../src/guestfs.pod:1526
3086 "As discussed above, libguestfs uses a qemu appliance running an embedded "
3087 "Linux kernel to access block devices. We can run a variety of appliances "
3088 "based on a variety of Linux kernels."
3092 #: ../src/guestfs.pod:1530
3094 "This causes a problem for libguestfs because many API calls use device or "
3095 "partition names. Working scripts and the recipe (example) scripts that we "
3096 "make available over the internet could fail if the naming scheme changes."
3100 #: ../src/guestfs.pod:1535
3102 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
3103 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
3104 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
3105 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
3109 #: ../src/guestfs.pod:1541
3111 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
3112 "L</guestfs_list_partitions> and similar calls return the true names of the "
3113 "devices and partitions as known to the appliance."
3117 #: ../src/guestfs.pod:1546
3118 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
3122 #: ../src/guestfs.pod:1548
3124 "Usually this translation is transparent. However in some (very rare) cases "
3125 "you may need to know the exact algorithm. Such cases include where you use "
3126 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
3127 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
3131 #: ../src/guestfs.pod:1554
3133 "The algorithm is applied only to I<parameters> which are known to be either "
3134 "device or partition names. Return values from functions such as L</"
3135 "guestfs_list_devices> are never changed."
3139 #: ../src/guestfs.pod:1562
3140 msgid "Is the string a parameter which is a device or partition name?"
3144 #: ../src/guestfs.pod:1566
3145 msgid "Does the string begin with C</dev/sd>?"
3149 #: ../src/guestfs.pod:1570
3151 "Does the named device exist? If so, we use that device. However if I<not> "
3152 "then we continue with this algorithm."
3156 #: ../src/guestfs.pod:1575
3157 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
3161 #: ../src/guestfs.pod:1577
3162 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
3166 #: ../src/guestfs.pod:1579
3167 msgid "If that named device exists, use it. If not, continue."
3171 #: ../src/guestfs.pod:1583
3172 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
3176 #: ../src/guestfs.pod:1585
3177 msgid "If that named device exists, use it. If not, return an error."
3181 #: ../src/guestfs.pod:1589
3182 msgid "PORTABILITY CONCERNS"
3186 #: ../src/guestfs.pod:1591
3188 "Although the standard naming scheme and automatic translation is useful for "
3189 "simple programs and guestfish scripts, for larger programs it is best not to "
3190 "rely on this mechanism."
3194 #: ../src/guestfs.pod:1595
3196 "Where possible for maximum future portability programs using libguestfs "
3197 "should use these future-proof techniques:"
3201 #: ../src/guestfs.pod:1602
3203 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
3204 "device names, and then use those names directly."
3208 #: ../src/guestfs.pod:1605
3210 "Since those device names exist by definition, they will never be translated."
3214 #: ../src/guestfs.pod:1610
3216 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
3217 "filesystem labels."
3221 #: ../src/guestfs.pod:1615
3226 #: ../src/guestfs.pod:1617
3227 msgid "COMMUNICATION PROTOCOL"
3231 #: ../src/guestfs.pod:1619
3233 "Don't rely on using this protocol directly. This section documents how it "
3234 "currently works, but it may change at any time."
3238 #: ../src/guestfs.pod:1622
3240 "The protocol used to talk between the library and the daemon running inside "
3241 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3242 "1014, RFC 1832, RFC 4506)."
3246 #: ../src/guestfs.pod:1626
3248 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3249 "this file is automatically generated)."
3253 #: ../src/guestfs.pod:1629
3255 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3256 "and C<FileOut> parameters, which are handled with very simple request/reply "
3257 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3258 "parameters, which use the same request and reply messages, but they may also "
3259 "be followed by files sent using a chunked encoding."
3263 #: ../src/guestfs.pod:1636
3264 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3268 #: ../src/guestfs.pod:1638
3269 msgid "For ordinary functions, the request message is:"
3273 #: ../src/guestfs.pod:1640
3276 " total length (header + arguments,\n"
3277 " but not including the length word itself)\n"
3278 " struct guestfs_message_header (encoded as XDR)\n"
3279 " struct guestfs_<foo>_args (encoded as XDR)\n"
3284 #: ../src/guestfs.pod:1645
3286 "The total length field allows the daemon to allocate a fixed size buffer "
3287 "into which it slurps the rest of the message. As a result, the total length "
3288 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3289 "effective size of any request is limited to somewhere under this size."
3293 #: ../src/guestfs.pod:1651
3295 "Note also that many functions don't take any arguments, in which case the "
3296 "C<guestfs_I<foo>_args> is completely omitted."
3300 #: ../src/guestfs.pod:1654
3302 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3303 "receiver knows what type of args structure to expect, or none at all."
3307 #: ../src/guestfs.pod:1658
3308 msgid "The reply message for ordinary functions is:"
3312 #: ../src/guestfs.pod:1660
3315 " total length (header + ret,\n"
3316 " but not including the length word itself)\n"
3317 " struct guestfs_message_header (encoded as XDR)\n"
3318 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3323 #: ../src/guestfs.pod:1665
3325 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3326 "functions that return no formal return values."
3330 #: ../src/guestfs.pod:1668
3332 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3336 #: ../src/guestfs.pod:1671
3338 "In the case of an error, a flag is set in the header, and the reply message "
3339 "is slightly changed:"
3343 #: ../src/guestfs.pod:1674
3346 " total length (header + error,\n"
3347 " but not including the length word itself)\n"
3348 " struct guestfs_message_header (encoded as XDR)\n"
3349 " struct guestfs_message_error (encoded as XDR)\n"
3354 #: ../src/guestfs.pod:1679
3356 "The C<guestfs_message_error> structure contains the error message as a "
3361 #: ../src/guestfs.pod:1682
3362 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3366 #: ../src/guestfs.pod:1684
3368 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3369 "The normal request message is sent (see above). However this is followed by "
3370 "a sequence of file chunks."
3374 #: ../src/guestfs.pod:1688
3377 " total length (header + arguments,\n"
3378 " but not including the length word itself,\n"
3379 " and not including the chunks)\n"
3380 " struct guestfs_message_header (encoded as XDR)\n"
3381 " struct guestfs_<foo>_args (encoded as XDR)\n"
3382 " sequence of chunks for FileIn param #0\n"
3383 " sequence of chunks for FileIn param #1 etc.\n"
3388 #: ../src/guestfs.pod:1696
3389 msgid "The \"sequence of chunks\" is:"
3393 #: ../src/guestfs.pod:1698
3396 " length of chunk (not including length word itself)\n"
3397 " struct guestfs_chunk (encoded as XDR)\n"
3398 " length of chunk\n"
3399 " struct guestfs_chunk (encoded as XDR)\n"
3401 " length of chunk\n"
3402 " struct guestfs_chunk (with data.data_len == 0)\n"
3407 #: ../src/guestfs.pod:1706
3409 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3410 "is set in the final chunk to indicate either successful completion or early "
3415 #: ../src/guestfs.pod:1710
3417 "At time of writing there are no functions that have more than one FileIn "
3418 "parameter. However this is (theoretically) supported, by sending the "
3419 "sequence of chunks for each FileIn parameter one after another (from left to "
3424 #: ../src/guestfs.pod:1715
3426 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3427 "transfer. The library does this by sending a chunk with a special flag set "
3428 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3429 "RPC, does I<not> send any reply, and goes back to reading the next request."
3433 #: ../src/guestfs.pod:1721
3435 "The daemon may also cancel. It does this by writing a special word "
3436 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3437 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3438 "cancel chunk). The special word is chosen so that even if cancellation "
3439 "happens right at the end of the transfer (after the library has finished "
3440 "writing and has started listening for the reply), the \"spurious\" cancel "
3441 "flag will not be confused with the reply message."
3445 #: ../src/guestfs.pod:1730
3447 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3448 "limit), and also files where the size is not known in advance (eg. from "
3449 "pipes or sockets). However the chunks are rather small "
3450 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3451 "to keep much in memory."
3455 #: ../src/guestfs.pod:1736
3456 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3460 #: ../src/guestfs.pod:1738
3462 "The protocol for FileOut parameters is exactly the same as for FileIn "
3463 "parameters, but with the roles of daemon and library reversed."
3467 #: ../src/guestfs.pod:1741
3470 " total length (header + ret,\n"
3471 " but not including the length word itself,\n"
3472 " and not including the chunks)\n"
3473 " struct guestfs_message_header (encoded as XDR)\n"
3474 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3475 " sequence of chunks for FileOut param #0\n"
3476 " sequence of chunks for FileOut param #1 etc.\n"
3481 #: ../src/guestfs.pod:1749
3482 msgid "INITIAL MESSAGE"
3486 #: ../src/guestfs.pod:1751
3488 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3489 "which indicates that the guest and daemon is alive. This is what L</"
3490 "guestfs_launch> waits for."
3494 #: ../src/guestfs.pod:1755
3495 msgid "PROGRESS NOTIFICATION MESSAGES"
3499 #: ../src/guestfs.pod:1757
3501 "The daemon may send progress notification messages at any time. These are "
3502 "distinguished by the normal length word being replaced by "
3503 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3507 #: ../src/guestfs.pod:1761
3509 "The library turns them into progress callbacks (see "
3510 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3511 "discards them if not."
3515 #: ../src/guestfs.pod:1765
3517 "The daemon self-limits the frequency of progress messages it sends (see "
3518 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3523 #: ../src/guestfs.pod:1769
3524 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
3528 #: ../src/guestfs.pod:1771
3530 "All high-level libguestfs actions are synchronous. If you want to use "
3531 "libguestfs asynchronously then you must create a thread."
3535 #: ../src/guestfs.pod:1774
3537 "Only use the handle from a single thread. Either use the handle exclusively "
3538 "from one thread, or provide your own mutex so that two threads cannot issue "
3539 "calls on the same handle at the same time."
3543 #: ../src/guestfs.pod:1778
3545 "See the graphical program guestfs-browser for one possible architecture for "
3546 "multithreaded programs using libvirt and libguestfs."
3550 #: ../src/guestfs.pod:1781
3551 msgid "QEMU WRAPPERS"
3555 #: ../src/guestfs.pod:1783
3557 "If you want to compile your own qemu, run qemu from a non-standard location, "
3558 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
3563 #: ../src/guestfs.pod:1787
3565 "There is one important rule to remember: you I<must C<exec qemu>> as the "
3566 "last command in the shell script (so that qemu replaces the shell and "
3567 "becomes the direct child of the libguestfs-using program). If you don't do "
3568 "this, then the qemu process won't be cleaned up correctly."
3572 #: ../src/guestfs.pod:1792
3574 "Here is an example of a wrapper, where I have built my own copy of qemu from "
3579 #: ../src/guestfs.pod:1795
3583 " qemudir=/home/rjones/d/qemu\n"
3584 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
3589 #: ../src/guestfs.pod:1799
3591 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
3592 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
3597 #: ../src/guestfs.pod:1803
3600 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
3605 #: ../src/guestfs.pod:1805
3607 "Note that libguestfs also calls qemu with the -help and -version options in "
3608 "order to determine features."
3612 #: ../src/guestfs.pod:1808
3613 msgid "LIBGUESTFS VERSION NUMBERS"
3617 #: ../src/guestfs.pod:1810
3619 "Since April 2010, libguestfs has started to make separate development and "
3620 "stable releases, along with corresponding branches in our git repository. "
3621 "These separate releases can be identified by version number:"
3625 #: ../src/guestfs.pod:1815
3628 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3629 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3635 " | `-------- sub-version\n"
3637 " `------ always '1' because we don't change the ABI\n"
3642 #: ../src/guestfs.pod:1826
3643 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3647 #: ../src/guestfs.pod:1828
3649 "As time passes we cherry pick fixes from the development branch and backport "
3650 "those into the stable branch, the effect being that the stable branch should "
3651 "get more stable and less buggy over time. So the stable releases are ideal "
3652 "for people who don't need new features but would just like the software to "
3657 #: ../src/guestfs.pod:1834
3658 msgid "Our criteria for backporting changes are:"
3662 #: ../src/guestfs.pod:1840
3664 "Documentation changes which don't affect any code are backported unless the "
3665 "documentation refers to a future feature which is not in stable."
3669 #: ../src/guestfs.pod:1846
3671 "Bug fixes which are not controversial, fix obvious problems, and have been "
3672 "well tested are backported."
3676 #: ../src/guestfs.pod:1851
3678 "Simple rearrangements of code which shouldn't affect how it works get "
3679 "backported. This is so that the code in the two branches doesn't get too "
3680 "far out of step, allowing us to backport future fixes more easily."
3684 #: ../src/guestfs.pod:1857
3686 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3687 "exceptional case: the new feature is required in order to implement an "
3688 "important bug fix."
3692 #: ../src/guestfs.pod:1863
3694 "A new stable branch starts when we think the new features in development are "
3695 "substantial and compelling enough over the current stable branch to warrant "
3696 "it. When that happens we create new stable and development versions 1.N.0 "
3697 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3698 "stable at this point, but by backporting fixes from development, that branch "
3699 "will stabilize over time."
3703 #: ../src/guestfs.pod:1871 ../fish/guestfish.pod:914
3704 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
3705 #: ../tools/virt-rescue.pl:255
3706 msgid "ENVIRONMENT VARIABLES"
3710 #: ../src/guestfs.pod:1875 ../fish/guestfish.pod:940
3711 msgid "LIBGUESTFS_APPEND"
3715 #: ../src/guestfs.pod:1877 ../fish/guestfish.pod:942
3716 msgid "Pass additional options to the guest kernel."
3720 #: ../src/guestfs.pod:1879 ../fish/guestfish.pod:944
3721 msgid "LIBGUESTFS_DEBUG"
3725 #: ../src/guestfs.pod:1881
3727 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3728 "effect as calling C<guestfs_set_verbose (g, 1)>."
3732 #: ../src/guestfs.pod:1884 ../fish/guestfish.pod:949
3733 msgid "LIBGUESTFS_MEMSIZE"
3737 #: ../src/guestfs.pod:1886 ../fish/guestfish.pod:951
3739 "Set the memory allocated to the qemu process, in megabytes. For example:"
3743 #: ../src/guestfs.pod:1889 ../fish/guestfish.pod:954
3746 " LIBGUESTFS_MEMSIZE=700\n"
3751 #: ../src/guestfs.pod:1891 ../fish/guestfish.pod:956
3752 msgid "LIBGUESTFS_PATH"
3756 #: ../src/guestfs.pod:1893
3758 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
3759 "the discussion of paths in section PATH above."
3763 #: ../src/guestfs.pod:1896 ../fish/guestfish.pod:961
3764 msgid "LIBGUESTFS_QEMU"
3768 #: ../src/guestfs.pod:1898 ../fish/guestfish.pod:963
3770 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
3771 "which was found at compile time by the configure script is used."
3775 #: ../src/guestfs.pod:1902
3776 msgid "See also L</QEMU WRAPPERS> above."
3780 #: ../src/guestfs.pod:1904 ../fish/guestfish.pod:967
3781 msgid "LIBGUESTFS_TRACE"
3785 #: ../src/guestfs.pod:1906
3787 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
3788 "effect as calling C<guestfs_set_trace (g, 1)>."
3792 #: ../src/guestfs.pod:1909 ../fish/guestfish.pod:976
3797 #: ../src/guestfs.pod:1911 ../fish/guestfish.pod:978
3798 msgid "Location of temporary directory, defaults to C</tmp>."
3802 #: ../src/guestfs.pod:1913 ../fish/guestfish.pod:980
3804 "If libguestfs was compiled to use the supermin appliance then the real "
3805 "appliance is cached in this directory, shared between all handles belonging "
3806 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
3807 "use in case C</tmp> is not large enough."
3811 #: ../src/guestfs.pod:1921 ../fish/guestfish.pod:1038
3812 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233
3813 #: ../inspector/virt-inspector.pl:536 ../tools/virt-edit.pl:350
3814 #: ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640
3815 #: ../tools/virt-ls.pl:232 ../tools/virt-resize.pl:1486
3816 #: ../tools/virt-list-filesystems.pl:186 ../tools/virt-tar.pl:281
3817 #: ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534
3818 #: ../tools/virt-list-partitions.pl:254
3823 #: ../src/guestfs.pod:1923
3825 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-edit"
3826 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
3827 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
3828 "tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
3829 "L<http://libguestfs.org/>."
3833 #: ../src/guestfs.pod:1941
3835 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
3836 "(8)>, L<disktype(1)>."
3840 #: ../src/guestfs.pod:1948 ../tools/virt-win-reg.pl:499
3841 #: ../tools/virt-make-fs.pl:548
3846 #: ../src/guestfs.pod:1950
3847 msgid "To get a list of bugs against libguestfs use this link:"
3851 #: ../src/guestfs.pod:1952
3853 "L<https://bugzilla.redhat.com/buglist.cgi?"
3854 "component=libguestfs&product=Virtualization+Tools>"
3858 #: ../src/guestfs.pod:1954
3859 msgid "To report a new bug against libguestfs use this link:"
3863 #: ../src/guestfs.pod:1956
3865 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
3866 "component=libguestfs&product=Virtualization+Tools>"
3870 #: ../src/guestfs.pod:1958
3871 msgid "When reporting a bug, please check:"
3875 #: ../src/guestfs.pod:1964
3876 msgid "That the bug hasn't been reported already."
3880 #: ../src/guestfs.pod:1968
3881 msgid "That you are testing a recent version."
3885 #: ../src/guestfs.pod:1972
3886 msgid "Describe the bug accurately, and give a way to reproduce it."
3890 #: ../src/guestfs.pod:1976
3892 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
3897 #: ../src/guestfs.pod:1981 ../fish/guestfish.pod:1055
3898 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
3899 #: ../inspector/virt-inspector.pl:546
3904 #: ../src/guestfs.pod:1983 ../fish/guestfish.pod:1057
3905 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
3906 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3910 #: ../src/guestfs.pod:1985 ../fish/guestfish.pod:1059
3911 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248
3912 #: ../inspector/virt-inspector.pl:560 ../tools/virt-edit.pl:366
3913 #: ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653
3914 #: ../tools/virt-ls.pl:247 ../tools/virt-resize.pl:1512
3915 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:296
3916 #: ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563
3917 #: ../tools/virt-list-partitions.pl:269
3922 #: ../src/guestfs.pod:1987 ../fish/guestfish.pod:1061
3923 #: ../fuse/guestmount.pod:250
3924 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
3928 #: ../src/guestfs.pod:1990
3930 "This library is free software; you can redistribute it and/or modify it "
3931 "under the terms of the GNU Lesser General Public License as published by the "
3932 "Free Software Foundation; either version 2 of the License, or (at your "
3933 "option) any later version."
3937 #: ../src/guestfs.pod:1995
3939 "This library is distributed in the hope that it will be useful, but WITHOUT "
3940 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3941 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3946 #: ../src/guestfs.pod:2000
3948 "You should have received a copy of the GNU Lesser General Public License "
3949 "along with this library; if not, write to the Free Software Foundation, "
3950 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3954 #: ../src/guestfs-actions.pod:1
3955 msgid "guestfs_add_cdrom"
3959 #: ../src/guestfs-actions.pod:3
3963 " guestfs_add_cdrom (guestfs_h *g,\n"
3964 " const char *filename);\n"
3969 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
3970 msgid "This function adds a virtual CD-ROM disk image to the guest."
3974 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
3975 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
3979 #: ../src/guestfs-actions.pod:17
3981 "This call checks for the existence of C<filename>. This stops you from "
3982 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3983 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
3988 #: ../src/guestfs-actions.pod:24
3990 "If you just want to add an ISO file (often you use this as an efficient way "
3991 "to transfer large files into the guest), then you should probably use "
3992 "C<guestfs_add_drive_ro> instead."
3996 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126
3997 #: ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224
3998 #: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259
3999 #: ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293
4000 #: ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428
4001 #: ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487
4002 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533
4003 #: ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633
4004 #: ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662
4005 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779
4006 #: ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807
4007 #: ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988
4008 #: ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090
4009 #: ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127
4010 #: ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161
4011 #: ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262
4012 #: ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324
4013 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464
4014 #: ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704
4015 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2213
4016 #: ../src/guestfs-actions.pod:2357 ../src/guestfs-actions.pod:2418
4017 #: ../src/guestfs-actions.pod:2453 ../src/guestfs-actions.pod:3045
4018 #: ../src/guestfs-actions.pod:3060 ../src/guestfs-actions.pod:3080
4019 #: ../src/guestfs-actions.pod:3205 ../src/guestfs-actions.pod:3219
4020 #: ../src/guestfs-actions.pod:3232 ../src/guestfs-actions.pod:3246
4021 #: ../src/guestfs-actions.pod:3261 ../src/guestfs-actions.pod:3297
4022 #: ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3389
4023 #: ../src/guestfs-actions.pod:3406 ../src/guestfs-actions.pod:3429
4024 #: ../src/guestfs-actions.pod:3452 ../src/guestfs-actions.pod:3484
4025 #: ../src/guestfs-actions.pod:3503 ../src/guestfs-actions.pod:3522
4026 #: ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3569
4027 #: ../src/guestfs-actions.pod:3605 ../src/guestfs-actions.pod:3621
4028 #: ../src/guestfs-actions.pod:3634 ../src/guestfs-actions.pod:3649
4029 #: ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:3759
4030 #: ../src/guestfs-actions.pod:3779 ../src/guestfs-actions.pod:3792
4031 #: ../src/guestfs-actions.pod:3843 ../src/guestfs-actions.pod:3861
4032 #: ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3895
4033 #: ../src/guestfs-actions.pod:3909 ../src/guestfs-actions.pod:3923
4034 #: ../src/guestfs-actions.pod:3940 ../src/guestfs-actions.pod:3955
4035 #: ../src/guestfs-actions.pod:3975 ../src/guestfs-actions.pod:4024
4036 #: ../src/guestfs-actions.pod:4055 ../src/guestfs-actions.pod:4074
4037 #: ../src/guestfs-actions.pod:4093 ../src/guestfs-actions.pod:4105
4038 #: ../src/guestfs-actions.pod:4122 ../src/guestfs-actions.pod:4135
4039 #: ../src/guestfs-actions.pod:4150 ../src/guestfs-actions.pod:4165
4040 #: ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4215
4041 #: ../src/guestfs-actions.pod:4235 ../src/guestfs-actions.pod:4249
4042 #: ../src/guestfs-actions.pod:4266 ../src/guestfs-actions.pod:4315
4043 #: ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4366
4044 #: ../src/guestfs-actions.pod:4394 ../src/guestfs-actions.pod:4411
4045 #: ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:4563
4046 #: ../src/guestfs-actions.pod:4620 ../src/guestfs-actions.pod:4642
4047 #: ../src/guestfs-actions.pod:4660 ../src/guestfs-actions.pod:4692
4048 #: ../src/guestfs-actions.pod:4758 ../src/guestfs-actions.pod:4775
4049 #: ../src/guestfs-actions.pod:4788 ../src/guestfs-actions.pod:4802
4050 #: ../src/guestfs-actions.pod:5091 ../src/guestfs-actions.pod:5110
4051 #: ../src/guestfs-actions.pod:5124 ../src/guestfs-actions.pod:5136
4052 #: ../src/guestfs-actions.pod:5150 ../src/guestfs-actions.pod:5162
4053 #: ../src/guestfs-actions.pod:5176 ../src/guestfs-actions.pod:5192
4054 #: ../src/guestfs-actions.pod:5213 ../src/guestfs-actions.pod:5232
4055 #: ../src/guestfs-actions.pod:5251 ../src/guestfs-actions.pod:5269
4056 #: ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:5310
4057 #: ../src/guestfs-actions.pod:5329 ../src/guestfs-actions.pod:5350
4058 #: ../src/guestfs-actions.pod:5369 ../src/guestfs-actions.pod:5386
4059 #: ../src/guestfs-actions.pod:5414 ../src/guestfs-actions.pod:5438
4060 #: ../src/guestfs-actions.pod:5457 ../src/guestfs-actions.pod:5481
4061 #: ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5511
4062 #: ../src/guestfs-actions.pod:5530 ../src/guestfs-actions.pod:5567
4063 #: ../src/guestfs-actions.pod:5590 ../src/guestfs-actions.pod:5616
4064 #: ../src/guestfs-actions.pod:5724 ../src/guestfs-actions.pod:5845
4065 #: ../src/guestfs-actions.pod:5857 ../src/guestfs-actions.pod:5870
4066 #: ../src/guestfs-actions.pod:5883 ../src/guestfs-actions.pod:5905
4067 #: ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5931
4068 #: ../src/guestfs-actions.pod:5944 ../src/guestfs-actions.pod:5959
4069 #: ../src/guestfs-actions.pod:6018 ../src/guestfs-actions.pod:6035
4070 #: ../src/guestfs-actions.pod:6051 ../src/guestfs-actions.pod:6067
4071 #: ../src/guestfs-actions.pod:6084 ../src/guestfs-actions.pod:6097
4072 #: ../src/guestfs-actions.pod:6117 ../src/guestfs-actions.pod:6153
4073 #: ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6208
4074 #: ../src/guestfs-actions.pod:6221 ../src/guestfs-actions.pod:6239
4075 #: ../src/guestfs-actions.pod:6268 ../src/guestfs-actions.pod:6299
4076 #: ../src/guestfs-actions.pod:6418 ../src/guestfs-actions.pod:6436
4077 #: ../src/guestfs-actions.pod:6450 ../src/guestfs-actions.pod:6505
4078 #: ../src/guestfs-actions.pod:6518 ../src/guestfs-actions.pod:6563
4079 #: ../src/guestfs-actions.pod:6596 ../src/guestfs-actions.pod:6650
4080 #: ../src/guestfs-actions.pod:6676 ../src/guestfs-actions.pod:6742
4081 #: ../src/guestfs-actions.pod:6761 ../src/guestfs-actions.pod:6790
4082 msgid "This function returns 0 on success or -1 on error."
4086 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240
4087 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28
4088 #: ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167
4090 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4095 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243
4096 #: ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435
4097 #: ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942
4098 #: ../src/guestfs-actions.pod:6684 ../src/guestfs-actions.pod:6853
4099 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156
4100 #: ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951
4101 #: ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322
4102 #: ../fish/guestfish-actions.pod:4423 ../fish/guestfish-actions.pod:4520
4104 "Deprecated functions will not be removed from the API, but the fact that "
4105 "they are deprecated indicates that there are problems with correct use of "
4110 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128
4111 #: ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893
4112 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094
4113 #: ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3062
4114 #: ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:5271
4115 #: ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5498
4116 #: ../src/guestfs-actions.pod:5961 ../src/guestfs-actions.pod:6086
4117 #: ../src/guestfs-actions.pod:6598
4118 msgid "(Added in 0.3)"
4122 #: ../src/guestfs-actions.pod:41
4123 msgid "guestfs_add_domain"
4127 #: ../src/guestfs-actions.pod:43
4131 " guestfs_add_domain (guestfs_h *g,\n"
4132 " const char *dom,\n"
4138 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
4140 "You may supply a list of optional arguments to this call. Use zero or more "
4141 "of the following pairs of parameters, and terminate the list with C<-1> on "
4142 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4146 #: ../src/guestfs-actions.pod:53
4149 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
4150 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
4151 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
4156 #: ../src/guestfs-actions.pod:57
4158 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4159 "It works by connecting to libvirt, requesting the domain and domain XML from "
4160 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
4165 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
4167 "The number of disks added is returned. This operation is atomic: if an "
4168 "error is returned, then no disks are added."
4172 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
4174 "This function does some minimal checks to make sure the libvirt domain is "
4175 "not running (unless C<readonly> is true). In a future version we will try "
4176 "to acquire the libvirt lock on each disk."
4180 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
4182 "Disks must be accessible locally. This often means that adding disks from a "
4183 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4184 "unless those disks are accessible via the same device path locally too."
4188 #: ../src/guestfs-actions.pod:74
4190 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
4191 "libvirt.org/uri.html>). If this is not set then we connect to the default "
4192 "libvirt URI (or one set through an environment variable, see the libvirt "
4193 "documentation for full details). If you are using the C API directly then "
4194 "it is more flexible to create the libvirt connection object yourself, get "
4195 "the domain object, and call C<guestfs_add_libvirt_dom>."
4199 #: ../src/guestfs-actions.pod:82
4201 "The other optional parameters are passed directly through to "
4202 "C<guestfs_add_drive_opts>."
4206 #: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:336
4207 #: ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679
4208 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728
4209 #: ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307
4210 #: ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864
4211 #: ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003
4212 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081
4213 #: ../src/guestfs-actions.pod:2344 ../src/guestfs-actions.pod:2602
4214 #: ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:4338
4215 #: ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4872
4216 #: ../src/guestfs-actions.pod:4898 ../src/guestfs-actions.pod:6194
4217 #: ../src/guestfs-actions.pod:6609 ../src/guestfs-actions.pod:6622
4218 #: ../src/guestfs-actions.pod:6635
4219 msgid "On error this function returns -1."
4223 #: ../src/guestfs-actions.pod:87
4224 msgid "guestfs_add_domain_va"
4228 #: ../src/guestfs-actions.pod:89
4232 " guestfs_add_domain_va (guestfs_h *g,\n"
4233 " const char *dom,\n"
4239 #: ../src/guestfs-actions.pod:94
4240 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4244 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107
4245 #: ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
4246 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4250 #: ../src/guestfs-actions.pod:98
4251 msgid "guestfs_add_domain_argv"
4255 #: ../src/guestfs-actions.pod:100
4259 " guestfs_add_domain_argv (guestfs_h *g,\n"
4260 " const char *dom,\n"
4261 " const struct guestfs_add_domain_argv *optargs);\n"
4266 #: ../src/guestfs-actions.pod:105
4267 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4271 #: ../src/guestfs-actions.pod:109
4272 msgid "guestfs_add_drive"
4276 #: ../src/guestfs-actions.pod:111
4280 " guestfs_add_drive (guestfs_h *g,\n"
4281 " const char *filename);\n"
4286 #: ../src/guestfs-actions.pod:115
4288 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4289 "optional parameters, so the disk is added writable, with the format being "
4290 "detected automatically."
4294 #: ../src/guestfs-actions.pod:119
4296 "Automatic detection of the format opens you up to a potential security hole "
4297 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4298 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4299 "you should think about replacing calls to this function with calls to "
4300 "C<guestfs_add_drive_opts>, and specifying the format."
4304 #: ../src/guestfs-actions.pod:130
4305 msgid "guestfs_add_drive_opts"
4309 #: ../src/guestfs-actions.pod:132
4313 " guestfs_add_drive_opts (guestfs_h *g,\n"
4314 " const char *filename,\n"
4320 #: ../src/guestfs-actions.pod:142
4323 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4324 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4325 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4330 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:92
4332 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4333 "The first time you call this function, the disk appears as C</dev/sda>, the "
4334 "second time as C</dev/sdb>, and so on."
4338 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:97
4340 "You don't necessarily need to be root when using libguestfs. However you "
4341 "obviously do need sufficient permissions to access the filename for whatever "
4342 "operations you want to perform (ie. read access if you just want to read the "
4343 "image or write access if you want to modify the image)."
4347 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:103
4348 msgid "This call checks that C<filename> exists."
4352 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:105
4353 msgid "The optional arguments are:"
4357 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:109
4362 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:111
4364 "If true then the image is treated as read-only. Writes are still allowed, "
4365 "but they are stored in a temporary snapshot overlay which is discarded at "
4366 "the end. The disk that you add is not modified."
4370 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:115
4375 #: ../src/guestfs-actions.pod:171
4377 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4378 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4379 "Possible formats include C<raw> and C<qcow2>."
4383 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:121
4385 "Automatic detection of the format opens you up to a potential security hole "
4386 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4387 "RHBZ#642934. Specifying the format closes this security hole."
4391 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:126
4396 #: ../src/guestfs-actions.pod:182
4398 "This rarely-used option lets you emulate the behaviour of the deprecated "
4399 "C<guestfs_add_drive_with_if> call (q.v.)"
4403 #: ../src/guestfs-actions.pod:189
4404 msgid "(Added in 1.5.23)"
4408 #: ../src/guestfs-actions.pod:191
4409 msgid "guestfs_add_drive_opts_va"
4413 #: ../src/guestfs-actions.pod:193
4417 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4418 " const char *filename,\n"
4424 #: ../src/guestfs-actions.pod:198
4425 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4429 #: ../src/guestfs-actions.pod:202
4430 msgid "guestfs_add_drive_opts_argv"
4434 #: ../src/guestfs-actions.pod:204
4438 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4439 " const char *filename,\n"
4440 " const struct guestfs_add_drive_opts_argv *optargs);\n"
4445 #: ../src/guestfs-actions.pod:209
4446 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4450 #: ../src/guestfs-actions.pod:213
4451 msgid "guestfs_add_drive_ro"
4455 #: ../src/guestfs-actions.pod:215
4459 " guestfs_add_drive_ro (guestfs_h *g,\n"
4460 " const char *filename);\n"
4465 #: ../src/guestfs-actions.pod:219
4467 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4468 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4469 "disk is added read-only, with the format being detected automatically."
4473 #: ../src/guestfs-actions.pod:226
4474 msgid "(Added in 1.0.38)"
4478 #: ../src/guestfs-actions.pod:228
4479 msgid "guestfs_add_drive_ro_with_if"
4483 #: ../src/guestfs-actions.pod:230
4487 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4488 " const char *filename,\n"
4489 " const char *iface);\n"
4494 #: ../src/guestfs-actions.pod:235
4496 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4497 "QEMU interface emulation to use at run time."
4501 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268
4502 #: ../src/guestfs-actions.pod:2303
4503 msgid "(Added in 1.0.84)"
4507 #: ../src/guestfs-actions.pod:249
4508 msgid "guestfs_add_drive_with_if"
4512 #: ../src/guestfs-actions.pod:251
4516 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4517 " const char *filename,\n"
4518 " const char *iface);\n"
4523 #: ../src/guestfs-actions.pod:256
4525 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4526 "QEMU interface emulation to use at run time."
4530 #: ../src/guestfs-actions.pod:270
4531 msgid "guestfs_aug_clear"
4535 #: ../src/guestfs-actions.pod:272
4539 " guestfs_aug_clear (guestfs_h *g,\n"
4540 " const char *augpath);\n"
4545 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:178
4547 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4548 "L<augtool(1)> C<clear> command."
4552 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
4553 msgid "(Added in 1.3.4)"
4557 #: ../src/guestfs-actions.pod:283
4558 msgid "guestfs_aug_close"
4562 #: ../src/guestfs-actions.pod:285
4566 " guestfs_aug_close (guestfs_h *g);\n"
4571 #: ../src/guestfs-actions.pod:288
4573 "Close the current Augeas handle and free up any resources used by it. After "
4574 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4575 "any other Augeas functions."
4579 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320
4580 #: ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352
4581 #: ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430
4582 #: ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475
4583 #: ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503
4584 #: ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535
4585 #: ../src/guestfs-actions.pod:4949
4586 msgid "(Added in 0.7)"
4590 #: ../src/guestfs-actions.pod:297
4591 msgid "guestfs_aug_defnode"
4595 #: ../src/guestfs-actions.pod:299
4598 " struct guestfs_int_bool *\n"
4599 " guestfs_aug_defnode (guestfs_h *g,\n"
4600 " const char *name,\n"
4601 " const char *expr,\n"
4602 " const char *val);\n"
4607 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:194
4609 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4613 #: ../src/guestfs-actions.pod:308
4615 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4616 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4617 "containing that single node."
4621 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:201
4623 "On success this returns a pair containing the number of nodes in the "
4624 "nodeset, and a boolean flag if a node was created."
4628 #: ../src/guestfs-actions.pod:316
4630 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4631 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4635 #: ../src/guestfs-actions.pod:322
4636 msgid "guestfs_aug_defvar"
4640 #: ../src/guestfs-actions.pod:324
4644 " guestfs_aug_defvar (guestfs_h *g,\n"
4645 " const char *name,\n"
4646 " const char *expr);\n"
4651 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:209
4653 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4654 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4658 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:213
4660 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4661 "evaluates to something which is not a nodeset."
4665 #: ../src/guestfs-actions.pod:340
4666 msgid "guestfs_aug_get"
4670 #: ../src/guestfs-actions.pod:342
4674 " guestfs_aug_get (guestfs_h *g,\n"
4675 " const char *augpath);\n"
4680 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:220
4682 "Look up the value associated with C<path>. If C<path> matches exactly one "
4683 "node, the C<value> is returned."
4687 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849
4688 #: ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927
4689 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046
4690 #: ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193
4691 #: ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341
4692 #: ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644
4693 #: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824
4694 #: ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936
4695 #: ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2268
4696 #: ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2548
4697 #: ../src/guestfs-actions.pod:2684 ../src/guestfs-actions.pod:2713
4698 #: ../src/guestfs-actions.pod:2735 ../src/guestfs-actions.pod:2791
4699 #: ../src/guestfs-actions.pod:2814 ../src/guestfs-actions.pod:3191
4700 #: ../src/guestfs-actions.pod:3541 ../src/guestfs-actions.pod:3711
4701 #: ../src/guestfs-actions.pod:3821 ../src/guestfs-actions.pod:4484
4702 #: ../src/guestfs-actions.pod:4677 ../src/guestfs-actions.pod:4847
4703 #: ../src/guestfs-actions.pod:5025 ../src/guestfs-actions.pod:5074
4704 #: ../src/guestfs-actions.pod:5637 ../src/guestfs-actions.pod:5653
4705 #: ../src/guestfs-actions.pod:5670 ../src/guestfs-actions.pod:5694
4706 #: ../src/guestfs-actions.pod:6358 ../src/guestfs-actions.pod:6377
4707 #: ../src/guestfs-actions.pod:6395 ../src/guestfs-actions.pod:6575
4708 #: ../src/guestfs-actions.pod:6847
4710 "This function returns a string, or NULL on error. I<The caller must free "
4711 "the returned string after use>."
4715 #: ../src/guestfs-actions.pod:354
4716 msgid "guestfs_aug_init"
4720 #: ../src/guestfs-actions.pod:356
4724 " guestfs_aug_init (guestfs_h *g,\n"
4725 " const char *root,\n"
4731 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:227
4733 "Create a new Augeas handle for editing configuration files. If there was "
4734 "any previous Augeas handle associated with this guestfs session, then it is "
4739 #: ../src/guestfs-actions.pod:365
4740 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4744 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:234
4746 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4750 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:237
4752 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4753 "logical I<or> of the following integers:"
4757 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:243
4758 msgid "C<AUG_SAVE_BACKUP> = 1"
4762 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:245
4763 msgid "Keep the original file with a C<.augsave> extension."
4767 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:247
4768 msgid "C<AUG_SAVE_NEWFILE> = 2"
4772 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:249
4774 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4775 "original. Overrides C<AUG_SAVE_BACKUP>."
4779 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:252
4780 msgid "C<AUG_TYPE_CHECK> = 4"
4784 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:254
4785 msgid "Typecheck lenses (can be expensive)."
4789 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:256
4790 msgid "C<AUG_NO_STDINC> = 8"
4794 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:258
4795 msgid "Do not use standard load path for modules."
4799 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:260
4800 msgid "C<AUG_SAVE_NOOP> = 16"
4804 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:262
4805 msgid "Make save a no-op, just record what would have been changed."
4809 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:264
4810 msgid "C<AUG_NO_LOAD> = 32"
4814 #: ../src/guestfs-actions.pod:400
4815 msgid "Do not load the tree in C<guestfs_aug_init>."
4819 #: ../src/guestfs-actions.pod:404
4820 msgid "To close the handle, you can call C<guestfs_aug_close>."
4824 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:272
4825 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4829 #: ../src/guestfs-actions.pod:412
4830 msgid "guestfs_aug_insert"
4834 #: ../src/guestfs-actions.pod:414
4838 " guestfs_aug_insert (guestfs_h *g,\n"
4839 " const char *augpath,\n"
4840 " const char *label,\n"
4846 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:278
4848 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4849 "or after C<path> (depending on the boolean flag C<before>)."
4853 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:282
4855 "C<path> must match exactly one existing node in the tree, and C<label> must "
4856 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4860 #: ../src/guestfs-actions.pod:432
4861 msgid "guestfs_aug_load"
4865 #: ../src/guestfs-actions.pod:434
4869 " guestfs_aug_load (guestfs_h *g);\n"
4874 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:290
4875 msgid "Load files into the tree."
4879 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:292
4880 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4884 #: ../src/guestfs-actions.pod:446
4885 msgid "guestfs_aug_ls"
4889 #: ../src/guestfs-actions.pod:448
4893 " guestfs_aug_ls (guestfs_h *g,\n"
4894 " const char *augpath);\n"
4899 #: ../src/guestfs-actions.pod:452