X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=po-docs%2Flibguestfs-docs.pot;h=f0d37b9cfdbb031ec799a95547c801c80ed6bbbb;hp=d8d5d1f7bad591c57c870b985d2fcd03a2547223;hb=c21d6dc29c91691f2dcd914d0cc85f060f83289c;hpb=12cf2f732a275928a7ce727840e1f5ba6684754d diff --git a/po-docs/libguestfs-docs.pot b/po-docs/libguestfs-docs.pot index d8d5d1f..f0d37b9 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.7.2\n" +"Project-Id-Version: libguestfs 1.11.16\n" "Report-Msgid-Bugs-To: libguestfs@redhat.com\n" -"POT-Creation-Date: 2010-11-05 12:18+0000\n" +"POT-Creation-Date: 2011-07-13 15:55+0200\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:31 ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:30 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-cat.pl:29 ../tools/virt-tar.pl:29 ../tools/virt-rescue.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28 -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:33 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:32 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-cat.pl:31 ../tools/virt-tar.pl:31 ../tools/virt-rescue.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 +#. type: =head1 +#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-win-reg.pl:35 ../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:37 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:36 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-cat.pl:35 ../tools/virt-tar.pl:35 ../tools/virt-rescue.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 +#. type: =head1 +#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-win-reg.pl:39 ../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:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../inspector/virt-inspector.pl:43 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:42 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-cat.pl:41 ../tools/virt-tar.pl:72 ../tools/virt-rescue.pl:51 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40 +#. type: =head1 +#: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-win-reg.pl:63 ../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,8 +212,8 @@ 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" @@ -221,21 +223,20 @@ msgid "" " \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,16 +271,16 @@ 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:131 +#. type: verbatim +#: ../src/guestfs.pod:133 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -287,13 +289,13 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:135 +#. type: textblock +#: ../src/guestfs.pod:137 msgid "You can add a disk read-only using:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:137 +#. type: verbatim +#: ../src/guestfs.pod:139 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -303,95 +305,103 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:142 +#. type: textblock +#: ../src/guestfs.pod:144 msgid "" "or by calling the older function L. In either case " "libguestfs won't modify the file." msgstr "" -# type: textblock -#: ../src/guestfs.pod:145 +#. 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:149 +#. 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:154 +#. 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:159 +#. type: =head2 +#: ../src/guestfs.pod:161 msgid "MOUNTING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:161 +#. 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:167 +#. 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:169 +#. 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:173 +#. 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:183 +#. 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:186 +#. type: =head2 +#: ../src/guestfs.pod:194 msgid "FILESYSTEM ACCESS AND MODIFICATION" msgstr "" -# type: textblock -#: ../src/guestfs.pod:188 +#. 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 " @@ -400,58 +410,58 @@ msgid "" "all in this overview." msgstr "" -# type: textblock -#: ../src/guestfs.pod:194 +#. 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:197 +#. 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:200 +#. type: verbatim +#: ../src/guestfs.pod:208 #, no-wrap msgid "" " char *data = guestfs_cat (g, \"/etc/passwd\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:202 +#. 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:206 +#. 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:209 +#. type: verbatim +#: ../src/guestfs.pod:217 #, no-wrap msgid "" " guestfs_mkdir (g, \"/var\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:211 +#. type: textblock +#: ../src/guestfs.pod:219 msgid "To create a symlink you could do:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:213 +#. type: verbatim +#: ../src/guestfs.pod:221 #, no-wrap msgid "" " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n" @@ -459,15 +469,15 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:216 +#. 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:219 +#. 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 " @@ -476,34 +486,34 @@ msgid "" "turn these errors into exceptions)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:225 +#. 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:228 +#. type: =head2 +#: ../src/guestfs.pod:236 msgid "PARTITIONING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:230 +#. 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:233 +#. 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:237 +#. type: verbatim +#: ../src/guestfs.pod:245 #, no-wrap msgid "" " const char *parttype = \"mbr\";\n" @@ -513,20 +523,20 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:242 +#. 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:245 +#. type: =head2 +#: ../src/guestfs.pod:253 msgid "LVM2" msgstr "" -# type: textblock -#: ../src/guestfs.pod:247 +#. 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 " @@ -534,60 +544,60 @@ msgid "" "volume groups and logical volumes." msgstr "" -# type: textblock -#: ../src/guestfs.pod:252 +#. type: textblock +#: ../src/guestfs.pod:260 msgid "" "This author strongly recommends reading the LVM HOWTO, online at " "L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:255 +#. type: =head2 +#: ../src/guestfs.pod:263 msgid "DOWNLOADING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:257 +#. 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:262 +#. 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:266 +#. 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:269 +#. type: textblock +#: ../src/guestfs.pod:276 msgid "To download multiple files, see L and L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:272 +#. type: =head2 +#: ../src/guestfs.pod:279 msgid "UPLOADING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:274 +#. 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:277 +#. 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 " @@ -596,20 +606,20 @@ msgid "" "L and L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:283 +#. 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:286 +#. type: textblock +#: ../src/guestfs.pod:293 msgid "To upload multiple files, see L and L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:288 +#. 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 " @@ -622,186 +632,230 @@ msgid "" "using a label or UUID, use an ISO image instead." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:299 +#. type: =head2 +#: ../src/guestfs.pod:306 msgid "COPYING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:301 +#. 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:307 +#. type: =item +#: ../src/guestfs.pod:314 msgid "B to B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:309 +#. 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:312 +#. type: =item +#: ../src/guestfs.pod:319 msgid "B to B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:314 +#. 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:317 +#. type: textblock +#: ../src/guestfs.pod:324 msgid "Example: duplicate the contents of an LV:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:319 +#. 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:321 +#. 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:325 +#. type: =item +#: ../src/guestfs.pod:332 msgid "B to B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:327 +#. type: textblock +#: ../src/guestfs.pod:334 msgid "Use L. See L above." msgstr "" -# type: =item -#: ../src/guestfs.pod:329 +#. type: =item +#: ../src/guestfs.pod:336 msgid "B to B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:331 +#. type: textblock +#: ../src/guestfs.pod:338 msgid "Use L. See L above." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:335 +#. 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 file descriptor 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:337 +#. 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:340 +#. 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:343 +#. 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:347 +#. type: textblock +#: ../src/guestfs.pod:375 msgid "" "L and L can be used to recursively list " "files." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:350 +#. type: =head2 +#: ../src/guestfs.pod:378 msgid "RUNNING COMMANDS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:352 +#. 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:356 +#. type: textblock +#: ../src/guestfs.pod:384 msgid "There are many limitations to this:" msgstr "" -# type: =item -#: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370 ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383 ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:1224 ../src/guestfs.pod:1229 ../src/guestfs.pod:1233 ../src/guestfs.pod:1449 ../src/guestfs.pod:1454 ../src/guestfs.pod:1458 ../src/guestfs.pod:1560 ../src/guestfs.pod:1564 ../src/guestfs.pod:1568 ../src/guestfs.pod:1573 ../src/guestfs.pod:1581 ../src/guestfs.pod:1600 ../src/guestfs.pod:1608 ../src/guestfs.pod:1838 ../src/guestfs.pod:1844 ../src/guestfs.pod:1849 ../src/guestfs.pod:1855 ../src/guestfs.pod:1962 ../src/guestfs.pod:1966 ../src/guestfs.pod:1970 ../src/guestfs.pod:1974 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:516 ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:1558 ../src/guestfs-actions.pod:1562 ../src/guestfs-actions.pod:1566 ../src/guestfs-actions.pod:1570 ../src/guestfs-actions.pod:1578 ../src/guestfs-actions.pod:1582 ../src/guestfs-actions.pod:1586 ../src/guestfs-actions.pod:1596 ../src/guestfs-actions.pod:1600 ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1742 ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:1751 ../src/guestfs-actions.pod:1756 ../src/guestfs-actions.pod:1817 ../src/guestfs-actions.pod:1821 ../src/guestfs-actions.pod:1826 ../fish/guestfish.pod:364 ../fish/guestfish.pod:368 ../fish/guestfish.pod:372 ../fish/guestfish.pod:376 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:339 ../fish/guestfish-actions.pod:347 ../fish/guestfish-actions.pod:354 ../fish/guestfish-actions.pod:361 ../fish/guestfish-actions.pod:1056 ../fish/guestfish-actions.pod:1060 ../fish/guestfish-actions.pod:1064 ../fish/guestfish-actions.pod:1068 ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1094 ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102 ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1196 ../fish/guestfish-actions.pod:1201 ../fish/guestfish-actions.pod:1206 ../fish/guestfish-actions.pod:1248 ../fish/guestfish-actions.pod:1252 ../fish/guestfish-actions.pod:1257 ../inspector/virt-inspector.pl:584 ../inspector/virt-inspector.pl:588 ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348 ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363 +#. 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:1064 ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077 ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112 ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142 ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154 ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652 ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763 ../src/guestfs.pod:1773 ../src/guestfs.pod:2008 ../src/guestfs.pod:2013 ../src/guestfs.pod:2019 ../src/guestfs.pod:2027 ../src/guestfs.pod:2381 ../src/guestfs.pod:2387 ../src/guestfs.pod:2392 ../src/guestfs.pod:2398 ../src/guestfs.pod:2972 ../src/guestfs.pod:2976 ../src/guestfs.pod:2980 ../src/guestfs.pod:2984 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598 ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1603 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1623 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1641 ../src/guestfs-actions.pod:1645 ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1787 ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:1796 ../src/guestfs-actions.pod:1801 ../src/guestfs-actions.pod:1862 ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1871 ../src/guestfs-actions.pod:2789 ../src/guestfs-actions.pod:2795 ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2810 ../src/guestfs-actions.pod:2817 ../fish/guestfish.pod:445 ../fish/guestfish.pod:449 ../fish/guestfish.pod:453 ../fish/guestfish.pod:457 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385 ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1074 ../fish/guestfish-actions.pod:1078 ../fish/guestfish-actions.pod:1082 ../fish/guestfish-actions.pod:1086 ../fish/guestfish-actions.pod:1094 ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102 ../fish/guestfish-actions.pod:1112 ../fish/guestfish-actions.pod:1116 ../fish/guestfish-actions.pod:1120 ../fish/guestfish-actions.pod:1210 ../fish/guestfish-actions.pod:1214 ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1224 ../fish/guestfish-actions.pod:1266 ../fish/guestfish-actions.pod:1270 ../fish/guestfish-actions.pod:1275 ../fish/guestfish-actions.pod:1902 ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:1916 ../fish/guestfish-actions.pod:1923 ../fish/guestfish-actions.pod:1930 ../tools/virt-win-reg.pl:195 ../tools/virt-win-reg.pl:200 ../tools/virt-win-reg.pl:206 ../tools/virt-win-reg.pl:708 ../tools/virt-win-reg.pl:714 ../tools/virt-win-reg.pl:720 msgid "*" msgstr "" -# type: textblock -#: ../src/guestfs.pod:362 +#. 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:367 +#. 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:372 +#. type: textblock +#: ../src/guestfs.pod:400 msgid "The command will be running in limited memory." msgstr "" -# type: textblock -#: ../src/guestfs.pod:376 +#. 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:381 +#. type: textblock +#: ../src/guestfs.pod:409 msgid "Only supports Linux guests (not Windows, BSD, etc)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:385 +#. 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:390 +#. 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:395 +#. 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 " @@ -812,36 +866,37 @@ msgid "" "context of your program to their advantage." msgstr "" -# type: textblock -#: ../src/guestfs.pod:404 +#. 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." +"network security and so on. For information about other security issues, " +"see L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:411 +#. 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:414 +#. 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:417 +#. type: =head2 +#: ../src/guestfs.pod:446 msgid "CONFIGURATION FILES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:419 +#. 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 " @@ -849,118 +904,118 @@ msgid "" "file, and so avoids you having to write that code." msgstr "" -# type: textblock -#: ../src/guestfs.pod:424 +#. 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:428 +#. 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:432 +#. type: =head2 +#: ../src/guestfs.pod:461 msgid "SELINUX" msgstr "" -# type: textblock -#: ../src/guestfs.pod:434 +#. 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:440 ../src/guestfs.pod:953 +#. type: =item +#: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395 ../src/guestfs.pod:2426 msgid "1." msgstr "" -# type: textblock -#: ../src/guestfs.pod:442 +#. type: textblock +#: ../src/guestfs.pod:471 msgid "Before launching, do:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:444 +#. type: verbatim +#: ../src/guestfs.pod:473 #, no-wrap msgid "" " guestfs_set_selinux (g, 1);\n" "\n" msgstr "" -# type: =item -#: ../src/guestfs.pod:446 ../src/guestfs.pod:957 +#. type: =item +#: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399 ../src/guestfs.pod:2451 msgid "2." msgstr "" -# type: textblock -#: ../src/guestfs.pod:448 +#. 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:452 +#. type: verbatim +#: ../src/guestfs.pod:481 #, no-wrap msgid "" " guestfs_sh (g, \"/usr/sbin/load_policy\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:454 +#. 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:457 ../src/guestfs.pod:963 +#. type: =item +#: ../src/guestfs.pod:486 ../src/guestfs.pod:1405 msgid "3." msgstr "" -# type: textblock -#: ../src/guestfs.pod:459 +#. 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:463 +#. 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:467 +#. type: textblock +#: ../src/guestfs.pod:496 msgid "This will work for running commands and editing existing files." msgstr "" -# type: textblock -#: ../src/guestfs.pod:469 +#. 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:473 +#. type: =head2 +#: ../src/guestfs.pod:502 msgid "UMASK" msgstr "" -# type: textblock -#: ../src/guestfs.pod:475 +#. 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 " @@ -969,33 +1024,33 @@ msgid "" "that you supply." msgstr "" -# type: textblock -#: ../src/guestfs.pod:481 +#. 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:484 +#. 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:488 +#. type: textblock +#: ../src/guestfs.pod:517 msgid "For more information about umask, see L." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:490 ../fish/guestfish.pod:630 +#. type: =head1 +#: ../src/guestfs.pod:519 ../fish/guestfish.pod:767 msgid "ENCRYPTED DISKS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:492 +#. 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) " @@ -1003,22 +1058,22 @@ msgid "" "modern Linux guests." msgstr "" -# type: textblock -#: ../src/guestfs.pod:498 +#. 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:501 +#. 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:504 +#. 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 " @@ -1026,16 +1081,16 @@ msgid "" "decrypted from and encrypted to the underlying block device respectively." msgstr "" -# type: textblock -#: ../src/guestfs.pod:510 +#. 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:514 +#. 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:529 +#. 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:532 +#. 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 " @@ -1079,8 +1134,8 @@ msgid "" "libguestfs to deal with it.)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:541 +#. 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 " @@ -1088,8 +1143,8 @@ msgid "" "Windows and Linux-based operating systems respectively." msgstr "" -# type: textblock -#: ../src/guestfs.pod:547 +#. 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 " @@ -1099,8 +1154,8 @@ msgid "" "hash table like this example:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:554 +#. type: verbatim +#: ../src/guestfs.pod:584 #, no-wrap msgid "" " /boot => /dev/sda1\n" @@ -1109,61 +1164,106 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:558 +#. 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:561 +#. 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:565 +#. 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:569 +#. 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:573 +#. 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:580 +#. 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:582 +#. 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:585 +#. 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 " @@ -1172,31 +1272,35 @@ msgid "" "that directory might be referred to as C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:591 +#. 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, " -"to determine yourself how drives are mapped (see also L and " -"L)." +"Drive letter mappings can be found using inspection (see L and " +"L)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:596 +#. type: textblock +#: ../src/guestfs.pod:647 msgid "" -"Replacing backslash characters with forward slash characters is also outside " -"the scope of libguestfs, but something that you can easily do." +"Dealing with separator characters (backslash vs forward slash) is outside " +"the scope of libguestfs, but usually a simple character replacement will " +"work." msgstr "" -# type: textblock -#: ../src/guestfs.pod:599 +#. type: textblock +#: ../src/guestfs.pod:651 msgid "" -"Where we can help is in resolving the case insensitivity of paths. For " -"this, call L." +"To resolve the case insensitivity of paths, call " +"L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:602 +#. type: =head3 +#: ../src/guestfs.pod:654 +msgid "ACCESSING THE WINDOWS REGISTRY" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:656 msgid "" "Libguestfs also provides some help for decoding Windows Registry \"hive\" " "files, through the library C which is part of the libguestfs project " @@ -1206,185 +1310,228 @@ msgid "" "L for more help on this issue." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:610 +#. type: =head3 +#: ../src/guestfs.pod:664 +msgid "SYMLINKS ON NTFS-3G FILESYSTEMS" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:666 +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:670 +msgid "L" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:672 +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:679 +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:684 +msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:686 +msgid "" +"There are other useful extended attributes that can be read from ntfs-3g " +"filesystems (using L). See:" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:689 +msgid "L" +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:691 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:612 +#. type: textblock +#: ../src/guestfs.pod:693 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:615 +#. type: textblock +#: ../src/guestfs.pod:696 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:621 +#. type: textblock +#: ../src/guestfs.pod:702 msgid "" "Error messages are automatically transformed into exceptions if the language " "supports it." msgstr "" -# type: textblock -#: ../src/guestfs.pod:624 +#. type: textblock +#: ../src/guestfs.pod:705 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:630 +#. type: =item +#: ../src/guestfs.pod:711 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:632 +#. type: textblock +#: ../src/guestfs.pod:713 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:636 +#. type: =item +#: ../src/guestfs.pod:717 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:638 +#. type: textblock +#: ../src/guestfs.pod:719 msgid "" "The C# bindings are highly experimental. Please read the warnings at the " "top of C." msgstr "" -# type: =item -#: ../src/guestfs.pod:641 +#. type: =item +#: ../src/guestfs.pod:722 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:643 +#. type: textblock +#: ../src/guestfs.pod:724 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:647 +#. type: =item +#: ../src/guestfs.pod:728 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:649 +#. type: textblock +#: ../src/guestfs.pod:730 msgid "" "Full documentation is contained in the Javadoc which is distributed with " "libguestfs." msgstr "" -# type: =item -#: ../src/guestfs.pod:652 +#. type: =item +#: ../src/guestfs.pod:733 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:654 -msgid "For documentation see the file C." +#. type: textblock +#: ../src/guestfs.pod:735 +msgid "See L." msgstr "" -# type: =item -#: ../src/guestfs.pod:656 +#. type: =item +#: ../src/guestfs.pod:737 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:658 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:739 +msgid "See L and L." msgstr "" -# type: =item -#: ../src/guestfs.pod:660 +#. type: =item +#: ../src/guestfs.pod:741 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:662 +#. type: textblock +#: ../src/guestfs.pod:743 msgid "" "For documentation see C supplied with libguestfs sources or in " "the php-libguestfs package for your distribution." msgstr "" -# type: textblock -#: ../src/guestfs.pod:665 +#. type: textblock +#: ../src/guestfs.pod:746 msgid "The PHP binding only works correctly on 64 bit machines." msgstr "" -# type: =item -#: ../src/guestfs.pod:667 +#. type: =item +#: ../src/guestfs.pod:748 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:669 -msgid "For documentation do:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:671 -#, no-wrap -msgid "" -" $ python\n" -" >>> import guestfs\n" -" >>> help (guestfs)\n" -"\n" +#. type: textblock +#: ../src/guestfs.pod:750 +msgid "See L." msgstr "" -# type: =item -#: ../src/guestfs.pod:675 +#. type: =item +#: ../src/guestfs.pod:752 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:677 -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:754 +msgid "See L." msgstr "" -# type: =item -#: ../src/guestfs.pod:680 +#. type: =item +#: ../src/guestfs.pod:756 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:682 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:758 +msgid "See L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:686 +#. type: =head2 +#: ../src/guestfs.pod:762 msgid "LIBGUESTFS GOTCHAS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:688 +#. type: textblock +#: ../src/guestfs.pod:764 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:692 +#. type: textblock +#: ../src/guestfs.pod:768 msgid "" "Since we developed libguestfs and the associated tools, there are several " "things we would have designed differently, but are now stuck with for " @@ -1392,110 +1539,110 @@ msgid "" "release, you can expect these to change. Beware of them." msgstr "" -# type: =item -#: ../src/guestfs.pod:700 +#. type: =item +#: ../src/guestfs.pod:776 msgid "Autosync / forgetting to sync." msgstr "" -# type: textblock -#: ../src/guestfs.pod:702 +#. type: textblock +#: ../src/guestfs.pod:778 +msgid "" +"I Autosync is enabled by default for all API users starting from " +"libguestfs 1.5.24. This section only applies to older versions." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:781 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:706 +#. type: verbatim +#: ../src/guestfs.pod:785 #, no-wrap msgid "" " guestfs_set_autosync (g, 1);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:708 +#. type: textblock +#: ../src/guestfs.pod:787 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:712 +#. type: textblock +#: ../src/guestfs.pod:791 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:716 +#. type: textblock +#: ../src/guestfs.pod:795 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: textblock -#: ../src/guestfs.pod:720 -msgid "" -"Update: Autosync is enabled by default for all API users starting from " -"libguestfs 1.5.24." -msgstr "" - -# type: =item -#: ../src/guestfs.pod:723 +#. type: =item +#: ../src/guestfs.pod:799 msgid "Mount option C<-o sync> should not be the default." msgstr "" -# type: textblock -#: ../src/guestfs.pod:725 +#. type: textblock +#: ../src/guestfs.pod:801 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:729 +#. type: textblock +#: ../src/guestfs.pod:805 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:732 +#. type: =item +#: ../src/guestfs.pod:808 msgid "Read-only should be the default." msgstr "" -# type: textblock -#: ../src/guestfs.pod:734 +#. type: textblock +#: ../src/guestfs.pod:810 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:737 +#. type: textblock +#: ../src/guestfs.pod:813 msgid "This would reduce the potential to corrupt live VM images." msgstr "" -# type: textblock -#: ../src/guestfs.pod:739 +#. type: textblock +#: ../src/guestfs.pod:815 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:743 +#. type: =item +#: ../src/guestfs.pod:819 msgid "guestfish command line is hard to use." msgstr "" -# type: textblock -#: ../src/guestfs.pod:745 +#. type: textblock +#: ../src/guestfs.pod:821 msgid "" "C doesn't do what people expect (open C for " "examination). It tries to run a guestfish command C which doesn't " @@ -1504,13 +1651,13 @@ msgid "" "we should have used C to run commands." msgstr "" -# type: =item -#: ../src/guestfs.pod:752 +#. type: =item +#: ../src/guestfs.pod:828 msgid "guestfish megabyte modifiers don't work right on all commands" msgstr "" -# type: textblock -#: ../src/guestfs.pod:754 +#. type: textblock +#: ../src/guestfs.pod:830 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 " @@ -1519,21 +1666,21 @@ msgid "" "expecting some other unit (eg. megabytes)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:761 +#. type: textblock +#: ../src/guestfs.pod:837 msgid "The most common is L. The guestfish command:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:763 +#. type: verbatim +#: ../src/guestfs.pod:839 #, no-wrap msgid "" " lvcreate LV VG 100M\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:765 +#. type: textblock +#: ../src/guestfs.pod:841 msgid "" "does not do what you might expect. Instead because L is " "already expecting megabytes, this tries to create a 100 I (100 " @@ -1541,28 +1688,28 @@ msgid "" "is also a little obscure." msgstr "" -# type: textblock -#: ../src/guestfs.pod:770 +#. type: textblock +#: ../src/guestfs.pod:846 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:773 +#. type: =item +#: ../src/guestfs.pod:849 msgid "Ambiguity between devices and paths" msgstr "" -# type: textblock -#: ../src/guestfs.pod:775 +#. type: textblock +#: ../src/guestfs.pod:851 msgid "" "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:780 +#. type: textblock +#: ../src/guestfs.pod:856 msgid "" "In the current API we usually resolve this ambiguity by having two separate " "calls, for example L and L. " @@ -1570,8 +1717,8 @@ msgid "" "detecting if the path supplied begins with C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:786 +#. type: textblock +#: ../src/guestfs.pod:862 msgid "" "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 " @@ -1580,21 +1727,21 @@ msgid "" "to this OCaml type:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:792 +#. type: verbatim +#: ../src/guestfs.pod:868 #, no-wrap msgid "" " type path = Path of string | Device of int | Partition of int * int\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:794 +#. type: textblock +#: ../src/guestfs.pod:870 msgid "which would allow you to pass arguments like:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:796 +#. type: verbatim +#: ../src/guestfs.pod:872 #, no-wrap msgid "" " Path \"/foo/bar\"\n" @@ -1604,67 +1751,27 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:801 +#. type: textblock +#: ../src/guestfs.pod:877 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:806 -msgid "PROTOCOL LIMITS" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:808 -msgid "" -"Internally libguestfs uses a message-based protocol to pass API calls and " -"their responses to and from a small \"appliance\" (see L for " -"plenty more detail about this). The maximum message size used by the " -"protocol is slightly less than 4 MB. For some API calls you may need to be " -"aware of this limit. The API calls which may be affected are individually " -"documented, with a link back to this section of the documentation." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:816 -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 " -"a message, the maximum size that it can return is slightly under 4 MB. If " -"the requested file is larger than this then you will get an error." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:822 -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:826 -msgid "" -"You might also consider mounting the disk image using our FUSE filesystem " -"support (L)." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:829 +#. type: =head2 +#: ../src/guestfs.pod:882 msgid "KEYS AND PASSPHRASES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:831 +#. type: textblock +#: ../src/guestfs.pod:884 msgid "" "Certain libguestfs calls take a parameter that contains sensitive key " "material, passed in as a C string." msgstr "" -# type: textblock -#: ../src/guestfs.pod:834 +#. type: textblock +#: ../src/guestfs.pod:887 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 " @@ -1672,25560 +1779,28150 @@ msgid "" "of such an implementation." msgstr "" -# type: textblock -#: ../src/guestfs.pod:839 +#. type: textblock +#: ../src/guestfs.pod:892 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:844 -msgid "CONNECTION MANAGEMENT" +#. type: =head2 +#: ../src/guestfs.pod:897 +msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:846 -msgid "guestfs_h *" +#. type: textblock +#: ../src/guestfs.pod:899 +msgid "" +"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:848 +#. type: textblock +#: ../src/guestfs.pod:902 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." +"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: textblock -#: ../src/guestfs.pod:852 +#. type: textblock +#: ../src/guestfs.pod:906 msgid "" -"For information on using multiple handles and threads, see the section " -"L below." +"See the graphical program guestfs-browser for one possible architecture for " +"multithreaded programs using libvirt and libguestfs." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:855 -msgid "guestfs_create" +#. type: =head2 +#: ../src/guestfs.pod:909 +msgid "PATH" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:857 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:911 msgid "" -" guestfs_h *guestfs_create (void);\n" -"\n" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:859 -msgid "Create a connection handle." +"Libguestfs needs a supermin appliance, which it finds by looking along an " +"internal path." msgstr "" -# type: textblock -#: ../src/guestfs.pod:861 +#. type: textblock +#: ../src/guestfs.pod:914 msgid "" -"You have to call L (or one of the equivalent calls) " -"on the handle at least once." +"By default it looks for these in the directory C<$libdir/guestfs> " +"(eg. C or C)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:864 +#. type: textblock +#: ../src/guestfs.pod:917 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:867 -msgid "After configuring the handle, you have to call L." +#. type: =head2 +#: ../src/guestfs.pod:924 +msgid "QEMU WRAPPERS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:869 +#. type: textblock +#: ../src/guestfs.pod:926 msgid "" -"You may also want to configure error handling for the handle. See L section below." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:872 -msgid "guestfs_close" +"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: verbatim -#: ../src/guestfs.pod:874 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:930 msgid "" -" void guestfs_close (guestfs_h *g);\n" -"\n" +"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: textblock -#: ../src/guestfs.pod:876 -msgid "This closes the connection handle and frees up all resources used." +#. type: textblock +#: ../src/guestfs.pod:935 +msgid "" +"Here is an example of a wrapper, where I have built my own copy of qemu from " +"source:" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:878 -msgid "ERROR HANDLING" +#. type: verbatim +#: ../src/guestfs.pod:938 +#, no-wrap +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" msgstr "" -# type: textblock -#: ../src/guestfs.pod:880 +#. type: textblock +#: ../src/guestfs.pod:942 msgid "" -"API functions can return errors. For example, almost all functions that " -"return C will return C<-1> to indicate an error." +"Save this script as C (or wherever), C, and " +"then use it by setting the LIBGUESTFS_QEMU environment variable. For " +"example:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:883 +#. type: verbatim +#: ../src/guestfs.pod:946 +#, no-wrap msgid "" -"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." +" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:887 +#. type: textblock +#: ../src/guestfs.pod:948 msgid "" -"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." +"Note that libguestfs also calls qemu with the -help and -version options in " +"order to determine features." msgstr "" -# type: textblock -#: ../src/guestfs.pod:892 -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:" +#. type: =head2 +#: ../src/guestfs.pod:951 +msgid "ATTACHING TO RUNNING DAEMONS" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:896 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:953 msgid "" -" if (guestfs_launch (g) == -1)\n" -" exit (EXIT_FAILURE);\n" -"\n" +"I This is B and has a tendency to eat " +"babies. Use with caution." msgstr "" -# type: textblock -#: ../src/guestfs.pod:899 +#. type: textblock +#: ../src/guestfs.pod:956 msgid "" -"since the default error handler will ensure that an error message has been " -"printed to C before the program exits." +"I This section explains how to attach to a running daemon from a " +"low level perspective. For most users, simply using virt tools such as " +"L with the I<--live> option will \"just work\"." msgstr "" -# type: textblock -#: ../src/guestfs.pod:902 -msgid "" -"For other programs the caller will almost certainly want to install an " -"alternate error handler or do error handling in-line like this:" +#. type: =head3 +#: ../src/guestfs.pod:960 +msgid "Using guestfs_set_attach_method" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:905 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:962 msgid "" -" g = guestfs_create ();\n" -" \n" +"By calling L you can change how the library " +"connects to the C daemon in L (read " +"L for some background)." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:907 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:966 msgid "" -" /* This disables the default behaviour of printing errors\n" -" on stderr. */\n" -" guestfs_set_error_handler (g, NULL, NULL);\n" -" \n" +"The normal attach method is C, where a small appliance is created " +"containing the daemon, and then the library connects to this." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:911 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:969 msgid "" -" 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" +"Setting attach method to C> (where I is the path of a " +"Unix domain socket) causes L to connect to an existing " +"daemon over the Unix domain socket." msgstr "" -# type: textblock -#: ../src/guestfs.pod:919 +#. type: textblock +#: ../src/guestfs.pod:973 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." +"The normal use for this is to connect to a running virtual machine that " +"contains a C daemon, and send commands so you can read and write " +"files inside the live virtual machine." msgstr "" -# type: textblock -#: ../src/guestfs.pod:923 -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)." +#. type: =head3 +#: ../src/guestfs.pod:977 +msgid "Using guestfs_add_domain with live flag" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:929 -msgid "guestfs_last_error" +#. type: textblock +#: ../src/guestfs.pod:979 +msgid "" +"L provides some help for getting the correct attach " +"method. If you pass the C option to this function, then (if the " +"virtual machine is running) it will examine the libvirt XML looking for a " +"virtio-serial channel to connect to:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:931 +#. type: verbatim +#: ../src/guestfs.pod:985 #, no-wrap msgid "" -" const char *guestfs_last_error (guestfs_h *g);\n" +" \n" +" ...\n" +" \n" +" ...\n" +" \n" +" \n" +" \n" +" \n" +" ...\n" +" \n" +" \n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:933 +#. 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." +"L extracts C and sets the attach " +"method to C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:937 +#. type: textblock +#: ../src/guestfs.pod:1000 msgid "" -"The lifetime of the returned string is until the next error occurs, or " -"L is called." +"Some of the libguestfs tools (including guestfish) support a I<--live> " +"option which is passed through to L thus allowing you " +"to attach to and modify live virtual machines." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:940 -msgid "guestfs_last_errno" +#. type: textblock +#: ../src/guestfs.pod:1004 +msgid "" +"The virtual machine needs to have been set up beforehand so that it has the " +"virtio-serial channel and so that guestfsd is running inside it." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:942 -#, no-wrap -msgid "" -" int guestfs_last_errno (guestfs_h *g);\n" -"\n" +#. type: =head2 +#: ../src/guestfs.pod:1008 +msgid "ABI GUARANTEE" msgstr "" -# type: textblock -#: ../src/guestfs.pod:944 -msgid "This returns the last error number (errno) that happened on C." +#. type: textblock +#: ../src/guestfs.pod:1010 +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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:946 -msgid "If successful, an errno integer not equal to zero is returned." +#. type: =head2 +#: ../src/guestfs.pod:1016 +msgid "BLOCK DEVICE NAMING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:948 -msgid "If no error, this returns 0. This call can return 0 in three situations:" +#. type: textblock +#: ../src/guestfs.pod:1018 +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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:955 -msgid "There has not been any error on the handle." +#. type: textblock +#: ../src/guestfs.pod:1030 +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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:959 +#. type: textblock +#: ../src/guestfs.pod:1034 msgid "" -"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." +"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:965 +#. type: textblock +#: ../src/guestfs.pod:1039 msgid "" -"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." +"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: textblock -#: ../src/guestfs.pod:971 +#. type: textblock +#: ../src/guestfs.pod:1045 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." +"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: =head2 -#: ../src/guestfs.pod:979 -msgid "guestfs_set_error_handler" +#. type: =head3 +#: ../src/guestfs.pod:1050 +msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:981 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1052 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" +"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:988 +#. type: textblock +#: ../src/guestfs.pod:1058 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." +"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:992 -msgid "" -"C is not passed to the callback. To get that the callback must call " -"L." +#. type: textblock +#: ../src/guestfs.pod:1066 +msgid "Is the string a parameter which is a device or partition name?" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1070 +msgid "Does the string begin with C?" msgstr "" -# type: textblock -#: ../src/guestfs.pod:995 +#. type: textblock +#: ../src/guestfs.pod:1074 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." +"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:999 -msgid "The default handler prints messages on C." +#. type: textblock +#: ../src/guestfs.pod:1079 +msgid "Replace initial C string with C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1001 -msgid "If you set C to C then I handler is called." +#. type: textblock +#: ../src/guestfs.pod:1081 +msgid "For example, change C to C." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1003 -msgid "guestfs_get_error_handler" +#. type: textblock +#: ../src/guestfs.pod:1083 +msgid "If that named device exists, use it. If not, continue." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1005 -#, no-wrap -msgid "" -" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" -" void **opaque_rtn);\n" -"\n" +#. type: textblock +#: ../src/guestfs.pod:1087 +msgid "Replace initial C string with C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1008 -msgid "Returns the current error handler callback." +#. type: textblock +#: ../src/guestfs.pod:1089 +msgid "If that named device exists, use it. If not, return an error." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1010 -msgid "guestfs_set_out_of_memory_handler" +#. type: =head3 +#: ../src/guestfs.pod:1093 +msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1012 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1095 msgid "" -" typedef void (*guestfs_abort_cb) (void);\n" -" int guestfs_set_out_of_memory_handler (guestfs_h *g,\n" -" guestfs_abort_cb);\n" -"\n" +"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: textblock -#: ../src/guestfs.pod:1016 +#. type: textblock +#: ../src/guestfs.pod:1099 msgid "" -"The callback C will be called if there is an out of memory situation. " -"I." +"Where possible for maximum future portability programs using libguestfs " +"should use these future-proof techniques:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1019 -msgid "The default is to call L." +#. type: textblock +#: ../src/guestfs.pod:1106 +msgid "" +"Use L or L to list actual " +"device names, and then use those names directly." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1021 -msgid "You cannot set C to C. You can't ignore out of memory situations." +#. type: textblock +#: ../src/guestfs.pod:1109 +msgid "Since those device names exist by definition, they will never be translated." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1024 -msgid "guestfs_get_out_of_memory_handler" +#. type: textblock +#: ../src/guestfs.pod:1114 +msgid "" +"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " +"filesystem labels." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1026 -#, no-wrap -msgid "" -" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" -"\n" +#. type: =head1 +#: ../src/guestfs.pod:1119 +msgid "SECURITY" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1028 -msgid "This returns the current out of memory handler." +#. type: textblock +#: ../src/guestfs.pod:1121 +msgid "" +"This section discusses security implications of using libguestfs, " +"particularly with untrusted or malicious guests or disk images." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1030 -msgid "PATH" +#. type: =head2 +#: ../src/guestfs.pod:1124 +msgid "GENERAL SECURITY CONSIDERATIONS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1032 +#. type: textblock +#: ../src/guestfs.pod:1126 msgid "" -"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " -"internal path." +"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:1035 -msgid "" -"By default it looks for these in the directory C<$libdir/guestfs> " -"(eg. C or C)." +#. type: textblock +#: ../src/guestfs.pod:1136 +msgid "the data (file etc) not being present" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1038 -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." +#. type: textblock +#: ../src/guestfs.pod:1140 +msgid "being present but empty" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1045 -msgid "HIGH-LEVEL API ACTIONS" +#. type: textblock +#: ../src/guestfs.pod:1144 +msgid "being much larger than normal" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1047 -msgid "ABI GUARANTEE" +#. type: textblock +#: ../src/guestfs.pod:1148 +msgid "containing arbitrary 8 bit data" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1049 -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." +#. type: textblock +#: ../src/guestfs.pod:1152 +msgid "being in an unexpected character encoding" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1055 ../fish/guestfish.pod:861 -msgid "@ACTIONS@" +#. type: textblock +#: ../src/guestfs.pod:1156 +msgid "containing homoglyphs." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1057 -msgid "STRUCTURES" +#. type: =head2 +#: ../src/guestfs.pod:1160 +msgid "SECURITY OF MOUNTING FILESYSTEMS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1059 -msgid "@STRUCTS@" +#. type: textblock +#: ../src/guestfs.pod:1162 +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: =head1 -#: ../src/guestfs.pod:1061 -msgid "AVAILABILITY" +#. type: textblock +#: ../src/guestfs.pod:1175 +msgid "" +"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:1063 -msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" +#. type: textblock +#: ../src/guestfs.pod:1186 +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:1065 -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: =head2 +#: ../src/guestfs.pod:1189 +msgid "PROTOCOL SECURITY" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1070 -msgid "@AVAILABILITY@" +#. type: textblock +#: ../src/guestfs.pod:1191 +msgid "" +"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: =head2 -#: ../src/guestfs.pod:1072 -msgid "GUESTFISH supported COMMAND" +#. type: =head2 +#: ../src/guestfs.pod:1197 +msgid "INSPECTION SECURITY" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1074 +#. type: textblock +#: ../src/guestfs.pod:1199 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." +"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: =head2 -#: ../src/guestfs.pod:1079 -msgid "SINGLE CALLS AT COMPILE TIME" +#. type: textblock +#: ../src/guestfs.pod:1205 +msgid "" +"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:1081 +#. type: textblock +#: ../src/guestfs.pod:1213 msgid "" -"Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " -"function, such as:" +"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: verbatim -#: ../src/guestfs.pod:1084 -#, no-wrap +#. type: =head2 +#: ../src/guestfs.pod:1219 +msgid "RUNNING UNTRUSTED GUEST COMMANDS" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1221 msgid "" -" #define LIBGUESTFS_HAVE_DD 1\n" -"\n" +"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:1086 -msgid "if L is available." +#. type: =head2 +#: ../src/guestfs.pod:1227 +msgid "CVE-2010-3851" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1088 -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:" +#. type: textblock +#: ../src/guestfs.pod:1229 +msgid "https://bugzilla.redhat.com/642934" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1093 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1231 msgid "" -" AC_CHECK_LIB([guestfs],[guestfs_create])\n" -" AC_CHECK_FUNCS([guestfs_dd])\n" -"\n" +"This security bug concerns the automatic disk format detection that qemu " +"does on disk images." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1096 +#. type: textblock +#: ../src/guestfs.pod:1234 msgid "" -"which would result in C being either defined or not defined " -"in your program." +"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: =head2 -#: ../src/guestfs.pod:1099 -msgid "SINGLE CALLS AT RUN TIME" +#. type: textblock +#: ../src/guestfs.pod:1239 +msgid "" +"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:1101 +#. type: textblock +#: ../src/guestfs.pod:1244 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." +"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: textblock +#: ../src/guestfs.pod:1252 +msgid "In libguestfs this is rather hard to exploit except under two circumstances:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1108 +#. type: textblock +#: ../src/guestfs.pod:1259 +msgid "You have enabled the network or have opened the disk in write mode." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1263 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):" +"You are also running untrusted code from the guest (see L)." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1112 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1268 msgid "" -" #include \n" -" #include \n" -" #include \n" -" #include \n" -" #include \n" -" \n" +"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: verbatim -#: ../src/guestfs.pod:1118 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1273 msgid "" -" main ()\n" -" {\n" -" #ifdef LIBGUESTFS_HAVE_DD\n" -" void *dl;\n" -" int has_function;\n" -" \n" +"For disks added from libvirt using calls like L, the " +"format is fetched from libvirt and passed through." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1124 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1276 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" +"For libguestfs tools, use the I<--format> command line parameter as " +"appropriate." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1133 -#, no-wrap +#. type: =head1 +#: ../src/guestfs.pod:1279 +msgid "CONNECTION MANAGEMENT" +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:1281 +msgid "guestfs_h *" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1283 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" +"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: textblock -#: ../src/guestfs.pod:1146 +#. type: textblock +#: ../src/guestfs.pod:1287 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:" +"For information on using multiple handles and threads, see the section " +"L above." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:1290 +msgid "guestfs_create" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1151 +#. type: verbatim +#: ../src/guestfs.pod:1292 #, no-wrap msgid "" -" Requires: libguestfs >= 1.0.80\n" +" guestfs_h *guestfs_create (void);\n" "\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1153 -msgid "CALLS WITH OPTIONAL ARGUMENTS" +#. type: textblock +#: ../src/guestfs.pod:1294 +msgid "Create a connection handle." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1155 +#. type: textblock +#: ../src/guestfs.pod:1296 msgid "" -"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:" +"On success this returns a non-NULL pointer to a handle. On error it returns " +"NULL." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1160 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1299 msgid "" -" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" -"\n" +"You have to \"configure\" the handle after creating it. This includes " +"calling L (or one of the equivalent calls) on the " +"handle at least once." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1162 +#. type: textblock +#: ../src/guestfs.pod:1303 +msgid "After configuring the handle, you have to call L." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1305 msgid "" -"Call this with a list of optional arguments, terminated by C<-1>. So to " -"call with no optional arguments specified:" +"You may also want to configure error handling for the handle. See the " +"L section below." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:1308 +msgid "guestfs_close" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1165 +#. type: verbatim +#: ../src/guestfs.pod:1310 #, no-wrap msgid "" -" guestfs_add_drive_opts (g, filename, -1);\n" +" void guestfs_close (guestfs_h *g);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1167 -msgid "With a single optional argument:" +#. type: textblock +#: ../src/guestfs.pod:1312 +msgid "This closes the connection handle and frees up all resources used." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1169 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1314 msgid "" -" guestfs_add_drive_opts (g, filename,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" -" -1);\n" -"\n" +"If autosync was set on the handle and the handle was launched, then this " +"implicitly calls various functions to unmount filesystems and sync the " +"disk. See L for more details." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1173 -msgid "With two:" +#. type: textblock +#: ../src/guestfs.pod:1318 +msgid "If a close callback was set on the handle, then it is called." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1175 -#, no-wrap +#. type: =head1 +#: ../src/guestfs.pod:1320 +msgid "ERROR HANDLING" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1322 msgid "" -" guestfs_add_drive_opts (g, filename,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" -" GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n" -" -1);\n" -"\n" +"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:1180 +#. type: textblock +#: ../src/guestfs.pod:1325 msgid "" -"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " -"happen!" +"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: =head2 -#: ../src/guestfs.pod:1183 -msgid "USING va_list FOR OPTIONAL ARGUMENTS" +#. type: textblock +#: ../src/guestfs.pod:1329 +msgid "" +"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: textblock -#: ../src/guestfs.pod:1185 +#. type: textblock +#: ../src/guestfs.pod:1334 msgid "" -"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:" +"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:1189 +#. type: verbatim +#: ../src/guestfs.pod:1338 #, no-wrap msgid "" -" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" -" va_list args);\n" +" if (guestfs_launch (g) == -1)\n" +" exit (EXIT_FAILURE);\n" "\n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1192 -msgid "CONSTRUCTING OPTIONAL ARGUMENTS" +#. type: textblock +#: ../src/guestfs.pod:1341 +msgid "" +"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:1194 +#. type: textblock +#: ../src/guestfs.pod:1344 msgid "" -"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:" +"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: verbatim -#: ../src/guestfs.pod:1200 +#. type: verbatim +#: ../src/guestfs.pod:1347 #, no-wrap msgid "" -" 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: textblock -#: ../src/guestfs.pod:1209 -msgid "You could call it like this:" +" g = guestfs_create ();\n" +" \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1211 +#. type: verbatim +#: ../src/guestfs.pod:1349 #, no-wrap msgid "" -" 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" +" /* 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:1218 +#. type: verbatim +#: ../src/guestfs.pod:1353 #, no-wrap msgid "" -" guestfs_add_drive_opts_argv (g, filename, &optargs);\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:1220 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1813 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1244 -msgid "Notes:" +#. type: textblock +#: ../src/guestfs.pod:1361 +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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1226 -msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." +#. type: textblock +#: ../src/guestfs.pod:1365 +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: textblock -#: ../src/guestfs.pod:1231 -msgid "You do not need to fill in all fields of the structure." +#. type: =head2 +#: ../src/guestfs.pod:1371 +msgid "guestfs_last_error" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1235 +#. type: verbatim +#: ../src/guestfs.pod:1373 +#, no-wrap msgid "" -"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: =head2 -#: ../src/guestfs.pod:1240 -msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" +" const char *guestfs_last_error (guestfs_h *g);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1242 +#. type: textblock +#: ../src/guestfs.pod:1375 msgid "" -"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." +"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: textblock -#: ../src/guestfs.pod:1246 -msgid "For guestfish, see L." +#. type: textblock +#: ../src/guestfs.pod:1379 +msgid "" +"The lifetime of the returned string is until the next error occurs, or " +"L is called." msgstr "" -# type: =end -#: ../src/guestfs.pod:1248 ../src/guestfs.pod:1253 -msgid "html" +#. type: =head2 +#: ../src/guestfs.pod:1382 +msgid "guestfs_last_errno" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1250 +#. type: verbatim +#: ../src/guestfs.pod:1384 +#, no-wrap msgid "" -" " +" int guestfs_last_errno (guestfs_h *g);\n" +"\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1255 -msgid "ARCHITECTURE" +#. type: textblock +#: ../src/guestfs.pod:1386 +msgid "This returns the last error number (errno) that happened on C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1257 -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." +#. type: textblock +#: ../src/guestfs.pod:1388 +msgid "If successful, an errno integer not equal to zero is returned." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1261 -#, 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" +#. type: textblock +#: ../src/guestfs.pod:1390 +msgid "If no error, this returns 0. This call can return 0 in three situations:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1281 -msgid "" -"The library, linked to the main program, creates the child process and hence " -"the appliance in the L function." +#. type: textblock +#: ../src/guestfs.pod:1397 +msgid "There has not been any error on the handle." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1284 +#. type: textblock +#: ../src/guestfs.pod:1401 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." +"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:1293 +#. type: textblock +#: ../src/guestfs.pod:1407 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)." +"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: =head1 -#: ../src/guestfs.pod:1300 -msgid "STATE MACHINE" +#. type: textblock +#: ../src/guestfs.pod:1413 +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:1302 -msgid "libguestfs uses a state machine to model the child process:" +#. type: =head2 +#: ../src/guestfs.pod:1421 +msgid "guestfs_set_error_handler" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1304 +#. type: verbatim +#: ../src/guestfs.pod:1423 #, 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" +" 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:1326 -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.pod:1331 -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.pod:1335 +#. type: textblock +#: ../src/guestfs.pod:1430 msgid "" -"Configuration commands for qemu such as L can only be " -"issued when in the CONFIG state." +"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:1338 +#. type: textblock +#: ../src/guestfs.pod:1434 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." +"C is not passed to the callback. To get that the callback must call " +"L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1344 +#. type: textblock +#: ../src/guestfs.pod:1437 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." +"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: textblock -#: ../src/guestfs.pod:1350 -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." +#. type: textblock +#: ../src/guestfs.pod:1441 +msgid "The default handler prints messages on C." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1354 -msgid "SETTING CALLBACKS TO HANDLE EVENTS" +#. type: textblock +#: ../src/guestfs.pod:1443 +msgid "If you set C to C then I handler is called." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1356 -msgid "" -"The child process generates events in some situations. Current events " -"include: receiving a log message, the child process exits." +#. type: =head2 +#: ../src/guestfs.pod:1445 +msgid "guestfs_get_error_handler" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1359 +#. type: verbatim +#: ../src/guestfs.pod:1447 +#, no-wrap msgid "" -"Use the C functions to set a callback for different " -"types of events." +" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" +" void **opaque_rtn);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1362 -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." +#. type: textblock +#: ../src/guestfs.pod:1450 +msgid "Returns the current error handler callback." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1367 -msgid "guestfs_set_log_message_callback" +#. type: =head2 +#: ../src/guestfs.pod:1452 +msgid "guestfs_set_out_of_memory_handler" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1369 +#. type: verbatim +#: ../src/guestfs.pod:1454 #, 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" +" 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:1375 +#. type: textblock +#: ../src/guestfs.pod:1458 msgid "" -"The callback function C will be called whenever qemu or the guest writes " -"anything to the console." +"The callback C will be called if there is an out of memory situation. " +"I." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1378 -msgid "Use this function to capture kernel messages and similar." +#. type: textblock +#: ../src/guestfs.pod:1461 +msgid "The default is to call L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1380 -msgid "" -"Normally there is no log message handler, and log messages are just " -"discarded." +#. type: textblock +#: ../src/guestfs.pod:1463 +msgid "You cannot set C to C. You can't ignore out of memory situations." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1383 -msgid "guestfs_set_subprocess_quit_callback" +#. type: =head2 +#: ../src/guestfs.pod:1466 +msgid "guestfs_get_out_of_memory_handler" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1385 +#. type: verbatim +#: ../src/guestfs.pod:1468 #, 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" +" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1390 -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)." +#. type: textblock +#: ../src/guestfs.pod:1470 +msgid "This returns the current out of memory handler." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1395 -msgid "guestfs_set_launch_done_callback" +#. type: =head1 +#: ../src/guestfs.pod:1472 +msgid "API CALLS" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1397 -#, 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" -"\n" +#. type: textblock +#: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1010 +msgid "@ACTIONS@" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1402 -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)." +#. type: =head1 +#: ../src/guestfs.pod:1476 +msgid "STRUCTURES" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1406 -msgid "guestfs_set_close_callback" +#. type: textblock +#: ../src/guestfs.pod:1478 +msgid "@STRUCTS@" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1408 -#, 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" -"\n" +#. type: =head1 +#: ../src/guestfs.pod:1480 +msgid "AVAILABILITY" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1413 -msgid "" -"The callback function C will be called while the handle is being closed " -"(synchronously from L)." +#. type: =head2 +#: ../src/guestfs.pod:1482 +msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1416 +#. type: textblock +#: ../src/guestfs.pod:1484 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)." +"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: =head2 -#: ../src/guestfs.pod:1424 -msgid "guestfs_set_progress_callback" +#. type: textblock +#: ../src/guestfs.pod:1489 +msgid "@AVAILABILITY@" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1426 -#, 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: =head2 +#: ../src/guestfs.pod:1491 +msgid "GUESTFISH supported COMMAND" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1433 +#. type: textblock +#: ../src/guestfs.pod:1493 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)." +"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: textblock -#: ../src/guestfs.pod:1439 -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." +#. type: =head2 +#: ../src/guestfs.pod:1498 +msgid "SINGLE CALLS AT COMPILE TIME" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1445 -msgid "The only defined and stable parts of the API are:" +#. type: textblock +#: ../src/guestfs.pod:1500 +msgid "" +"Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " +"function, such as:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1451 +#. type: verbatim +#: ../src/guestfs.pod:1503 +#, no-wrap msgid "" -"The callback can display to the user some type of progress bar or indicator " -"which shows the ratio of C:C." +" #define LIBGUESTFS_HAVE_DD 1\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1456 -msgid "0 E= C E= C" +#. type: textblock +#: ../src/guestfs.pod:1505 +msgid "if L is available." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1460 +#. type: textblock +#: ../src/guestfs.pod:1507 msgid "" -"If any progress notification is sent during a call, then a final progress " -"notification is always sent when C = C." +"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:1463 +#. type: verbatim +#: ../src/guestfs.pod:1512 +#, no-wrap 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." +" AC_CHECK_LIB([guestfs],[guestfs_create])\n" +" AC_CHECK_FUNCS([guestfs_dd])\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1469 +#. type: textblock +#: ../src/guestfs.pod:1515 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." +"which would result in C being either defined or not defined " +"in your program." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1474 -msgid "PRIVATE DATA AREA" +#. type: =head2 +#: ../src/guestfs.pod:1518 +msgid "SINGLE CALLS AT RUN TIME" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1476 +#. type: textblock +#: ../src/guestfs.pod:1520 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." +"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:1480 -msgid "To attach a named piece of data, use the following call:" +#. type: textblock +#: ../src/guestfs.pod:1527 +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):" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1482 +#. type: verbatim +#: ../src/guestfs.pod:1531 #, no-wrap msgid "" -" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" -"\n" +" #include \n" +" #include \n" +" #include \n" +" #include \n" +" #include \n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1484 +#. type: verbatim +#: ../src/guestfs.pod:1537 +#, no-wrap 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." +" main ()\n" +" {\n" +" #ifdef LIBGUESTFS_HAVE_DD\n" +" void *dl;\n" +" int has_function;\n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1488 +#. type: verbatim +#: ../src/guestfs.pod:1543 +#, no-wrap 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:1493 -msgid "To retrieve the pointer, use:" +" /* 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: verbatim -#: ../src/guestfs.pod:1495 +#. type: verbatim +#: ../src/guestfs.pod:1552 #, no-wrap msgid "" -" void *guestfs_get_private (guestfs_h *g, const char *key);\n" +" 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:1497 +#. type: textblock +#: ../src/guestfs.pod:1565 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." +"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: textblock -#: ../src/guestfs.pod:1501 +#. type: verbatim +#: ../src/guestfs.pod:1570 +#, no-wrap 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)." +" Requires: libguestfs >= 1.0.80\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1509 -msgid "" -"The private data area is implemented using a hash table, and should be " -"reasonably efficient for moderate numbers of keys." +#. type: =head1 +#: ../src/guestfs.pod:1572 +msgid "CALLS WITH OPTIONAL ARGUMENTS" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1512 -msgid "BLOCK DEVICE NAMING" +#. type: textblock +#: ../src/guestfs.pod:1574 +msgid "" +"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: textblock -#: ../src/guestfs.pod:1514 +#. type: verbatim +#: ../src/guestfs.pod:1579 +#, no-wrap 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." +" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1526 +#. type: textblock +#: ../src/guestfs.pod:1581 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." +"Call this with a list of optional arguments, terminated by C<-1>. So to " +"call with no optional arguments specified:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1530 +#. type: verbatim +#: ../src/guestfs.pod:1584 +#, 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_add_drive_opts (g, filename, -1);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1535 -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:1586 +msgid "With a single optional argument:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1541 +#. type: verbatim +#: ../src/guestfs.pod:1588 +#, no-wrap 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." +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" +" -1);\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1546 -msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" +#. type: textblock +#: ../src/guestfs.pod:1592 +msgid "With two:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1548 +#. type: verbatim +#: ../src/guestfs.pod:1594 +#, no-wrap 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." +" 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:1554 +#. type: textblock +#: ../src/guestfs.pod:1599 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." +"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " +"happen!" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1562 -msgid "Is the string a parameter which is a device or partition name?" +#. type: =head2 +#: ../src/guestfs.pod:1602 +msgid "USING va_list FOR OPTIONAL ARGUMENTS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1566 -msgid "Does the string begin with C?" +#. type: textblock +#: ../src/guestfs.pod:1604 +msgid "" +"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:1570 +#. type: verbatim +#: ../src/guestfs.pod:1608 +#, no-wrap msgid "" -"Does the named device exist? If so, we use that device. However if I " -"then we continue with this algorithm." +" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" +" va_list args);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1575 -msgid "Replace initial C string with C." +#. type: =head2 +#: ../src/guestfs.pod:1611 +msgid "CONSTRUCTING OPTIONAL ARGUMENTS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1577 -msgid "For example, change C to C." +#. type: textblock +#: ../src/guestfs.pod:1613 +msgid "" +"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: textblock -#: ../src/guestfs.pod:1579 -msgid "If that named device exists, use it. If not, continue." +#. type: verbatim +#: ../src/guestfs.pod:1619 +#, no-wrap +msgid "" +" 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: textblock -#: ../src/guestfs.pod:1583 -msgid "Replace initial C string with C." +#. type: textblock +#: ../src/guestfs.pod:1628 +msgid "You could call it like this:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1585 -msgid "If that named device exists, use it. If not, return an error." +#. type: verbatim +#: ../src/guestfs.pod:1630 +#, no-wrap +msgid "" +" 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: verbatim +#: ../src/guestfs.pod:1637 +#, no-wrap +msgid "" +" guestfs_add_drive_opts_argv (g, filename, &optargs);\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1589 -msgid "PORTABILITY CONCERNS" +#. type: textblock +#: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:2785 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1262 ../fish/guestfish-actions.pod:1898 ../tools/virt-win-reg.pl:704 +msgid "Notes:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1591 -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." +#. type: textblock +#: ../src/guestfs.pod:1645 +msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1595 -msgid "" -"Where possible for maximum future portability programs using libguestfs " -"should use these future-proof techniques:" +#. type: textblock +#: ../src/guestfs.pod:1650 +msgid "You do not need to fill in all fields of the structure." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1602 +#. type: textblock +#: ../src/guestfs.pod:1654 msgid "" -"Use L or L to list actual " -"device names, and then use those names directly." +"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:1605 -msgid "Since those device names exist by definition, they will never be translated." +#. type: =head2 +#: ../src/guestfs.pod:1659 +msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1610 +#. type: textblock +#: ../src/guestfs.pod:1661 msgid "" -"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " -"filesystem labels." +"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:1615 -msgid "INTERNALS" +#. type: textblock +#: ../src/guestfs.pod:1665 +msgid "For guestfish, see L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1617 -msgid "COMMUNICATION PROTOCOL" +#. type: =head2 +#: ../src/guestfs.pod:1667 +msgid "SETTING CALLBACKS TO HANDLE EVENTS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1619 +#. type: textblock +#: ../src/guestfs.pod:1669 msgid "" -"Don't rely on using this protocol directly. This section documents how it " -"currently works, but it may change at any time." +"B This section documents the generic event mechanism introduced in " +"libguestfs 1.10, which you should use in new code if possible. The old " +"functions C, " +"C, " +"C, C and " +"C are no longer documented in this manual " +"page. Because of the ABI guarantee, the old functions continue to work." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1622 +#. type: textblock +#: ../src/guestfs.pod:1678 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)." +"Handles generate events when certain things happen, such as log messages " +"being generated, progress messages during long-running operations, or the " +"handle being closed. The API calls described below let you register a " +"callback to be called when events happen. You can register multiple " +"callbacks (for the same, different or overlapping sets of events), and " +"individually remove callbacks. If callbacks are not removed, then they " +"remain in force until the handle is closed." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1626 +#. type: textblock +#: ../src/guestfs.pod:1686 msgid "" -"The detailed format of structures is in C (note: " -"this file is automatically generated)." +"In the current implementation, events are only generated synchronously: that " +"means that events (and hence callbacks) can only happen while you are in the " +"middle of making another libguestfs call. The callback is called in the " +"same thread." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1629 +#. type: textblock +#: ../src/guestfs.pod:1691 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:1636 -msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" +"Events may contain a payload, usually nothing (void), an array of 64 bit " +"unsigned integers, or a message buffer. Payloads are discussed later on." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1638 -msgid "For ordinary functions, the request message is:" +#. type: =head3 +#: ../src/guestfs.pod:1695 +msgid "CLASSES OF EVENTS" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1640 -#, 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" +#. type: =item +#: ../src/guestfs.pod:1699 +msgid "GUESTFS_EVENT_CLOSE (payload type: void)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1645 +#. type: textblock +#: ../src/guestfs.pod:1702 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." +"The callback function will be called while the handle is being closed " +"(synchronously from L)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1651 +#. type: textblock +#: ../src/guestfs.pod:1705 msgid "" -"Note also that many functions don't take any arguments, in which case the " -"C_args> is completely omitted." +"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:1654 +#. type: textblock +#: ../src/guestfs.pod:1712 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." +"If no callback is registered: the handle is closed without any callback " +"being invoked." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1658 -msgid "The reply message for ordinary functions is:" +#. type: =item +#: ../src/guestfs.pod:1715 +msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1660 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1718 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" -"\n" +"The callback function 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:1665 -msgid "" -"As above the C_ret> structure may be completely omitted for " -"functions that return no formal return values." +#. type: textblock +#: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731 +msgid "If no callback is registered: the event is ignored." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1668 -msgid "As above the total length of the reply is limited to C." +#. type: =item +#: ../src/guestfs.pod:1724 +msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1671 +#. type: textblock +#: ../src/guestfs.pod:1727 msgid "" -"In the case of an error, a flag is set in the header, and the reply message " -"is slightly changed:" +"The callback function 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: verbatim -#: ../src/guestfs.pod:1674 -#, 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" -"\n" +#. type: =item +#: ../src/guestfs.pod:1733 +msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1679 +#. type: textblock +#: ../src/guestfs.pod:1736 msgid "" -"The C structure contains the error message as a " -"string." +"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: =head3 -#: ../src/guestfs.pod:1682 -msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" +#. type: textblock +#: ../src/guestfs.pod:1742 +msgid "" +"The callback receives in the payload four unsigned 64 bit numbers which are " +"(in order): C, C, C, C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1684 +#. type: textblock +#: ../src/guestfs.pod:1745 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." +"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: verbatim -#: ../src/guestfs.pod:1688 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1750 +msgid "The only defined and stable parts of the API are:" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1756 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" -"\n" +"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:1696 -msgid "The \"sequence of chunks\" is:" +#. type: textblock +#: ../src/guestfs.pod:1761 +msgid "0 E= C E= C" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1698 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1765 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" -"\n" +"If any progress notification is sent during a call, then a final progress " +"notification is always sent when C = C (I the call " +"fails with an error)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1706 +#. type: textblock +#: ../src/guestfs.pod:1769 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." +"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: textblock -#: ../src/guestfs.pod:1710 +#. type: textblock +#: ../src/guestfs.pod:1775 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)." +"For some calls we are unable to estimate the progress of the call, but we " +"can still generate progress messages to indicate activity. This is known as " +"\"pulse mode\", and is directly supported by certain progress bar " +"implementations (eg. GtkProgressBar)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1715 +#. type: textblock +#: ../src/guestfs.pod:1780 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." +"For these calls, zero or more progress messages are generated with " +"C and C, followed by a final message with " +"C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1721 +#. type: textblock +#: ../src/guestfs.pod:1784 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." +"As noted above, if the call fails with an error then the final message may " +"not be generated." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1730 +#. type: textblock +#: ../src/guestfs.pod:1789 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." +"The callback also receives the procedure number (C) and serial " +"number (C) 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: =head3 -#: ../src/guestfs.pod:1736 -msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" +#. type: textblock +#: ../src/guestfs.pod:1795 +msgid "If no callback is registered: progress messages are discarded." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1738 -msgid "" -"The protocol for FileOut parameters is exactly the same as for FileIn " -"parameters, but with the roles of daemon and library reversed." +#. type: =item +#: ../src/guestfs.pod:1797 +msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1741 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1800 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" -"\n" +"The callback function is called whenever a log message is generated by qemu, " +"the appliance kernel, guestfsd (daemon), or utility programs." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1749 -msgid "INITIAL MESSAGE" +#. type: textblock +#: ../src/guestfs.pod:1803 +msgid "" +"If the verbose flag (L) is set before launch " +"(L) then additional debug messages are generated." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1751 +#. type: textblock +#: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820 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." +"If no callback is registered: the messages are discarded unless the verbose " +"flag is set in which case they are sent to stderr. You can override the " +"printing of verbose messages to stderr by setting up a callback." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1755 -msgid "PROGRESS NOTIFICATION MESSAGES" +#. type: =item +#: ../src/guestfs.pod:1811 +msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1757 +#. type: textblock +#: ../src/guestfs.pod:1814 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." +"The callback function is called whenever a log message is generated by the " +"library part of libguestfs." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1761 +#. type: textblock +#: ../src/guestfs.pod:1817 msgid "" -"The library turns them into progress callbacks (see " -"C) if there is a callback registered, or " -"discards them if not." +"If the verbose flag (L) is set then additional debug " +"messages are generated." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1765 +#. type: =item +#: ../src/guestfs.pod:1825 +msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1828 msgid "" -"The daemon self-limits the frequency of progress messages it sends (see " -"C). Not all calls generate progress " -"messages." +"The callback function is called whenever a trace message is generated. This " +"only applies if the trace flag (L) is set." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1769 -msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" +#. type: textblock +#: ../src/guestfs.pod:1831 +msgid "" +"If no callback is registered: the messages are sent to stderr. You can " +"override the printing of trace messages to stderr by setting up a callback." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1771 +#. type: =head3 +#: ../src/guestfs.pod:1837 +msgid "guestfs_set_event_callback" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:1839 +#, no-wrap msgid "" -"All high-level libguestfs actions are synchronous. If you want to use " -"libguestfs asynchronously then you must create a thread." +" int guestfs_set_event_callback (guestfs_h *g,\n" +" guestfs_event_callback cb,\n" +" uint64_t event_bitmask,\n" +" int flags,\n" +" void *opaque);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1774 +#. type: textblock +#: ../src/guestfs.pod:1845 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." +"This function registers a callback (C) for all event classes in the " +"C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1778 +#. type: textblock +#: ../src/guestfs.pod:1848 msgid "" -"See the graphical program guestfs-browser for one possible architecture for " -"multithreaded programs using libvirt and libguestfs." +"For example, to register for all log message events, you could call this " +"function with the bitmask C. " +"To register a single callback for all possible classes of events, use " +"C." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1781 -msgid "QEMU WRAPPERS" +#. type: textblock +#: ../src/guestfs.pod:1854 +msgid "C should always be passed as 0." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1783 +#. type: textblock +#: ../src/guestfs.pod:1856 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." +"C is an opaque pointer which is passed to the callback. You can use " +"it for any purpose." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1787 +#. type: textblock +#: ../src/guestfs.pod:1859 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 return value is the event handle (an integer) which you can use to " +"delete the callback (see below)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1792 +#. type: textblock +#: ../src/guestfs.pod:1862 msgid "" -"Here is an example of a wrapper, where I have built my own copy of qemu from " -"source:" +"If there is an error, this function returns C<-1>, and sets the error in the " +"handle in the usual way (see L etc.)" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1795 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1865 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" +"Callbacks remain in effect until they are deleted, or until the handle is " +"closed." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1799 +#. type: textblock +#: ../src/guestfs.pod:1868 msgid "" -"Save this script as C (or wherever), C, and " -"then use it by setting the LIBGUESTFS_QEMU environment variable. For " -"example:" +"In the case where multiple callbacks are registered for a particular event " +"class, all of the callbacks are called. The order in which multiple " +"callbacks are called is not defined." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1803 +#. type: =head3 +#: ../src/guestfs.pod:1872 +msgid "guestfs_delete_event_callback" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:1874 #, no-wrap msgid "" -" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" +" void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1805 +#. type: textblock +#: ../src/guestfs.pod:1876 msgid "" -"Note that libguestfs also calls qemu with the -help and -version options in " -"order to determine features." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1808 -msgid "LIBGUESTFS VERSION NUMBERS" +"Delete a callback that was previously registered. C should be " +"the integer that was returned by a previous call to " +"C on the same handle." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1810 -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:" +#. type: =head3 +#: ../src/guestfs.pod:1880 +msgid "guestfs_event_callback" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1815 +#. type: verbatim +#: ../src/guestfs.pod:1882 #, 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_event_callback) (\n" +" guestfs_h *g,\n" +" void *opaque,\n" +" uint64_t event,\n" +" int event_handle,\n" +" int flags,\n" +" const char *buf, size_t buf_len,\n" +" const uint64_t *array, size_t array_len);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1826 -msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." +#. type: textblock +#: ../src/guestfs.pod:1891 +msgid "This is the type of the event callback function that you have to provide." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1828 +#. type: textblock +#: ../src/guestfs.pod:1894 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 basic parameters are: the handle (C), the opaque user pointer " +"(C), the event class (eg. C), the event " +"handle, and C which in the current API you should ignore." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1834 -msgid "Our criteria for backporting changes are:" +#. type: textblock +#: ../src/guestfs.pod:1898 +msgid "" +"The remaining parameters contain the event payload (if any). Each event may " +"contain a payload, which usually relates to the event class, but for future " +"proofing your code should be written to handle any payload for any event " +"class." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1840 +#. type: textblock +#: ../src/guestfs.pod:1903 msgid "" -"Documentation changes which don't affect any code are backported unless the " -"documentation refers to a future feature which is not in stable." +"C and C contain a message buffer (if C, then " +"there is no message buffer). Note that this message buffer can contain " +"arbitrary 8 bit data, including NUL bytes." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1846 +#. type: textblock +#: ../src/guestfs.pod:1907 msgid "" -"Bug fixes which are not controversial, fix obvious problems, and have been " -"well tested are backported." +"C and C is an array of 64 bit unsigned integers. At the " +"moment this is only used for progress messages." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1851 -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: =head3 +#: ../src/guestfs.pod:1910 +msgid "EXAMPLE: CAPTURING LOG MESSAGES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1857 +#. type: textblock +#: ../src/guestfs.pod:1912 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." +"One motivation for the generic event API was to allow GUI programs to " +"capture debug and other messages. In libguestfs E 1.8 these were sent " +"unconditionally to C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1863 +#. type: textblock +#: ../src/guestfs.pod:1916 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." +"Events associated with log messages are: C, " +"C and C. (Note that error " +"messages are not events; you must capture error messages separately)." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1871 ../fish/guestfish.pod:868 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255 -msgid "ENVIRONMENT VARIABLES" +#. type: textblock +#: ../src/guestfs.pod:1921 +msgid "" +"Programs have to set up a callback to capture the classes of events of " +"interest:" msgstr "" -# type: =item -#: ../src/guestfs.pod:1875 ../fish/guestfish.pod:894 -msgid "LIBGUESTFS_APPEND" +#. type: verbatim +#: ../src/guestfs.pod:1924 +#, no-wrap +msgid "" +" int eh =\n" +" guestfs_set_event_callback\n" +" (g, message_callback,\n" +" GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n" +" GUESTFS_EVENT_TRACE,\n" +" 0, NULL) == -1)\n" +" if (eh == -1) {\n" +" // handle error in the usual way\n" +" }\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1877 ../fish/guestfish.pod:896 -msgid "Pass additional options to the guest kernel." +#. type: textblock +#: ../src/guestfs.pod:1934 +msgid "" +"The callback can then direct messages to the appropriate place. In this " +"example, messages are directed to syslog:" msgstr "" -# type: =item -#: ../src/guestfs.pod:1879 ../fish/guestfish.pod:898 -msgid "LIBGUESTFS_DEBUG" +#. type: verbatim +#: ../src/guestfs.pod:1937 +#, no-wrap +msgid "" +" static void\n" +" message_callback (\n" +" guestfs_h *g,\n" +" void *opaque,\n" +" uint64_t event,\n" +" int event_handle,\n" +" int flags,\n" +" const char *buf, size_t buf_len,\n" +" const uint64_t *array, size_t array_len)\n" +" {\n" +" const int priority = LOG_USER|LOG_INFO;\n" +" if (buf_len > 0)\n" +" syslog (priority, \"event 0x%lx: %s\", event, buf);\n" +" }\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1881 -msgid "" -"Set C to enable verbose messages. This has the same " -"effect as calling C." +#. type: =head1 +#: ../src/guestfs.pod:1952 +msgid "PRIVATE DATA AREA" msgstr "" -# type: =item -#: ../src/guestfs.pod:1884 ../fish/guestfish.pod:903 -msgid "LIBGUESTFS_MEMSIZE" +#. type: textblock +#: ../src/guestfs.pod:1954 +msgid "" +"You can attach named pieces of private data to the libguestfs handle, fetch " +"them by name, and walk over them, for the lifetime of the handle. This is " +"called the private data area and is only available from the C API." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1886 ../fish/guestfish.pod:905 -msgid "Set the memory allocated to the qemu process, in megabytes. For example:" +#. type: textblock +#: ../src/guestfs.pod:1959 +msgid "To attach a named piece of data, use the following call:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1889 ../fish/guestfish.pod:908 +#. type: verbatim +#: ../src/guestfs.pod:1961 #, no-wrap msgid "" -" LIBGUESTFS_MEMSIZE=700\n" +" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" "\n" msgstr "" -# type: =item -#: ../src/guestfs.pod:1891 ../fish/guestfish.pod:910 -msgid "LIBGUESTFS_PATH" +#. type: textblock +#: ../src/guestfs.pod:1963 +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 key is " +"overwritten." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1893 +#. type: textblock +#: ../src/guestfs.pod:1967 msgid "" -"Set the path that libguestfs uses to search for kernel and initrd.img. See " -"the discussion of paths in section PATH above." +"You can use any C you want, but your key should I start with an " +"underscore character. Keys beginning with an underscore character are " +"reserved for internal libguestfs purposes (eg. for implementing language " +"bindings). It is recommended that you prefix the key with some unique " +"string to avoid collisions with other users." msgstr "" -# type: =item -#: ../src/guestfs.pod:1896 ../fish/guestfish.pod:915 -msgid "LIBGUESTFS_QEMU" +#. type: textblock +#: ../src/guestfs.pod:1973 +msgid "To retrieve the pointer, use:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1898 ../fish/guestfish.pod:917 +#. type: verbatim +#: ../src/guestfs.pod:1975 +#, no-wrap 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." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1902 -msgid "See also L above." -msgstr "" - -# type: =item -#: ../src/guestfs.pod:1904 ../fish/guestfish.pod:921 -msgid "LIBGUESTFS_TRACE" +" void *guestfs_get_private (guestfs_h *g, const char *key);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1906 +#. type: textblock +#: ../src/guestfs.pod:1977 msgid "" -"Set C to enable command traces. This has the same " -"effect as calling C." -msgstr "" - -# type: =item -#: ../src/guestfs.pod:1909 ../fish/guestfish.pod:930 -msgid "TMPDIR" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1911 ../fish/guestfish.pod:932 -msgid "Location of temporary directory, defaults to C." +"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:1913 ../fish/guestfish.pod:934 +#. type: textblock +#: ../src/guestfs.pod:1981 msgid "" -"If libguestfs was compiled to use the supermin appliance then the real " -"appliance is cached in this directory, shared between all handles belonging " -"to the same EUID. You can use C<$TMPDIR> to configure another directory to " -"use in case C is not large enough." +"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)." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1921 ../fish/guestfish.pod:992 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:226 ../inspector/virt-inspector.pl:570 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640 ../tools/virt-ls.pl:232 ../tools/virt-resize.pl:1486 ../tools/virt-list-filesystems.pl:186 ../tools/virt-cat.pl:185 ../tools/virt-tar.pl:281 ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:254 -msgid "SEE ALSO" +#. type: textblock +#: ../src/guestfs.pod:1988 +msgid "To walk over all entries, use these two functions:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1923 +#. type: verbatim +#: ../src/guestfs.pod:1990 +#, no-wrap msgid "" -"L, L, L, L, " -"L, L, L, " -"L, L, L, " -"L, L, L, L, " -"L, L, L." +" void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1941 +#. type: verbatim +#: ../src/guestfs.pod:1992 +#, no-wrap msgid "" -"Tools with a similar purpose: L, L, L, " -"L, L." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1948 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548 -msgid "BUGS" +" void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1950 -msgid "To get a list of bugs against libguestfs use this link:" +#. type: textblock +#: ../src/guestfs.pod:1994 +msgid "" +"C returns the first key, pointer pair (\"first\" does " +"not have any particular meaning -- keys are not returned in any defined " +"order). A pointer to the key is returned in C<*key_rtn> and the " +"corresponding data pointer is returned from the function. C is " +"returned if there are no keys stored in the handle." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1952 -msgid "L" +#. type: textblock +#: ../src/guestfs.pod:2000 +msgid "" +"C returns the next key, pointer pair. The return " +"value of this function is also C is there are no further entries to " +"return." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1954 -msgid "To report a new bug against libguestfs use this link:" +#. type: textblock +#: ../src/guestfs.pod:2004 +msgid "Notes about walking over entries:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1956 -msgid "L" +#. type: textblock +#: ../src/guestfs.pod:2010 +msgid "You must not call C while walking over the entries." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1958 -msgid "When reporting a bug, please check:" +#. type: textblock +#: ../src/guestfs.pod:2015 +msgid "" +"The handle maintains an internal iterator which is reset when you call " +"C. This internal iterator is invalidated when you " +"call C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1964 -msgid "That the bug hasn't been reported already." +#. type: textblock +#: ../src/guestfs.pod:2021 +msgid "If you have set the data pointer associated with a key to C, ie:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1968 -msgid "That you are testing a recent version." +#. type: verbatim +#: ../src/guestfs.pod:2023 +#, no-wrap +msgid "" +" guestfs_set_private (g, key, NULL);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1972 -msgid "Describe the bug accurately, and give a way to reproduce it." +#. type: textblock +#: ../src/guestfs.pod:2025 +msgid "then that C is not returned when walking." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1976 +#. type: textblock +#: ../src/guestfs.pod:2029 msgid "" -"Run libguestfs-test-tool and paste the B output into the " -"bug report." +"C<*key_rtn> is only valid until the next call to C, " +"C or C." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1981 ../fish/guestfish.pod:1009 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:237 ../inspector/virt-inspector.pl:580 -msgid "AUTHORS" +#. type: textblock +#: ../src/guestfs.pod:2035 +msgid "" +"The following example code shows how to print all keys and data pointers " +"that are associated with the handle C:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1983 ../fish/guestfish.pod:1011 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:239 -msgid "Richard W.M. Jones (C)" +#. type: verbatim +#: ../src/guestfs.pod:2038 +#, no-wrap +msgid "" +" const char *key;\n" +" void *data = guestfs_first_private (g, &key);\n" +" while (data != NULL)\n" +" {\n" +" printf (\"key = %s, data = %p\\n\", key, data);\n" +" data = guestfs_next_private (g, &key);\n" +" }\n" +"\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1985 ../fish/guestfish.pod:1013 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:241 ../inspector/virt-inspector.pl:594 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653 ../tools/virt-ls.pl:247 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:202 ../tools/virt-cat.pl:199 ../tools/virt-tar.pl:296 ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:269 -msgid "COPYRIGHT" +#. type: textblock +#: ../src/guestfs.pod:2046 +msgid "" +"More commonly you are only interested in keys that begin with an " +"application-specific prefix C. Modify the loop like so:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1987 ../fish/guestfish.pod:1015 ../fuse/guestmount.pod:243 -msgid "Copyright (C) 2009-2010 Red Hat Inc. L" +#. type: verbatim +#: ../src/guestfs.pod:2049 +#, no-wrap +msgid "" +" const char *key;\n" +" void *data = guestfs_first_private (g, &key);\n" +" while (data != NULL)\n" +" {\n" +" if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n" +" printf (\"key = %s, data = %p\\n\", key, data);\n" +" data = guestfs_next_private (g, &key);\n" +" }\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1990 +#. type: textblock +#: ../src/guestfs.pod:2058 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." +"If you need to modify keys while walking, then you have to jump back to the " +"beginning of the loop. For example, to delete all keys prefixed with " +"C:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1995 +#. type: verbatim +#: ../src/guestfs.pod:2062 +#, no-wrap 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." +" const char *key;\n" +" void *data;\n" +" again:\n" +" data = guestfs_first_private (g, &key);\n" +" while (data != NULL)\n" +" {\n" +" if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n" +" {\n" +" guestfs_set_private (g, key, NULL);\n" +" /* note that 'key' pointer is now invalid, and so is\n" +" the internal iterator */\n" +" goto again;\n" +" }\n" +" data = guestfs_next_private (g, &key);\n" +" }\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2000 +#. type: textblock +#: ../src/guestfs.pod:2078 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" +"Note that the above loop is guaranteed to terminate because the keys are " +"being deleted, but other manipulations of keys within the loop might not " +"terminate unless you also maintain an indication of which keys have been " +"visited." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1 -msgid "guestfs_add_cdrom" +#. type: =end +#: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088 +msgid "html" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:3 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2085 msgid "" -" int\n" -" guestfs_add_cdrom (guestfs_h *g,\n" -" const char *filename);\n" -"\n" -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5 -msgid "This function adds a virtual CD-ROM disk image to the guest." +" " msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7 -msgid "This is equivalent to the qemu parameter C<-cdrom filename>." +#. type: =head1 +#: ../src/guestfs.pod:2090 +msgid "ARCHITECTURE" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:17 +#. type: textblock +#: ../src/guestfs.pod:2092 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." +"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: textblock -#: ../src/guestfs-actions.pod:24 +#. type: verbatim +#: ../src/guestfs.pod:2096 +#, no-wrap 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." +" ___________________\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-actions.pod:30 ../src/guestfs-actions.pod:58 ../src/guestfs-actions.pod:119 ../src/guestfs-actions.pod:156 ../src/guestfs-actions.pod:170 ../src/guestfs-actions.pod:191 ../src/guestfs-actions.pod:211 ../src/guestfs-actions.pod:225 ../src/guestfs-actions.pod:340 ../src/guestfs-actions.pod:360 ../src/guestfs-actions.pod:374 ../src/guestfs-actions.pod:419 ../src/guestfs-actions.pod:447 ../src/guestfs-actions.pod:465 ../src/guestfs-actions.pod:532 ../src/guestfs-actions.pod:565 ../src/guestfs-actions.pod:579 ../src/guestfs-actions.pod:594 ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:711 ../src/guestfs-actions.pod:725 ../src/guestfs-actions.pod:739 ../src/guestfs-actions.pod:900 ../src/guestfs-actions.pod:920 ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1040 ../src/guestfs-actions.pod:1059 ../src/guestfs-actions.pod:1073 ../src/guestfs-actions.pod:1093 ../src/guestfs-actions.pod:1132 ../src/guestfs-actions.pod:1202 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1258 ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1401 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1653 ../src/guestfs-actions.pod:1675 ../src/guestfs-actions.pod:1762 ../src/guestfs-actions.pod:2185 ../src/guestfs-actions.pod:2329 ../src/guestfs-actions.pod:2390 ../src/guestfs-actions.pod:2426 ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:2959 ../src/guestfs-actions.pod:2979 ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3132 ../src/guestfs-actions.pod:3146 ../src/guestfs-actions.pod:3161 ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3270 ../src/guestfs-actions.pod:3290 ../src/guestfs-actions.pod:3307 ../src/guestfs-actions.pod:3330 ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:3404 ../src/guestfs-actions.pod:3423 ../src/guestfs-actions.pod:3458 ../src/guestfs-actions.pod:3470 ../src/guestfs-actions.pod:3506 ../src/guestfs-actions.pod:3522 ../src/guestfs-actions.pod:3535 ../src/guestfs-actions.pod:3550 ../src/guestfs-actions.pod:3567 ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3682 ../src/guestfs-actions.pod:3695 ../src/guestfs-actions.pod:3746 ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:3782 ../src/guestfs-actions.pod:3798 ../src/guestfs-actions.pod:3812 ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3843 ../src/guestfs-actions.pod:3858 ../src/guestfs-actions.pod:3878 ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:3977 ../src/guestfs-actions.pod:3996 ../src/guestfs-actions.pod:4008 ../src/guestfs-actions.pod:4025 ../src/guestfs-actions.pod:4038 ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4068 ../src/guestfs-actions.pod:4103 ../src/guestfs-actions.pod:4118 ../src/guestfs-actions.pod:4138 ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:4169 ../src/guestfs-actions.pod:4218 ../src/guestfs-actions.pod:4255 ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:4297 ../src/guestfs-actions.pod:4314 ../src/guestfs-actions.pod:4332 ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4524 ../src/guestfs-actions.pod:4546 ../src/guestfs-actions.pod:4564 ../src/guestfs-actions.pod:4596 ../src/guestfs-actions.pod:4662 ../src/guestfs-actions.pod:4679 ../src/guestfs-actions.pod:4692 ../src/guestfs-actions.pod:4706 ../src/guestfs-actions.pod:4997 ../src/guestfs-actions.pod:5016 ../src/guestfs-actions.pod:5030 ../src/guestfs-actions.pod:5042 ../src/guestfs-actions.pod:5056 ../src/guestfs-actions.pod:5068 ../src/guestfs-actions.pod:5082 ../src/guestfs-actions.pod:5098 ../src/guestfs-actions.pod:5119 ../src/guestfs-actions.pod:5138 ../src/guestfs-actions.pod:5157 ../src/guestfs-actions.pod:5175 ../src/guestfs-actions.pod:5198 ../src/guestfs-actions.pod:5216 ../src/guestfs-actions.pod:5235 ../src/guestfs-actions.pod:5256 ../src/guestfs-actions.pod:5275 ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:5320 ../src/guestfs-actions.pod:5344 ../src/guestfs-actions.pod:5363 ../src/guestfs-actions.pod:5387 ../src/guestfs-actions.pod:5402 ../src/guestfs-actions.pod:5417 ../src/guestfs-actions.pod:5436 ../src/guestfs-actions.pod:5473 ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5522 ../src/guestfs-actions.pod:5630 ../src/guestfs-actions.pod:5751 ../src/guestfs-actions.pod:5763 ../src/guestfs-actions.pod:5776 ../src/guestfs-actions.pod:5789 ../src/guestfs-actions.pod:5811 ../src/guestfs-actions.pod:5824 ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5850 ../src/guestfs-actions.pod:5865 ../src/guestfs-actions.pod:5924 ../src/guestfs-actions.pod:5941 ../src/guestfs-actions.pod:5957 ../src/guestfs-actions.pod:5973 ../src/guestfs-actions.pod:5990 ../src/guestfs-actions.pod:6003 ../src/guestfs-actions.pod:6023 ../src/guestfs-actions.pod:6059 ../src/guestfs-actions.pod:6073 ../src/guestfs-actions.pod:6114 ../src/guestfs-actions.pod:6127 ../src/guestfs-actions.pod:6145 ../src/guestfs-actions.pod:6174 ../src/guestfs-actions.pod:6205 ../src/guestfs-actions.pod:6324 ../src/guestfs-actions.pod:6342 ../src/guestfs-actions.pod:6356 ../src/guestfs-actions.pod:6411 ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6470 ../src/guestfs-actions.pod:6503 ../src/guestfs-actions.pod:6557 ../src/guestfs-actions.pod:6583 ../src/guestfs-actions.pod:6649 ../src/guestfs-actions.pod:6668 ../src/guestfs-actions.pod:6697 -msgid "This function returns 0 on success or -1 on error." +#. type: textblock +#: ../src/guestfs.pod:2116 +msgid "" +"The library, linked to the main program, creates the child process and hence " +"the appliance in the L function." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:172 ../src/guestfs-actions.pod:193 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:117 ../fish/guestfish-actions.pod:131 +#. type: textblock +#: ../src/guestfs.pod:2119 msgid "" -"This function is deprecated. In new code, use the C call " -"instead." +"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-actions.pod:35 ../src/guestfs-actions.pod:175 ../src/guestfs-actions.pod:196 ../src/guestfs-actions.pod:1406 ../src/guestfs-actions.pod:1892 ../src/guestfs-actions.pod:1913 ../src/guestfs-actions.pod:6591 ../src/guestfs-actions.pod:6760 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:120 ../fish/guestfish-actions.pod:134 ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:1297 ../fish/guestfish-actions.pod:1311 ../fish/guestfish-actions.pod:4353 ../fish/guestfish-actions.pod:4450 +#. type: textblock +#: ../src/guestfs.pod:2128 msgid "" -"Deprecated functions will not be removed from the API, but the fact that " -"they are deprecated indicates that there are problems with correct use of " -"these functions." +"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-actions.pod:39 ../src/guestfs-actions.pod:60 ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:1864 ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2065 ../src/guestfs-actions.pod:2946 ../src/guestfs-actions.pod:2961 ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:5294 ../src/guestfs-actions.pod:5404 ../src/guestfs-actions.pod:5867 ../src/guestfs-actions.pod:5992 ../src/guestfs-actions.pod:6505 -msgid "(Added in 0.3)" +#. type: =head1 +#: ../src/guestfs.pod:2135 +msgid "STATE MACHINE" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:41 -msgid "guestfs_add_drive" +#. type: textblock +#: ../src/guestfs.pod:2137 +msgid "libguestfs uses a state machine to model the child process:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:43 +#. type: verbatim +#: ../src/guestfs.pod:2139 #, no-wrap msgid "" -" int\n" -" guestfs_add_drive (guestfs_h *g,\n" -" const 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:47 +#. type: textblock +#: ../src/guestfs.pod:2161 msgid "" -"This function is the equivalent of calling C with no " -"optional parameters, so the disk is added writable, with the format being " -"detected automatically." +"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:51 +#. type: textblock +#: ../src/guestfs.pod:2166 msgid "" -"Automatic detection of the format opens you up to a potential security hole " -"when dealing with untrusted raw-format images. See CVE-2010-3851 and " -"RHBZ#642934. Specifying the format closes this security hole. Therefore " -"you should think about replacing calls to this function with calls to " -"C, and specifying the format." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:62 -msgid "guestfs_add_drive_opts" +"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: verbatim -#: ../src/guestfs-actions.pod:64 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2170 msgid "" -" int\n" -" guestfs_add_drive_opts (guestfs_h *g,\n" -" const char *filename,\n" -" ...);\n" -"\n" +"Configuration commands for qemu such as L can only be " +"issued when in the CONFIG state." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:69 +#. type: textblock +#: ../src/guestfs.pod:2173 msgid "" -"You may supply a list of optional arguments to this call. Use zero or more " -"of the following pairs of parameters, and terminate the list with C<-1> on " -"its own. See L." +"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: verbatim -#: ../src/guestfs-actions.pod:74 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2179 msgid "" -" GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n" -" GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n" -"\n" +"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: textblock -#: ../src/guestfs-actions.pod:78 ../fish/guestfish-actions.pod:56 +#. type: textblock +#: ../src/guestfs.pod:2185 msgid "" -"This function adds a virtual machine disk image C to libguestfs. " -"The first time you call this function, the disk appears as C, the " -"second time as C, and so on." +"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: textblock -#: ../src/guestfs-actions.pod:83 ../fish/guestfish-actions.pod:61 -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)." +#. type: =head1 +#: ../src/guestfs.pod:2189 +msgid "INTERNALS" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:67 -msgid "This call checks that C exists." +#. type: =head2 +#: ../src/guestfs.pod:2191 +msgid "COMMUNICATION PROTOCOL" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:91 ../fish/guestfish-actions.pod:69 -msgid "The optional arguments are:" +#. type: textblock +#: ../src/guestfs.pod:2193 +msgid "" +"Don't rely on using this protocol directly. This section documents how it " +"currently works, but it may change at any time." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:95 ../fish/guestfish-actions.pod:73 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2196 +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)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:97 ../fish/guestfish-actions.pod:75 +#. type: textblock +#: ../src/guestfs.pod:2200 msgid "" -"If true then the image is treated as read-only. Writes are still allowed, " -"but they are stored in a temporary snapshot overlay which is discarded at " -"the end. The disk that you add is not modified." -msgstr "" - -# type: =item -#: ../src/guestfs-actions.pod:101 ../fish/guestfish-actions.pod:79 -msgid "C" -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:103 -msgid "" -"This forces the image format. If you omit this (or use C " -"or C) then the format is automatically detected. " -"Possible formats include C and C." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:107 ../fish/guestfish-actions.pod:85 -msgid "" -"Automatic detection of the format opens you up to a potential security hole " -"when dealing with untrusted raw-format images. See CVE-2010-3851 and " -"RHBZ#642934. Specifying the format closes this security hole." -msgstr "" - -# type: =item -#: ../src/guestfs-actions.pod:112 ../fish/guestfish-actions.pod:90 -msgid "C" +"The detailed format of structures is in C (note: " +"this file is automatically generated)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:114 +#. type: textblock +#: ../src/guestfs.pod:2203 msgid "" -"This rarely-used option lets you emulate the behaviour of the deprecated " -"C call (q.v.)" +"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:121 -msgid "(Added in 1.5.23)" +#. type: =head3 +#: ../src/guestfs.pod:2210 +msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:123 -msgid "guestfs_add_drive_opts_va" +#. type: textblock +#: ../src/guestfs.pod:2212 +msgid "For ordinary functions, the request message is:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:125 +#. type: verbatim +#: ../src/guestfs.pod:2214 #, no-wrap msgid "" -" int\n" -" guestfs_add_drive_opts_va (guestfs_h *g,\n" -" const char *filename,\n" -" va_list args);\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:130 -msgid "This is the \"va_list variant\" of L." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:132 ../src/guestfs-actions.pod:143 -msgid "See L." +#. type: textblock +#: ../src/guestfs.pod:2219 +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: =head2 -#: ../src/guestfs-actions.pod:134 -msgid "guestfs_add_drive_opts_argv" +#. type: textblock +#: ../src/guestfs.pod:2225 +msgid "" +"Note also that many functions don't take any arguments, in which case the " +"C_args> is completely omitted." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:136 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2228 msgid "" -" int\n" -" guestfs_add_drive_opts_argv (guestfs_h *g,\n" -" const char *filename,\n" -" const struct guestfs_add_drive_opts_argv " -"*optargs);\n" -"\n" +"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:141 -msgid "This is the \"argv variant\" of L." +#. type: textblock +#: ../src/guestfs.pod:2232 +msgid "" +"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:145 -msgid "guestfs_add_drive_ro" +#. type: textblock +#: ../src/guestfs.pod:2240 +msgid "The reply message for ordinary functions is:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:147 +#. type: verbatim +#: ../src/guestfs.pod:2242 #, no-wrap msgid "" -" int\n" -" guestfs_add_drive_ro (guestfs_h *g,\n" -" const char *filename);\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:151 +#. type: textblock +#: ../src/guestfs.pod:2247 msgid "" -"This function is the equivalent of calling C with " -"the optional parameter C set to 1, so the " -"disk is added read-only, with the format being detected automatically." +"As above the C_ret> structure may be completely omitted for " +"functions that return no formal return values." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:158 -msgid "(Added in 1.0.38)" +#. type: textblock +#: ../src/guestfs.pod:2250 +msgid "As above the total length of the reply is limited to C." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:160 -msgid "guestfs_add_drive_ro_with_if" +#. type: textblock +#: ../src/guestfs.pod:2253 +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:162 +#. type: verbatim +#: ../src/guestfs.pod:2256 #, no-wrap msgid "" -" int\n" -" guestfs_add_drive_ro_with_if (guestfs_h *g,\n" -" const char *filename,\n" -" const 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:167 +#. type: textblock +#: ../src/guestfs.pod:2261 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: textblock -#: ../src/guestfs-actions.pod:179 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:2275 -msgid "(Added in 1.0.84)" +#. type: =head3 +#: ../src/guestfs.pod:2264 +msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:181 -msgid "guestfs_add_drive_with_if" +#. type: textblock +#: ../src/guestfs.pod:2266 +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." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:183 +#. type: verbatim +#: ../src/guestfs.pod:2270 #, no-wrap msgid "" -" int\n" -" guestfs_add_drive_with_if (guestfs_h *g,\n" -" const char *filename,\n" -" const char *iface);\n" +" 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: textblock -#: ../src/guestfs-actions.pod:188 -msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:202 -msgid "guestfs_aug_clear" +#. type: textblock +#: ../src/guestfs.pod:2278 +msgid "The \"sequence of chunks\" is:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:204 +#. type: verbatim +#: ../src/guestfs.pod:2280 #, no-wrap msgid "" -" int\n" -" guestfs_aug_clear (guestfs_h *g,\n" -" const char *augpath);\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:208 ../fish/guestfish-actions.pod:142 +#. type: textblock +#: ../src/guestfs.pod:2288 msgid "" -"Set the value associated with C to C. This is the same as the " -"L C command." +"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-actions.pod:213 ../src/guestfs-actions.pod:2054 -msgid "(Added in 1.3.4)" +#. type: textblock +#: ../src/guestfs.pod:2292 +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)." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:215 -msgid "guestfs_aug_close" +#. type: textblock +#: ../src/guestfs.pod:2297 +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: verbatim -#: ../src/guestfs-actions.pod:217 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2303 msgid "" -" int\n" -" guestfs_aug_close (guestfs_h *g);\n" -"\n" +"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:220 +#. type: textblock +#: ../src/guestfs.pod:2312 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." +"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:227 ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:270 ../src/guestfs-actions.pod:284 ../src/guestfs-actions.pod:342 ../src/guestfs-actions.pod:362 ../src/guestfs-actions.pod:376 ../src/guestfs-actions.pod:407 ../src/guestfs-actions.pod:421 ../src/guestfs-actions.pod:435 ../src/guestfs-actions.pod:449 ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:4854 -msgid "(Added in 0.7)" +#. type: =head3 +#: ../src/guestfs.pod:2318 +msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:229 -msgid "guestfs_aug_defnode" +#. type: textblock +#: ../src/guestfs.pod:2320 +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:231 +#. type: verbatim +#: ../src/guestfs.pod:2323 #, no-wrap msgid "" -" struct guestfs_int_bool *\n" -" guestfs_aug_defnode (guestfs_h *g,\n" -" const char *name,\n" -" const char *expr,\n" -" const char *val);\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:237 ../fish/guestfish-actions.pod:158 -msgid "Defines a variable C whose value is the result of evaluating C." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:240 -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." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:244 ../fish/guestfish-actions.pod:165 -msgid "" -"On success this returns a pair containing the number of nodes in the " -"nodeset, and a boolean flag if a node was created." +#. type: =head3 +#: ../src/guestfs.pod:2331 +msgid "INITIAL MESSAGE" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:248 +#. type: textblock +#: ../src/guestfs.pod:2333 msgid "" -"This function returns a C, or NULL if there was " -"an error. I after use>." +"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: =head2 -#: ../src/guestfs-actions.pod:254 -msgid "guestfs_aug_defvar" +#. type: =head3 +#: ../src/guestfs.pod:2337 +msgid "PROGRESS NOTIFICATION MESSAGES" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:256 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2339 msgid "" -" int\n" -" guestfs_aug_defvar (guestfs_h *g,\n" -" const char *name,\n" -" const char *expr);\n" -"\n" +"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: textblock -#: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:173 +#. type: textblock +#: ../src/guestfs.pod:2343 msgid "" -"Defines an Augeas variable C whose value is the result of evaluating " -"C. If C is NULL, then C is undefined." +"The library turns them into progress callbacks (see " +"L) if there is a callback registered, or discards " +"them if not." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:265 ../fish/guestfish-actions.pod:177 +#. type: textblock +#: ../src/guestfs.pod:2347 msgid "" -"On success this returns the number of nodes in C, or C<0> if C " -"evaluates to something which is not a nodeset." +"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:268 ../src/guestfs-actions.pod:433 ../src/guestfs-actions.pod:611 ../src/guestfs-actions.pod:642 ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1632 ../src/guestfs-actions.pod:1835 ../src/guestfs-actions.pod:1934 ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2575 ../src/guestfs-actions.pod:2596 ../src/guestfs-actions.pod:4241 ../src/guestfs-actions.pod:4369 ../src/guestfs-actions.pod:4777 ../src/guestfs-actions.pod:4803 ../src/guestfs-actions.pod:6100 ../src/guestfs-actions.pod:6516 ../src/guestfs-actions.pod:6529 ../src/guestfs-actions.pod:6542 -msgid "On error this function returns -1." +#. type: =head1 +#: ../src/guestfs.pod:2351 +msgid "LIBGUESTFS VERSION NUMBERS" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:272 -msgid "guestfs_aug_get" +#. type: textblock +#: ../src/guestfs.pod:2353 +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:274 +#. type: verbatim +#: ../src/guestfs.pod:2358 #, no-wrap msgid "" -" char *\n" -" guestfs_aug_get (guestfs_h *g,\n" -" const char *augpath);\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:278 ../fish/guestfish-actions.pod:184 -msgid "" -"Look up the value associated with C. If C matches exactly one " -"node, the C is returned." +#. type: textblock +#: ../src/guestfs.pod:2369 +msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:781 ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:859 ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:978 ../src/guestfs-actions.pod:1112 ../src/guestfs-actions.pod:1147 ../src/guestfs-actions.pod:1164 ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1312 ../src/guestfs-actions.pod:1503 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1778 ../src/guestfs-actions.pod:1795 ../src/guestfs-actions.pod:1886 ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:2077 ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2448 ../src/guestfs-actions.pod:2521 ../src/guestfs-actions.pod:2652 ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2713 ../src/guestfs-actions.pod:3091 ../src/guestfs-actions.pod:3442 ../src/guestfs-actions.pod:3613 ../src/guestfs-actions.pod:3724 ../src/guestfs-actions.pod:4387 ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:4752 ../src/guestfs-actions.pod:4931 ../src/guestfs-actions.pod:4980 ../src/guestfs-actions.pod:5543 ../src/guestfs-actions.pod:5559 ../src/guestfs-actions.pod:5576 ../src/guestfs-actions.pod:5600 ../src/guestfs-actions.pod:6264 ../src/guestfs-actions.pod:6283 ../src/guestfs-actions.pod:6301 ../src/guestfs-actions.pod:6482 ../src/guestfs-actions.pod:6754 +#. type: textblock +#: ../src/guestfs.pod:2371 msgid "" -"This function returns a string, or NULL on error. I." -msgstr "" +"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: =head2 -#: ../src/guestfs-actions.pod:286 -msgid "guestfs_aug_init" +#. type: textblock +#: ../src/guestfs.pod:2377 +msgid "Our criteria for backporting changes are:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:288 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2383 msgid "" -" int\n" -" guestfs_aug_init (guestfs_h *g,\n" -" const char *root,\n" -" int flags);\n" -"\n" +"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: textblock -#: ../src/guestfs-actions.pod:293 ../fish/guestfish-actions.pod:191 +#. type: textblock +#: ../src/guestfs.pod:2389 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." +"Bug fixes which are not controversial, fix obvious problems, and have been " +"well tested are backported." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:297 -msgid "You must call this before using any other C commands." +#. type: textblock +#: ../src/guestfs.pod:2394 +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: textblock -#: ../src/guestfs-actions.pod:300 ../fish/guestfish-actions.pod:198 -msgid "C is the filesystem root. C must not be NULL, use C instead." +#. type: textblock +#: ../src/guestfs.pod:2400 +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:303 ../fish/guestfish-actions.pod:201 +#. type: textblock +#: ../src/guestfs.pod:2406 msgid "" -"The flags are the same as the flags defined in Eaugeas.hE, the " -"logical I of the following integers:" +"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:309 ../fish/guestfish-actions.pod:207 -msgid "C = 1" +#. type: =head1 +#: ../src/guestfs.pod:2414 +msgid "EXTENDING LIBGUESTFS" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:311 ../fish/guestfish-actions.pod:209 -msgid "Keep the original file with a C<.augsave> extension." +#. type: =head2 +#: ../src/guestfs.pod:2416 +msgid "ADDING A NEW API ACTION" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:211 -msgid "C = 2" +#. type: textblock +#: ../src/guestfs.pod:2418 +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:315 ../fish/guestfish-actions.pod:213 -msgid "" -"Save changes into a file with extension C<.augnew>, and do not overwrite " -"original. Overrides C." +#. type: textblock +#: ../src/guestfs.pod:2422 +msgid "To add a new API action there are two changes:" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:318 ../fish/guestfish-actions.pod:216 -msgid "C = 4" +#. type: textblock +#: ../src/guestfs.pod:2428 +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:320 ../fish/guestfish-actions.pod:218 -msgid "Typecheck lenses (can be expensive)." +#. type: textblock +#: ../src/guestfs.pod:2431 +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:322 ../fish/guestfish-actions.pod:220 -msgid "C = 8" +#. type: textblock +#: ../src/guestfs.pod:2439 +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:324 ../fish/guestfish-actions.pod:222 -msgid "Do not use standard load path for modules." +#. type: textblock +#: ../src/guestfs.pod:2445 +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: =item -#: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:224 -msgid "C = 16" +#. type: textblock +#: ../src/guestfs.pod:2453 +msgid "Implement the action (in C):" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:328 ../fish/guestfish-actions.pod:226 -msgid "Make save a no-op, just record what would have been changed." +#. type: textblock +#: ../src/guestfs.pod:2455 +msgid "" +"For daemon actions, implement the function CnameE> in the " +"C directory." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:330 ../fish/guestfish-actions.pod:228 -msgid "C = 32" +#. type: textblock +#: ../src/guestfs.pod:2458 +msgid "" +"For library actions, implement the function CnameE> " +"(note: double underscore) in the C directory." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:332 -msgid "Do not load the tree in C." +#. type: textblock +#: ../src/guestfs.pod:2461 +msgid "In either case, use another function as an example of what to do." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:336 -msgid "To close the handle, you can call C." +#. type: textblock +#: ../src/guestfs.pod:2465 +msgid "After making these changes, use C to compile." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:338 ../fish/guestfish-actions.pod:236 -msgid "To find out more about Augeas, see L." +#. type: textblock +#: ../src/guestfs.pod:2467 +msgid "" +"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: =head2 -#: ../src/guestfs-actions.pod:344 -msgid "guestfs_aug_insert" +#. type: =head2 +#: ../src/guestfs.pod:2471 +msgid "ADDING TESTS FOR AN API ACTION" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:346 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2473 msgid "" -" int\n" -" guestfs_aug_insert (guestfs_h *g,\n" -" const char *augpath,\n" -" const char *label,\n" -" int before);\n" -"\n" +"You can supply zero or as many tests as you want per API call. The tests " +"can either be added as part of the API description " +"(C), or in some rarer cases you may want to " +"drop a script into C. Note that adding a script to " +"C is slower, so if possible use the first method." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:352 ../fish/guestfish-actions.pod:242 +#. type: textblock +#: ../src/guestfs.pod:2479 msgid "" -"Create a new sibling C