X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=po-docs%2Flibguestfs-docs.pot;h=27f79f48a6818d21d90c0cf063c45e45ce19f0e8;hp=f3c56febf5cbe909f5d1f0540896a678edc3a1e5;hb=ff6065063335194a8cac88be2d213047bf18a891;hpb=a7a1c981529a882ae0252584f0752dd1c14b8f00 diff --git a/po-docs/libguestfs-docs.pot b/po-docs/libguestfs-docs.pot index f3c56fe..27f79f4 100644 --- a/po-docs/libguestfs-docs.pot +++ b/po-docs/libguestfs-docs.pot @@ -6,37 +6,33 @@ #, fuzzy msgid "" msgstr "" -"Project-Id-Version: libguestfs 1.5.19\n" +"Project-Id-Version: libguestfs 1.9.7\n" "Report-Msgid-Bugs-To: libguestfs@redhat.com\n" -"POT-Creation-Date: 2010-09-22 21:43+0200\n" +"POT-Creation-Date: 2011-01-30 23:51+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" +"Language: \n" "MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=utf-8\n" -"Content-Transfer-Encoding: ENCODING" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" -# type: =encoding -#: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 ../inspector/virt-inspector.pl:36 ../tools/virt-cat.pl:30 ../tools/virt-df.pl:32 ../tools/virt-edit.pl:31 ../tools/virt-list-filesystems.pl:28 ../tools/virt-list-partitions.pl:28 ../tools/virt-ls.pl:31 ../tools/virt-make-fs.pl:33 ../tools/virt-rescue.pl:29 ../tools/virt-resize.pl:38 ../tools/virt-tar.pl:30 ../tools/virt-win-reg.pl:34 -msgid "utf8" -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pl:38 ../tools/virt-cat.pl:32 ../tools/virt-df.pl:34 ../tools/virt-edit.pl:33 ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30 ../tools/virt-ls.pl:33 ../tools/virt-make-fs.pl:35 ../tools/virt-rescue.pl:31 ../tools/virt-resize.pl:40 ../tools/virt-tar.pl:32 ../tools/virt-win-reg.pl:36 +#. type: =head1 +#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 msgid "NAME" msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:5 msgid "guestfs - Library for accessing and modifying virtual machine images" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pl:42 ../tools/virt-cat.pl:36 ../tools/virt-df.pl:38 ../tools/virt-edit.pl:37 ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34 ../tools/virt-ls.pl:37 ../tools/virt-make-fs.pl:39 ../tools/virt-rescue.pl:35 ../tools/virt-resize.pl:44 ../tools/virt-tar.pl:36 ../tools/virt-win-reg.pl:40 +#. type: =head1 +#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 msgid "SYNOPSIS" msgstr "" -# type: verbatim +#. type: verbatim #: ../src/guestfs.pod:9 #, no-wrap msgid "" @@ -44,7 +40,7 @@ msgid "" " \n" msgstr "" -# type: verbatim +#. type: verbatim #: ../src/guestfs.pod:11 #, no-wrap msgid "" @@ -54,13 +50,12 @@ msgid "" " guestfs_mount (g, \"/dev/sda1\", \"/\");\n" " guestfs_touch (g, \"/hello\");\n" " guestfs_umount (g, \"/\");\n" -" guestfs_sync (g);\n" " guestfs_close (g);\n" "\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:20 +#. type: verbatim +#: ../src/guestfs.pod:19 #, no-wrap msgid "" " cc prog.c -o prog -lguestfs\n" @@ -69,13 +64,13 @@ msgid "" "\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:24 ../fish/guestfish.pod:115 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:16 ../inspector/virt-inspector.pl:48 ../tools/virt-cat.pl:42 ../tools/virt-df.pl:46 ../tools/virt-edit.pl:51 ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40 ../tools/virt-ls.pl:43 ../tools/virt-make-fs.pl:47 ../tools/virt-rescue.pl:51 ../tools/virt-resize.pl:50 ../tools/virt-tar.pl:73 ../tools/virt-win-reg.pl:64 +#. type: =head1 +#: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40 msgid "DESCRIPTION" msgstr "" -# type: textblock -#: ../src/guestfs.pod:26 +#. type: textblock +#: ../src/guestfs.pod:25 msgid "" "Libguestfs is a library for accessing and modifying guest disk images. " "Amongst the things this is good for: making batch configuration changes to " @@ -85,8 +80,8 @@ msgid "" "registry/UUID/hostname info, and much else besides." msgstr "" -# type: textblock -#: ../src/guestfs.pod:34 +#. type: textblock +#: ../src/guestfs.pod:33 msgid "" "Libguestfs uses Linux kernel and qemu code, and can access any type of guest " "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, " @@ -94,16 +89,16 @@ msgid "" "qcow2, vmdk." msgstr "" -# type: textblock -#: ../src/guestfs.pod:39 +#. type: textblock +#: ../src/guestfs.pod:38 msgid "" "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, " "what filesystem is in each LV, etc.). It can also run commands in the " "context of the guest. Also you can access filesystems over FUSE." msgstr "" -# type: textblock -#: ../src/guestfs.pod:44 +#. type: textblock +#: ../src/guestfs.pod:43 msgid "" "Libguestfs is a library that can be linked with C and C++ management " "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, " @@ -111,40 +106,47 @@ msgid "" "line." msgstr "" -# type: textblock -#: ../src/guestfs.pod:49 +#. type: textblock +#: ../src/guestfs.pod:48 msgid "" "You don't need to be root to use libguestfs, although obviously you do need " "enough permissions to access the disk images." msgstr "" -# type: textblock -#: ../src/guestfs.pod:52 +#. type: textblock +#: ../src/guestfs.pod:51 msgid "" "Libguestfs is a large API because it can do many things. For a gentle " "introduction, please read the L section next." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:55 -msgid "API OVERVIEW" +#. type: textblock +#: ../src/guestfs.pod:54 +msgid "" +"There are also some example programs in the L manual " +"page." msgstr "" -# type: textblock +#. type: =head1 #: ../src/guestfs.pod:57 +msgid "API OVERVIEW" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:59 msgid "" "This section provides a gentler overview of the libguestfs API. We also try " "to group API calls together, where that may not be obvious from reading " "about the individual calls in the main section of this manual." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:62 +#. type: =head2 +#: ../src/guestfs.pod:64 msgid "HANDLES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:64 +#. type: textblock +#: ../src/guestfs.pod:66 msgid "" "Before you can use libguestfs calls, you have to create a handle. Then you " "must add at least one disk image to the handle, followed by launching the " @@ -153,21 +155,21 @@ msgid "" "handle variable, although of course you can use any name you want." msgstr "" -# type: textblock -#: ../src/guestfs.pod:71 +#. type: textblock +#: ../src/guestfs.pod:73 msgid "The general structure of all libguestfs-using programs looks like this:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:74 +#. type: verbatim +#: ../src/guestfs.pod:76 #, no-wrap msgid "" " guestfs_h *g = guestfs_create ();\n" " \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:76 +#. type: verbatim +#: ../src/guestfs.pod:78 #, no-wrap msgid "" " /* Call guestfs_add_drive additional times if there are\n" @@ -177,8 +179,8 @@ msgid "" " \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:81 +#. type: verbatim +#: ../src/guestfs.pod:83 #, no-wrap msgid "" " /* Most manipulation calls won't work until you've launched\n" @@ -189,8 +191,8 @@ msgid "" " \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:87 +#. type: verbatim +#: ../src/guestfs.pod:89 #, no-wrap msgid "" " /* Now you can examine what partitions, LVs etc are available.\n" @@ -200,8 +202,8 @@ msgid "" " \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:92 +#. type: verbatim +#: ../src/guestfs.pod:94 #, no-wrap msgid "" " /* To access a filesystem in the image, you must mount it.\n" @@ -210,32 +212,31 @@ msgid "" " \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:96 +#. type: verbatim +#: ../src/guestfs.pod:98 #, no-wrap msgid "" " /* Now you can perform filesystem actions on the guest\n" " * disk image.\n" " */\n" " guestfs_touch (g, \"/hello\");\n" -" \n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:101 +#. type: verbatim +#: ../src/guestfs.pod:103 #, no-wrap msgid "" -" /* You only need to call guestfs_sync if you have made\n" -" * changes to the guest image. (But if you've made changes\n" -" * then you *must* sync). See also: guestfs_umount and\n" -" * guestfs_umount_all calls.\n" +" /* This is only needed for libguestfs < 1.5.24. Since then\n" +" * it is done automatically when you close the handle. See\n" +" * discussion of autosync in this page.\n" " */\n" " guestfs_sync (g);\n" " \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:108 +#. type: verbatim +#: ../src/guestfs.pod:109 #, no-wrap msgid "" " /* Close the handle 'g'. */\n" @@ -243,24 +244,25 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:111 +#. type: textblock +#: ../src/guestfs.pod:112 msgid "" "The code above doesn't include any error checking. In real code you should " "check return values carefully for errors. In general all functions that " "return integers return C<-1> on error, and all functions that return " "pointers return C on error. See section L below for " "how to handle errors, and consult the documentation for each function call " -"below to see precisely how they return error indications." +"below to see precisely how they return error indications. See " +"L for fully worked examples." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:119 +#. type: =head2 +#: ../src/guestfs.pod:121 msgid "DISK IMAGES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:121 +#. type: textblock +#: ../src/guestfs.pod:123 msgid "" "The image filename (C<\"guest.img\"> in the example above) could be a disk " "image from a virtual machine, a L copy of a physical hard disk, an " @@ -269,95 +271,137 @@ msgid "" "of these." msgstr "" -# type: textblock -#: ../src/guestfs.pod:127 +#. type: textblock +#: ../src/guestfs.pod:129 +msgid "" +"The call you should use in modern code for adding drives is " +"L. To add a disk image, allowing writes, and " +"specifying that the format is raw, do:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:133 +#, no-wrap +msgid "" +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n" +" -1);\n" +"\n" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:137 +msgid "You can add a disk read-only using:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:139 +#, no-wrap +msgid "" +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n" +" GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n" +" -1);\n" +"\n" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:144 msgid "" -"You can add a disk read-only using L, in which case " +"or by calling the older function L. In either case " "libguestfs won't modify the file." msgstr "" -# type: textblock -#: ../src/guestfs.pod:130 +#. type: textblock +#: ../src/guestfs.pod:147 msgid "" "Be extremely cautious if the disk image is in use, eg. if it is being used " "by a virtual machine. Adding it read-write will almost certainly cause disk " "corruption, but adding it read-only is safe." msgstr "" -# type: textblock -#: ../src/guestfs.pod:134 +#. type: textblock +#: ../src/guestfs.pod:151 msgid "" "You must add at least one disk image, and you may add multiple disk images. " "In the API, the disk images are usually referred to as C (for the " "first one you added), C (for the second one you added), etc." msgstr "" -# type: textblock -#: ../src/guestfs.pod:139 +#. type: textblock +#: ../src/guestfs.pod:156 msgid "" "Once L has been called you cannot add any more images. You " "can call L to get a list of the device names, in the " "order that you added them. See also L below." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:144 +#. type: =head2 +#: ../src/guestfs.pod:161 msgid "MOUNTING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:146 +#. type: textblock +#: ../src/guestfs.pod:163 msgid "" "Before you can read or write files, create directories and so on in a disk " "image that contains filesystems, you have to mount those filesystems using " -"L. If you already know that a disk image contains (for " -"example) one partition with a filesystem on that partition, then you can " -"mount it directly:" +"L or L. If you already know that " +"a disk image contains (for example) one partition with a filesystem on that " +"partition, then you can mount it directly:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:152 +#. type: verbatim +#: ../src/guestfs.pod:170 #, no-wrap msgid "" -" guestfs_mount (g, \"/dev/sda1\", \"/\");\n" +" guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:154 +#. type: textblock +#: ../src/guestfs.pod:172 msgid "" "where C means literally the first partition (C<1>) of the first " "disk image that we added (C). If the disk contains Linux LVM2 " -"logical volumes you could refer to those instead (eg. C)." +"logical volumes you could refer to those instead (eg. C). Note " +"that these are libguestfs virtual devices, and are nothing to do with host " +"devices." msgstr "" -# type: textblock -#: ../src/guestfs.pod:158 +#. type: textblock +#: ../src/guestfs.pod:178 msgid "" "If you are given a disk image and you don't know what it contains then you " "have to find out. Libguestfs can do that too: use " "L and L to list possible partitions " "and LVs, and either try mounting each to see what is mountable, or else " -"examine them with L or L. Libguestfs also " -"has a set of APIs for inspection of disk images (see L below). " -"But you might find it easier to look at higher level programs built on top " -"of libguestfs, in particular L." +"examine them with L or L. To list just " +"filesystems, use L." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:186 +msgid "" +"Libguestfs also has a set of APIs for inspection of unknown disk images (see " +"L below). But you might find it easier to look at higher level " +"programs built on top of libguestfs, in particular L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:168 +#. type: textblock +#: ../src/guestfs.pod:191 msgid "" -"To mount a disk image read-only, use L. There are " +"To mount a filesystem read-only, use L. There are " "several other variations of the C call." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:171 +#. type: =head2 +#: ../src/guestfs.pod:194 msgid "FILESYSTEM ACCESS AND MODIFICATION" msgstr "" -# type: textblock -#: ../src/guestfs.pod:173 +#. type: textblock +#: ../src/guestfs.pod:196 msgid "" "The majority of the libguestfs API consists of fairly low-level calls for " "accessing and modifying the files, directories, symlinks etc on mounted " @@ -366,58 +410,58 @@ msgid "" "all in this overview." msgstr "" -# type: textblock -#: ../src/guestfs.pod:179 +#. type: textblock +#: ../src/guestfs.pod:202 msgid "" "Specify filenames as full paths, starting with C<\"/\"> and including the " "mount point." msgstr "" -# type: textblock -#: ../src/guestfs.pod:182 +#. type: textblock +#: ../src/guestfs.pod:205 msgid "" "For example, if you mounted a filesystem at C<\"/\"> and you want to read " "the file called C<\"etc/passwd\"> then you could do:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:185 +#. type: verbatim +#: ../src/guestfs.pod:208 #, no-wrap msgid "" " char *data = guestfs_cat (g, \"/etc/passwd\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:187 +#. type: textblock +#: ../src/guestfs.pod:210 msgid "" "This would return C as a newly allocated buffer containing the full " "content of that file (with some conditions: see also L below), " "or C if there was an error." msgstr "" -# type: textblock -#: ../src/guestfs.pod:191 +#. type: textblock +#: ../src/guestfs.pod:214 msgid "" "As another example, to create a top-level directory on that filesystem " "called C<\"var\"> you would do:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:194 +#. type: verbatim +#: ../src/guestfs.pod:217 #, no-wrap msgid "" " guestfs_mkdir (g, \"/var\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:196 +#. type: textblock +#: ../src/guestfs.pod:219 msgid "To create a symlink you could do:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:198 +#. type: verbatim +#: ../src/guestfs.pod:221 #, no-wrap msgid "" " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n" @@ -425,15 +469,15 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:201 +#. type: textblock +#: ../src/guestfs.pod:224 msgid "" "Libguestfs will reject attempts to use relative paths and there is no " "concept of a current working directory." msgstr "" -# type: textblock -#: ../src/guestfs.pod:204 +#. type: textblock +#: ../src/guestfs.pod:227 msgid "" "Libguestfs can return errors in many situations: for example if the " "filesystem isn't writable, or if a file or directory that you requested " @@ -442,34 +486,34 @@ msgid "" "turn these errors into exceptions)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:210 +#. type: textblock +#: ../src/guestfs.pod:233 msgid "" "File writes are affected by the per-handle umask, set by calling " "L and defaulting to 022. See L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:213 +#. type: =head2 +#: ../src/guestfs.pod:236 msgid "PARTITIONING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:215 +#. type: textblock +#: ../src/guestfs.pod:238 msgid "" "Libguestfs contains API calls to read, create and modify partition tables on " "disk images." msgstr "" -# type: textblock -#: ../src/guestfs.pod:218 +#. type: textblock +#: ../src/guestfs.pod:241 msgid "" "In the common case where you want to create a single partition covering the " "whole disk, you should use the L call:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:222 +#. type: verbatim +#: ../src/guestfs.pod:245 #, no-wrap msgid "" " const char *parttype = \"mbr\";\n" @@ -479,20 +523,20 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:227 +#. type: textblock +#: ../src/guestfs.pod:250 msgid "" "Obviously this effectively wipes anything that was on that disk image " "before." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:230 +#. type: =head2 +#: ../src/guestfs.pod:253 msgid "LVM2" msgstr "" -# type: textblock -#: ../src/guestfs.pod:232 +#. type: textblock +#: ../src/guestfs.pod:255 msgid "" "Libguestfs provides access to a large part of the LVM2 API, such as " "L and L. It won't make much sense " @@ -500,60 +544,60 @@ msgid "" "volume groups and logical volumes." msgstr "" -# type: textblock -#: ../src/guestfs.pod:237 +#. type: textblock +#: ../src/guestfs.pod:260 msgid "" "This author strongly recommends reading the LVM HOWTO, online at " "L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:240 +#. type: =head2 +#: ../src/guestfs.pod:263 msgid "DOWNLOADING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:242 +#. type: textblock +#: ../src/guestfs.pod:265 msgid "" "Use L to download small, text only files. This call is " "limited to files which are less than 2 MB and which cannot contain any ASCII " -"NUL (C<\\0>) characters. However it has a very simple to use API." +"NUL (C<\\0>) characters. However the API is very simple to use." msgstr "" -# type: textblock -#: ../src/guestfs.pod:247 +#. type: textblock +#: ../src/guestfs.pod:269 msgid "" "L can be used to read files which contain arbitrary 8 " "bit data, since it returns a (pointer, size) pair. However it is still " "limited to \"small\" files, less than 2 MB." msgstr "" -# type: textblock -#: ../src/guestfs.pod:251 +#. type: textblock +#: ../src/guestfs.pod:273 msgid "" "L can be used to download any file, with no limits on " "content or size (even files larger than 4 GB)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:254 +#. type: textblock +#: ../src/guestfs.pod:276 msgid "To download multiple files, see L and L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:257 +#. type: =head2 +#: ../src/guestfs.pod:279 msgid "UPLOADING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:259 +#. type: textblock +#: ../src/guestfs.pod:281 msgid "" "It's often the case that you want to write a file or files to the disk " "image." msgstr "" -# type: textblock -#: ../src/guestfs.pod:262 +#. type: textblock +#: ../src/guestfs.pod:284 msgid "" "To write a small file with fixed content, use L. To create " "a file of all zeroes, use L (sparse) or " @@ -562,20 +606,20 @@ msgid "" "L and L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:268 +#. type: textblock +#: ../src/guestfs.pod:290 msgid "" "To upload a single file, use L. This call has no limits on " "file content or size (even files larger than 4 GB)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:271 +#. type: textblock +#: ../src/guestfs.pod:293 msgid "To upload multiple files, see L and L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:273 +#. type: textblock +#: ../src/guestfs.pod:295 msgid "" "However the fastest way to upload I is to " "turn them into a squashfs or CD ISO (see L and " @@ -588,205 +632,271 @@ msgid "" "using a label or UUID, use an ISO image instead." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:284 +#. type: =head2 +#: ../src/guestfs.pod:306 msgid "COPYING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:286 +#. type: textblock +#: ../src/guestfs.pod:308 msgid "" "There are various different commands for copying between files and devices " "and in and out of the guest filesystem. These are summarised in the table " "below." msgstr "" -# type: =item -#: ../src/guestfs.pod:292 +#. type: =item +#: ../src/guestfs.pod:314 msgid "B to B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:294 +#. type: textblock +#: ../src/guestfs.pod:316 msgid "" "Use L to copy a single file, or L to copy " "directories recursively." msgstr "" -# type: =item -#: ../src/guestfs.pod:297 +#. type: =item +#: ../src/guestfs.pod:319 msgid "B to B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:299 +#. type: textblock +#: ../src/guestfs.pod:321 msgid "" "Use L which efficiently uses L to copy between files and " "devices in the guest." msgstr "" -# type: textblock -#: ../src/guestfs.pod:302 +#. type: textblock +#: ../src/guestfs.pod:324 msgid "Example: duplicate the contents of an LV:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:304 +#. type: verbatim +#: ../src/guestfs.pod:326 #, no-wrap msgid "" " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:306 +#. type: textblock +#: ../src/guestfs.pod:328 msgid "" "The destination (C) must be at least as large as the source " "(C). To copy less than the whole source device, use " "L." msgstr "" -# type: =item -#: ../src/guestfs.pod:310 +#. type: =item +#: ../src/guestfs.pod:332 msgid "B to B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:312 +#. type: textblock +#: ../src/guestfs.pod:334 msgid "Use L. See L above." msgstr "" -# type: =item -#: ../src/guestfs.pod:314 +#. type: =item +#: ../src/guestfs.pod:336 msgid "B to B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:316 +#. type: textblock +#: ../src/guestfs.pod:338 msgid "Use L. See L above." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:320 +#. type: =head2 +#: ../src/guestfs.pod:342 +msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:344 +msgid "" +"Calls like L, L, L, " +"L etc appear to only take filenames as arguments, so it " +"appears you can only upload and download to files. However many Un*x-like " +"hosts let you use the special device files C, C, " +"C and C to read and write from stdin, stdout, " +"stderr, and arbitrary file descriptor N." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:352 +msgid "For example, L writes its output to stdout by doing:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:355 +#, no-wrap +msgid "" +" guestfs_download (g, filename, \"/dev/stdout\");\n" +"\n" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:357 +msgid "and you can write tar output to a pipe C by doing:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:359 +#, no-wrap +msgid "" +" char devfd[64];\n" +" snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n" +" guestfs_tar_out (g, \"/\", devfd);\n" +"\n" +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:363 msgid "LISTING FILES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:322 +#. type: textblock +#: ../src/guestfs.pod:365 msgid "" "L is just designed for humans to read (mainly when using the " "L-equivalent command C)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:325 +#. type: textblock +#: ../src/guestfs.pod:368 msgid "" "L is a quick way to get a list of files in a directory from " "programs, as a flat list of strings." msgstr "" -# type: textblock -#: ../src/guestfs.pod:328 +#. type: textblock +#: ../src/guestfs.pod:371 msgid "" "L is a programmatic way to get a list of files in a " "directory, plus additional information about each one. It is more " "equivalent to using the L call on a local filesystem." msgstr "" -# type: textblock -#: ../src/guestfs.pod:332 +#. type: textblock +#: ../src/guestfs.pod:375 msgid "" "L and L can be used to recursively list " "files." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:335 +#. type: =head2 +#: ../src/guestfs.pod:378 msgid "RUNNING COMMANDS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:337 +#. type: textblock +#: ../src/guestfs.pod:380 msgid "" "Although libguestfs is primarily an API for manipulating files inside guest " "images, we also provide some limited facilities for running commands inside " "guests." msgstr "" -# type: textblock -#: ../src/guestfs.pod:341 +#. type: textblock +#: ../src/guestfs.pod:384 msgid "There are many limitations to this:" msgstr "" -# type: =item -#: ../src/guestfs.pod:345 ../src/guestfs.pod:350 ../src/guestfs.pod:355 ../src/guestfs.pod:359 ../src/guestfs.pod:364 ../src/guestfs.pod:368 ../src/guestfs.pod:373 ../src/guestfs.pod:1223 ../src/guestfs.pod:1228 ../src/guestfs.pod:1232 ../src/guestfs.pod:1334 ../src/guestfs.pod:1338 ../src/guestfs.pod:1342 ../src/guestfs.pod:1347 ../src/guestfs.pod:1355 ../src/guestfs.pod:1374 ../src/guestfs.pod:1382 ../src/guestfs.pod:1612 ../src/guestfs.pod:1618 ../src/guestfs.pod:1623 ../src/guestfs.pod:1629 ../src/guestfs.pod:1736 ../src/guestfs.pod:1740 ../src/guestfs.pod:1744 ../src/guestfs.pod:1748 ../src/guestfs-actions.pod:14 ../src/guestfs-actions.pod:21 ../src/guestfs-actions.pod:372 ../src/guestfs-actions.pod:380 ../src/guestfs-actions.pod:387 ../src/guestfs-actions.pod:394 ../src/guestfs-actions.pod:1285 ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1293 ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1305 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:1313 ../src/guestfs-actions.pod:1323 ../src/guestfs-actions.pod:1327 ../src/guestfs-actions.pod:1331 ../src/guestfs-actions.pod:1454 ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1463 ../src/guestfs-actions.pod:1468 ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1524 ../src/guestfs-actions.pod:1529 ../fish/guestfish.pod:316 ../fish/guestfish.pod:320 ../fish/guestfish.pod:324 ../fish/guestfish.pod:328 ../fish/guestfish-actions.pod:15 ../fish/guestfish-actions.pod:22 ../fish/guestfish-actions.pod:306 ../fish/guestfish-actions.pod:314 ../fish/guestfish-actions.pod:321 ../fish/guestfish-actions.pod:328 ../fish/guestfish-actions.pod:1023 ../fish/guestfish-actions.pod:1027 ../fish/guestfish-actions.pod:1031 ../fish/guestfish-actions.pod:1035 ../fish/guestfish-actions.pod:1043 ../fish/guestfish-actions.pod:1047 ../fish/guestfish-actions.pod:1051 ../fish/guestfish-actions.pod:1061 ../fish/guestfish-actions.pod:1065 ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1159 ../fish/guestfish-actions.pod:1163 ../fish/guestfish-actions.pod:1168 ../fish/guestfish-actions.pod:1173 ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1224 ../tools/virt-df.pl:144 ../tools/virt-df.pl:150 ../tools/virt-resize.pl:324 ../tools/virt-resize.pl:329 ../tools/virt-resize.pl:339 +#. type: =item +#: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1031 ../src/guestfs.pod:1035 ../src/guestfs.pod:1039 ../src/guestfs.pod:1044 ../src/guestfs.pod:1052 ../src/guestfs.pod:1071 ../src/guestfs.pod:1079 ../src/guestfs.pod:1101 ../src/guestfs.pod:1105 ../src/guestfs.pod:1109 ../src/guestfs.pod:1113 ../src/guestfs.pod:1117 ../src/guestfs.pod:1121 ../src/guestfs.pod:1603 ../src/guestfs.pod:1608 ../src/guestfs.pod:1612 ../src/guestfs.pod:1722 ../src/guestfs.pod:1727 ../src/guestfs.pod:1731 ../src/guestfs.pod:2083 ../src/guestfs.pod:2089 ../src/guestfs.pod:2094 ../src/guestfs.pod:2100 ../src/guestfs.pod:2565 ../src/guestfs.pod:2569 ../src/guestfs.pod:2573 ../src/guestfs.pod:2577 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633 ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775 ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:427 ../fish/guestfish.pod:431 ../fish/guestfish.pod:435 ../fish/guestfish.pod:439 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:373 ../fish/guestfish-actions.pod:381 ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:1065 ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1073 ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1085 ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1093 ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107 ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1201 ../fish/guestfish-actions.pod:1205 ../fish/guestfish-actions.pod:1210 ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1257 ../fish/guestfish-actions.pod:1261 ../fish/guestfish-actions.pod:1266 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360 msgid "*" msgstr "" -# type: textblock -#: ../src/guestfs.pod:347 +#. type: textblock +#: ../src/guestfs.pod:390 msgid "" "The kernel version that the command runs under will be different from what " "it expects." msgstr "" -# type: textblock -#: ../src/guestfs.pod:352 +#. type: textblock +#: ../src/guestfs.pod:395 msgid "" "If the command needs to communicate with daemons, then most likely they " "won't be running." msgstr "" -# type: textblock -#: ../src/guestfs.pod:357 +#. type: textblock +#: ../src/guestfs.pod:400 msgid "The command will be running in limited memory." msgstr "" -# type: textblock -#: ../src/guestfs.pod:361 +#. type: textblock +#: ../src/guestfs.pod:404 msgid "" "The network may not be available unless you enable it (see " "L)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:366 +#. type: textblock +#: ../src/guestfs.pod:409 msgid "Only supports Linux guests (not Windows, BSD, etc)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:370 +#. type: textblock +#: ../src/guestfs.pod:413 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:375 +#. type: textblock +#: ../src/guestfs.pod:418 msgid "" "For SELinux guests, you may need to enable SELinux and load policy first. " "See L in this manpage." msgstr "" -# type: textblock -#: ../src/guestfs.pod:380 +#. type: textblock +#: ../src/guestfs.pod:423 +msgid "" +"I It is not safe to run commands from untrusted, possibly " +"malicious guests. These commands may attempt to exploit your program by " +"sending unexpected output. They could also try to exploit the Linux kernel " +"or qemu provided by the libguestfs appliance. They could use the network " +"provided by the libguestfs appliance to bypass ordinary network partitions " +"and firewalls. They could use the elevated privileges or different SELinux " +"context of your program to their advantage." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:432 +msgid "" +"A secure alternative is to use libguestfs to install a \"firstboot\" script " +"(a script which runs when the guest next boots normally), and to have this " +"script run the commands you want in the normal context of the running guest, " +"network security and so on. For information about other security issues, " +"see L." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:440 msgid "" "The two main API calls to run commands are L and " "L (there are also variations)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:383 +#. type: textblock +#: ../src/guestfs.pod:443 msgid "" "The difference is that L runs commands using the shell, so any " "shell globs, redirections, etc will work." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:386 +#. type: =head2 +#: ../src/guestfs.pod:446 msgid "CONFIGURATION FILES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:388 +#. type: textblock +#: ../src/guestfs.pod:448 msgid "" "To read and write configuration files in Linux guest filesystems, we " "strongly recommend using Augeas. For example, Augeas understands how to " @@ -794,118 +904,118 @@ msgid "" "file, and so avoids you having to write that code." msgstr "" -# type: textblock -#: ../src/guestfs.pod:393 +#. type: textblock +#: ../src/guestfs.pod:453 msgid "" "The main Augeas calls are bound through the C APIs. We don't " "document Augeas itself here because there is excellent documentation on the " "L website." msgstr "" -# type: textblock -#: ../src/guestfs.pod:397 +#. type: textblock +#: ../src/guestfs.pod:457 msgid "" "If you don't want to use Augeas (you fool!) then try calling " "L to get the file as a list of lines which you can " "iterate over." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:401 +#. type: =head2 +#: ../src/guestfs.pod:461 msgid "SELINUX" msgstr "" -# type: textblock -#: ../src/guestfs.pod:403 +#. type: textblock +#: ../src/guestfs.pod:463 msgid "" "We support SELinux guests. To ensure that labeling happens correctly in " "SELinux guests, you need to enable SELinux and load the guest's policy:" msgstr "" -# type: =item -#: ../src/guestfs.pod:409 +#. type: =item +#: ../src/guestfs.pod:469 ../src/guestfs.pod:1224 ../src/guestfs.pod:1355 ../src/guestfs.pod:2128 msgid "1." msgstr "" -# type: textblock -#: ../src/guestfs.pod:411 +#. type: textblock +#: ../src/guestfs.pod:471 msgid "Before launching, do:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:413 +#. type: verbatim +#: ../src/guestfs.pod:473 #, no-wrap msgid "" " guestfs_set_selinux (g, 1);\n" "\n" msgstr "" -# type: =item -#: ../src/guestfs.pod:415 +#. type: =item +#: ../src/guestfs.pod:475 ../src/guestfs.pod:1228 ../src/guestfs.pod:1359 ../src/guestfs.pod:2153 msgid "2." msgstr "" -# type: textblock -#: ../src/guestfs.pod:417 +#. type: textblock +#: ../src/guestfs.pod:477 msgid "" "After mounting the guest's filesystem(s), load the policy. This is best " "done by running the L command in the guest itself:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:421 +#. type: verbatim +#: ../src/guestfs.pod:481 #, no-wrap msgid "" " guestfs_sh (g, \"/usr/sbin/load_policy\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:423 +#. type: textblock +#: ../src/guestfs.pod:483 msgid "" "(Older versions of C require you to specify the name of the " "policy file)." msgstr "" -# type: =item -#: ../src/guestfs.pod:426 +#. type: =item +#: ../src/guestfs.pod:486 ../src/guestfs.pod:1365 msgid "3." msgstr "" -# type: textblock -#: ../src/guestfs.pod:428 +#. type: textblock +#: ../src/guestfs.pod:488 msgid "" "Optionally, set the security context for the API. The correct security " "context to use can only be known by inspecting the guest. As an example:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:432 +#. type: verbatim +#: ../src/guestfs.pod:492 #, no-wrap msgid "" " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:436 +#. type: textblock +#: ../src/guestfs.pod:496 msgid "This will work for running commands and editing existing files." msgstr "" -# type: textblock -#: ../src/guestfs.pod:438 +#. type: textblock +#: ../src/guestfs.pod:498 msgid "" "When new files are created, you may need to label them explicitly, for " "example by running the external command C." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:442 +#. type: =head2 +#: ../src/guestfs.pod:502 msgid "UMASK" msgstr "" -# type: textblock -#: ../src/guestfs.pod:444 +#. type: textblock +#: ../src/guestfs.pod:504 msgid "" "Certain calls are affected by the current file mode creation mask (the " "\"umask\"). In particular ones which create files or directories, such as " @@ -914,33 +1024,33 @@ msgid "" "that you supply." msgstr "" -# type: textblock -#: ../src/guestfs.pod:450 +#. type: textblock +#: ../src/guestfs.pod:510 msgid "" "The default umask is C<022>, so files are created with modes such as C<0644> " "and directories with C<0755>." msgstr "" -# type: textblock -#: ../src/guestfs.pod:453 +#. type: textblock +#: ../src/guestfs.pod:513 msgid "" "There are two ways to avoid being affected by umask. Either set umask to 0 " "(call C early after launching). Or call " "L after creating each file or directory." msgstr "" -# type: textblock -#: ../src/guestfs.pod:457 +#. type: textblock +#: ../src/guestfs.pod:517 msgid "For more information about umask, see L." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:459 ../fish/guestfish.pod:566 +#. type: =head1 +#: ../src/guestfs.pod:519 ../fish/guestfish.pod:746 msgid "ENCRYPTED DISKS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:461 +#. type: textblock +#: ../src/guestfs.pod:521 msgid "" "Libguestfs allows you to access Linux guests which have been encrypted using " "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) " @@ -948,22 +1058,22 @@ msgid "" "modern Linux guests." msgstr "" -# type: textblock -#: ../src/guestfs.pod:467 +#. type: textblock +#: ../src/guestfs.pod:527 msgid "" "Use L to identify LUKS-encrypted block devices (it " "returns the string C)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:470 +#. type: textblock +#: ../src/guestfs.pod:530 msgid "" "Then open these devices by calling L. Obviously you " "will require the passphrase!" msgstr "" -# type: textblock -#: ../src/guestfs.pod:473 +#. type: textblock +#: ../src/guestfs.pod:533 msgid "" "Opening a LUKS device creates a new device mapper device called " "C (where C is the string you supply to " @@ -971,16 +1081,16 @@ msgid "" "decrypted from and encrypted to the underlying block device respectively." msgstr "" -# type: textblock -#: ../src/guestfs.pod:479 +#. type: textblock +#: ../src/guestfs.pod:539 msgid "" "LVM volume groups on the device can be made visible by calling " "L followed by L. The logical " "volume(s) can now be mounted in the usual way." msgstr "" -# type: textblock -#: ../src/guestfs.pod:483 +#. type: textblock +#: ../src/guestfs.pod:543 msgid "" "Use the reverse process to close a LUKS device. Unmount any logical volumes " "on it, deactivate the volume groups by caling C but since version 1.5.3 the most " -"frequently used part of this library has been rewritten in C and moved into " -"the core code)." +"contains operating systems, an install CD or a live CD. (These APIs used to " +"be in a separate Perl-only library called L but since " +"version 1.5.3 the most frequently used part of this library has been " +"rewritten in C and moved into the core code)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:498 +#. type: textblock +#: ../src/guestfs.pod:559 msgid "" "Add all disks belonging to the unknown virtual machine and call " "L in the usual way." msgstr "" -# type: textblock -#: ../src/guestfs.pod:501 +#. type: textblock +#: ../src/guestfs.pod:562 msgid "" "Then call L. This function uses other libguestfs calls " "and certain heuristics, and returns a list of operating systems that were " @@ -1024,8 +1134,8 @@ msgid "" "libguestfs to deal with it.)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:510 +#. type: textblock +#: ../src/guestfs.pod:571 msgid "" "For each root, you can then call various C functions " "to get additional details about that operating system. For example, call " @@ -1033,8 +1143,8 @@ msgid "" "Windows and Linux-based operating systems respectively." msgstr "" -# type: textblock -#: ../src/guestfs.pod:516 +#. type: textblock +#: ../src/guestfs.pod:577 msgid "" "Un*x-like and Linux-based operating systems usually consist of several " "filesystems which are mounted at boot time (for example, a separate boot " @@ -1044,8 +1154,8 @@ msgid "" "hash table like this example:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:523 +#. type: verbatim +#: ../src/guestfs.pod:584 #, no-wrap msgid "" " /boot => /dev/sda1\n" @@ -1054,61 +1164,106 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:527 +#. type: textblock +#: ../src/guestfs.pod:588 msgid "" "The caller can then make calls to L to mount the " "filesystems as suggested." msgstr "" -# type: textblock -#: ../src/guestfs.pod:530 +#. type: textblock +#: ../src/guestfs.pod:591 msgid "" "Be careful to mount filesystems in the right order (eg. C before " "C). Sorting the keys of the hash by length, shortest first, should " "work." msgstr "" -# type: textblock -#: ../src/guestfs.pod:534 +#. type: textblock +#: ../src/guestfs.pod:595 msgid "" "Inspection currently only works for some common operating systems. " "Contributors are welcome to send patches for other operating systems that we " "currently cannot detect." msgstr "" -# type: textblock -#: ../src/guestfs.pod:538 +#. type: textblock +#: ../src/guestfs.pod:599 msgid "" "Encrypted disks must be opened before inspection. See L " "for more details. The L function just ignores any " "encrypted devices." msgstr "" -# type: textblock -#: ../src/guestfs.pod:542 +#. type: textblock +#: ../src/guestfs.pod:603 msgid "" "A note on the implementation: The call L performs " "inspection and caches the results in the guest handle. Subsequent calls to " "C return this cached information, but I " "re-read the disks. If you change the content of the guest disks, you can " -"redo inspection by calling L again." +"redo inspection by calling L again. " +"(L works a little differently from the " +"other calls and does read the disks. See documentation for that function " +"for details)." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:549 +#. type: =head3 +#: ../src/guestfs.pod:612 +msgid "INSPECTING INSTALL DISKS" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:614 +msgid "" +"Libguestfs (since 1.9.4) can detect some install disks, install CDs, live " +"CDs and more." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:617 +msgid "" +"Call L to return the format of the operating " +"system, which currently can be C (a regular operating system) or " +"C (some sort of install disk)." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:621 +msgid "" +"Further information is available about the operating system that can be " +"installed using the regular inspection APIs like " +"L, L " +"etc." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:626 +msgid "" +"Some additional information specific to installer disks is also available " +"from the L, L and " +"L calls." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:631 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:551 +#. type: textblock +#: ../src/guestfs.pod:633 msgid "" "Libguestfs can mount NTFS partitions. It does this using the " "L driver." msgstr "" -# type: textblock -#: ../src/guestfs.pod:554 +#. type: =head3 +#: ../src/guestfs.pod:636 +msgid "DRIVE LETTERS AND PATHS" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:638 msgid "" "DOS and Windows still use drive letters, and the filesystems are always " "treated as case insensitive by Windows itself, and therefore you might find " @@ -1117,8 +1272,8 @@ msgid "" "that directory might be referred to as C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:560 +#. type: textblock +#: ../src/guestfs.pod:644 msgid "" "Drive letter mappings are outside the scope of libguestfs. You have to use " "libguestfs to read the appropriate Windows Registry and configuration files, " @@ -1126,22 +1281,27 @@ msgid "" "L)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:565 +#. type: textblock +#: ../src/guestfs.pod:649 msgid "" "Replacing backslash characters with forward slash characters is also outside " "the scope of libguestfs, but something that you can easily do." msgstr "" -# type: textblock -#: ../src/guestfs.pod:568 +#. type: textblock +#: ../src/guestfs.pod:652 msgid "" "Where we can help is in resolving the case insensitivity of paths. For " "this, call L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:571 +#. type: =head3 +#: ../src/guestfs.pod:655 +msgid "ACCESSING THE WINDOWS REGISTRY" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:657 msgid "" "Libguestfs also provides some help for decoding Windows Registry \"hive\" " "files, through the library C which is part of the libguestfs project " @@ -1151,185 +1311,228 @@ msgid "" "L for more help on this issue." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:579 +#. type: =head3 +#: ../src/guestfs.pod:665 +msgid "SYMLINKS ON NTFS-3G FILESYSTEMS" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:667 +msgid "" +"Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to " +"provide something which looks like a Linux symlink. The way it tries to do " +"the rewriting is described here:" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:671 +msgid "L" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:673 +msgid "" +"The essential problem is that ntfs-3g simply does not have enough " +"information to do a correct job. NTFS links can contain drive letters and " +"references to external device GUIDs that ntfs-3g has no way of resolving. " +"It is almost certainly the case that libguestfs callers should ignore what " +"ntfs-3g does (ie. don't use L on NTFS volumes)." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:680 +msgid "" +"Instead if you encounter a symbolic link on an ntfs-3g filesystem, use " +"L to read the C extended " +"attribute, and read the raw reparse data from that (you can find the format " +"documented in various places around the web)." +msgstr "" + +#. type: =head3 +#: ../src/guestfs.pod:685 +msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:687 +msgid "" +"There are other useful extended attributes that can be read from ntfs-3g " +"filesystems (using L). See:" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:690 +msgid "L" +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:692 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:581 +#. type: textblock +#: ../src/guestfs.pod:694 msgid "" "Although we don't want to discourage you from using the C API, we will " "mention here that the same API is also available in other languages." msgstr "" -# type: textblock -#: ../src/guestfs.pod:584 +#. type: textblock +#: ../src/guestfs.pod:697 msgid "" "The API is broadly identical in all supported languages. This means that " -"the C call C is C<$g-Emount($path)> in Perl, " -"C in Python, and C in OCaml. In other " -"words, a straightforward, predictable isomorphism between each language." +"the C call C is C<$g-Eadd_drive_ro($file)> " +"in Perl, C in Python, and C in " +"OCaml. In other words, a straightforward, predictable isomorphism between " +"each language." msgstr "" -# type: textblock -#: ../src/guestfs.pod:590 +#. type: textblock +#: ../src/guestfs.pod:703 msgid "" "Error messages are automatically transformed into exceptions if the language " "supports it." msgstr "" -# type: textblock -#: ../src/guestfs.pod:593 +#. type: textblock +#: ../src/guestfs.pod:706 msgid "" "We don't try to \"object orientify\" parts of the API in OO languages, " "although contributors are welcome to write higher level APIs above what we " "provide in their favourite languages if they wish." msgstr "" -# type: =item -#: ../src/guestfs.pod:599 +#. type: =item +#: ../src/guestfs.pod:712 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:601 +#. type: textblock +#: ../src/guestfs.pod:714 msgid "" "You can use the I header file from C++ programs. The C++ API is " "identical to the C API. C++ classes and exceptions are not used." msgstr "" -# type: =item -#: ../src/guestfs.pod:605 +#. type: =item +#: ../src/guestfs.pod:718 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:607 +#. type: textblock +#: ../src/guestfs.pod:720 msgid "" "The C# bindings are highly experimental. Please read the warnings at the " "top of C." msgstr "" -# type: =item -#: ../src/guestfs.pod:610 +#. type: =item +#: ../src/guestfs.pod:723 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:612 +#. type: textblock +#: ../src/guestfs.pod:725 msgid "" "This is the only language binding that is working but incomplete. Only " "calls which return simple integers have been bound in Haskell, and we are " "looking for help to complete this binding." msgstr "" -# type: =item -#: ../src/guestfs.pod:616 +#. type: =item +#: ../src/guestfs.pod:729 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:618 +#. type: textblock +#: ../src/guestfs.pod:731 msgid "" "Full documentation is contained in the Javadoc which is distributed with " "libguestfs." msgstr "" -# type: =item -#: ../src/guestfs.pod:621 +#. type: =item +#: ../src/guestfs.pod:734 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:623 -msgid "For documentation see the file C." +#. type: textblock +#: ../src/guestfs.pod:736 +msgid "See L." msgstr "" -# type: =item -#: ../src/guestfs.pod:625 +#. type: =item +#: ../src/guestfs.pod:738 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:627 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:740 +msgid "See L and L." msgstr "" -# type: =item -#: ../src/guestfs.pod:629 +#. type: =item +#: ../src/guestfs.pod:742 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:631 +#. type: textblock +#: ../src/guestfs.pod:744 msgid "" "For documentation see C supplied with libguestfs sources or in " "the php-libguestfs package for your distribution." msgstr "" -# type: textblock -#: ../src/guestfs.pod:634 +#. type: textblock +#: ../src/guestfs.pod:747 msgid "The PHP binding only works correctly on 64 bit machines." msgstr "" -# type: =item -#: ../src/guestfs.pod:636 +#. type: =item +#: ../src/guestfs.pod:749 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:638 -msgid "For documentation do:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:640 -#, no-wrap -msgid "" -" $ python\n" -" >>> import guestfs\n" -" >>> help (guestfs)\n" -"\n" +#. type: textblock +#: ../src/guestfs.pod:751 +msgid "See L." msgstr "" -# type: =item -#: ../src/guestfs.pod:644 +#. type: =item +#: ../src/guestfs.pod:753 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:646 -msgid "" -"Use the Guestfs module. There is no Ruby-specific documentation, but you " -"can find examples written in Ruby in the libguestfs source." +#. type: textblock +#: ../src/guestfs.pod:755 +msgid "See L." msgstr "" -# type: =item -#: ../src/guestfs.pod:649 +#. type: =item +#: ../src/guestfs.pod:757 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:651 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:759 +msgid "See L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:655 +#. type: =head2 +#: ../src/guestfs.pod:763 msgid "LIBGUESTFS GOTCHAS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:657 +#. type: textblock +#: ../src/guestfs.pod:765 msgid "" "L: \"A feature of a " "system [...] that works in the way it is documented but is counterintuitive " "and almost invites mistakes.\"" msgstr "" -# type: textblock -#: ../src/guestfs.pod:661 +#. type: textblock +#: ../src/guestfs.pod:769 msgid "" "Since we developed libguestfs and the associated tools, there are several " "things we would have designed differently, but are now stuck with for " @@ -1337,103 +1540,110 @@ msgid "" "release, you can expect these to change. Beware of them." msgstr "" -# type: =item -#: ../src/guestfs.pod:669 +#. type: =item +#: ../src/guestfs.pod:777 msgid "Autosync / forgetting to sync." msgstr "" -# type: textblock -#: ../src/guestfs.pod:671 +#. type: textblock +#: ../src/guestfs.pod:779 msgid "" "When modifying a filesystem from C or another language, you B unmount " "all filesystems and call L explicitly before you close the " "libguestfs handle. You can also call:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:675 +#. type: verbatim +#: ../src/guestfs.pod:783 #, no-wrap msgid "" " guestfs_set_autosync (g, 1);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:677 +#. type: textblock +#: ../src/guestfs.pod:785 msgid "" "to have the unmount/sync done automatically for you when the handle 'g' is " "closed. (This feature is called \"autosync\", L " "q.v.)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:681 +#. type: textblock +#: ../src/guestfs.pod:789 msgid "" "If you forget to do this, then it is entirely possible that your changes " "won't be written out, or will be partially written, or (very rarely) that " "you'll get disk corruption." msgstr "" -# type: textblock -#: ../src/guestfs.pod:685 +#. type: textblock +#: ../src/guestfs.pod:793 msgid "" "Note that in L autosync is the default. So quick and dirty " "guestfish scripts that forget to sync will work just fine, which can make " "this very puzzling if you are trying to debug a problem." msgstr "" -# type: =item -#: ../src/guestfs.pod:689 +#. type: textblock +#: ../src/guestfs.pod:797 +msgid "" +"Update: Autosync is enabled by default for all API users starting from " +"libguestfs 1.5.24." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:800 msgid "Mount option C<-o sync> should not be the default." msgstr "" -# type: textblock -#: ../src/guestfs.pod:691 +#. type: textblock +#: ../src/guestfs.pod:802 msgid "" "If you use L, then C<-o sync,noatime> are added implicitly. " "However C<-o sync> does not add any reliability benefit, but does have a " "very large performance impact." msgstr "" -# type: textblock -#: ../src/guestfs.pod:695 +#. type: textblock +#: ../src/guestfs.pod:806 msgid "" "The work around is to use L and set the mount " "options that you actually want to use." msgstr "" -# type: =item -#: ../src/guestfs.pod:698 +#. type: =item +#: ../src/guestfs.pod:809 msgid "Read-only should be the default." msgstr "" -# type: textblock -#: ../src/guestfs.pod:700 +#. type: textblock +#: ../src/guestfs.pod:811 msgid "" "In L, I<--ro> should be the default, and you should have to " "specify I<--rw> if you want to make changes to the image." msgstr "" -# type: textblock -#: ../src/guestfs.pod:703 +#. type: textblock +#: ../src/guestfs.pod:814 msgid "This would reduce the potential to corrupt live VM images." msgstr "" -# type: textblock -#: ../src/guestfs.pod:705 +#. type: textblock +#: ../src/guestfs.pod:816 msgid "" "Note that many filesystems change the disk when you just mount and unmount, " "even if you didn't perform any writes. You need to use " "L to guarantee that the disk is not changed." msgstr "" -# type: =item -#: ../src/guestfs.pod:709 +#. type: =item +#: ../src/guestfs.pod:820 msgid "guestfish command line is hard to use." msgstr "" -# type: textblock -#: ../src/guestfs.pod:711 +#. type: textblock +#: ../src/guestfs.pod:822 msgid "" "C doesn't do what people expect (open C for " "examination). It tries to run a guestfish command C which doesn't " @@ -1442,13 +1652,13 @@ msgid "" "we should have used C to run commands." msgstr "" -# type: =item -#: ../src/guestfs.pod:718 +#. type: =item +#: ../src/guestfs.pod:829 msgid "guestfish megabyte modifiers don't work right on all commands" msgstr "" -# type: textblock -#: ../src/guestfs.pod:720 +#. type: textblock +#: ../src/guestfs.pod:831 msgid "" "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for " "other modifiers). What guestfish actually does is to multiply the number " @@ -1457,21 +1667,21 @@ msgid "" "expecting some other unit (eg. megabytes)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:727 +#. type: textblock +#: ../src/guestfs.pod:838 msgid "The most common is L. The guestfish command:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:729 +#. type: verbatim +#: ../src/guestfs.pod:840 #, no-wrap msgid "" " lvcreate LV VG 100M\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:731 +#. type: textblock +#: ../src/guestfs.pod:842 msgid "" "does not do what you might expect. Instead because L is " "already expecting megabytes, this tries to create a 100 I (100 " @@ -1479,41 +1689,83 @@ msgid "" "is also a little obscure." msgstr "" -# type: textblock -#: ../src/guestfs.pod:736 +#. type: textblock +#: ../src/guestfs.pod:847 msgid "" "This could be fixed in the generator by specially marking parameters and " "return values which take bytes or other units." msgstr "" -# type: =item -#: ../src/guestfs.pod:739 -msgid "Library should return errno with error messages." +#. type: =item +#: ../src/guestfs.pod:850 +msgid "Ambiguity between devices and paths" msgstr "" -# type: textblock -#: ../src/guestfs.pod:741 +#. type: textblock +#: ../src/guestfs.pod:852 msgid "" -"It would be a nice-to-have to be able to get the original value of 'errno' " -"from inside the appliance along error paths (where set). Currently " -"L goes through hoops to try to reverse the error message " -"string into an errno, see the function error() in fuse/guestmount.c." +"There is a subtle ambiguity in the API between a device name " +"(eg. C) and a similar pathname. A file might just happen to be " +"called C in the directory C (consider some non-Unix VM image)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:747 +#. type: textblock +#: ../src/guestfs.pod:857 +msgid "" +"In the current API we usually resolve this ambiguity by having two separate " +"calls, for example L and L. " +"Some API calls are ambiguous and (incorrectly) resolve the problem by " +"detecting if the path supplied begins with C." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:863 msgid "" -"In libguestfs 1.5.4, the protocol was changed so that the Linux errno is " -"sent back from the daemon." +"To avoid both the ambiguity and the need to duplicate some calls, we could " +"make paths/devices into structured names. One way to do this would be to " +"use a notation like grub (C), although nobody really likes this " +"aspect of grub. Another way would be to use a structured type, equivalent " +"to this OCaml type:" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:752 +#. type: verbatim +#: ../src/guestfs.pod:869 +#, no-wrap +msgid "" +" type path = Path of string | Device of int | Partition of int * int\n" +"\n" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:871 +msgid "which would allow you to pass arguments like:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:873 +#, no-wrap +msgid "" +" Path \"/foo/bar\"\n" +" Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n" +" Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n" +" Path \"/dev/sdb2\" (* not a device *)\n" +"\n" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:878 +msgid "" +"As you can see there are still problems to resolve even with this " +"representation. Also consider how it might work in guestfish." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:883 msgid "PROTOCOL LIMITS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:754 +#. type: textblock +#: ../src/guestfs.pod:885 msgid "" "Internally libguestfs uses a message-based protocol to pass API calls and " "their responses to and from a small \"appliance\" (see L for " @@ -1523,8 +1775,8 @@ msgid "" "documented, with a link back to this section of the documentation." msgstr "" -# type: textblock -#: ../src/guestfs.pod:762 +#. type: textblock +#: ../src/guestfs.pod:893 msgid "" "A simple call such as L returns its result (the file data) in " "a simple string. Because this string is at some point internally encoded as " @@ -1532,35 +1784,35 @@ msgid "" "the requested file is larger than this then you will get an error." msgstr "" -# type: textblock -#: ../src/guestfs.pod:768 +#. type: textblock +#: ../src/guestfs.pod:899 msgid "" "In order to transfer large files into and out of the guest filesystem, you " "need to use particular calls that support this. The sections L " "and L document how to do this." msgstr "" -# type: textblock -#: ../src/guestfs.pod:772 +#. type: textblock +#: ../src/guestfs.pod:903 msgid "" "You might also consider mounting the disk image using our FUSE filesystem " "support (L)." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:775 +#. type: =head2 +#: ../src/guestfs.pod:906 msgid "KEYS AND PASSPHRASES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:777 +#. type: textblock +#: ../src/guestfs.pod:908 msgid "" "Certain libguestfs calls take a parameter that contains sensitive key " "material, passed in as a C string." msgstr "" -# type: textblock -#: ../src/guestfs.pod:780 +#. type: textblock +#: ../src/guestfs.pod:911 msgid "" "In the future we would hope to change the libguestfs implementation so that " "keys are L-ed into physical RAM, and thus can never end up in " @@ -1568,23312 +1820,26325 @@ msgid "" "of such an implementation." msgstr "" -# type: textblock -#: ../src/guestfs.pod:785 +#. type: textblock +#: ../src/guestfs.pod:916 msgid "" "Therefore you should be aware that any key parameter you pass to libguestfs " "might end up being written out to the swap partition. If this is a concern, " "scrub the swap partition or don't use libguestfs on encrypted devices." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:790 -msgid "CONNECTION MANAGEMENT" -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:792 -msgid "guestfs_h *" +#. type: =head2 +#: ../src/guestfs.pod:921 +msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:794 +#. type: textblock +#: ../src/guestfs.pod:923 msgid "" -"C is the opaque type representing a connection handle. Create a " -"handle by calling L. Call L to free the " -"handle and release all resources used." +"All high-level libguestfs actions are synchronous. If you want to use " +"libguestfs asynchronously then you must create a thread." msgstr "" -# type: textblock -#: ../src/guestfs.pod:798 +#. type: textblock +#: ../src/guestfs.pod:926 msgid "" -"For information on using multiple handles and threads, see the section " -"L below." +"Only use the handle from a single thread. Either use the handle exclusively " +"from one thread, or provide your own mutex so that two threads cannot issue " +"calls on the same handle at the same time." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:801 -msgid "guestfs_create" +#. type: textblock +#: ../src/guestfs.pod:930 +msgid "" +"See the graphical program guestfs-browser for one possible architecture for " +"multithreaded programs using libvirt and libguestfs." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:803 -#, no-wrap -msgid "" -" guestfs_h *guestfs_create (void);\n" -"\n" +#. type: =head2 +#: ../src/guestfs.pod:933 +msgid "PATH" msgstr "" -# type: textblock -#: ../src/guestfs.pod:805 -msgid "Create a connection handle." +#. type: textblock +#: ../src/guestfs.pod:935 +msgid "" +"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " +"internal path." msgstr "" -# type: textblock -#: ../src/guestfs.pod:807 -msgid "You have to call L on the handle at least once." +#. type: textblock +#: ../src/guestfs.pod:938 +msgid "" +"By default it looks for these in the directory C<$libdir/guestfs> " +"(eg. C or C)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:809 +#. type: textblock +#: ../src/guestfs.pod:941 msgid "" -"This function returns a non-NULL pointer to a handle on success or NULL on " -"error." +"Use L or set the environment variable L " +"to change the directories that libguestfs will search in. The value is a " +"colon-separated list of paths. The current directory is I searched " +"unless the path contains an empty element or C<.>. For example " +"C would search the current directory and " +"then C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:812 -msgid "After configuring the handle, you have to call L." +#. type: =head2 +#: ../src/guestfs.pod:948 +msgid "QEMU WRAPPERS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:814 +#. type: textblock +#: ../src/guestfs.pod:950 msgid "" -"You may also want to configure error handling for the handle. See L section below." +"If you want to compile your own qemu, run qemu from a non-standard location, " +"or pass extra arguments to qemu, then you can write a shell-script wrapper " +"around qemu." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:817 -msgid "guestfs_close" +#. type: textblock +#: ../src/guestfs.pod:954 +msgid "" +"There is one important rule to remember: you I> as the " +"last command in the shell script (so that qemu replaces the shell and " +"becomes the direct child of the libguestfs-using program). If you don't do " +"this, then the qemu process won't be cleaned up correctly." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:819 +#. type: textblock +#: ../src/guestfs.pod:959 +msgid "" +"Here is an example of a wrapper, where I have built my own copy of qemu from " +"source:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:962 #, no-wrap msgid "" -" void guestfs_close (guestfs_h *g);\n" +" #!/bin/sh -\n" +" qemudir=/home/rjones/d/qemu\n" +" exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios " +"\"$@\"\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:821 -msgid "This closes the connection handle and frees up all resources used." +#. type: textblock +#: ../src/guestfs.pod:966 +msgid "" +"Save this script as C (or wherever), C, and " +"then use it by setting the LIBGUESTFS_QEMU environment variable. For " +"example:" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:823 -msgid "ERROR HANDLING" +#. type: verbatim +#: ../src/guestfs.pod:970 +#, no-wrap +msgid "" +" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:825 +#. type: textblock +#: ../src/guestfs.pod:972 msgid "" -"The convention in all functions that return C is that they return C<-1> " -"to indicate an error. You can get additional information on errors by " -"calling L and/or by setting up an error handler with " -"L." +"Note that libguestfs also calls qemu with the -help and -version options in " +"order to determine features." msgstr "" -# type: textblock -#: ../src/guestfs.pod:830 -msgid "The default error handler prints the information string to C." +#. type: =head2 +#: ../src/guestfs.pod:975 +msgid "ABI GUARANTEE" msgstr "" -# type: textblock -#: ../src/guestfs.pod:832 +#. type: textblock +#: ../src/guestfs.pod:977 msgid "" -"Out of memory errors are handled differently. The default action is to call " -"L. If this is undesirable, then you can set a handler using " -"L." +"We guarantee the libguestfs ABI (binary interface), for public, high-level " +"actions as outlined in this section. Although we will deprecate some " +"actions, for example if they get replaced by newer calls, we will keep the " +"old actions forever. This allows you the developer to program in confidence " +"against the libguestfs API." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:836 -msgid "guestfs_last_error" +#. type: =head2 +#: ../src/guestfs.pod:983 +msgid "BLOCK DEVICE NAMING" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:838 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:985 msgid "" -" const char *guestfs_last_error (guestfs_h *g);\n" -"\n" +"In the kernel there is now quite a profusion of schemata for naming block " +"devices (in this context, by I I mean a physical or virtual " +"hard drive). The original Linux IDE driver used names starting with " +"C. SCSI devices have historically used a different naming scheme, " +"C. When the Linux kernel I driver became a popular " +"replacement for the old IDE driver (particularly for SATA devices) those " +"devices also used the C scheme. Additionally we now have virtual " +"machines with paravirtualized drivers. This has created several different " +"naming systems, such as C for virtio disks and C for " +"Xen PV disks." msgstr "" -# type: textblock -#: ../src/guestfs.pod:840 +#. type: textblock +#: ../src/guestfs.pod:997 msgid "" -"This returns the last error message that happened on C. If there has not " -"been an error since the handle was created, then this returns C." +"As discussed above, libguestfs uses a qemu appliance running an embedded " +"Linux kernel to access block devices. We can run a variety of appliances " +"based on a variety of Linux kernels." msgstr "" -# type: textblock -#: ../src/guestfs.pod:844 +#. type: textblock +#: ../src/guestfs.pod:1001 msgid "" -"The lifetime of the returned string is until the next error occurs, or " -"L is called." +"This causes a problem for libguestfs because many API calls use device or " +"partition names. Working scripts and the recipe (example) scripts that we " +"make available over the internet could fail if the naming scheme changes." msgstr "" -# type: textblock -#: ../src/guestfs.pod:847 +#. type: textblock +#: ../src/guestfs.pod:1006 msgid "" -"The error string is not localized (ie. is always in English), because this " -"makes searching for error messages in search engines give the largest number " -"of results." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:851 -msgid "guestfs_set_error_handler" +"Therefore libguestfs defines C as the I. " +"Internally C names are translated, if necessary, to other names as " +"required. For example, under RHEL 5 which uses the C scheme, any " +"device parameter C is translated to C transparently." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:853 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1012 msgid "" -" typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" -" void *opaque,\n" -" const char *msg);\n" -" void guestfs_set_error_handler (guestfs_h *g,\n" -" guestfs_error_handler_cb cb,\n" -" void *opaque);\n" -"\n" +"Note that this I applies to parameters. The L, " +"L and similar calls return the true names of the " +"devices and partitions as known to the appliance." msgstr "" -# type: textblock -#: ../src/guestfs.pod:860 -msgid "" -"The callback C will be called if there is an error. The parameters " -"passed to the callback are an opaque data pointer and the error message " -"string." +#. type: =head3 +#: ../src/guestfs.pod:1017 +msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" msgstr "" -# type: textblock -#: ../src/guestfs.pod:864 +#. type: textblock +#: ../src/guestfs.pod:1019 msgid "" -"Note that the message string C is freed as soon as the callback " -"function returns, so if you want to stash it somewhere you must make your " -"own copy." +"Usually this translation is transparent. However in some (very rare) cases " +"you may need to know the exact algorithm. Such cases include where you use " +"L to add a mixture of virtio and IDE devices to the " +"qemu-based appliance, so have a mixture of C and C " +"devices." msgstr "" -# type: textblock -#: ../src/guestfs.pod:868 -msgid "The default handler prints messages on C." +#. type: textblock +#: ../src/guestfs.pod:1025 +msgid "" +"The algorithm is applied only to I which are known to be either " +"device or partition names. Return values from functions such as " +"L are never changed." msgstr "" -# type: textblock -#: ../src/guestfs.pod:870 -msgid "If you set C to C then I handler is called." +#. type: textblock +#: ../src/guestfs.pod:1033 +msgid "Is the string a parameter which is a device or partition name?" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:872 -msgid "guestfs_get_error_handler" +#. type: textblock +#: ../src/guestfs.pod:1037 +msgid "Does the string begin with C?" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:874 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1041 msgid "" -" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" -" void **opaque_rtn);\n" -"\n" +"Does the named device exist? If so, we use that device. However if I " +"then we continue with this algorithm." msgstr "" -# type: textblock -#: ../src/guestfs.pod:877 -msgid "Returns the current error handler callback." +#. type: textblock +#: ../src/guestfs.pod:1046 +msgid "Replace initial C string with C." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:879 -msgid "guestfs_set_out_of_memory_handler" +#. type: textblock +#: ../src/guestfs.pod:1048 +msgid "For example, change C to C." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:881 -#, no-wrap -msgid "" -" typedef void (*guestfs_abort_cb) (void);\n" -" int guestfs_set_out_of_memory_handler (guestfs_h *g,\n" -" guestfs_abort_cb);\n" -"\n" +#. type: textblock +#: ../src/guestfs.pod:1050 +msgid "If that named device exists, use it. If not, continue." msgstr "" -# type: textblock -#: ../src/guestfs.pod:885 -msgid "" -"The callback C will be called if there is an out of memory situation. " -"I." +#. type: textblock +#: ../src/guestfs.pod:1054 +msgid "Replace initial C string with C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:888 -msgid "The default is to call L." +#. type: textblock +#: ../src/guestfs.pod:1056 +msgid "If that named device exists, use it. If not, return an error." msgstr "" -# type: textblock -#: ../src/guestfs.pod:890 -msgid "You cannot set C to C. You can't ignore out of memory situations." +#. type: =head3 +#: ../src/guestfs.pod:1060 +msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:893 -msgid "guestfs_get_out_of_memory_handler" +#. type: textblock +#: ../src/guestfs.pod:1062 +msgid "" +"Although the standard naming scheme and automatic translation is useful for " +"simple programs and guestfish scripts, for larger programs it is best not to " +"rely on this mechanism." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:895 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1066 msgid "" -" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" -"\n" +"Where possible for maximum future portability programs using libguestfs " +"should use these future-proof techniques:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:897 -msgid "This returns the current out of memory handler." +#. type: textblock +#: ../src/guestfs.pod:1073 +msgid "" +"Use L or L to list actual " +"device names, and then use those names directly." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:899 -msgid "PATH" +#. type: textblock +#: ../src/guestfs.pod:1076 +msgid "Since those device names exist by definition, they will never be translated." msgstr "" -# type: textblock -#: ../src/guestfs.pod:901 +#. type: textblock +#: ../src/guestfs.pod:1081 msgid "" -"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " -"internal path." +"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " +"filesystem labels." msgstr "" -# type: textblock -#: ../src/guestfs.pod:904 -msgid "" -"By default it looks for these in the directory C<$libdir/guestfs> " -"(eg. C or C)." +#. type: =head1 +#: ../src/guestfs.pod:1086 +msgid "SECURITY" msgstr "" -# type: textblock -#: ../src/guestfs.pod:907 +#. type: textblock +#: ../src/guestfs.pod:1088 msgid "" -"Use L or set the environment variable L " -"to change the directories that libguestfs will search in. The value is a " -"colon-separated list of paths. The current directory is I searched " -"unless the path contains an empty element or C<.>. For example " -"C would search the current directory and " -"then C." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:914 -msgid "HIGH-LEVEL API ACTIONS" +"This section discusses security implications of using libguestfs, " +"particularly with untrusted or malicious guests or disk images." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:916 -msgid "ABI GUARANTEE" +#. type: =head2 +#: ../src/guestfs.pod:1091 +msgid "GENERAL SECURITY CONSIDERATIONS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:918 +#. type: textblock +#: ../src/guestfs.pod:1093 msgid "" -"We guarantee the libguestfs ABI (binary interface), for public, high-level " -"actions as outlined in this section. Although we will deprecate some " -"actions, for example if they get replaced by newer calls, we will keep the " -"old actions forever. This allows you the developer to program in confidence " -"against the libguestfs API." +"Be careful with any files or data that you download from a guest (by " +"\"download\" we mean not just the L command but any " +"command that reads files, filenames, directories or anything else from a " +"disk image). An attacker could manipulate the data to fool your program " +"into doing the wrong thing. Consider cases such as:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:924 ../fish/guestfish.pod:796 -msgid "@ACTIONS@" +#. type: textblock +#: ../src/guestfs.pod:1103 +msgid "the data (file etc) not being present" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:926 -msgid "STRUCTURES" +#. type: textblock +#: ../src/guestfs.pod:1107 +msgid "being present but empty" msgstr "" -# type: textblock -#: ../src/guestfs.pod:928 -msgid "@STRUCTS@" +#. type: textblock +#: ../src/guestfs.pod:1111 +msgid "being much larger than normal" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:930 -msgid "AVAILABILITY" +#. type: textblock +#: ../src/guestfs.pod:1115 +msgid "containing arbitrary 8 bit data" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:932 -msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" +#. type: textblock +#: ../src/guestfs.pod:1119 +msgid "being in an unexpected character encoding" msgstr "" -# type: textblock -#: ../src/guestfs.pod:934 -msgid "" -"Using L you can test availability of the following " -"groups of functions. This test queries the appliance to see if the " -"appliance you are currently using supports the functionality." +#. type: textblock +#: ../src/guestfs.pod:1123 +msgid "containing homoglyphs." msgstr "" -# type: textblock -#: ../src/guestfs.pod:939 -msgid "@AVAILABILITY@" +#. type: =head2 +#: ../src/guestfs.pod:1127 +msgid "SECURITY OF MOUNTING FILESYSTEMS" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:941 -msgid "GUESTFISH supported COMMAND" +#. type: textblock +#: ../src/guestfs.pod:1129 +msgid "" +"When you mount a filesystem under Linux, mistakes in the kernel filesystem " +"(VFS) module can sometimes be escalated into exploits by deliberately " +"creating a malicious, malformed filesystem. These exploits are very severe " +"for two reasons. Firstly there are very many filesystem drivers in the " +"kernel, and many of them are infrequently used and not much developer " +"attention has been paid to the code. Linux userspace helps potential " +"crackers by detecting the filesystem type and automatically choosing the " +"right VFS driver, even if that filesystem type is obscure or unexpected for " +"the administrator. Secondly, a kernel-level exploit is like a local root " +"exploit (worse in some ways), giving immediate and total access to the " +"system right down to the hardware level." msgstr "" -# type: textblock -#: ../src/guestfs.pod:943 +#. type: textblock +#: ../src/guestfs.pod:1142 msgid "" -"In L there is a handy interactive command C which " -"prints out the available groups and whether they are supported by this build " -"of libguestfs. Note however that you have to do C first." +"That explains why you should never mount a filesystem from an untrusted " +"guest on your host kernel. How about libguestfs? We run a Linux kernel " +"inside a qemu virtual machine, usually running as a non-root user. The " +"attacker would need to write a filesystem which first exploited the kernel, " +"and then exploited either qemu virtualization (eg. a faulty qemu driver) or " +"the libguestfs protocol, and finally to be as serious as the host kernel " +"exploit it would need to escalate its privileges to root. This multi-step " +"escalation, performed by a static piece of data, is thought to be extremely " +"hard to do, although we never say 'never' about security issues." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:948 -msgid "SINGLE CALLS AT COMPILE TIME" +#. type: textblock +#: ../src/guestfs.pod:1153 +msgid "" +"In any case callers can reduce the attack surface by forcing the filesystem " +"type when mounting (use L)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:950 -msgid "" -"Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " -"function, such as:" +#. type: =head2 +#: ../src/guestfs.pod:1156 +msgid "PROTOCOL SECURITY" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:953 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1158 msgid "" -" #define LIBGUESTFS_HAVE_DD 1\n" -"\n" +"The protocol is designed to be secure, being based on RFC 4506 (XDR) with a " +"defined upper message size. However a program that uses libguestfs must " +"also take care - for example you can write a program that downloads a binary " +"from a disk image and executes it locally, and no amount of protocol " +"security will save you from the consequences." msgstr "" -# type: textblock -#: ../src/guestfs.pod:955 -msgid "if L is available." +#. type: =head2 +#: ../src/guestfs.pod:1164 +msgid "INSPECTION SECURITY" msgstr "" -# type: textblock -#: ../src/guestfs.pod:957 +#. type: textblock +#: ../src/guestfs.pod:1166 msgid "" -"Before version 1.5.8, if you needed to test whether a single libguestfs " -"function is available at compile time, we recommended using build tools such " -"as autoconf or cmake. For example in autotools you could use:" +"Parts of the inspection API (see L) return untrusted strings " +"directly from the guest, and these could contain any 8 bit data. Callers " +"should be careful to escape these before printing them to a structured file " +"(for example, use HTML escaping if creating a web page)." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:962 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1172 msgid "" -" AC_CHECK_LIB([guestfs],[guestfs_create])\n" -" AC_CHECK_FUNCS([guestfs_dd])\n" -"\n" +"Guest configuration may be altered in unusual ways by the administrator of " +"the virtual machine, and may not reflect reality (particularly for untrusted " +"or actively malicious guests). For example we parse the hostname from " +"configuration files like C that we find in the " +"guest, but the guest administrator can easily manipulate these files to " +"provide the wrong hostname." msgstr "" -# type: textblock -#: ../src/guestfs.pod:965 +#. type: textblock +#: ../src/guestfs.pod:1180 msgid "" -"which would result in C being either defined or not defined " -"in your program." +"The inspection API parses guest configuration using two external libraries: " +"Augeas (Linux configuration) and hivex (Windows Registry). Both are " +"designed to be robust in the face of malicious data, although denial of " +"service attacks are still possible, for example with oversized configuration " +"files." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:968 -msgid "SINGLE CALLS AT RUN TIME" +#. type: =head2 +#: ../src/guestfs.pod:1186 +msgid "RUNNING UNTRUSTED GUEST COMMANDS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:970 +#. type: textblock +#: ../src/guestfs.pod:1188 msgid "" -"Testing at compile time doesn't guarantee that a function really exists in " -"the library. The reason is that you might be dynamically linked against a " -"previous I (dynamic library) which doesn't have the call. " -"This situation unfortunately results in a segmentation fault, which is a " -"shortcoming of the C dynamic linking system itself." +"Be very cautious about running commands from the guest. By running a " +"command in the guest, you are giving CPU time to a binary that you do not " +"control, under the same user account as the library, albeit wrapped in qemu " +"virtualization. More information and alternatives can be found in the " +"section L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:977 -msgid "" -"You can use L to test if a function is available at run time, as " -"in this example program (note that you still need the compile time check as " -"well):" +#. type: =head2 +#: ../src/guestfs.pod:1194 +msgid "CVE-2010-3851" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:981 -#, no-wrap -msgid "" -" #include \n" -" #include \n" -" #include \n" -" #include \n" -" #include \n" -" \n" +#. type: textblock +#: ../src/guestfs.pod:1196 +msgid "https://bugzilla.redhat.com/642934" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:987 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1198 msgid "" -" main ()\n" -" {\n" -" #ifdef LIBGUESTFS_HAVE_DD\n" -" void *dl;\n" -" int has_function;\n" -" \n" +"This security bug concerns the automatic disk format detection that qemu " +"does on disk images." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:993 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1201 msgid "" -" /* Test if the function guestfs_dd is really available. */\n" -" dl = dlopen (NULL, RTLD_LAZY);\n" -" if (!dl) {\n" -" fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n" -" exit (EXIT_FAILURE);\n" -" }\n" -" has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n" -" dlclose (dl);\n" -" \n" +"A raw disk image is just the raw bytes, there is no header. Other disk " +"images like qcow2 contain a special header. Qemu deals with this by looking " +"for one of the known headers, and if none is found then assuming the disk " +"image must be raw." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1002 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1206 msgid "" -" if (!has_function)\n" -" printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n" -" else {\n" -" printf (\"this libguestfs.so has guestfs_dd function\\n\");\n" -" /* Now it's safe to call\n" -" guestfs_dd (g, \"foo\", \"bar\");\n" -" */\n" -" }\n" -" #else\n" -" printf (\"guestfs_dd function was not found at compile time\\n\");\n" -" #endif\n" -" }\n" -"\n" +"This allows a guest which has been given a raw disk image to write some " +"other header. At next boot (or when the disk image is accessed by " +"libguestfs) qemu would do autodetection and think the disk image format was, " +"say, qcow2 based on the header written by the guest." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1015 +#. type: textblock +#: ../src/guestfs.pod:1211 msgid "" -"You may think the above is an awful lot of hassle, and it is. There are " -"other ways outside of the C linking system to ensure that this kind of " -"incompatibility never arises, such as using package versioning:" +"This in itself would not be a problem, but qcow2 offers many features, one " +"of which is to allow a disk image to refer to another image (called the " +"\"backing disk\"). It does this by placing the path to the backing disk " +"into the qcow2 header. This path is not validated and could point to any " +"host file (eg. \"/etc/passwd\"). The backing disk is then exposed through " +"\"holes\" in the qcow2 disk image, which of course is completely under the " +"control of the attacker." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1020 -#, no-wrap -msgid "" -" Requires: libguestfs >= 1.0.80\n" -"\n" +#. type: textblock +#: ../src/guestfs.pod:1219 +msgid "In libguestfs this is rather hard to exploit except under two circumstances:" msgstr "" -# type: =end -#: ../src/guestfs.pod:1022 ../src/guestfs.pod:1027 -msgid "html" +#. type: textblock +#: ../src/guestfs.pod:1226 +msgid "You have enabled the network or have opened the disk in write mode." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1024 +#. type: textblock +#: ../src/guestfs.pod:1230 msgid "" -" " +"You are also running untrusted code from the guest (see L)." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1029 -msgid "ARCHITECTURE" +#. type: textblock +#: ../src/guestfs.pod:1235 +msgid "" +"The way to avoid this is to specify the expected disk format when adding " +"disks (the optional C option to L). You " +"should always do this if the disk is raw format, and it's a good idea for " +"other cases too." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1031 +#. type: textblock +#: ../src/guestfs.pod:1240 msgid "" -"Internally, libguestfs is implemented by running an appliance (a special " -"type of small virtual machine) using L. Qemu runs as a child " -"process of the main program." +"For disks added from libvirt using calls like L, the " +"format is fetched from libvirt and passed through." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1035 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1243 msgid "" -" ___________________\n" -" / \\\n" -" | main program |\n" -" | |\n" -" | | child process / appliance\n" -" | | __________________________\n" -" | | / qemu \\\n" -" +-------------------+ RPC | +-----------------+ |\n" -" | libguestfs <--------------------> guestfsd | |\n" -" | | | +-----------------+ |\n" -" \\___________________/ | | Linux kernel | |\n" -" | +--^--------------+ |\n" -" \\_________|________________/\n" -" |\n" -" _______v______\n" -" / \\\n" -" | Device or |\n" -" | disk image |\n" -" \\______________/\n" -"\n" +"For libguestfs tools, use the I<--format> command line parameter as " +"appropriate." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1055 -msgid "" -"The library, linked to the main program, creates the child process and hence " -"the appliance in the L function." +#. type: =head1 +#: ../src/guestfs.pod:1246 +msgid "CONNECTION MANAGEMENT" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1058 -msgid "" -"Inside the appliance is a Linux kernel and a complete stack of userspace " -"tools (such as LVM and ext2 programs) and a small controlling daemon called " -"L. The library talks to L using remote procedure " -"calls (RPC). There is a mostly one-to-one correspondence between libguestfs " -"API calls and RPC calls to the daemon. Lastly the disk image(s) are " -"attached to the qemu process which translates device access by the " -"appliance's Linux kernel into accesses to the image." +#. type: =head2 +#: ../src/guestfs.pod:1248 +msgid "guestfs_h *" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1067 +#. type: textblock +#: ../src/guestfs.pod:1250 msgid "" -"A common misunderstanding is that the appliance \"is\" the virtual machine. " -"Although the disk image you are attached to might also be used by some " -"virtual machine, libguestfs doesn't know or care about this. (But you will " -"care if both libguestfs's qemu process and your virtual machine are trying " -"to update the disk image at the same time, since these usually results in " -"massive disk corruption)." +"C is the opaque type representing a connection handle. Create a " +"handle by calling L. Call L to free the " +"handle and release all resources used." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1074 -msgid "STATE MACHINE" +#. type: textblock +#: ../src/guestfs.pod:1254 +msgid "" +"For information on using multiple handles and threads, see the section " +"L below." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1076 -msgid "libguestfs uses a state machine to model the child process:" +#. type: =head2 +#: ../src/guestfs.pod:1257 +msgid "guestfs_create" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1078 +#. type: verbatim +#: ../src/guestfs.pod:1259 #, no-wrap msgid "" -" |\n" -" guestfs_create\n" -" |\n" -" |\n" -" ____V_____\n" -" / \\\n" -" | CONFIG |\n" -" \\__________/\n" -" ^ ^ ^ \\\n" -" / | \\ \\ guestfs_launch\n" -" / | _\\__V______\n" -" / | / \\\n" -" / | | LAUNCHING |\n" -" / | \\___________/\n" -" / | /\n" -" / | guestfs_launch\n" -" / | /\n" -" ______ / __|____V\n" -" / \\ ------> / \\\n" -" | BUSY | | READY |\n" -" \\______/ <------ \\________/\n" +" guestfs_h *guestfs_create (void);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1100 -msgid "" -"The normal transitions are (1) CONFIG (when the handle is created, but there " -"is no child process), (2) LAUNCHING (when the child process is booting up), " -"(3) alternating between READY and BUSY as commands are issued to, and " -"carried out by, the child process." +#. type: textblock +#: ../src/guestfs.pod:1261 +msgid "Create a connection handle." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1105 +#. type: textblock +#: ../src/guestfs.pod:1263 msgid "" -"The guest may be killed by L, or may die " -"asynchronously at any time (eg. due to some internal error), and that causes " -"the state to transition back to CONFIG." +"You have to call L (or one of the equivalent calls) " +"on the handle at least once." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1109 +#. type: textblock +#: ../src/guestfs.pod:1266 msgid "" -"Configuration commands for qemu such as L can only be " -"issued when in the CONFIG state." +"This function returns a non-NULL pointer to a handle on success or NULL on " +"error." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1112 -msgid "" -"The API offers one call that goes from CONFIG through LAUNCHING to READY. " -"L blocks until the child process is READY to accept " -"commands (or until some failure or timeout). L internally " -"moves the state from CONFIG to LAUNCHING while it is running." +#. type: textblock +#: ../src/guestfs.pod:1269 +msgid "After configuring the handle, you have to call L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1118 +#. type: textblock +#: ../src/guestfs.pod:1271 msgid "" -"API actions such as L can only be issued when in the READY " -"state. These API calls block waiting for the command to be carried out " -"(ie. the state to transition to BUSY and then back to READY). There are no " -"non-blocking versions, and no way to issue more than one command per handle " -"at the same time." +"You may also want to configure error handling for the handle. See L section below." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:1274 +msgid "guestfs_close" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1124 +#. type: verbatim +#: ../src/guestfs.pod:1276 +#, no-wrap msgid "" -"Finally, the child process sends asynchronous messages back to the main " -"program, such as kernel log messages. You can register a callback to " -"receive these messages." +" void guestfs_close (guestfs_h *g);\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1128 -msgid "SETTING CALLBACKS TO HANDLE EVENTS" +#. type: textblock +#: ../src/guestfs.pod:1278 +msgid "This closes the connection handle and frees up all resources used." +msgstr "" + +#. type: =head1 +#: ../src/guestfs.pod:1280 +msgid "ERROR HANDLING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1130 +#. type: textblock +#: ../src/guestfs.pod:1282 msgid "" -"The child process generates events in some situations. Current events " -"include: receiving a log message, the child process exits." +"API functions can return errors. For example, almost all functions that " +"return C will return C<-1> to indicate an error." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1133 +#. type: textblock +#: ../src/guestfs.pod:1285 msgid "" -"Use the C functions to set a callback for different " -"types of events." +"Additional information is available for errors: an error message string and " +"optionally an error number (errno) if the thing that failed was a system " +"call." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1136 +#. type: textblock +#: ../src/guestfs.pod:1289 msgid "" -"Only I can be registered for each handle. " -"Calling C again overwrites the previous callback of " -"that type. Cancel all callbacks of this type by calling this function with " -"C set to C." +"You can get at the additional information about the last error on the handle " +"by calling L, L, and/or by setting " +"up an error handler with L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1141 -msgid "guestfs_set_log_message_callback" +#. type: textblock +#: ../src/guestfs.pod:1294 +msgid "" +"When the handle is created, a default error handler is installed which " +"prints the error message string to C. For small short-running " +"command line programs it is sufficient to do:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1143 +#. type: verbatim +#: ../src/guestfs.pod:1298 #, no-wrap msgid "" -" typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n" -" char *buf, int len);\n" -" void guestfs_set_log_message_callback (guestfs_h *g,\n" -" guestfs_log_message_cb cb,\n" -" void *opaque);\n" +" if (guestfs_launch (g) == -1)\n" +" exit (EXIT_FAILURE);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1149 +#. type: textblock +#: ../src/guestfs.pod:1301 msgid "" -"The callback function C will be called whenever qemu or the guest writes " -"anything to the console." +"since the default error handler will ensure that an error message has been " +"printed to C before the program exits." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1152 -msgid "Use this function to capture kernel messages and similar." +#. type: textblock +#: ../src/guestfs.pod:1304 +msgid "" +"For other programs the caller will almost certainly want to install an " +"alternate error handler or do error handling in-line like this:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1154 +#. type: verbatim +#: ../src/guestfs.pod:1307 +#, no-wrap msgid "" -"Normally there is no log message handler, and log messages are just " -"discarded." +" g = guestfs_create ();\n" +" \n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1157 -msgid "guestfs_set_subprocess_quit_callback" +#. type: verbatim +#: ../src/guestfs.pod:1309 +#, no-wrap +msgid "" +" /* This disables the default behaviour of printing errors\n" +" on stderr. */\n" +" guestfs_set_error_handler (g, NULL, NULL);\n" +" \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1159 +#. type: verbatim +#: ../src/guestfs.pod:1313 #, no-wrap msgid "" -" typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n" -" void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n" -" guestfs_subprocess_quit_cb cb,\n" -" void *opaque);\n" +" if (guestfs_launch (g) == -1) {\n" +" /* Examine the error message and print it etc. */\n" +" char *msg = guestfs_last_error (g);\n" +" int errnum = guestfs_last_errno (g);\n" +" fprintf (stderr, \"%s\\n\", msg);\n" +" /* ... */\n" +" }\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1164 +#. type: textblock +#: ../src/guestfs.pod:1321 msgid "" -"The callback function C will be called when the child process quits, " -"either asynchronously or if killed by L. (This " -"corresponds to a transition from any state to the CONFIG state)." +"Out of memory errors are handled differently. The default action is to call " +"L. If this is undesirable, then you can set a handler using " +"L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1169 -msgid "guestfs_set_launch_done_callback" +#. type: textblock +#: ../src/guestfs.pod:1325 +msgid "" +"L returns C if the handle cannot be created, and " +"because there is no handle if this happens there is no way to get additional " +"error information. However L is supposed to be a " +"lightweight operation which can only fail because of insufficient memory (it " +"returns NULL in this case)." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1171 +#. type: =head2 +#: ../src/guestfs.pod:1331 +msgid "guestfs_last_error" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:1333 #, no-wrap msgid "" -" typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n" -" void guestfs_set_launch_done_callback (guestfs_h *g,\n" -" guestfs_launch_done_cb cb,\n" -" void *opaque);\n" +" const char *guestfs_last_error (guestfs_h *g);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1176 +#. type: textblock +#: ../src/guestfs.pod:1335 msgid "" -"The callback function C will be called when the child process becomes " -"ready first time after it has been launched. (This corresponds to a " -"transition from LAUNCHING to the READY state)." +"This returns the last error message that happened on C. If there has not " +"been an error since the handle was created, then this returns C." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1180 -msgid "guestfs_set_close_callback" +#. type: textblock +#: ../src/guestfs.pod:1339 +msgid "" +"The lifetime of the returned string is until the next error occurs, or " +"L is called." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:1342 +msgid "guestfs_last_errno" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1182 +#. type: verbatim +#: ../src/guestfs.pod:1344 #, no-wrap msgid "" -" typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n" -" void guestfs_set_close_callback (guestfs_h *g,\n" -" guestfs_close_cb cb,\n" -" void *opaque);\n" +" int guestfs_last_errno (guestfs_h *g);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1187 -msgid "" -"The callback function C will be called while the handle is being closed " -"(synchronously from L)." +#. type: textblock +#: ../src/guestfs.pod:1346 +msgid "This returns the last error number (errno) that happened on C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1190 -msgid "" -"Note that libguestfs installs an L handler to try to clean up " -"handles that are open when the program exits. This means that this callback " -"might be called indirectly from L, which can cause unexpected " -"problems in higher-level languages (eg. if your HLL interpreter has already " -"been cleaned up by the time this is called, and if your callback then jumps " -"into some HLL function)." +#. type: textblock +#: ../src/guestfs.pod:1348 +msgid "If successful, an errno integer not equal to zero is returned." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1198 -msgid "guestfs_set_progress_callback" +#. type: textblock +#: ../src/guestfs.pod:1350 +msgid "If no error, this returns 0. This call can return 0 in three situations:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1200 -#, no-wrap -msgid "" -" typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n" -" int proc_nr, int serial,\n" -" uint64_t position, uint64_t total);\n" -" void guestfs_set_progress_callback (guestfs_h *g,\n" -" guestfs_progress_cb cb,\n" -" void *opaque);\n" -"\n" +#. type: textblock +#: ../src/guestfs.pod:1357 +msgid "There has not been any error on the handle." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1207 +#. type: textblock +#: ../src/guestfs.pod:1361 msgid "" -"Some long-running operations can generate progress messages. If this " -"callback is registered, then it will be called each time a progress message " -"is generated (usually two seconds after the operation started, and three " -"times per second thereafter until it completes, although the frequency may " -"change in future versions)." +"There has been an error but the errno was meaningless. This corresponds to " +"the case where the error did not come from a failed system call, but for " +"some other reason." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1213 +#. type: textblock +#: ../src/guestfs.pod:1367 msgid "" -"The callback receives two numbers: C and C. The units of " -"C are not defined, although for some operations C may relate " -"in some way to the amount of data to be transferred (eg. in bytes or " -"megabytes), and C may be the portion which has been transferred." +"There was an error from a failed system call, but for some reason the errno " +"was not captured and returned. This usually indicates a bug in libguestfs." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1219 -msgid "The only defined and stable parts of the API are:" +#. type: textblock +#: ../src/guestfs.pod:1373 +msgid "" +"Libguestfs tries to convert the errno from inside the applicance into a " +"corresponding errno for the caller (not entirely trivial: the appliance " +"might be running a completely different operating system from the library " +"and error numbers are not standardized across Un*xen). If this could not be " +"done, then the error is translated to C. In practice this should " +"only happen in very rare circumstances." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1225 -msgid "" -"The callback can display to the user some type of progress bar or indicator " -"which shows the ratio of C:C." +#. type: =head2 +#: ../src/guestfs.pod:1381 +msgid "guestfs_set_error_handler" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1230 -msgid "0 E= C E= C" +#. type: verbatim +#: ../src/guestfs.pod:1383 +#, no-wrap +msgid "" +" typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" +" void *opaque,\n" +" const char *msg);\n" +" void guestfs_set_error_handler (guestfs_h *g,\n" +" guestfs_error_handler_cb cb,\n" +" void *opaque);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1234 +#. type: textblock +#: ../src/guestfs.pod:1390 msgid "" -"If any progress notification is sent during a call, then a final progress " -"notification is always sent when C = C." +"The callback C will be called if there is an error. The parameters " +"passed to the callback are an opaque data pointer and the error message " +"string." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1237 +#. type: textblock +#: ../src/guestfs.pod:1394 msgid "" -"This is to simplify caller code, so callers can easily set the progress " -"indicator to \"100%\" at the end of the operation, without requiring special " -"code to detect this case." +"C is not passed to the callback. To get that the callback must call " +"L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1243 +#. type: textblock +#: ../src/guestfs.pod:1397 msgid "" -"The callback also receives the procedure number and serial number of the " -"call. These are only useful for debugging protocol issues, and the callback " -"can normally ignore them. The callback may want to print these numbers in " -"error messages or debugging messages." +"Note that the message string C is freed as soon as the callback " +"function returns, so if you want to stash it somewhere you must make your " +"own copy." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1248 -msgid "PRIVATE DATA AREA" +#. type: textblock +#: ../src/guestfs.pod:1401 +msgid "The default handler prints messages on C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1250 -msgid "" -"You can attach named pieces of private data to the libguestfs handle, and " -"fetch them by name for the lifetime of the handle. This is called the " -"private data area and is only available from the C API." +#. type: textblock +#: ../src/guestfs.pod:1403 +msgid "If you set C to C then I handler is called." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1254 -msgid "To attach a named piece of data, use the following call:" +#. type: =head2 +#: ../src/guestfs.pod:1405 +msgid "guestfs_get_error_handler" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1256 +#. type: verbatim +#: ../src/guestfs.pod:1407 #, no-wrap msgid "" -" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" +" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" +" void **opaque_rtn);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1258 -msgid "" -"C is the name to associate with this data, and C is an arbitrary " -"pointer (which can be C). Any previous item with the same name is " -"overwritten." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1262 -msgid "" -"You can use any C you want, but names beginning with an underscore " -"character are reserved for internal libguestfs purposes (for implementing " -"language bindings). It is recommended to prefix the name with some unique " -"string to avoid collisions with other users." +#. type: textblock +#: ../src/guestfs.pod:1410 +msgid "Returns the current error handler callback." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1267 -msgid "To retrieve the pointer, use:" +#. type: =head2 +#: ../src/guestfs.pod:1412 +msgid "guestfs_set_out_of_memory_handler" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1269 +#. type: verbatim +#: ../src/guestfs.pod:1414 #, no-wrap msgid "" -" void *guestfs_get_private (guestfs_h *g, const char *key);\n" +" typedef void (*guestfs_abort_cb) (void);\n" +" int guestfs_set_out_of_memory_handler (guestfs_h *g,\n" +" guestfs_abort_cb);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1271 -msgid "" -"This function returns C if either no data is found associated with " -"C, or if the user previously set the C's C pointer to " -"C." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1275 -msgid "" -"Libguestfs does not try to look at or interpret the C pointer in any " -"way. As far as libguestfs is concerned, it need not be a valid pointer at " -"all. In particular, libguestfs does I try to free the data when the " -"handle is closed. If the data must be freed, then the caller must either " -"free it before calling L or must set up a close callback to " -"do it (see L, and note that only one callback " -"can be registered for a handle)." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1283 +#. type: textblock +#: ../src/guestfs.pod:1418 msgid "" -"The private data area is implemented using a hash table, and should be " -"reasonably efficient for moderate numbers of keys." +"The callback C will be called if there is an out of memory situation. " +"I." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1286 -msgid "BLOCK DEVICE NAMING" +#. type: textblock +#: ../src/guestfs.pod:1421 +msgid "The default is to call L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1288 -msgid "" -"In the kernel there is now quite a profusion of schemata for naming block " -"devices (in this context, by I I mean a physical or virtual " -"hard drive). The original Linux IDE driver used names starting with " -"C. SCSI devices have historically used a different naming scheme, " -"C. When the Linux kernel I driver became a popular " -"replacement for the old IDE driver (particularly for SATA devices) those " -"devices also used the C scheme. Additionally we now have virtual " -"machines with paravirtualized drivers. This has created several different " -"naming systems, such as C for virtio disks and C for " -"Xen PV disks." +#. type: textblock +#: ../src/guestfs.pod:1423 +msgid "You cannot set C to C. You can't ignore out of memory situations." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1300 -msgid "" -"As discussed above, libguestfs uses a qemu appliance running an embedded " -"Linux kernel to access block devices. We can run a variety of appliances " -"based on a variety of Linux kernels." +#. type: =head2 +#: ../src/guestfs.pod:1426 +msgid "guestfs_get_out_of_memory_handler" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1304 +#. type: verbatim +#: ../src/guestfs.pod:1428 +#, no-wrap msgid "" -"This causes a problem for libguestfs because many API calls use device or " -"partition names. Working scripts and the recipe (example) scripts that we " -"make available over the internet could fail if the naming scheme changes." +" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1309 -msgid "" -"Therefore libguestfs defines C as the I. " -"Internally C names are translated, if necessary, to other names as " -"required. For example, under RHEL 5 which uses the C scheme, any " -"device parameter C is translated to C transparently." +#. type: textblock +#: ../src/guestfs.pod:1430 +msgid "This returns the current out of memory handler." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1315 -msgid "" -"Note that this I applies to parameters. The L, " -"L and similar calls return the true names of the " -"devices and partitions as known to the appliance." +#. type: =head1 +#: ../src/guestfs.pod:1432 +msgid "API CALLS" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1320 -msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" +#. type: textblock +#: ../src/guestfs.pod:1434 ../fish/guestfish.pod:984 +msgid "@ACTIONS@" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1322 -msgid "" -"Usually this translation is transparent. However in some (very rare) cases " -"you may need to know the exact algorithm. Such cases include where you use " -"L to add a mixture of virtio and IDE devices to the " -"qemu-based appliance, so have a mixture of C and C " -"devices." +#. type: =head1 +#: ../src/guestfs.pod:1436 +msgid "STRUCTURES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1328 -msgid "" -"The algorithm is applied only to I which are known to be either " -"device or partition names. Return values from functions such as " -"L are never changed." +#. type: textblock +#: ../src/guestfs.pod:1438 +msgid "@STRUCTS@" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1336 -msgid "Is the string a parameter which is a device or partition name?" +#. type: =head1 +#: ../src/guestfs.pod:1440 +msgid "AVAILABILITY" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1340 -msgid "Does the string begin with C?" +#. type: =head2 +#: ../src/guestfs.pod:1442 +msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1344 +#. type: textblock +#: ../src/guestfs.pod:1444 msgid "" -"Does the named device exist? If so, we use that device. However if I " -"then we continue with this algorithm." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1349 -msgid "Replace initial C string with C." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1351 -msgid "For example, change C to C." +"Using L you can test availability of the following " +"groups of functions. This test queries the appliance to see if the " +"appliance you are currently using supports the functionality." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1353 -msgid "If that named device exists, use it. If not, continue." +#. type: textblock +#: ../src/guestfs.pod:1449 +msgid "@AVAILABILITY@" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1357 -msgid "Replace initial C string with C." +#. type: =head2 +#: ../src/guestfs.pod:1451 +msgid "GUESTFISH supported COMMAND" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1359 -msgid "If that named device exists, use it. If not, return an error." +#. type: textblock +#: ../src/guestfs.pod:1453 +msgid "" +"In L there is a handy interactive command C which " +"prints out the available groups and whether they are supported by this build " +"of libguestfs. Note however that you have to do C first." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1363 -msgid "PORTABILITY CONCERNS" +#. type: =head2 +#: ../src/guestfs.pod:1458 +msgid "SINGLE CALLS AT COMPILE TIME" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1365 +#. type: textblock +#: ../src/guestfs.pod:1460 msgid "" -"Although the standard naming scheme and automatic translation is useful for " -"simple programs and guestfish scripts, for larger programs it is best not to " -"rely on this mechanism." +"Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " +"function, such as:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1369 +#. type: verbatim +#: ../src/guestfs.pod:1463 +#, no-wrap msgid "" -"Where possible for maximum future portability programs using libguestfs " -"should use these future-proof techniques:" +" #define LIBGUESTFS_HAVE_DD 1\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1376 -msgid "" -"Use L or L to list actual " -"device names, and then use those names directly." +#. type: textblock +#: ../src/guestfs.pod:1465 +msgid "if L is available." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1379 -msgid "Since those device names exist by definition, they will never be translated." +#. type: textblock +#: ../src/guestfs.pod:1467 +msgid "" +"Before version 1.5.8, if you needed to test whether a single libguestfs " +"function is available at compile time, we recommended using build tools such " +"as autoconf or cmake. For example in autotools you could use:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1384 +#. type: verbatim +#: ../src/guestfs.pod:1472 +#, no-wrap msgid "" -"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " -"filesystem labels." +" AC_CHECK_LIB([guestfs],[guestfs_create])\n" +" AC_CHECK_FUNCS([guestfs_dd])\n" +"\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1389 -msgid "INTERNALS" +#. type: textblock +#: ../src/guestfs.pod:1475 +msgid "" +"which would result in C being either defined or not defined " +"in your program." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1391 -msgid "COMMUNICATION PROTOCOL" +#. type: =head2 +#: ../src/guestfs.pod:1478 +msgid "SINGLE CALLS AT RUN TIME" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1393 +#. type: textblock +#: ../src/guestfs.pod:1480 msgid "" -"Don't rely on using this protocol directly. This section documents how it " -"currently works, but it may change at any time." +"Testing at compile time doesn't guarantee that a function really exists in " +"the library. The reason is that you might be dynamically linked against a " +"previous I (dynamic library) which doesn't have the call. " +"This situation unfortunately results in a segmentation fault, which is a " +"shortcoming of the C dynamic linking system itself." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1396 +#. type: textblock +#: ../src/guestfs.pod:1487 msgid "" -"The protocol used to talk between the library and the daemon running inside " -"the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC " -"1014, RFC 1832, RFC 4506)." +"You can use L to test if a function is available at run time, as " +"in this example program (note that you still need the compile time check as " +"well):" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1400 +#. type: verbatim +#: ../src/guestfs.pod:1491 +#, no-wrap msgid "" -"The detailed format of structures is in C (note: " -"this file is automatically generated)." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1403 -msgid "" -"There are two broad cases, ordinary functions that don't have any C " -"and C parameters, which are handled with very simple request/reply " -"messages. Then there are functions that have any C or C " -"parameters, which use the same request and reply messages, but they may also " -"be followed by files sent using a chunked encoding." -msgstr "" - -# type: =head3 -#: ../src/guestfs.pod:1410 -msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1412 -msgid "For ordinary functions, the request message is:" +" #include \n" +" #include \n" +" #include \n" +" #include \n" +" #include \n" +" \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1414 +#. type: verbatim +#: ../src/guestfs.pod:1497 #, no-wrap msgid "" -" total length (header + arguments,\n" -" but not including the length word itself)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs__args (encoded as XDR)\n" -"\n" +" main ()\n" +" {\n" +" #ifdef LIBGUESTFS_HAVE_DD\n" +" void *dl;\n" +" int has_function;\n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1419 +#. type: verbatim +#: ../src/guestfs.pod:1503 +#, no-wrap msgid "" -"The total length field allows the daemon to allocate a fixed size buffer " -"into which it slurps the rest of the message. As a result, the total length " -"is limited to C bytes (currently 4MB), which means the " -"effective size of any request is limited to somewhere under this size." +" /* Test if the function guestfs_dd is really available. */\n" +" dl = dlopen (NULL, RTLD_LAZY);\n" +" if (!dl) {\n" +" fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n" +" exit (EXIT_FAILURE);\n" +" }\n" +" has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n" +" dlclose (dl);\n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1425 +#. type: verbatim +#: ../src/guestfs.pod:1512 +#, no-wrap msgid "" -"Note also that many functions don't take any arguments, in which case the " -"C_args> is completely omitted." +" if (!has_function)\n" +" printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n" +" else {\n" +" printf (\"this libguestfs.so has guestfs_dd function\\n\");\n" +" /* Now it's safe to call\n" +" guestfs_dd (g, \"foo\", \"bar\");\n" +" */\n" +" }\n" +" #else\n" +" printf (\"guestfs_dd function was not found at compile time\\n\");\n" +" #endif\n" +" }\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1428 +#. type: textblock +#: ../src/guestfs.pod:1525 msgid "" -"The header contains the procedure number (C) which is how the " -"receiver knows what type of args structure to expect, or none at all." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1432 -msgid "The reply message for ordinary functions is:" +"You may think the above is an awful lot of hassle, and it is. There are " +"other ways outside of the C linking system to ensure that this kind of " +"incompatibility never arises, such as using package versioning:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1434 +#. type: verbatim +#: ../src/guestfs.pod:1530 #, no-wrap msgid "" -" total length (header + ret,\n" -" but not including the length word itself)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs__ret (encoded as XDR)\n" +" Requires: libguestfs >= 1.0.80\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1439 -msgid "" -"As above the C_ret> structure may be completely omitted for " -"functions that return no formal return values." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1442 -msgid "As above the total length of the reply is limited to C." +#. type: =head1 +#: ../src/guestfs.pod:1532 +msgid "CALLS WITH OPTIONAL ARGUMENTS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1445 +#. type: textblock +#: ../src/guestfs.pod:1534 msgid "" -"In the case of an error, a flag is set in the header, and the reply message " -"is slightly changed:" +"A recent feature of the API is the introduction of calls which take optional " +"arguments. In C these are declared 3 ways. The main way is as a call which " +"takes variable arguments (ie. C<...>), as in this example:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1448 +#. type: verbatim +#: ../src/guestfs.pod:1539 #, no-wrap msgid "" -" total length (header + error,\n" -" but not including the length word itself)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs_message_error (encoded as XDR)\n" +" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1453 +#. type: textblock +#: ../src/guestfs.pod:1541 msgid "" -"The C structure contains the error message as a " -"string." +"Call this with a list of optional arguments, terminated by C<-1>. So to " +"call with no optional arguments specified:" msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1456 -msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" +#. type: verbatim +#: ../src/guestfs.pod:1544 +#, no-wrap +msgid "" +" guestfs_add_drive_opts (g, filename, -1);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1458 -msgid "" -"A C parameter indicates that we transfer a file I the guest. " -"The normal request message is sent (see above). However this is followed by " -"a sequence of file chunks." +#. type: textblock +#: ../src/guestfs.pod:1546 +msgid "With a single optional argument:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1462 +#. type: verbatim +#: ../src/guestfs.pod:1548 #, no-wrap msgid "" -" total length (header + arguments,\n" -" but not including the length word itself,\n" -" and not including the chunks)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs__args (encoded as XDR)\n" -" sequence of chunks for FileIn param #0\n" -" sequence of chunks for FileIn param #1 etc.\n" +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" +" -1);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1470 -msgid "The \"sequence of chunks\" is:" +#. type: textblock +#: ../src/guestfs.pod:1552 +msgid "With two:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1472 +#. type: verbatim +#: ../src/guestfs.pod:1554 #, no-wrap msgid "" -" length of chunk (not including length word itself)\n" -" struct guestfs_chunk (encoded as XDR)\n" -" length of chunk\n" -" struct guestfs_chunk (encoded as XDR)\n" -" ...\n" -" length of chunk\n" -" struct guestfs_chunk (with data.data_len == 0)\n" +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" +" GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n" +" -1);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1480 -msgid "" -"The final chunk has the C field set to zero. Additionally a flag " -"is set in the final chunk to indicate either successful completion or early " -"cancellation." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1484 +#. type: textblock +#: ../src/guestfs.pod:1559 msgid "" -"At time of writing there are no functions that have more than one FileIn " -"parameter. However this is (theoretically) supported, by sending the " -"sequence of chunks for each FileIn parameter one after another (from left to " -"right)." +"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " +"happen!" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1489 -msgid "" -"Both the library (sender) I the daemon (receiver) may cancel the " -"transfer. The library does this by sending a chunk with a special flag set " -"to indicate cancellation. When the daemon sees this, it cancels the whole " -"RPC, does I send any reply, and goes back to reading the next request." +#. type: =head2 +#: ../src/guestfs.pod:1562 +msgid "USING va_list FOR OPTIONAL ARGUMENTS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1495 +#. type: textblock +#: ../src/guestfs.pod:1564 msgid "" -"The daemon may also cancel. It does this by writing a special word " -"C to the socket. The library listens for this during " -"the transfer, and if it gets it, it will cancel the transfer (it sends a " -"cancel chunk). The special word is chosen so that even if cancellation " -"happens right at the end of the transfer (after the library has finished " -"writing and has started listening for the reply), the \"spurious\" cancel " -"flag will not be confused with the reply message." +"The second variant has the same name with the suffix C<_va>, which works the " +"same way but takes a C. See the C manual for details. For the " +"example function, this is declared:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1504 +#. type: verbatim +#: ../src/guestfs.pod:1568 +#, no-wrap msgid "" -"This protocol allows the transfer of arbitrary sized files (no 32 bit " -"limit), and also files where the size is not known in advance (eg. from " -"pipes or sockets). However the chunks are rather small " -"(C), so that neither the library nor the daemon need " -"to keep much in memory." +" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" +" va_list args);\n" +"\n" msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1510 -msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" +#. type: =head2 +#: ../src/guestfs.pod:1571 +msgid "CONSTRUCTING OPTIONAL ARGUMENTS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1512 +#. type: textblock +#: ../src/guestfs.pod:1573 msgid "" -"The protocol for FileOut parameters is exactly the same as for FileIn " -"parameters, but with the roles of daemon and library reversed." +"The third variant is useful where you need to construct these calls. You " +"pass in a structure where you fill in the optional fields. The structure " +"has a bitmask as the first element which you must set to indicate which " +"fields you have filled in. For our example function the structure and call " +"are declared:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1515 +#. type: verbatim +#: ../src/guestfs.pod:1579 #, no-wrap msgid "" -" total length (header + ret,\n" -" but not including the length word itself,\n" -" and not including the chunks)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs__ret (encoded as XDR)\n" -" sequence of chunks for FileOut param #0\n" -" sequence of chunks for FileOut param #1 etc.\n" +" struct guestfs_add_drive_opts_argv {\n" +" uint64_t bitmask;\n" +" int readonly;\n" +" const char *format;\n" +" /* ... */\n" +" };\n" +" int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n" +" const struct guestfs_add_drive_opts_argv *optargs);\n" "\n" msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1523 -msgid "INITIAL MESSAGE" +#. type: textblock +#: ../src/guestfs.pod:1588 +msgid "You could call it like this:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1525 +#. type: verbatim +#: ../src/guestfs.pod:1590 +#, no-wrap msgid "" -"When the daemon launches it sends an initial word (C) " -"which indicates that the guest and daemon is alive. This is what " -"L waits for." -msgstr "" - -# type: =head3 -#: ../src/guestfs.pod:1529 -msgid "PROGRESS NOTIFICATION MESSAGES" +" struct guestfs_add_drive_opts_argv optargs = {\n" +" .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n" +" .readonly = 1,\n" +" .format = \"qcow2\"\n" +" };\n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1531 +#. type: verbatim +#: ../src/guestfs.pod:1597 +#, no-wrap msgid "" -"The daemon may send progress notification messages at any time. These are " -"distinguished by the normal length word being replaced by " -"C, followed by a fixed size progress message." +" guestfs_add_drive_opts_argv (g, filename, &optargs);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1535 -msgid "" -"The library turns them into progress callbacks (see " -"C) if there is a callback registered, or " -"discards them if not." +#. type: textblock +#: ../src/guestfs.pod:1599 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1253 ../tools/virt-win-reg.pl:532 +msgid "Notes:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1539 -msgid "" -"The daemon self-limits the frequency of progress messages it sends (see " -"C). Not all calls generate progress " -"messages." +#. type: textblock +#: ../src/guestfs.pod:1605 +msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1543 -msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" +#. type: textblock +#: ../src/guestfs.pod:1610 +msgid "You do not need to fill in all fields of the structure." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1545 +#. type: textblock +#: ../src/guestfs.pod:1614 msgid "" -"All high-level libguestfs actions are synchronous. If you want to use " -"libguestfs asynchronously then you must create a thread." +"There must be a one-to-one correspondence between fields of the structure " +"that are filled in, and bits set in the bitmask." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1548 -msgid "" -"Only use the handle from a single thread. Either use the handle exclusively " -"from one thread, or provide your own mutex so that two threads cannot issue " -"calls on the same handle at the same time." +#. type: =head2 +#: ../src/guestfs.pod:1619 +msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1552 +#. type: textblock +#: ../src/guestfs.pod:1621 msgid "" -"See the graphical program guestfs-browser for one possible architecture for " -"multithreaded programs using libvirt and libguestfs." +"In other languages, optional arguments are expressed in the way that is " +"natural for that language. We refer you to the language-specific " +"documentation for more details on that." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1555 -msgid "QEMU WRAPPERS" +#. type: textblock +#: ../src/guestfs.pod:1625 +msgid "For guestfish, see L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1557 -msgid "" -"If you want to compile your own qemu, run qemu from a non-standard location, " -"or pass extra arguments to qemu, then you can write a shell-script wrapper " -"around qemu." +#. type: =head2 +#: ../src/guestfs.pod:1627 +msgid "SETTING CALLBACKS TO HANDLE EVENTS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1561 +#. type: textblock +#: ../src/guestfs.pod:1629 msgid "" -"There is one important rule to remember: you I> as the " -"last command in the shell script (so that qemu replaces the shell and " -"becomes the direct child of the libguestfs-using program). If you don't do " -"this, then the qemu process won't be cleaned up correctly." +"The child process generates events in some situations. Current events " +"include: receiving a log message, the child process exits." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1566 +#. type: textblock +#: ../src/guestfs.pod:1632 msgid "" -"Here is an example of a wrapper, where I have built my own copy of qemu from " -"source:" +"Use the C functions to set a callback for different " +"types of events." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1569 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1635 msgid "" -" #!/bin/sh -\n" -" qemudir=/home/rjones/d/qemu\n" -" exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios " -"\"$@\"\n" -"\n" +"Only I can be registered for each handle. " +"Calling C again overwrites the previous callback of " +"that type. Cancel all callbacks of this type by calling this function with " +"C set to C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1573 -msgid "" -"Save this script as C (or wherever), C, and " -"then use it by setting the LIBGUESTFS_QEMU environment variable. For " -"example:" +#. type: =head2 +#: ../src/guestfs.pod:1640 +msgid "guestfs_set_log_message_callback" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1577 +#. type: verbatim +#: ../src/guestfs.pod:1642 #, no-wrap msgid "" -" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" +" typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n" +" char *buf, int len);\n" +" void guestfs_set_log_message_callback (guestfs_h *g,\n" +" guestfs_log_message_cb cb,\n" +" void *opaque);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1579 +#. type: textblock +#: ../src/guestfs.pod:1648 msgid "" -"Note that libguestfs also calls qemu with the -help and -version options in " -"order to determine features." +"The callback function C will be called whenever qemu or the guest writes " +"anything to the console." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1582 -msgid "LIBGUESTFS VERSION NUMBERS" +#. type: textblock +#: ../src/guestfs.pod:1651 +msgid "Use this function to capture kernel messages and similar." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1584 +#. type: textblock +#: ../src/guestfs.pod:1653 msgid "" -"Since April 2010, libguestfs has started to make separate development and " -"stable releases, along with corresponding branches in our git repository. " -"These separate releases can be identified by version number:" +"Normally there is no log message handler, and log messages are just " +"discarded." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1589 +#. type: =head2 +#: ../src/guestfs.pod:1656 +msgid "guestfs_set_subprocess_quit_callback" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:1658 #, no-wrap msgid "" -" even numbers for stable: 1.2.x, 1.4.x, ...\n" -" .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n" -" |\n" -" v\n" -" 1 . 3 . 5\n" -" ^ ^\n" -" | |\n" -" | `-------- sub-version\n" -" |\n" -" `------ always '1' because we don't change the ABI\n" +" typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n" +" void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n" +" guestfs_subprocess_quit_cb cb,\n" +" void *opaque);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1600 -msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1602 +#. type: textblock +#: ../src/guestfs.pod:1663 msgid "" -"As time passes we cherry pick fixes from the development branch and backport " -"those into the stable branch, the effect being that the stable branch should " -"get more stable and less buggy over time. So the stable releases are ideal " -"for people who don't need new features but would just like the software to " -"work." +"The callback function C will be called when the child process quits, " +"either asynchronously or if killed by L. (This " +"corresponds to a transition from any state to the CONFIG state)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1608 -msgid "Our criteria for backporting changes are:" +#. type: =head2 +#: ../src/guestfs.pod:1668 +msgid "guestfs_set_launch_done_callback" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1614 +#. type: verbatim +#: ../src/guestfs.pod:1670 +#, no-wrap msgid "" -"Documentation changes which don't affect any code are backported unless the " -"documentation refers to a future feature which is not in stable." +" typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n" +" void guestfs_set_launch_done_callback (guestfs_h *g,\n" +" guestfs_launch_done_cb cb,\n" +" void *opaque);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1620 +#. type: textblock +#: ../src/guestfs.pod:1675 msgid "" -"Bug fixes which are not controversial, fix obvious problems, and have been " -"well tested are backported." +"The callback function C will be called when the child process becomes " +"ready first time after it has been launched. (This corresponds to a " +"transition from LAUNCHING to the READY state)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1625 -msgid "" -"Simple rearrangements of code which shouldn't affect how it works get " -"backported. This is so that the code in the two branches doesn't get too " -"far out of step, allowing us to backport future fixes more easily." +#. type: =head2 +#: ../src/guestfs.pod:1679 +msgid "guestfs_set_close_callback" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1631 +#. type: verbatim +#: ../src/guestfs.pod:1681 +#, no-wrap msgid "" -"We I backport new features, new APIs, new tools etc, except in one " -"exceptional case: the new feature is required in order to implement an " -"important bug fix." +" typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n" +" void guestfs_set_close_callback (guestfs_h *g,\n" +" guestfs_close_cb cb,\n" +" void *opaque);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1637 +#. type: textblock +#: ../src/guestfs.pod:1686 msgid "" -"A new stable branch starts when we think the new features in development are " -"substantial and compelling enough over the current stable branch to warrant " -"it. When that happens we create new stable and development versions 1.N.0 " -"and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so " -"stable at this point, but by backporting fixes from development, that branch " -"will stabilize over time." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1645 ../fish/guestfish.pod:803 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:312 ../tools/virt-rescue.pl:226 -msgid "ENVIRONMENT VARIABLES" -msgstr "" - -# type: =item -#: ../src/guestfs.pod:1649 ../fish/guestfish.pod:829 -msgid "LIBGUESTFS_APPEND" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1651 ../fish/guestfish.pod:831 -msgid "Pass additional options to the guest kernel." -msgstr "" - -# type: =item -#: ../src/guestfs.pod:1653 ../fish/guestfish.pod:833 -msgid "LIBGUESTFS_DEBUG" +"The callback function C will be called while the handle is being closed " +"(synchronously from L)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1655 +#. type: textblock +#: ../src/guestfs.pod:1689 msgid "" -"Set C to enable verbose messages. This has the same " -"effect as calling C." -msgstr "" - -# type: =item -#: ../src/guestfs.pod:1658 ../fish/guestfish.pod:838 -msgid "LIBGUESTFS_MEMSIZE" +"Note that libguestfs installs an L handler to try to clean up " +"handles that are open when the program exits. This means that this callback " +"might be called indirectly from L, which can cause unexpected " +"problems in higher-level languages (eg. if your HLL interpreter has already " +"been cleaned up by the time this is called, and if your callback then jumps " +"into some HLL function)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1660 ../fish/guestfish.pod:840 -msgid "Set the memory allocated to the qemu process, in megabytes. For example:" +#. type: =head2 +#: ../src/guestfs.pod:1697 +msgid "guestfs_set_progress_callback" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1663 ../fish/guestfish.pod:843 +#. type: verbatim +#: ../src/guestfs.pod:1699 #, no-wrap msgid "" -" LIBGUESTFS_MEMSIZE=700\n" +" typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n" +" int proc_nr, int serial,\n" +" uint64_t position, uint64_t total);\n" +" void guestfs_set_progress_callback (guestfs_h *g,\n" +" guestfs_progress_cb cb,\n" +" void *opaque);\n" "\n" msgstr "" -# type: =item -#: ../src/guestfs.pod:1665 ../fish/guestfish.pod:845 -msgid "LIBGUESTFS_PATH" +#. type: textblock +#: ../src/guestfs.pod:1706 +msgid "" +"Some long-running operations can generate progress messages. If this " +"callback is registered, then it will be called each time a progress message " +"is generated (usually two seconds after the operation started, and three " +"times per second thereafter until it completes, although the frequency may " +"change in future versions)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1667 +#. type: textblock +#: ../src/guestfs.pod:1712 msgid "" -"Set the path that libguestfs uses to search for kernel and initrd.img. See " -"the discussion of paths in section PATH above." +"The callback receives two numbers: C and C. The units of " +"C are not defined, although for some operations C may relate " +"in some way to the amount of data to be transferred (eg. in bytes or " +"megabytes), and C may be the portion which has been transferred." msgstr "" -# type: =item -#: ../src/guestfs.pod:1670 ../fish/guestfish.pod:850 -msgid "LIBGUESTFS_QEMU" +#. type: textblock +#: ../src/guestfs.pod:1718 +msgid "The only defined and stable parts of the API are:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1672 ../fish/guestfish.pod:852 +#. type: textblock +#: ../src/guestfs.pod:1724 msgid "" -"Set the default qemu binary that libguestfs uses. If not set, then the qemu " -"which was found at compile time by the configure script is used." +"The callback can display to the user some type of progress bar or indicator " +"which shows the ratio of C:C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1676 -msgid "See also L above." +#. type: textblock +#: ../src/guestfs.pod:1729 +msgid "0 E= C E= C" msgstr "" -# type: =item -#: ../src/guestfs.pod:1678 ../fish/guestfish.pod:856 -msgid "LIBGUESTFS_TRACE" +#. type: textblock +#: ../src/guestfs.pod:1733 +msgid "" +"If any progress notification is sent during a call, then a final progress " +"notification is always sent when C = C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1680 +#. type: textblock +#: ../src/guestfs.pod:1736 msgid "" -"Set C to enable command traces. This has the same " -"effect as calling C." +"This is to simplify caller code, so callers can easily set the progress " +"indicator to \"100%\" at the end of the operation, without requiring special " +"code to detect this case." msgstr "" -# type: =item -#: ../src/guestfs.pod:1683 ../fish/guestfish.pod:865 -msgid "TMPDIR" +#. type: textblock +#: ../src/guestfs.pod:1742 +msgid "" +"The callback also receives the procedure number and serial number of the " +"call. These are only useful for debugging protocol issues, and the callback " +"can normally ignore them. The callback may want to print these numbers in " +"error messages or debugging messages." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1685 ../fish/guestfish.pod:867 -msgid "Location of temporary directory, defaults to C." +#. type: =head1 +#: ../src/guestfs.pod:1747 +msgid "PRIVATE DATA AREA" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1687 ../fish/guestfish.pod:869 +#. type: textblock +#: ../src/guestfs.pod:1749 msgid "" -"If libguestfs was compiled to use the supermin appliance then each handle " -"will require rather a large amount of space in this directory for short " -"periods of time (~ 80 MB). You can use C<$TMPDIR> to configure another " -"directory to use in case C is not large enough." +"You can attach named pieces of private data to the libguestfs handle, and " +"fetch them by name for the lifetime of the handle. This is called the " +"private data area and is only available from the C API." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1695 ../fish/guestfish.pod:927 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:178 ../inspector/virt-inspector.pl:846 ../tools/virt-cat.pl:163 ../tools/virt-df.pl:536 ../tools/virt-edit.pl:325 ../tools/virt-list-filesystems.pl:191 ../tools/virt-list-partitions.pl:229 ../tools/virt-ls.pl:210 ../tools/virt-make-fs.pl:527 ../tools/virt-rescue.pl:231 ../tools/virt-resize.pl:1390 ../tools/virt-tar.pl:257 ../tools/virt-win-reg.pl:461 -msgid "SEE ALSO" +#. type: textblock +#: ../src/guestfs.pod:1753 +msgid "To attach a named piece of data, use the following call:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1697 +#. type: verbatim +#: ../src/guestfs.pod:1755 +#, no-wrap msgid "" -"L, L, L, L, " -"L, L, L, " -"L, L, L, " -"L, L, L, L, " -"L, L, L." +" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1715 +#. type: textblock +#: ../src/guestfs.pod:1757 msgid "" -"Tools with a similar purpose: L, L, L, " -"L, L." +"C is the name to associate with this data, and C is an arbitrary " +"pointer (which can be C). Any previous item with the same name is " +"overwritten." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1722 ../tools/virt-make-fs.pl:541 ../tools/virt-win-reg.pl:476 -msgid "BUGS" +#. type: textblock +#: ../src/guestfs.pod:1761 +msgid "" +"You can use any C you want, but names beginning with an underscore " +"character are reserved for internal libguestfs purposes (for implementing " +"language bindings). It is recommended to prefix the name with some unique " +"string to avoid collisions with other users." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1724 -msgid "To get a list of bugs against libguestfs use this link:" +#. type: textblock +#: ../src/guestfs.pod:1766 +msgid "To retrieve the pointer, use:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1726 -msgid "L" +#. type: verbatim +#: ../src/guestfs.pod:1768 +#, no-wrap +msgid "" +" void *guestfs_get_private (guestfs_h *g, const char *key);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1728 -msgid "To report a new bug against libguestfs use this link:" +#. type: textblock +#: ../src/guestfs.pod:1770 +msgid "" +"This function returns C if either no data is found associated with " +"C, or if the user previously set the C's C pointer to " +"C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1730 -msgid "L" +#. type: textblock +#: ../src/guestfs.pod:1774 +msgid "" +"Libguestfs does not try to look at or interpret the C pointer in any " +"way. As far as libguestfs is concerned, it need not be a valid pointer at " +"all. In particular, libguestfs does I try to free the data when the " +"handle is closed. If the data must be freed, then the caller must either " +"free it before calling L or must set up a close callback to " +"do it (see L, and note that only one callback " +"can be registered for a handle)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1732 -msgid "When reporting a bug, please check:" +#. type: textblock +#: ../src/guestfs.pod:1782 +msgid "" +"The private data area is implemented using a hash table, and should be " +"reasonably efficient for moderate numbers of keys." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1738 -msgid "That the bug hasn't been reported already." +#. type: =end +#: ../src/guestfs.pod:1785 ../src/guestfs.pod:1790 +msgid "html" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1742 -msgid "That you are testing a recent version." +#. type: textblock +#: ../src/guestfs.pod:1787 +msgid "" +" " msgstr "" -# type: textblock -#: ../src/guestfs.pod:1746 -msgid "Describe the bug accurately, and give a way to reproduce it." +#. type: =head1 +#: ../src/guestfs.pod:1792 +msgid "ARCHITECTURE" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1750 +#. type: textblock +#: ../src/guestfs.pod:1794 msgid "" -"Run libguestfs-test-tool and paste the B output into the " -"bug report." +"Internally, libguestfs is implemented by running an appliance (a special " +"type of small virtual machine) using L. Qemu runs as a child " +"process of the main program." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1755 ../fish/guestfish.pod:944 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:189 ../inspector/virt-inspector.pl:855 -msgid "AUTHORS" +#. type: verbatim +#: ../src/guestfs.pod:1798 +#, no-wrap +msgid "" +" ___________________\n" +" / \\\n" +" | main program |\n" +" | |\n" +" | | child process / appliance\n" +" | | __________________________\n" +" | | / qemu \\\n" +" +-------------------+ RPC | +-----------------+ |\n" +" | libguestfs <--------------------> guestfsd | |\n" +" | | | +-----------------+ |\n" +" \\___________________/ | | Linux kernel | |\n" +" | +--^--------------+ |\n" +" \\_________|________________/\n" +" |\n" +" _______v______\n" +" / \\\n" +" | Device or |\n" +" | disk image |\n" +" \\______________/\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1757 ../fish/guestfish.pod:946 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:191 -msgid "Richard W.M. Jones (C)" +#. type: textblock +#: ../src/guestfs.pod:1818 +msgid "" +"The library, linked to the main program, creates the child process and hence " +"the appliance in the L function." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1759 ../fish/guestfish.pod:948 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:193 ../inspector/virt-inspector.pl:861 ../tools/virt-cat.pl:177 ../tools/virt-df.pl:549 ../tools/virt-edit.pl:341 ../tools/virt-list-filesystems.pl:207 ../tools/virt-list-partitions.pl:244 ../tools/virt-ls.pl:225 ../tools/virt-make-fs.pl:556 ../tools/virt-rescue.pl:245 ../tools/virt-resize.pl:1411 ../tools/virt-tar.pl:272 ../tools/virt-win-reg.pl:491 -msgid "COPYRIGHT" +#. type: textblock +#: ../src/guestfs.pod:1821 +msgid "" +"Inside the appliance is a Linux kernel and a complete stack of userspace " +"tools (such as LVM and ext2 programs) and a small controlling daemon called " +"L. The library talks to L using remote procedure " +"calls (RPC). There is a mostly one-to-one correspondence between libguestfs " +"API calls and RPC calls to the daemon. Lastly the disk image(s) are " +"attached to the qemu process which translates device access by the " +"appliance's Linux kernel into accesses to the image." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1761 ../fish/guestfish.pod:950 -msgid "Copyright (C) 2009-2010 Red Hat Inc. L" +#. type: textblock +#: ../src/guestfs.pod:1830 +msgid "" +"A common misunderstanding is that the appliance \"is\" the virtual machine. " +"Although the disk image you are attached to might also be used by some " +"virtual machine, libguestfs doesn't know or care about this. (But you will " +"care if both libguestfs's qemu process and your virtual machine are trying " +"to update the disk image at the same time, since these usually results in " +"massive disk corruption)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1764 -msgid "" -"This library is free software; you can redistribute it and/or modify it " -"under the terms of the GNU Lesser General Public License as published by the " -"Free Software Foundation; either version 2 of the License, or (at your " -"option) any later version." +#. type: =head1 +#: ../src/guestfs.pod:1837 +msgid "STATE MACHINE" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1769 -msgid "" -"This library is distributed in the hope that it will be useful, but WITHOUT " -"ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or " -"FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License " -"for more details." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1774 -msgid "" -"You should have received a copy of the GNU Lesser General Public License " -"along with this library; if not, write to the Free Software Foundation, " -"Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA" -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:1 -msgid "guestfs_add_cdrom" +#. type: textblock +#: ../src/guestfs.pod:1839 +msgid "libguestfs uses a state machine to model the child process:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:3 +#. type: verbatim +#: ../src/guestfs.pod:1841 #, no-wrap msgid "" -" int guestfs_add_cdrom (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" |\n" +" guestfs_create\n" +" |\n" +" |\n" +" ____V_____\n" +" / \\\n" +" | CONFIG |\n" +" \\__________/\n" +" ^ ^ ^ \\\n" +" / | \\ \\ guestfs_launch\n" +" / | _\\__V______\n" +" / | / \\\n" +" / | | LAUNCHING |\n" +" / | \\___________/\n" +" / | /\n" +" / | guestfs_launch\n" +" / | /\n" +" ______ / __|____V\n" +" / \\ ------> / \\\n" +" | BUSY | | READY |\n" +" \\______/ <------ \\________/\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:6 ../fish/guestfish-actions.pod:7 -msgid "This function adds a virtual CD-ROM disk image to the guest." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:8 ../fish/guestfish-actions.pod:9 -msgid "This is equivalent to the qemu parameter C<-cdrom filename>." +#. type: textblock +#: ../src/guestfs.pod:1863 +msgid "" +"The normal transitions are (1) CONFIG (when the handle is created, but there " +"is no child process), (2) LAUNCHING (when the child process is booting up), " +"(3) alternating between READY and BUSY as commands are issued to, and " +"carried out by, the child process." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:1516 ../fish/guestfish-actions.pod:11 ../fish/guestfish-actions.pod:1211 -msgid "Notes:" +#. type: textblock +#: ../src/guestfs.pod:1868 +msgid "" +"The guest may be killed by L, or may die " +"asynchronously at any time (eg. due to some internal error), and that causes " +"the state to transition back to CONFIG." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:16 +#. type: textblock +#: ../src/guestfs.pod:1872 msgid "" -"This call checks for the existence of C. This stops you from " -"specifying other types of drive which are supported by qemu such as C " -"and C URLs. To specify those, use the general C call " -"instead." +"Configuration commands for qemu such as L can only be " +"issued when in the CONFIG state." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:23 +#. type: textblock +#: ../src/guestfs.pod:1875 msgid "" -"If you just want to add an ISO file (often you use this as an efficient way " -"to transfer large files into the guest), then you should probably use " -"C instead." +"The API offers one call that goes from CONFIG through LAUNCHING to READY. " +"L blocks until the child process is READY to accept " +"commands (or until some failure or timeout). L internally " +"moves the state from CONFIG to LAUNCHING while it is running." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:63 ../src/guestfs-actions.pod:92 ../src/guestfs-actions.pod:103 ../src/guestfs-actions.pod:114 ../src/guestfs-actions.pod:124 ../src/guestfs-actions.pod:135 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:266 ../src/guestfs-actions.pod:302 ../src/guestfs-actions.pod:324 ../src/guestfs-actions.pod:339 ../src/guestfs-actions.pod:403 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:441 ../src/guestfs-actions.pod:453 ../src/guestfs-actions.pod:534 ../src/guestfs-actions.pod:549 ../src/guestfs-actions.pod:560 ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:717 ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:824 ../src/guestfs-actions.pod:839 ../src/guestfs-actions.pod:855 ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:883 ../src/guestfs-actions.pod:916 ../src/guestfs-actions.pod:974 ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:1055 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1174 ../src/guestfs-actions.pod:1374 ../src/guestfs-actions.pod:1393 ../src/guestfs-actions.pod:1474 ../src/guestfs-actions.pod:1822 ../src/guestfs-actions.pod:1945 ../src/guestfs-actions.pod:2000 ../src/guestfs-actions.pod:2030 ../src/guestfs-actions.pod:2439 ../src/guestfs-actions.pod:2451 ../src/guestfs-actions.pod:2468 ../src/guestfs-actions.pod:2576 ../src/guestfs-actions.pod:2587 ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:2650 ../src/guestfs-actions.pod:2714 ../src/guestfs-actions.pod:2731 ../src/guestfs-actions.pod:2745 ../src/guestfs-actions.pod:2765 ../src/guestfs-actions.pod:2785 ../src/guestfs-actions.pod:2814 ../src/guestfs-actions.pod:2830 ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2858 ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2900 ../src/guestfs-actions.pod:2913 ../src/guestfs-actions.pod:2923 ../src/guestfs-actions.pod:2935 ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:3029 ../src/guestfs-actions.pod:3046 ../src/guestfs-actions.pod:3056 ../src/guestfs-actions.pod:3101 ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3131 ../src/guestfs-actions.pod:3144 ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:3166 ../src/guestfs-actions.pod:3180 ../src/guestfs-actions.pod:3192 ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3284 ../src/guestfs-actions.pod:3300 ../src/guestfs-actions.pod:3309 ../src/guestfs-actions.pod:3323 ../src/guestfs-actions.pod:3333 ../src/guestfs-actions.pod:3345 ../src/guestfs-actions.pod:3357 ../src/guestfs-actions.pod:3389 ../src/guestfs-actions.pod:3401 ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3429 ../src/guestfs-actions.pod:3443 ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3514 ../src/guestfs-actions.pod:3525 ../src/guestfs-actions.pod:3550 ../src/guestfs-actions.pod:3564 ../src/guestfs-actions.pod:3579 ../src/guestfs-actions.pod:3701 ../src/guestfs-actions.pod:3753 ../src/guestfs-actions.pod:3772 ../src/guestfs-actions.pod:3787 ../src/guestfs-actions.pod:3813 ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:3861 ../src/guestfs-actions.pod:3871 ../src/guestfs-actions.pod:3882 ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4130 ../src/guestfs-actions.pod:4141 ../src/guestfs-actions.pod:4150 ../src/guestfs-actions.pod:4161 ../src/guestfs-actions.pod:4170 ../src/guestfs-actions.pod:4181 ../src/guestfs-actions.pod:4194 ../src/guestfs-actions.pod:4212 ../src/guestfs-actions.pod:4228 ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4259 ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:4294 ../src/guestfs-actions.pod:4310 ../src/guestfs-actions.pod:4328 ../src/guestfs-actions.pod:4344 ../src/guestfs-actions.pod:4358 ../src/guestfs-actions.pod:4383 ../src/guestfs-actions.pod:4404 ../src/guestfs-actions.pod:4420 ../src/guestfs-actions.pod:4441 ../src/guestfs-actions.pod:4453 ../src/guestfs-actions.pod:4465 ../src/guestfs-actions.pod:4481 ../src/guestfs-actions.pod:4515 ../src/guestfs-actions.pod:4535 ../src/guestfs-actions.pod:4558 ../src/guestfs-actions.pod:4648 ../src/guestfs-actions.pod:4754 ../src/guestfs-actions.pod:4763 ../src/guestfs-actions.pod:4773 ../src/guestfs-actions.pod:4783 ../src/guestfs-actions.pod:4802 ../src/guestfs-actions.pod:4812 ../src/guestfs-actions.pod:4822 ../src/guestfs-actions.pod:4832 ../src/guestfs-actions.pod:4844 ../src/guestfs-actions.pod:4894 ../src/guestfs-actions.pod:4908 ../src/guestfs-actions.pod:4921 ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4948 ../src/guestfs-actions.pod:4958 ../src/guestfs-actions.pod:4975 ../src/guestfs-actions.pod:5005 ../src/guestfs-actions.pod:5016 ../src/guestfs-actions.pod:5051 ../src/guestfs-actions.pod:5061 ../src/guestfs-actions.pod:5076 ../src/guestfs-actions.pod:5102 ../src/guestfs-actions.pod:5130 ../src/guestfs-actions.pod:5234 ../src/guestfs-actions.pod:5249 ../src/guestfs-actions.pod:5260 ../src/guestfs-actions.pod:5306 ../src/guestfs-actions.pod:5316 ../src/guestfs-actions.pod:5353 ../src/guestfs-actions.pod:5380 ../src/guestfs-actions.pod:5422 ../src/guestfs-actions.pod:5445 ../src/guestfs-actions.pod:5502 ../src/guestfs-actions.pod:5518 ../src/guestfs-actions.pod:5544 -msgid "This function returns 0 on success or -1 on error." +#. type: textblock +#: ../src/guestfs.pod:1881 +msgid "" +"API actions such as L can only be issued when in the READY " +"state. These API calls block waiting for the command to be carried out " +"(ie. the state to transition to BUSY and then back to READY). There are no " +"non-blocking versions, and no way to issue more than one command per handle " +"at the same time." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:31 -msgid "guestfs_add_drive" +#. type: textblock +#: ../src/guestfs.pod:1887 +msgid "" +"Finally, the child process sends asynchronous messages back to the main " +"program, such as kernel log messages. You can register a callback to " +"receive these messages." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:33 -#, no-wrap -msgid "" -" int guestfs_add_drive (guestfs_h *g,\n" -"\t\tconst char *filename);\n" -"\n" +#. type: =head1 +#: ../src/guestfs.pod:1891 +msgid "INTERNALS" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:36 ../fish/guestfish-actions.pod:36 -msgid "" -"This function adds a virtual machine disk image C to the guest. " -"The first time you call this function, the disk appears as IDE disk 0 " -"(C) in the guest, the second time as C, and so on." +#. type: =head2 +#: ../src/guestfs.pod:1893 +msgid "COMMUNICATION PROTOCOL" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:41 ../fish/guestfish-actions.pod:41 +#. type: textblock +#: ../src/guestfs.pod:1895 msgid "" -"You don't necessarily need to be root when using libguestfs. However you " -"obviously do need sufficient permissions to access the filename for whatever " -"operations you want to perform (ie. read access if you just want to read the " -"image or write access if you want to modify the image)." +"Don't rely on using this protocol directly. This section documents how it " +"currently works, but it may change at any time." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:47 ../fish/guestfish-actions.pod:47 +#. type: textblock +#: ../src/guestfs.pod:1898 msgid "" -"This is equivalent to the qemu parameter C<-drive " -"file=filename,cache=off,if=...>." +"The protocol used to talk between the library and the daemon running inside " +"the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC " +"1014, RFC 1832, RFC 4506)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:50 ../fish/guestfish-actions.pod:50 +#. type: textblock +#: ../src/guestfs.pod:1902 msgid "" -"C is omitted in cases where it is not supported by the underlying " -"filesystem." +"The detailed format of structures is in C (note: " +"this file is automatically generated)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:53 ../src/guestfs-actions.pod:82 +#. type: textblock +#: ../src/guestfs.pod:1905 msgid "" -"C is set at compile time by the configuration option C<./configure " -"--with-drive-if=...>. In the rare case where you might need to change this " -"at run time, use C or " -"C." +"There are two broad cases, ordinary functions that don't have any C " +"and C parameters, which are handled with very simple request/reply " +"messages. Then there are functions that have any C or C " +"parameters, which use the same request and reply messages, but they may also " +"be followed by files sent using a chunked encoding." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:58 ../src/guestfs-actions.pod:87 -msgid "" -"Note that this call checks for the existence of C. This stops you " -"from specifying other types of drive which are supported by qemu such as " -"C and C URLs. To specify those, use the general " -"C call instead." +#. type: =head3 +#: ../src/guestfs.pod:1912 +msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:65 -msgid "guestfs_add_drive_ro" +#. type: textblock +#: ../src/guestfs.pod:1914 +msgid "For ordinary functions, the request message is:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:67 +#. type: verbatim +#: ../src/guestfs.pod:1916 #, no-wrap msgid "" -" int guestfs_add_drive_ro (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" total length (header + arguments,\n" +" but not including the length word itself)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs__args (encoded as XDR)\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:69 -msgid "This adds a drive in snapshot mode, making it effectively read-only." +#. type: textblock +#: ../src/guestfs.pod:1921 +msgid "" +"The total length field allows the daemon to allocate a fixed size buffer " +"into which it slurps the rest of the message. As a result, the total length " +"is limited to C bytes (currently 4MB), which means the " +"effective size of any request is limited to somewhere under this size." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1927 +msgid "" +"Note also that many functions don't take any arguments, in which case the " +"C_args> is completely omitted." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:73 ../fish/guestfish-actions.pod:72 +#. type: textblock +#: ../src/guestfs.pod:1930 msgid "" -"Note that writes to the device are allowed, and will be seen for the " -"duration of the guestfs handle, but they are written to a temporary file " -"which is discarded as soon as the guestfs handle is closed. We don't " -"currently have any method to enable changes to be committed, although qemu " -"can support this." +"The header contains the procedure number (C) which is how the " +"receiver knows what type of args structure to expect, or none at all." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:79 ../fish/guestfish-actions.pod:78 +#. type: textblock +#: ../src/guestfs.pod:1934 msgid "" -"This is equivalent to the qemu parameter C<-drive " -"file=filename,snapshot=on,if=...>." +"For functions that take optional arguments, the optional arguments are " +"encoded in the C_args> structure in the same way as ordinary " +"arguments. A bitmask in the header indicates which optional arguments are " +"meaningful. The bitmask is also checked to see if it contains bits set " +"which the daemon does not know about (eg. if more optional arguments were " +"added in a later version of the library), and this causes the call to be " +"rejected." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:94 -msgid "guestfs_add_drive_ro_with_if" +#. type: textblock +#: ../src/guestfs.pod:1942 +msgid "The reply message for ordinary functions is:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:96 +#. type: verbatim +#: ../src/guestfs.pod:1944 #, no-wrap msgid "" -" int guestfs_add_drive_ro_with_if (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst char *iface);\n" +" total length (header + ret,\n" +" but not including the length word itself)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs__ret (encoded as XDR)\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:100 +#. type: textblock +#: ../src/guestfs.pod:1949 msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." +"As above the C_ret> structure may be completely omitted for " +"functions that return no formal return values." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:105 -msgid "guestfs_add_drive_with_if" +#. type: textblock +#: ../src/guestfs.pod:1952 +msgid "As above the total length of the reply is limited to C." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1955 +msgid "" +"In the case of an error, a flag is set in the header, and the reply message " +"is slightly changed:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:107 +#. type: verbatim +#: ../src/guestfs.pod:1958 #, no-wrap msgid "" -" int guestfs_add_drive_with_if (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst char *iface);\n" +" total length (header + error,\n" +" but not including the length word itself)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs_message_error (encoded as XDR)\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:111 +#. type: textblock +#: ../src/guestfs.pod:1963 msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." +"The C structure contains the error message as a " +"string." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:116 -msgid "guestfs_aug_clear" +#. type: =head3 +#: ../src/guestfs.pod:1966 +msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:118 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1968 msgid "" -" int guestfs_aug_clear (guestfs_h *g,\n" -"\t\tconst char *augpath);\n" -"\n" +"A C parameter indicates that we transfer a file I the guest. " +"The normal request message is sent (see above). However this is followed by " +"a sequence of file chunks." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:121 ../fish/guestfish-actions.pod:109 +#. type: verbatim +#: ../src/guestfs.pod:1972 +#, no-wrap msgid "" -"Set the value associated with C to C. This is the same as the " -"L C command." +" total length (header + arguments,\n" +" but not including the length word itself,\n" +" and not including the chunks)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs__args (encoded as XDR)\n" +" sequence of chunks for FileIn param #0\n" +" sequence of chunks for FileIn param #1 etc.\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:126 -msgid "guestfs_aug_close" +#. type: textblock +#: ../src/guestfs.pod:1980 +msgid "The \"sequence of chunks\" is:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:128 +#. type: verbatim +#: ../src/guestfs.pod:1982 #, no-wrap msgid "" -" int guestfs_aug_close (guestfs_h *g);\n" +" length of chunk (not including length word itself)\n" +" struct guestfs_chunk (encoded as XDR)\n" +" length of chunk\n" +" struct guestfs_chunk (encoded as XDR)\n" +" ...\n" +" length of chunk\n" +" struct guestfs_chunk (with data.data_len == 0)\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:130 +#. type: textblock +#: ../src/guestfs.pod:1990 msgid "" -"Close the current Augeas handle and free up any resources used by it. After " -"calling this, you have to call C again before you can use " -"any other Augeas functions." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:137 -msgid "guestfs_aug_defnode" +"The final chunk has the C field set to zero. Additionally a flag " +"is set in the final chunk to indicate either successful completion or early " +"cancellation." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:139 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1994 msgid "" -" struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *g,\n" -"\t\tconst char *name,\n" -"\t\tconst char *expr,\n" -"\t\tconst char *val);\n" -"\n" +"At time of writing there are no functions that have more than one FileIn " +"parameter. However this is (theoretically) supported, by sending the " +"sequence of chunks for each FileIn parameter one after another (from left to " +"right)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:144 ../fish/guestfish-actions.pod:125 -msgid "Defines a variable C whose value is the result of evaluating C." +#. type: textblock +#: ../src/guestfs.pod:1999 +msgid "" +"Both the library (sender) I the daemon (receiver) may cancel the " +"transfer. The library does this by sending a chunk with a special flag set " +"to indicate cancellation. When the daemon sees this, it cancels the whole " +"RPC, does I send any reply, and goes back to reading the next request." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:147 +#. type: textblock +#: ../src/guestfs.pod:2005 msgid "" -"If C evaluates to an empty nodeset, a node is created, equivalent to " -"calling C C, C. C will be the nodeset " -"containing that single node." +"The daemon may also cancel. It does this by writing a special word " +"C to the socket. The library listens for this during " +"the transfer, and if it gets it, it will cancel the transfer (it sends a " +"cancel chunk). The special word is chosen so that even if cancellation " +"happens right at the end of the transfer (after the library has finished " +"writing and has started listening for the reply), the \"spurious\" cancel " +"flag will not be confused with the reply message." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:132 +#. type: textblock +#: ../src/guestfs.pod:2014 msgid "" -"On success this returns a pair containing the number of nodes in the " -"nodeset, and a boolean flag if a node was created." +"This protocol allows the transfer of arbitrary sized files (no 32 bit " +"limit), and also files where the size is not known in advance (eg. from " +"pipes or sockets). However the chunks are rather small " +"(C), so that neither the library nor the daemon need " +"to keep much in memory." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:155 -msgid "" -"This function returns a C, or NULL if there was " -"an error. I after use>." +#. type: =head3 +#: ../src/guestfs.pod:2020 +msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:159 -msgid "guestfs_aug_defvar" +#. type: textblock +#: ../src/guestfs.pod:2022 +msgid "" +"The protocol for FileOut parameters is exactly the same as for FileIn " +"parameters, but with the roles of daemon and library reversed." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:161 +#. type: verbatim +#: ../src/guestfs.pod:2025 #, no-wrap msgid "" -" int guestfs_aug_defvar (guestfs_h *g,\n" -"\t\tconst char *name,\n" -"\t\tconst char *expr);\n" +" total length (header + ret,\n" +" but not including the length word itself,\n" +" and not including the chunks)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs__ret (encoded as XDR)\n" +" sequence of chunks for FileOut param #0\n" +" sequence of chunks for FileOut param #1 etc.\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:140 -msgid "" -"Defines an Augeas variable C whose value is the result of evaluating " -"C. If C is NULL, then C is undefined." +#. type: =head3 +#: ../src/guestfs.pod:2033 +msgid "INITIAL MESSAGE" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:144 +#. type: textblock +#: ../src/guestfs.pod:2035 msgid "" -"On success this returns the number of nodes in C, or C<0> if C " -"evaluates to something which is not a nodeset." +"When the daemon launches it sends an initial word (C) " +"which indicates that the guest and daemon is alive. This is what " +"L waits for." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:172 ../src/guestfs-actions.pod:313 ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:492 ../src/guestfs-actions.pod:507 ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:1041 ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1538 ../src/guestfs-actions.pod:1619 ../src/guestfs-actions.pod:1650 ../src/guestfs-actions.pod:1693 ../src/guestfs-actions.pod:1710 ../src/guestfs-actions.pod:1935 ../src/guestfs-actions.pod:2147 ../src/guestfs-actions.pod:2165 ../src/guestfs-actions.pod:3503 ../src/guestfs-actions.pod:3610 ../src/guestfs-actions.pod:3941 ../src/guestfs-actions.pod:5040 ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5400 ../src/guestfs-actions.pod:5410 -msgid "On error this function returns -1." +#. type: =head3 +#: ../src/guestfs.pod:2039 +msgid "PROGRESS NOTIFICATION MESSAGES" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:174 -msgid "guestfs_aug_get" +#. type: textblock +#: ../src/guestfs.pod:2041 +msgid "" +"The daemon may send progress notification messages at any time. These are " +"distinguished by the normal length word being replaced by " +"C, followed by a fixed size progress message." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:176 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2045 msgid "" -" char *guestfs_aug_get (guestfs_h *g,\n" -"\t\tconst char *augpath);\n" -"\n" +"The library turns them into progress callbacks (see " +"C) if there is a callback registered, or " +"discards them if not." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:151 +#. type: textblock +#: ../src/guestfs.pod:2049 msgid "" -"Look up the value associated with C. If C matches exactly one " -"node, the C is returned." +"The daemon self-limits the frequency of progress messages it sends (see " +"C). Not all calls generate progress " +"messages." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:182 ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:695 ../src/guestfs-actions.pod:786 ../src/guestfs-actions.pod:899 ../src/guestfs-actions.pod:928 ../src/guestfs-actions.pod:942 ../src/guestfs-actions.pod:958 ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:1487 ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1577 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1729 ../src/guestfs-actions.pod:1868 ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:2099 ../src/guestfs-actions.pod:2215 ../src/guestfs-actions.pod:2250 ../src/guestfs-actions.pod:2565 ../src/guestfs-actions.pod:2986 ../src/guestfs-actions.pod:3082 ../src/guestfs-actions.pod:3625 ../src/guestfs-actions.pod:3801 ../src/guestfs-actions.pod:3919 ../src/guestfs-actions.pod:4057 ../src/guestfs-actions.pod:4100 ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4589 ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:4624 ../src/guestfs-actions.pod:5183 ../src/guestfs-actions.pod:5199 ../src/guestfs-actions.pod:5214 ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5592 -msgid "" -"This function returns a string, or NULL on error. I." +#. type: =head1 +#: ../src/guestfs.pod:2053 +msgid "LIBGUESTFS VERSION NUMBERS" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:185 -msgid "guestfs_aug_init" +#. type: textblock +#: ../src/guestfs.pod:2055 +msgid "" +"Since April 2010, libguestfs has started to make separate development and " +"stable releases, along with corresponding branches in our git repository. " +"These separate releases can be identified by version number:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:187 +#. type: verbatim +#: ../src/guestfs.pod:2060 #, no-wrap msgid "" -" int guestfs_aug_init (guestfs_h *g,\n" -"\t\tconst char *root,\n" -"\t\tint flags);\n" +" even numbers for stable: 1.2.x, 1.4.x, ...\n" +" .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n" +" |\n" +" v\n" +" 1 . 3 . 5\n" +" ^ ^\n" +" | |\n" +" | `-------- sub-version\n" +" |\n" +" `------ always '1' because we don't change the ABI\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:191 ../fish/guestfish-actions.pod:158 -msgid "" -"Create a new Augeas handle for editing configuration files. If there was " -"any previous Augeas handle associated with this guestfs session, then it is " -"closed." +#. type: textblock +#: ../src/guestfs.pod:2071 +msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:195 -msgid "You must call this before using any other C commands." +#. type: textblock +#: ../src/guestfs.pod:2073 +msgid "" +"As time passes we cherry pick fixes from the development branch and backport " +"those into the stable branch, the effect being that the stable branch should " +"get more stable and less buggy over time. So the stable releases are ideal " +"for people who don't need new features but would just like the software to " +"work." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:198 ../fish/guestfish-actions.pod:165 -msgid "C is the filesystem root. C must not be NULL, use C instead." +#. type: textblock +#: ../src/guestfs.pod:2079 +msgid "Our criteria for backporting changes are:" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:201 ../fish/guestfish-actions.pod:168 +#. type: textblock +#: ../src/guestfs.pod:2085 msgid "" -"The flags are the same as the flags defined in Eaugeas.hE, the " -"logical I of the following integers:" +"Documentation changes which don't affect any code are backported unless the " +"documentation refers to a future feature which is not in stable." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:207 ../fish/guestfish-actions.pod:174 -msgid "C = 1" +#. type: textblock +#: ../src/guestfs.pod:2091 +msgid "" +"Bug fixes which are not controversial, fix obvious problems, and have been " +"well tested are backported." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:209 ../fish/guestfish-actions.pod:176 -msgid "Keep the original file with a C<.augsave> extension." +#. type: textblock +#: ../src/guestfs.pod:2096 +msgid "" +"Simple rearrangements of code which shouldn't affect how it works get " +"backported. This is so that the code in the two branches doesn't get too " +"far out of step, allowing us to backport future fixes more easily." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:211 ../fish/guestfish-actions.pod:178 -msgid "C = 2" +#. type: textblock +#: ../src/guestfs.pod:2102 +msgid "" +"We I backport new features, new APIs, new tools etc, except in one " +"exceptional case: the new feature is required in order to implement an " +"important bug fix." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:213 ../fish/guestfish-actions.pod:180 +#. type: textblock +#: ../src/guestfs.pod:2108 msgid "" -"Save changes into a file with extension C<.augnew>, and do not overwrite " -"original. Overrides C." +"A new stable branch starts when we think the new features in development are " +"substantial and compelling enough over the current stable branch to warrant " +"it. When that happens we create new stable and development versions 1.N.0 " +"and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so " +"stable at this point, but by backporting fixes from development, that branch " +"will stabilize over time." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:216 ../fish/guestfish-actions.pod:183 -msgid "C = 4" +#. type: =head1 +#: ../src/guestfs.pod:2116 +msgid "EXTENDING LIBGUESTFS" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:218 ../fish/guestfish-actions.pod:185 -msgid "Typecheck lenses (can be expensive)." +#. type: =head2 +#: ../src/guestfs.pod:2118 +msgid "ADDING A NEW API ACTION" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:220 ../fish/guestfish-actions.pod:187 -msgid "C = 8" +#. type: textblock +#: ../src/guestfs.pod:2120 +msgid "" +"Large amounts of boilerplate code in libguestfs (RPC, bindings, " +"documentation) are generated, and this makes it easy to extend the " +"libguestfs API." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:222 ../fish/guestfish-actions.pod:189 -msgid "Do not use standard load path for modules." +#. type: textblock +#: ../src/guestfs.pod:2124 +msgid "To add a new API action there are two changes:" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:224 ../fish/guestfish-actions.pod:191 -msgid "C = 16" +#. type: textblock +#: ../src/guestfs.pod:2130 +msgid "" +"You need to add a description of the call (name, parameters, return type, " +"tests, documentation) to C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:226 ../fish/guestfish-actions.pod:193 -msgid "Make save a no-op, just record what would have been changed." +#. type: textblock +#: ../src/guestfs.pod:2133 +msgid "" +"There are two sorts of API action, depending on whether the call goes " +"through to the daemon in the appliance, or is serviced entirely by the " +"library (see L above). L is an example of the " +"former, since the sync is done in the appliance. L is " +"an example of the latter, since a trace flag is maintained in the handle and " +"all tracing is done on the library side." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:228 ../fish/guestfish-actions.pod:195 -msgid "C = 32" +#. type: textblock +#: ../src/guestfs.pod:2141 +msgid "" +"Most new actions are of the first type, and get added to the " +"C list. Each function has a unique procedure number used " +"in the RPC protocol which is assigned to that action when we publish " +"libguestfs and cannot be reused. Take the latest procedure number and " +"increment it." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:230 -msgid "Do not load the tree in C." +#. type: textblock +#: ../src/guestfs.pod:2147 +msgid "" +"For library-only actions of the second type, add to the " +"C list. Since these functions are serviced by the " +"library and do not travel over the RPC mechanism to the daemon, these " +"functions do not need a procedure number, and so the procedure number is set " +"to C<-1>." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:234 -msgid "To close the handle, you can call C." +#. type: textblock +#: ../src/guestfs.pod:2155 +msgid "Implement the action (in C):" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:236 ../fish/guestfish-actions.pod:203 -msgid "To find out more about Augeas, see L." +#. type: textblock +#: ../src/guestfs.pod:2157 +msgid "" +"For daemon actions, implement the function CnameE> in the " +"C directory." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:240 -msgid "guestfs_aug_insert" +#. type: textblock +#: ../src/guestfs.pod:2160 +msgid "" +"For library actions, implement the function CnameE> " +"(note: double underscore) in the C directory." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:242 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2163 +msgid "In either case, use another function as an example of what to do." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2167 +msgid "After making these changes, use C to compile." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2169 msgid "" -" int guestfs_aug_insert (guestfs_h *g,\n" -"\t\tconst char *augpath,\n" -"\t\tconst char *label,\n" -"\t\tint before);\n" -"\n" +"Note that you don't need to implement the RPC, language bindings, manual " +"pages or anything else. It's all automatically generated from the OCaml " +"description." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:247 ../fish/guestfish-actions.pod:209 +#. type: =head2 +#: ../src/guestfs.pod:2173 +msgid "ADDING TESTS FOR AN API ACTION" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2175 msgid "" -"Create a new sibling C