X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=po-docs%2Flibguestfs-docs.pot;h=63d7a9672c0c86b7723df1502b4a9b4603168aa5;hp=b2c8de13e9bbc58e98f904bb12aad6663c8751c0;hb=5419153954ee0a2597358b992cc29e448a21ca60;hpb=fc279d28060b2ee6f52dbc92cb1541f2494e1258 diff --git a/po-docs/libguestfs-docs.pot b/po-docs/libguestfs-docs.pot index b2c8de1..63d7a96 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.8.0\n" +"Project-Id-Version: libguestfs 1.11.4\n" "Report-Msgid-Bugs-To: libguestfs@redhat.com\n" -"POT-Creation-Date: 2010-12-19 15:38+0000\n" +"POT-Creation-Date: 2011-05-08 16:51+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 ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-tar.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 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 +#. type: =head1 +#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-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 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 +#. type: =head1 +#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-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 "" @@ -58,7 +54,7 @@ msgid "" "\n" msgstr "" -# type: verbatim +#. type: verbatim #: ../src/guestfs.pod:19 #, no-wrap msgid "" @@ -68,12 +64,12 @@ msgid "" "\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:72 ../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-edit.pl:50 ../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 +#. type: textblock #: ../src/guestfs.pod:25 msgid "" "Libguestfs is a library for accessing and modifying guest disk images. " @@ -84,7 +80,7 @@ msgid "" "registry/UUID/hostname info, and much else besides." msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:33 msgid "" "Libguestfs uses Linux kernel and qemu code, and can access any type of guest " @@ -93,7 +89,7 @@ msgid "" "qcow2, vmdk." msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:38 msgid "" "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, " @@ -101,7 +97,7 @@ msgid "" "context of the guest. Also you can access filesystems over FUSE." msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:43 msgid "" "Libguestfs is a library that can be linked with C and C++ management " @@ -110,33 +106,33 @@ msgid "" "line." msgstr "" -# type: textblock +#. 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 +#. 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: textblock +#. type: textblock #: ../src/guestfs.pod:54 msgid "" "There are also some example programs in the L manual " "page." msgstr "" -# type: =head1 +#. type: =head1 #: ../src/guestfs.pod:57 msgid "API OVERVIEW" msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:59 msgid "" "This section provides a gentler overview of the libguestfs API. We also try " @@ -144,12 +140,12 @@ msgid "" "about the individual calls in the main section of this manual." msgstr "" -# type: =head2 +#. type: =head2 #: ../src/guestfs.pod:64 msgid "HANDLES" msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:66 msgid "" "Before you can use libguestfs calls, you have to create a handle. Then you " @@ -159,12 +155,12 @@ msgid "" "handle variable, although of course you can use any name you want." msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:73 msgid "The general structure of all libguestfs-using programs looks like this:" msgstr "" -# type: verbatim +#. type: verbatim #: ../src/guestfs.pod:76 #, no-wrap msgid "" @@ -172,7 +168,7 @@ msgid "" " \n" msgstr "" -# type: verbatim +#. type: verbatim #: ../src/guestfs.pod:78 #, no-wrap msgid "" @@ -183,7 +179,7 @@ msgid "" " \n" msgstr "" -# type: verbatim +#. type: verbatim #: ../src/guestfs.pod:83 #, no-wrap msgid "" @@ -195,7 +191,7 @@ msgid "" " \n" msgstr "" -# type: verbatim +#. type: verbatim #: ../src/guestfs.pod:89 #, no-wrap msgid "" @@ -206,7 +202,7 @@ msgid "" " \n" msgstr "" -# type: verbatim +#. type: verbatim #: ../src/guestfs.pod:94 #, no-wrap msgid "" @@ -216,7 +212,7 @@ msgid "" " \n" msgstr "" -# type: verbatim +#. type: verbatim #: ../src/guestfs.pod:98 #, no-wrap msgid "" @@ -224,10 +220,10 @@ msgid "" " * disk image.\n" " */\n" " guestfs_touch (g, \"/hello\");\n" -"\n" +" \n" msgstr "" -# type: verbatim +#. type: verbatim #: ../src/guestfs.pod:103 #, no-wrap msgid "" @@ -239,7 +235,7 @@ msgid "" " \n" msgstr "" -# type: verbatim +#. type: verbatim #: ../src/guestfs.pod:109 #, no-wrap msgid "" @@ -248,7 +244,7 @@ msgid "" "\n" msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:112 msgid "" "The code above doesn't include any error checking. In real code you should " @@ -260,12 +256,12 @@ msgid "" "L for fully worked examples." msgstr "" -# type: =head2 +#. type: =head2 #: ../src/guestfs.pod:121 msgid "DISK IMAGES" msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:123 msgid "" "The image filename (C<\"guest.img\"> in the example above) could be a disk " @@ -275,7 +271,7 @@ msgid "" "of these." msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:129 msgid "" "The call you should use in modern code for adding drives is " @@ -283,7 +279,7 @@ msgid "" "specifying that the format is raw, do:" msgstr "" -# type: verbatim +#. type: verbatim #: ../src/guestfs.pod:133 #, no-wrap msgid "" @@ -293,12 +289,12 @@ msgid "" "\n" msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:137 msgid "You can add a disk read-only using:" msgstr "" -# type: verbatim +#. type: verbatim #: ../src/guestfs.pod:139 #, no-wrap msgid "" @@ -309,14 +305,14 @@ msgid "" "\n" msgstr "" -# type: textblock +#. 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 +#. type: textblock #: ../src/guestfs.pod:147 msgid "" "Be extremely cautious if the disk image is in use, eg. if it is being used " @@ -324,7 +320,7 @@ msgid "" "corruption, but adding it read-only is safe." msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:151 msgid "" "You must add at least one disk image, and you may add multiple disk images. " @@ -332,7 +328,7 @@ msgid "" "first one you added), C (for the second one you added), etc." msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:156 msgid "" "Once L has been called you cannot add any more images. You " @@ -340,64 +336,72 @@ msgid "" "order that you added them. See also L below." msgstr "" -# type: =head2 +#. type: =head2 #: ../src/guestfs.pod:161 msgid "MOUNTING" msgstr "" -# type: textblock +#. 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:169 +#. 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:171 +#. 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:175 +#. 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:185 +#. 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:188 +#. type: =head2 +#: ../src/guestfs.pod:194 msgid "FILESYSTEM ACCESS AND MODIFICATION" msgstr "" -# type: textblock -#: ../src/guestfs.pod:190 +#. 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 " @@ -406,58 +410,58 @@ msgid "" "all in this overview." msgstr "" -# type: textblock -#: ../src/guestfs.pod:196 +#. 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:199 +#. 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:202 +#. type: verbatim +#: ../src/guestfs.pod:208 #, no-wrap msgid "" " char *data = guestfs_cat (g, \"/etc/passwd\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:204 +#. 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:208 +#. 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:211 +#. type: verbatim +#: ../src/guestfs.pod:217 #, no-wrap msgid "" " guestfs_mkdir (g, \"/var\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:213 +#. type: textblock +#: ../src/guestfs.pod:219 msgid "To create a symlink you could do:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:215 +#. type: verbatim +#: ../src/guestfs.pod:221 #, no-wrap msgid "" " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n" @@ -465,15 +469,15 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:218 +#. 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:221 +#. 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 " @@ -482,34 +486,34 @@ msgid "" "turn these errors into exceptions)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:227 +#. 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:230 +#. type: =head2 +#: ../src/guestfs.pod:236 msgid "PARTITIONING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:232 +#. 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:235 +#. 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:239 +#. type: verbatim +#: ../src/guestfs.pod:245 #, no-wrap msgid "" " const char *parttype = \"mbr\";\n" @@ -519,20 +523,20 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:244 +#. 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:247 +#. type: =head2 +#: ../src/guestfs.pod:253 msgid "LVM2" msgstr "" -# type: textblock -#: ../src/guestfs.pod:249 +#. 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 " @@ -540,60 +544,60 @@ msgid "" "volume groups and logical volumes." msgstr "" -# type: textblock -#: ../src/guestfs.pod:254 +#. type: textblock +#: ../src/guestfs.pod:260 msgid "" "This author strongly recommends reading the LVM HOWTO, online at " "L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:257 +#. type: =head2 +#: ../src/guestfs.pod:263 msgid "DOWNLOADING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:259 +#. 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:264 +#. 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:268 +#. 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:271 +#. type: textblock +#: ../src/guestfs.pod:276 msgid "To download multiple files, see L and L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:274 +#. type: =head2 +#: ../src/guestfs.pod:279 msgid "UPLOADING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:276 +#. 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:279 +#. 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 " @@ -602,20 +606,20 @@ msgid "" "L and L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:285 +#. 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:288 +#. type: textblock +#: ../src/guestfs.pod:293 msgid "To upload multiple files, see L and L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:290 +#. 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 " @@ -628,91 +632,91 @@ msgid "" "using a label or UUID, use an ISO image instead." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:301 +#. type: =head2 +#: ../src/guestfs.pod:306 msgid "COPYING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:303 +#. 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:309 +#. type: =item +#: ../src/guestfs.pod:314 msgid "B to B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:311 +#. 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:314 +#. type: =item +#: ../src/guestfs.pod:319 msgid "B to B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:316 +#. 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:319 +#. type: textblock +#: ../src/guestfs.pod:324 msgid "Example: duplicate the contents of an LV:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:321 +#. 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:323 +#. 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:327 +#. type: =item +#: ../src/guestfs.pod:332 msgid "B to B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:329 +#. type: textblock +#: ../src/guestfs.pod:334 msgid "Use L. See L above." msgstr "" -# type: =item -#: ../src/guestfs.pod:331 +#. type: =item +#: ../src/guestfs.pod:336 msgid "B to B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:333 +#. type: textblock +#: ../src/guestfs.pod:338 msgid "Use L. See L above." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:337 +#. type: =head2 +#: ../src/guestfs.pod:342 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:339 +#. type: textblock +#: ../src/guestfs.pod:344 msgid "" "Calls like L, L, L, " "L etc appear to only take filenames as arguments, so it " @@ -722,136 +726,136 @@ msgid "" "stderr, and arbitrary file descriptor N." msgstr "" -# type: textblock -#: ../src/guestfs.pod:347 +#. type: textblock +#: ../src/guestfs.pod:352 msgid "For example, L writes its output to stdout by doing:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:350 +#. type: verbatim +#: ../src/guestfs.pod:355 #, no-wrap msgid "" -" guestfs_download (filename, \"/dev/stdout\");\n" +" guestfs_download (g, filename, \"/dev/stdout\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:352 -msgid "and you can write tar output to a pipe C by doing:" +#. 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:354 +#. 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 (\"/\", devfd);\n" +" guestfs_tar_out (g, \"/\", devfd);\n" "\n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:358 +#. type: =head2 +#: ../src/guestfs.pod:363 msgid "LISTING FILES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:360 +#. 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:363 +#. 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:366 +#. 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:370 +#. type: textblock +#: ../src/guestfs.pod:375 msgid "" "L and L can be used to recursively list " "files." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:373 +#. type: =head2 +#: ../src/guestfs.pod:378 msgid "RUNNING COMMANDS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:375 +#. 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:379 +#. type: textblock +#: ../src/guestfs.pod:384 msgid "There are many limitations to this:" msgstr "" -# type: =item -#: ../src/guestfs.pod:383 ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:397 ../src/guestfs.pod:402 ../src/guestfs.pod:406 ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:1006 ../src/guestfs.pod:1010 ../src/guestfs.pod:1014 ../src/guestfs.pod:1019 ../src/guestfs.pod:1027 ../src/guestfs.pod:1046 ../src/guestfs.pod:1054 ../src/guestfs.pod:1076 ../src/guestfs.pod:1080 ../src/guestfs.pod:1084 ../src/guestfs.pod:1088 ../src/guestfs.pod:1092 ../src/guestfs.pod:1096 ../src/guestfs.pod:1578 ../src/guestfs.pod:1583 ../src/guestfs.pod:1587 ../src/guestfs.pod:1697 ../src/guestfs.pod:1702 ../src/guestfs.pod:1706 ../src/guestfs.pod:2058 ../src/guestfs.pod:2064 ../src/guestfs.pod:2069 ../src/guestfs.pod:2075 ../src/guestfs.pod:2187 ../src/guestfs.pod:2191 ../src/guestfs.pod:2195 ../src/guestfs.pod:2199 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:579 ../src/guestfs-actions.pod:586 ../src/guestfs-actions.pod:593 ../src/guestfs-actions.pod:1589 ../src/guestfs-actions.pod:1593 ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1613 ../src/guestfs-actions.pod:1617 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1635 ../src/guestfs-actions.pod:1773 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1787 ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1852 ../src/guestfs-actions.pod:1857 ../fish/guestfish.pod:427 ../fish/guestfish.pod:431 ../fish/guestfish.pod:435 ../fish/guestfish.pod:439 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:375 ../fish/guestfish-actions.pod:383 ../fish/guestfish-actions.pod:390 ../fish/guestfish-actions.pod:397 ../fish/guestfish-actions.pod:1067 ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075 ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087 ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095 ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109 ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203 ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259 ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360 +#. 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:2963 ../src/guestfs.pod:2967 ../src/guestfs.pod:2971 ../src/guestfs.pod:2975 ../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:1606 ../src/guestfs-actions.pod:1610 ../src/guestfs-actions.pod:1614 ../src/guestfs-actions.pod:1618 ../src/guestfs-actions.pod:1626 ../src/guestfs-actions.pod:1630 ../src/guestfs-actions.pod:1634 ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1648 ../src/guestfs-actions.pod:1652 ../src/guestfs-actions.pod:1790 ../src/guestfs-actions.pod:1794 ../src/guestfs-actions.pod:1799 ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:1865 ../src/guestfs-actions.pod:1869 ../src/guestfs-actions.pod:1874 ../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:1077 ../fish/guestfish-actions.pod:1081 ../fish/guestfish-actions.pod:1085 ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1097 ../fish/guestfish-actions.pod:1101 ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1115 ../fish/guestfish-actions.pod:1119 ../fish/guestfish-actions.pod:1123 ../fish/guestfish-actions.pod:1213 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1227 ../fish/guestfish-actions.pod:1269 ../fish/guestfish-actions.pod:1273 ../fish/guestfish-actions.pod:1278 ../tools/virt-edit.pl:351 ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361 ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 msgid "*" msgstr "" -# type: textblock -#: ../src/guestfs.pod:385 +#. 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:390 +#. 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:395 +#. type: textblock +#: ../src/guestfs.pod:400 msgid "The command will be running in limited memory." msgstr "" -# type: textblock -#: ../src/guestfs.pod:399 +#. 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:404 +#. type: textblock +#: ../src/guestfs.pod:409 msgid "Only supports Linux guests (not Windows, BSD, etc)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:408 +#. 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:413 +#. 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:418 +#. 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 " @@ -862,8 +866,8 @@ msgid "" "context of your program to their advantage." msgstr "" -# type: textblock -#: ../src/guestfs.pod:427 +#. 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 " @@ -872,27 +876,27 @@ msgid "" "see L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:435 +#. 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:438 +#. 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:441 +#. type: =head2 +#: ../src/guestfs.pod:446 msgid "CONFIGURATION FILES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:443 +#. 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 " @@ -900,118 +904,118 @@ msgid "" "file, and so avoids you having to write that code." msgstr "" -# type: textblock -#: ../src/guestfs.pod:448 +#. 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:452 +#. 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:456 +#. type: =head2 +#: ../src/guestfs.pod:461 msgid "SELINUX" msgstr "" -# type: textblock -#: ../src/guestfs.pod:458 +#. 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:464 ../src/guestfs.pod:1199 ../src/guestfs.pod:1330 +#. 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:466 +#. type: textblock +#: ../src/guestfs.pod:471 msgid "Before launching, do:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:468 +#. type: verbatim +#: ../src/guestfs.pod:473 #, no-wrap msgid "" " guestfs_set_selinux (g, 1);\n" "\n" msgstr "" -# type: =item -#: ../src/guestfs.pod:470 ../src/guestfs.pod:1203 ../src/guestfs.pod:1334 +#. 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:472 +#. 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:476 +#. type: verbatim +#: ../src/guestfs.pod:481 #, no-wrap msgid "" " guestfs_sh (g, \"/usr/sbin/load_policy\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:478 +#. 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:481 ../src/guestfs.pod:1340 +#. type: =item +#: ../src/guestfs.pod:486 ../src/guestfs.pod:1405 msgid "3." msgstr "" -# type: textblock -#: ../src/guestfs.pod:483 +#. 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:487 +#. 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:491 +#. type: textblock +#: ../src/guestfs.pod:496 msgid "This will work for running commands and editing existing files." msgstr "" -# type: textblock -#: ../src/guestfs.pod:493 +#. 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:497 +#. type: =head2 +#: ../src/guestfs.pod:502 msgid "UMASK" msgstr "" -# type: textblock -#: ../src/guestfs.pod:499 +#. 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 " @@ -1020,33 +1024,33 @@ msgid "" "that you supply." msgstr "" -# type: textblock -#: ../src/guestfs.pod:505 +#. 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:508 +#. 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:512 +#. type: textblock +#: ../src/guestfs.pod:517 msgid "For more information about umask, see L." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:514 ../fish/guestfish.pod:720 +#. type: =head1 +#: ../src/guestfs.pod:519 ../fish/guestfish.pod:767 msgid "ENCRYPTED DISKS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:516 +#. 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) " @@ -1054,22 +1058,22 @@ msgid "" "modern Linux guests." msgstr "" -# type: textblock -#: ../src/guestfs.pod:522 +#. 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:525 +#. 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:528 +#. 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 " @@ -1077,16 +1081,16 @@ msgid "" "decrypted from and encrypted to the underlying block device respectively." msgstr "" -# type: textblock -#: ../src/guestfs.pod:534 +#. 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:538 +#. 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:553 +#. 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:556 +#. 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 " @@ -1130,8 +1134,8 @@ msgid "" "libguestfs to deal with it.)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:565 +#. 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 " @@ -1139,8 +1143,8 @@ msgid "" "Windows and Linux-based operating systems respectively." msgstr "" -# type: textblock -#: ../src/guestfs.pod:571 +#. 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 " @@ -1150,8 +1154,8 @@ msgid "" "hash table like this example:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:578 +#. type: verbatim +#: ../src/guestfs.pod:584 #, no-wrap msgid "" " /boot => /dev/sda1\n" @@ -1160,39 +1164,39 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:582 +#. 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:585 +#. 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:589 +#. 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:593 +#. 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:597 +#. 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 " @@ -1204,25 +1208,62 @@ msgid "" "for details)." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:606 +#. 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:608 +#. type: textblock +#: ../src/guestfs.pod:633 msgid "" "Libguestfs can mount NTFS partitions. It does this using the " "L driver." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:611 +#. type: =head3 +#: ../src/guestfs.pod:636 msgid "DRIVE LETTERS AND PATHS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:613 +#. 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 " @@ -1231,36 +1272,35 @@ msgid "" "that directory might be referred to as C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:619 +#. 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:624 +#. 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:627 +#. 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: =head3 -#: ../src/guestfs.pod:630 +#. type: =head3 +#: ../src/guestfs.pod:654 msgid "ACCESSING THE WINDOWS REGISTRY" msgstr "" -# type: textblock -#: ../src/guestfs.pod:632 +#. 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 " @@ -1270,26 +1310,26 @@ msgid "" "L for more help on this issue." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:640 +#. type: =head3 +#: ../src/guestfs.pod:664 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:642 +#. 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:646 +#. type: textblock +#: ../src/guestfs.pod:670 msgid "L" msgstr "" -# type: textblock -#: ../src/guestfs.pod:648 +#. 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 " @@ -1298,8 +1338,8 @@ msgid "" "ntfs-3g does (ie. don't use L on NTFS volumes)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:655 +#. 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 " @@ -1307,190 +1347,191 @@ msgid "" "documented in various places around the web)." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:660 +#. type: =head3 +#: ../src/guestfs.pod:684 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:662 +#. 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:665 +#. type: textblock +#: ../src/guestfs.pod:689 msgid "L" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:667 +#. type: =head2 +#: ../src/guestfs.pod:691 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:669 +#. 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:672 +#. 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:678 +#. 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:681 +#. 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:687 +#. type: =item +#: ../src/guestfs.pod:711 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:689 +#. 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:693 +#. type: =item +#: ../src/guestfs.pod:717 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:695 +#. 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:698 +#. type: =item +#: ../src/guestfs.pod:722 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:700 +#. 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:704 +#. type: =item +#: ../src/guestfs.pod:728 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:706 +#. 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:709 +#. type: =item +#: ../src/guestfs.pod:733 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:711 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:735 +msgid "See L." msgstr "" -# type: =item -#: ../src/guestfs.pod:713 +#. type: =item +#: ../src/guestfs.pod:737 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:715 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:739 +msgid "See L and L." msgstr "" -# type: =item -#: ../src/guestfs.pod:717 +#. type: =item +#: ../src/guestfs.pod:741 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:719 +#. 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:722 +#. type: textblock +#: ../src/guestfs.pod:746 msgid "The PHP binding only works correctly on 64 bit machines." msgstr "" -# type: =item -#: ../src/guestfs.pod:724 +#. type: =item +#: ../src/guestfs.pod:748 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:726 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:750 +msgid "See L." msgstr "" -# type: =item -#: ../src/guestfs.pod:728 +#. type: =item +#: ../src/guestfs.pod:752 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:730 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:754 +msgid "See L." msgstr "" -# type: =item -#: ../src/guestfs.pod:732 +#. type: =item +#: ../src/guestfs.pod:756 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:734 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:758 +msgid "See L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:738 +#. type: =head2 +#: ../src/guestfs.pod:762 msgid "LIBGUESTFS GOTCHAS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:740 +#. 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:744 +#. 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 " @@ -1498,110 +1539,110 @@ msgid "" "release, you can expect these to change. Beware of them." msgstr "" -# type: =item -#: ../src/guestfs.pod:752 +#. type: =item +#: ../src/guestfs.pod:776 msgid "Autosync / forgetting to sync." msgstr "" -# type: textblock -#: ../src/guestfs.pod:754 +#. 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:758 +#. type: verbatim +#: ../src/guestfs.pod:785 #, no-wrap msgid "" " guestfs_set_autosync (g, 1);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:760 +#. 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:764 +#. 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:768 +#. 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:772 -msgid "" -"Update: Autosync is enabled by default for all API users starting from " -"libguestfs 1.5.24." -msgstr "" - -# type: =item -#: ../src/guestfs.pod:775 +#. type: =item +#: ../src/guestfs.pod:799 msgid "Mount option C<-o sync> should not be the default." msgstr "" -# type: textblock -#: ../src/guestfs.pod:777 +#. 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:781 +#. 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:784 +#. type: =item +#: ../src/guestfs.pod:808 msgid "Read-only should be the default." msgstr "" -# type: textblock -#: ../src/guestfs.pod:786 +#. 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:789 +#. type: textblock +#: ../src/guestfs.pod:813 msgid "This would reduce the potential to corrupt live VM images." msgstr "" -# type: textblock -#: ../src/guestfs.pod:791 +#. 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:795 +#. type: =item +#: ../src/guestfs.pod:819 msgid "guestfish command line is hard to use." msgstr "" -# type: textblock -#: ../src/guestfs.pod:797 +#. 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 " @@ -1610,13 +1651,13 @@ msgid "" "we should have used C to run commands." msgstr "" -# type: =item -#: ../src/guestfs.pod:804 +#. type: =item +#: ../src/guestfs.pod:828 msgid "guestfish megabyte modifiers don't work right on all commands" msgstr "" -# type: textblock -#: ../src/guestfs.pod:806 +#. 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 " @@ -1625,21 +1666,21 @@ msgid "" "expecting some other unit (eg. megabytes)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:813 +#. type: textblock +#: ../src/guestfs.pod:837 msgid "The most common is L. The guestfish command:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:815 +#. type: verbatim +#: ../src/guestfs.pod:839 #, no-wrap msgid "" " lvcreate LV VG 100M\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:817 +#. 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 " @@ -1647,28 +1688,28 @@ msgid "" "is also a little obscure." msgstr "" -# type: textblock -#: ../src/guestfs.pod:822 +#. 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:825 +#. type: =item +#: ../src/guestfs.pod:849 msgid "Ambiguity between devices and paths" msgstr "" -# type: textblock -#: ../src/guestfs.pod:827 +#. 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:832 +#. 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. " @@ -1676,8 +1717,8 @@ msgid "" "detecting if the path supplied begins with C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:838 +#. 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 " @@ -1686,21 +1727,21 @@ msgid "" "to this OCaml type:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:844 +#. 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:846 +#. type: textblock +#: ../src/guestfs.pod:870 msgid "which would allow you to pass arguments like:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:848 +#. type: verbatim +#: ../src/guestfs.pod:872 #, no-wrap msgid "" " Path \"/foo/bar\"\n" @@ -1710,67 +1751,27 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:853 +#. 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:858 -msgid "PROTOCOL LIMITS" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:860 -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:868 -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:874 -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:878 -msgid "" -"You might also consider mounting the disk image using our FUSE filesystem " -"support (L)." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:881 +#. type: =head2 +#: ../src/guestfs.pod:882 msgid "KEYS AND PASSPHRASES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:883 +#. 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:886 +#. 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 " @@ -1778,62 +1779,62 @@ msgid "" "of such an implementation." msgstr "" -# type: textblock -#: ../src/guestfs.pod:891 +#. 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: =head2 -#: ../src/guestfs.pod:896 +#. type: =head2 +#: ../src/guestfs.pod:897 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:898 +#. 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:901 +#. type: textblock +#: ../src/guestfs.pod:902 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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:905 +#. type: textblock +#: ../src/guestfs.pod:906 msgid "" "See the graphical program guestfs-browser for one possible architecture for " "multithreaded programs using libvirt and libguestfs." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:908 +#. type: =head2 +#: ../src/guestfs.pod:909 msgid "PATH" msgstr "" -# type: textblock -#: ../src/guestfs.pod:910 +#. type: textblock +#: ../src/guestfs.pod:911 msgid "" -"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " +"Libguestfs needs a supermin appliance, which it finds by looking along an " "internal path." msgstr "" -# type: textblock -#: ../src/guestfs.pod:913 +#. type: textblock +#: ../src/guestfs.pod:914 msgid "" "By default it looks for these in the directory C<$libdir/guestfs> " "(eg. C or C)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:916 +#. type: textblock +#: ../src/guestfs.pod:917 msgid "" "Use L or set the environment variable L " "to change the directories that libguestfs will search in. The value is a " @@ -1843,21 +1844,21 @@ msgid "" "then C." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:923 +#. type: =head2 +#: ../src/guestfs.pod:924 msgid "QEMU WRAPPERS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:925 +#. type: textblock +#: ../src/guestfs.pod:926 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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:929 +#. type: textblock +#: ../src/guestfs.pod:930 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 " @@ -1865,15 +1866,15 @@ msgid "" "this, then the qemu process won't be cleaned up correctly." msgstr "" -# type: textblock -#: ../src/guestfs.pod:934 +#. 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: verbatim -#: ../src/guestfs.pod:937 +#. type: verbatim +#: ../src/guestfs.pod:938 #, no-wrap msgid "" " #!/bin/sh -\n" @@ -1883,36 +1884,146 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:941 +#. type: textblock +#: ../src/guestfs.pod:942 msgid "" "Save this script as C (or wherever), C, and " "then use it by setting the LIBGUESTFS_QEMU environment variable. For " "example:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:945 +#. type: verbatim +#: ../src/guestfs.pod:946 #, no-wrap msgid "" " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:947 +#. type: textblock +#: ../src/guestfs.pod:948 msgid "" "Note that libguestfs also calls qemu with the -help and -version options in " "order to determine features." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:950 +#. type: =head2 +#: ../src/guestfs.pod:951 +msgid "ATTACHING TO RUNNING DAEMONS" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:953 +msgid "" +"I This is B and has a tendency to eat " +"babies. Use with caution." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:956 +msgid "" +"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: =head3 +#: ../src/guestfs.pod:960 +msgid "Using guestfs_set_attach_method" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:962 +msgid "" +"By calling L you can change how the library " +"connects to the C daemon in L (read " +"L for some background)." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:966 +msgid "" +"The normal attach method is C, where a small appliance is created " +"containing the daemon, and then the library connects to this." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:969 +msgid "" +"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:973 +msgid "" +"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: =head3 +#: ../src/guestfs.pod:977 +msgid "Using guestfs_add_domain with live flag" +msgstr "" + +#. 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:985 +#, no-wrap +msgid "" +" \n" +" ...\n" +" \n" +" ...\n" +" \n" +" \n" +" \n" +" \n" +" ...\n" +" \n" +" \n" +"\n" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:997 +msgid "" +"L extracts C and sets the attach " +"method to C." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1000 +msgid "" +"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: 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: =head2 +#: ../src/guestfs.pod:1008 msgid "ABI GUARANTEE" msgstr "" -# type: textblock -#: ../src/guestfs.pod:952 +#. 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 " @@ -1921,13 +2032,13 @@ msgid "" "against the libguestfs API." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:958 +#. type: =head2 +#: ../src/guestfs.pod:1016 msgid "BLOCK DEVICE NAMING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:960 +#. 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 " @@ -1941,24 +2052,24 @@ msgid "" "Xen PV disks." msgstr "" -# type: textblock -#: ../src/guestfs.pod:972 +#. 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:976 +#. type: textblock +#: ../src/guestfs.pod:1034 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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:981 +#. type: textblock +#: ../src/guestfs.pod:1039 msgid "" "Therefore libguestfs defines C as the I. " "Internally C names are translated, if necessary, to other names as " @@ -1966,21 +2077,21 @@ msgid "" "device parameter C is translated to C transparently." msgstr "" -# type: textblock -#: ../src/guestfs.pod:987 +#. type: textblock +#: ../src/guestfs.pod:1045 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." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:992 +#. type: =head3 +#: ../src/guestfs.pod:1050 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" msgstr "" -# type: textblock -#: ../src/guestfs.pod:994 +#. type: textblock +#: ../src/guestfs.pod:1052 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 " @@ -1989,114 +2100,114 @@ msgid "" "devices." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1000 +#. type: textblock +#: ../src/guestfs.pod:1058 msgid "" "The algorithm is applied only to I which are known to be either " "device or partition names. Return values from functions such as " "L are never changed." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1008 +#. 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:1012 +#. type: textblock +#: ../src/guestfs.pod:1070 msgid "Does the string begin with C?" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1016 +#. type: textblock +#: ../src/guestfs.pod:1074 msgid "" "Does the named device exist? If so, we use that device. However if I " "then we continue with this algorithm." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1021 +#. type: textblock +#: ../src/guestfs.pod:1079 msgid "Replace initial C string with C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1023 +#. type: textblock +#: ../src/guestfs.pod:1081 msgid "For example, change C to C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1025 +#. type: textblock +#: ../src/guestfs.pod:1083 msgid "If that named device exists, use it. If not, continue." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1029 +#. type: textblock +#: ../src/guestfs.pod:1087 msgid "Replace initial C string with C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1031 +#. type: textblock +#: ../src/guestfs.pod:1089 msgid "If that named device exists, use it. If not, return an error." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1035 +#. type: =head3 +#: ../src/guestfs.pod:1093 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1037 +#. type: textblock +#: ../src/guestfs.pod:1095 msgid "" "Although the standard naming scheme and automatic translation is useful for " "simple programs and guestfish scripts, for larger programs it is best not to " "rely on this mechanism." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1041 +#. type: textblock +#: ../src/guestfs.pod:1099 msgid "" "Where possible for maximum future portability programs using libguestfs " "should use these future-proof techniques:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1048 +#. 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:1051 +#. type: textblock +#: ../src/guestfs.pod:1109 msgid "Since those device names exist by definition, they will never be translated." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1056 +#. type: textblock +#: ../src/guestfs.pod:1114 msgid "" "Use higher level ways to identify filesystems, such as LVM names, UUIDs and " "filesystem labels." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1061 +#. type: =head1 +#: ../src/guestfs.pod:1119 msgid "SECURITY" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1063 +#. 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: =head2 -#: ../src/guestfs.pod:1066 +#. type: =head2 +#: ../src/guestfs.pod:1124 msgid "GENERAL SECURITY CONSIDERATIONS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1068 +#. type: textblock +#: ../src/guestfs.pod:1126 msgid "" "Be careful with any files or data that you download from a guest (by " "\"download\" we mean not just the L command but any " @@ -2105,43 +2216,43 @@ msgid "" "into doing the wrong thing. Consider cases such as:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1078 +#. type: textblock +#: ../src/guestfs.pod:1136 msgid "the data (file etc) not being present" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1082 +#. type: textblock +#: ../src/guestfs.pod:1140 msgid "being present but empty" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1086 +#. type: textblock +#: ../src/guestfs.pod:1144 msgid "being much larger than normal" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1090 +#. type: textblock +#: ../src/guestfs.pod:1148 msgid "containing arbitrary 8 bit data" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1094 +#. type: textblock +#: ../src/guestfs.pod:1152 msgid "being in an unexpected character encoding" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1098 +#. type: textblock +#: ../src/guestfs.pod:1156 msgid "containing homoglyphs." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1102 +#. type: =head2 +#: ../src/guestfs.pod:1160 msgid "SECURITY OF MOUNTING FILESYSTEMS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1104 +#. 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 " @@ -2156,8 +2267,8 @@ msgid "" "system right down to the hardware level." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1117 +#. 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 " @@ -2170,20 +2281,20 @@ msgid "" "hard to do, although we never say 'never' about security issues." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1128 +#. 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: =head2 -#: ../src/guestfs.pod:1131 +#. type: =head2 +#: ../src/guestfs.pod:1189 msgid "PROTOCOL SECURITY" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1133 +#. 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 " @@ -2192,13 +2303,13 @@ msgid "" "security will save you from the consequences." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1139 +#. type: =head2 +#: ../src/guestfs.pod:1197 msgid "INSPECTION SECURITY" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1141 +#. type: textblock +#: ../src/guestfs.pod:1199 msgid "" "Parts of the inspection API (see L) return untrusted strings " "directly from the guest, and these could contain any 8 bit data. Callers " @@ -2206,8 +2317,8 @@ msgid "" "(for example, use HTML escaping if creating a web page)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1147 +#. 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 " @@ -2217,8 +2328,8 @@ msgid "" "provide the wrong hostname." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1155 +#. type: textblock +#: ../src/guestfs.pod:1213 msgid "" "The inspection API parses guest configuration using two external libraries: " "Augeas (Linux configuration) and hivex (Windows Registry). Both are " @@ -2227,13 +2338,13 @@ msgid "" "files." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1161 +#. type: =head2 +#: ../src/guestfs.pod:1219 msgid "RUNNING UNTRUSTED GUEST COMMANDS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1163 +#. type: textblock +#: ../src/guestfs.pod:1221 msgid "" "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 " @@ -2242,25 +2353,25 @@ msgid "" "section L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1169 +#. type: =head2 +#: ../src/guestfs.pod:1227 msgid "CVE-2010-3851" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1171 +#. type: textblock +#: ../src/guestfs.pod:1229 msgid "https://bugzilla.redhat.com/642934" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1173 +#. type: textblock +#: ../src/guestfs.pod:1231 msgid "" "This security bug concerns the automatic disk format detection that qemu " "does on disk images." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1176 +#. type: textblock +#: ../src/guestfs.pod:1234 msgid "" "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 " @@ -2268,8 +2379,8 @@ msgid "" "image must be raw." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1181 +#. 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 " @@ -2277,8 +2388,8 @@ msgid "" "say, qcow2 based on the header written by the guest." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1186 +#. type: textblock +#: ../src/guestfs.pod:1244 msgid "" "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 " @@ -2289,25 +2400,25 @@ msgid "" "control of the attacker." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1194 +#. 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:1201 +#. 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:1205 +#. type: textblock +#: ../src/guestfs.pod:1263 msgid "" "You are also running untrusted code from the guest (see L)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1210 +#. type: textblock +#: ../src/guestfs.pod:1268 msgid "" "The way to avoid this is to specify the expected disk format when adding " "disks (the optional C option to L). You " @@ -2315,145 +2426,159 @@ msgid "" "other cases too." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1215 +#. type: textblock +#: ../src/guestfs.pod:1273 msgid "" "For disks added from libvirt using calls like L, the " "format is fetched from libvirt and passed through." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1218 +#. type: textblock +#: ../src/guestfs.pod:1276 msgid "" "For libguestfs tools, use the I<--format> command line parameter as " "appropriate." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1221 +#. type: =head1 +#: ../src/guestfs.pod:1279 msgid "CONNECTION MANAGEMENT" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1223 +#. type: =head2 +#: ../src/guestfs.pod:1281 msgid "guestfs_h *" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1225 +#. type: textblock +#: ../src/guestfs.pod:1283 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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1229 +#. type: textblock +#: ../src/guestfs.pod:1287 msgid "" "For information on using multiple handles and threads, see the section " -"L below." +"L above." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1232 +#. type: =head2 +#: ../src/guestfs.pod:1290 msgid "guestfs_create" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1234 +#. type: verbatim +#: ../src/guestfs.pod:1292 #, no-wrap msgid "" " guestfs_h *guestfs_create (void);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1236 +#. type: textblock +#: ../src/guestfs.pod:1294 msgid "Create a connection handle." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1238 +#. type: textblock +#: ../src/guestfs.pod:1296 msgid "" -"You have to call L (or one of the equivalent calls) " -"on the handle at least once." +"On success this returns a non-NULL pointer to a handle. On error it returns " +"NULL." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1241 +#. type: textblock +#: ../src/guestfs.pod:1299 msgid "" -"This function returns a non-NULL pointer to a handle on success or NULL on " -"error." +"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:1244 +#. type: textblock +#: ../src/guestfs.pod:1303 msgid "After configuring the handle, you have to call L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1246 +#. type: textblock +#: ../src/guestfs.pod:1305 msgid "" -"You may also want to configure error handling for the handle. See L section below." +"You may also want to configure error handling for the handle. See the " +"L section below." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1249 +#. type: =head2 +#: ../src/guestfs.pod:1308 msgid "guestfs_close" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1251 +#. type: verbatim +#: ../src/guestfs.pod:1310 #, no-wrap msgid "" " void guestfs_close (guestfs_h *g);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1253 +#. type: textblock +#: ../src/guestfs.pod:1312 msgid "This closes the connection handle and frees up all resources used." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1255 +#. type: textblock +#: ../src/guestfs.pod:1314 +msgid "" +"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:1318 +msgid "If a close callback was set on the handle, then it is called." +msgstr "" + +#. type: =head1 +#: ../src/guestfs.pod:1320 msgid "ERROR HANDLING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1257 +#. type: textblock +#: ../src/guestfs.pod:1322 msgid "" "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:1260 +#. type: textblock +#: ../src/guestfs.pod:1325 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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1264 +#. 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:1269 +#. type: textblock +#: ../src/guestfs.pod:1334 msgid "" "When the handle is created, a default error handler is installed which " "prints the error message string to C. For small short-running " "command line programs it is sufficient to do:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1273 +#. type: verbatim +#: ../src/guestfs.pod:1338 #, no-wrap msgid "" " if (guestfs_launch (g) == -1)\n" @@ -2461,30 +2586,30 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1276 +#. 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:1279 +#. type: textblock +#: ../src/guestfs.pod:1344 msgid "" "For other programs the caller will almost certainly want to install an " "alternate error handler or do error handling in-line like this:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1282 +#. type: verbatim +#: ../src/guestfs.pod:1347 #, no-wrap msgid "" " g = guestfs_create ();\n" " \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1284 +#. type: verbatim +#: ../src/guestfs.pod:1349 #, no-wrap msgid "" " /* This disables the default behaviour of printing errors\n" @@ -2493,8 +2618,8 @@ msgid "" " \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1288 +#. type: verbatim +#: ../src/guestfs.pod:1353 #, no-wrap msgid "" " if (guestfs_launch (g) == -1) {\n" @@ -2507,16 +2632,16 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1296 +#. 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:1300 +#. 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 " @@ -2525,83 +2650,83 @@ msgid "" "returns NULL in this case)." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1306 +#. type: =head2 +#: ../src/guestfs.pod:1371 msgid "guestfs_last_error" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1308 +#. type: verbatim +#: ../src/guestfs.pod:1373 #, no-wrap msgid "" " const char *guestfs_last_error (guestfs_h *g);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1310 +#. type: textblock +#: ../src/guestfs.pod:1375 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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1314 +#. 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: =head2 -#: ../src/guestfs.pod:1317 +#. type: =head2 +#: ../src/guestfs.pod:1382 msgid "guestfs_last_errno" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1319 +#. type: verbatim +#: ../src/guestfs.pod:1384 #, no-wrap msgid "" " int guestfs_last_errno (guestfs_h *g);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1321 +#. type: textblock +#: ../src/guestfs.pod:1386 msgid "This returns the last error number (errno) that happened on C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1323 +#. type: textblock +#: ../src/guestfs.pod:1388 msgid "If successful, an errno integer not equal to zero is returned." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1325 +#. 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:1332 +#. type: textblock +#: ../src/guestfs.pod:1397 msgid "There has not been any error on the handle." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1336 +#. type: textblock +#: ../src/guestfs.pod:1401 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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1342 +#. type: textblock +#: ../src/guestfs.pod:1407 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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1348 +#. 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 " @@ -2611,13 +2736,13 @@ msgid "" "only happen in very rare circumstances." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1356 +#. type: =head2 +#: ../src/guestfs.pod:1421 msgid "guestfs_set_error_handler" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1358 +#. type: verbatim +#: ../src/guestfs.pod:1423 #, no-wrap msgid "" " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" @@ -2629,46 +2754,46 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1365 +#. type: textblock +#: ../src/guestfs.pod:1430 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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1369 +#. type: textblock +#: ../src/guestfs.pod:1434 msgid "" "C is not passed to the callback. To get that the callback must call " "L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1372 +#. type: textblock +#: ../src/guestfs.pod:1437 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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1376 +#. type: textblock +#: ../src/guestfs.pod:1441 msgid "The default handler prints messages on C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1378 +#. type: textblock +#: ../src/guestfs.pod:1443 msgid "If you set C to C then I handler is called." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1380 +#. type: =head2 +#: ../src/guestfs.pod:1445 msgid "guestfs_get_error_handler" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1382 +#. type: verbatim +#: ../src/guestfs.pod:1447 #, no-wrap msgid "" " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" @@ -2676,18 +2801,18 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1385 +#. type: textblock +#: ../src/guestfs.pod:1450 msgid "Returns the current error handler callback." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1387 +#. type: =head2 +#: ../src/guestfs.pod:1452 msgid "guestfs_set_out_of_memory_handler" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1389 +#. type: verbatim +#: ../src/guestfs.pod:1454 #, no-wrap msgid "" " typedef void (*guestfs_abort_cb) (void);\n" @@ -2696,132 +2821,132 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1393 +#. type: textblock +#: ../src/guestfs.pod:1458 msgid "" "The callback C will be called if there is an out of memory situation. " "I." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1396 +#. type: textblock +#: ../src/guestfs.pod:1461 msgid "The default is to call L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1398 +#. 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:1401 +#. type: =head2 +#: ../src/guestfs.pod:1466 msgid "guestfs_get_out_of_memory_handler" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1403 +#. type: verbatim +#: ../src/guestfs.pod:1468 #, no-wrap msgid "" " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1405 +#. type: textblock +#: ../src/guestfs.pod:1470 msgid "This returns the current out of memory handler." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1407 +#. type: =head1 +#: ../src/guestfs.pod:1472 msgid "API CALLS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1409 ../fish/guestfish.pod:958 +#. type: textblock +#: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1010 msgid "@ACTIONS@" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1411 +#. type: =head1 +#: ../src/guestfs.pod:1476 msgid "STRUCTURES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1413 +#. type: textblock +#: ../src/guestfs.pod:1478 msgid "@STRUCTS@" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1415 +#. type: =head1 +#: ../src/guestfs.pod:1480 msgid "AVAILABILITY" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1417 +#. type: =head2 +#: ../src/guestfs.pod:1482 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1419 +#. type: textblock +#: ../src/guestfs.pod:1484 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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1424 +#. type: textblock +#: ../src/guestfs.pod:1489 msgid "@AVAILABILITY@" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1426 +#. type: =head2 +#: ../src/guestfs.pod:1491 msgid "GUESTFISH supported COMMAND" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1428 +#. type: textblock +#: ../src/guestfs.pod:1493 msgid "" "In L there is a handy interactive command C which " "prints out the available groups and whether they are supported by this build " "of libguestfs. Note however that you have to do C first." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1433 +#. type: =head2 +#: ../src/guestfs.pod:1498 msgid "SINGLE CALLS AT COMPILE TIME" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1435 +#. 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: verbatim -#: ../src/guestfs.pod:1438 +#. type: verbatim +#: ../src/guestfs.pod:1503 #, no-wrap msgid "" " #define LIBGUESTFS_HAVE_DD 1\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1440 +#. type: textblock +#: ../src/guestfs.pod:1505 msgid "if L is available." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1442 +#. type: textblock +#: ../src/guestfs.pod:1507 msgid "" "Before version 1.5.8, if you needed to test whether a single libguestfs " "function is available at compile time, we recommended using build tools such " "as autoconf or cmake. For example in autotools you could use:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1447 +#. type: verbatim +#: ../src/guestfs.pod:1512 #, no-wrap msgid "" " AC_CHECK_LIB([guestfs],[guestfs_create])\n" @@ -2829,20 +2954,20 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1450 +#. type: textblock +#: ../src/guestfs.pod:1515 msgid "" "which would result in C being either defined or not defined " "in your program." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1453 +#. type: =head2 +#: ../src/guestfs.pod:1518 msgid "SINGLE CALLS AT RUN TIME" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1455 +#. type: textblock +#: ../src/guestfs.pod:1520 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 " @@ -2851,16 +2976,16 @@ msgid "" "shortcoming of the C dynamic linking system itself." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1462 +#. 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:1466 +#. type: verbatim +#: ../src/guestfs.pod:1531 #, no-wrap msgid "" " #include \n" @@ -2871,8 +2996,8 @@ msgid "" " \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1472 +#. type: verbatim +#: ../src/guestfs.pod:1537 #, no-wrap msgid "" " main ()\n" @@ -2883,8 +3008,8 @@ msgid "" " \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1478 +#. type: verbatim +#: ../src/guestfs.pod:1543 #, no-wrap msgid "" " /* Test if the function guestfs_dd is really available. */\n" @@ -2898,8 +3023,8 @@ msgid "" " \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1487 +#. type: verbatim +#: ../src/guestfs.pod:1552 #, no-wrap msgid "" " if (!has_function)\n" @@ -2917,65 +3042,65 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1500 +#. type: textblock +#: ../src/guestfs.pod:1565 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:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1505 +#. type: verbatim +#: ../src/guestfs.pod:1570 #, no-wrap msgid "" " Requires: libguestfs >= 1.0.80\n" "\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1507 +#. type: =head1 +#: ../src/guestfs.pod:1572 msgid "CALLS WITH OPTIONAL ARGUMENTS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1509 +#. 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: verbatim -#: ../src/guestfs.pod:1514 +#. type: verbatim +#: ../src/guestfs.pod:1579 #, no-wrap msgid "" " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1516 +#. type: textblock +#: ../src/guestfs.pod:1581 msgid "" "Call this with a list of optional arguments, terminated by C<-1>. So to " "call with no optional arguments specified:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1519 +#. type: verbatim +#: ../src/guestfs.pod:1584 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename, -1);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1521 +#. type: textblock +#: ../src/guestfs.pod:1586 msgid "With a single optional argument:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1523 +#. type: verbatim +#: ../src/guestfs.pod:1588 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -2984,13 +3109,13 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1527 +#. type: textblock +#: ../src/guestfs.pod:1592 msgid "With two:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1529 +#. type: verbatim +#: ../src/guestfs.pod:1594 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -3000,28 +3125,28 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1534 +#. type: textblock +#: ../src/guestfs.pod:1599 msgid "" "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " "happen!" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1537 +#. type: =head2 +#: ../src/guestfs.pod:1602 msgid "USING va_list FOR OPTIONAL ARGUMENTS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1539 +#. 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: verbatim -#: ../src/guestfs.pod:1543 +#. type: verbatim +#: ../src/guestfs.pod:1608 #, no-wrap msgid "" " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" @@ -3029,13 +3154,13 @@ msgid "" "\n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1546 +#. type: =head2 +#: ../src/guestfs.pod:1611 msgid "CONSTRUCTING OPTIONAL ARGUMENTS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1548 +#. 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 " @@ -3044,8 +3169,8 @@ msgid "" "are declared:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1554 +#. type: verbatim +#: ../src/guestfs.pod:1619 #, no-wrap msgid "" " struct guestfs_add_drive_opts_argv {\n" @@ -3059,13 +3184,13 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1563 +#. type: textblock +#: ../src/guestfs.pod:1628 msgid "You could call it like this:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1565 +#. type: verbatim +#: ../src/guestfs.pod:1630 #, no-wrap msgid "" " struct guestfs_add_drive_opts_argv optargs = {\n" @@ -3077,220 +3202,172 @@ msgid "" " \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1572 +#. type: verbatim +#: ../src/guestfs.pod:1637 #, no-wrap msgid "" " guestfs_add_drive_opts_argv (g, filename, &optargs);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1574 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255 ../tools/virt-win-reg.pl:532 +#. type: textblock +#: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1265 ../tools/virt-win-reg.pl:532 msgid "Notes:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1580 +#. 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:1585 +#. 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:1589 +#. type: textblock +#: ../src/guestfs.pod:1654 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:1594 +#. type: =head2 +#: ../src/guestfs.pod:1659 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1596 +#. type: textblock +#: ../src/guestfs.pod:1661 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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1600 +#. type: textblock +#: ../src/guestfs.pod:1665 msgid "For guestfish, see L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1602 +#. type: =head2 +#: ../src/guestfs.pod:1667 msgid "SETTING CALLBACKS TO HANDLE EVENTS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1604 +#. type: textblock +#: ../src/guestfs.pod:1669 msgid "" -"The child process generates events in some situations. Current events " -"include: receiving a log message, the child process exits." +"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:1607 +#. type: textblock +#: ../src/guestfs.pod:1678 msgid "" -"Use the C functions to set a callback for different " -"types of events." +"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:1610 +#. type: textblock +#: ../src/guestfs.pod:1686 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." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1615 -msgid "guestfs_set_log_message_callback" +"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: verbatim -#: ../src/guestfs.pod:1617 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1691 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" -"\n" +"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:1623 -msgid "" -"The callback function C will be called whenever qemu or the guest writes " -"anything to the console." +#. type: =head3 +#: ../src/guestfs.pod:1695 +msgid "CLASSES OF EVENTS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1626 -msgid "Use this function to capture kernel messages and similar." +#. type: =item +#: ../src/guestfs.pod:1699 +msgid "GUESTFS_EVENT_CLOSE (payload type: void)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1628 +#. type: textblock +#: ../src/guestfs.pod:1702 msgid "" -"Normally there is no log message handler, and log messages are just " -"discarded." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1631 -msgid "guestfs_set_subprocess_quit_callback" +"The callback function will be called while the handle is being closed " +"(synchronously from L)." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1633 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1705 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" -"\n" +"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:1638 +#. type: textblock +#: ../src/guestfs.pod:1712 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)." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1643 -msgid "guestfs_set_launch_done_callback" +"If no callback is registered: the handle is closed without any callback " +"being invoked." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1645 -#, 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: =item +#: ../src/guestfs.pod:1715 +msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1650 +#. type: textblock +#: ../src/guestfs.pod:1718 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)." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1654 -msgid "guestfs_set_close_callback" +"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: verbatim -#: ../src/guestfs.pod:1656 -#, 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: 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:1661 -msgid "" -"The callback function C will be called while the handle is being closed " -"(synchronously from L)." +#. type: =item +#: ../src/guestfs.pod:1724 +msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1664 +#. type: textblock +#: ../src/guestfs.pod:1727 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)." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1672 -msgid "guestfs_set_progress_callback" +"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 "" -" 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: =item +#: ../src/guestfs.pod:1733 +msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1681 +#. type: textblock +#: ../src/guestfs.pod:1736 msgid "" "Some long-running operations can generate progress messages. If this " "callback is registered, then it will be called each time a progress message " @@ -3299,24731 +3376,26092 @@ msgid "" "change in future versions)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1687 +#. 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:1745 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." +"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: textblock -#: ../src/guestfs.pod:1693 +#. type: textblock +#: ../src/guestfs.pod:1750 msgid "The only defined and stable parts of the API are:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1699 +#. type: textblock +#: ../src/guestfs.pod:1756 msgid "" "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:1704 +#. type: textblock +#: ../src/guestfs.pod:1761 msgid "0 E= C E= C" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1708 +#. type: textblock +#: ../src/guestfs.pod:1765 msgid "" "If any progress notification is sent during a call, then a final progress " -"notification is always sent when C = C." +"notification is always sent when C = C (I the call " +"fails with an error)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1711 +#. type: textblock +#: ../src/guestfs.pod:1769 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." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1717 +#. type: textblock +#: ../src/guestfs.pod:1775 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." +"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: =head1 -#: ../src/guestfs.pod:1722 -msgid "PRIVATE DATA AREA" +#. type: textblock +#: ../src/guestfs.pod:1780 +msgid "" +"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:1724 +#. type: textblock +#: ../src/guestfs.pod:1784 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." +"As noted above, if the call fails with an error then the final message may " +"not be generated." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1728 -msgid "To attach a named piece of data, use the following call:" +#. type: textblock +#: ../src/guestfs.pod:1789 +msgid "" +"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: verbatim -#: ../src/guestfs.pod:1730 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1795 +msgid "If no callback is registered: progress messages are discarded." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:1797 +msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1800 msgid "" -" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\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: textblock -#: ../src/guestfs.pod:1732 +#. type: textblock +#: ../src/guestfs.pod:1803 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." +"If the verbose flag (L) is set before launch " +"(L) then additional debug messages are generated." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1736 +#. type: textblock +#: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820 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." +"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: textblock -#: ../src/guestfs.pod:1741 -msgid "To retrieve the pointer, use:" +#. type: =item +#: ../src/guestfs.pod:1811 +msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1743 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1814 msgid "" -" void *guestfs_get_private (guestfs_h *g, const char *key);\n" -"\n" +"The callback function is called whenever a log message is generated by the " +"library part of libguestfs." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1745 +#. type: textblock +#: ../src/guestfs.pod:1817 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." +"If the verbose flag (L) is set then additional debug " +"messages are generated." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:1825 +msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1749 +#. type: textblock +#: ../src/guestfs.pod:1828 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)." +"The callback function is called whenever a trace message is generated. This " +"only applies if the trace flag (L) is set." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1757 +#. type: textblock +#: ../src/guestfs.pod:1831 msgid "" -"The private data area is implemented using a hash table, and should be " -"reasonably efficient for moderate numbers of keys." +"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: =end -#: ../src/guestfs.pod:1760 ../src/guestfs.pod:1765 -msgid "html" +#. type: =head3 +#: ../src/guestfs.pod:1837 +msgid "guestfs_set_event_callback" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1762 +#. type: verbatim +#: ../src/guestfs.pod:1839 +#, no-wrap msgid "" -" " +" 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: =head1 -#: ../src/guestfs.pod:1767 -msgid "ARCHITECTURE" +#. type: textblock +#: ../src/guestfs.pod:1845 +msgid "" +"This function registers a callback (C) for all event classes in the " +"C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1769 +#. type: textblock +#: ../src/guestfs.pod:1848 msgid "" -"Internally, libguestfs is implemented by running an appliance (a special " -"type of small virtual machine) using L. Qemu runs as a child " -"process of the main program." +"For 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: verbatim -#: ../src/guestfs.pod:1773 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1854 +msgid "C should always be passed as 0." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1856 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" +"C is an opaque pointer which is passed to the callback. You can use " +"it for any purpose." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1793 +#. type: textblock +#: ../src/guestfs.pod:1859 msgid "" -"The library, linked to the main program, creates the child process and hence " -"the appliance in the L function." +"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:1796 +#. type: textblock +#: ../src/guestfs.pod:1862 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." +"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: textblock -#: ../src/guestfs.pod:1805 +#. type: textblock +#: ../src/guestfs.pod:1865 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)." +"Callbacks remain in effect until they are deleted, or until the handle is " +"closed." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1812 -msgid "STATE MACHINE" +#. type: textblock +#: ../src/guestfs.pod:1868 +msgid "" +"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: textblock -#: ../src/guestfs.pod:1814 -msgid "libguestfs uses a state machine to model the child process:" +#. type: =head3 +#: ../src/guestfs.pod:1872 +msgid "guestfs_delete_event_callback" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1816 +#. type: verbatim +#: ../src/guestfs.pod:1874 #, 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" +" void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1838 +#. type: textblock +#: ../src/guestfs.pod:1876 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." +"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:1843 +#. type: =head3 +#: ../src/guestfs.pod:1880 +msgid "guestfs_event_callback" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:1882 +#, no-wrap 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." +" 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:1847 +#. 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:1894 msgid "" -"Configuration commands for qemu such as L can only be " -"issued when in the CONFIG state." +"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:1850 +#. type: textblock +#: ../src/guestfs.pod:1898 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." +"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:1856 +#. type: textblock +#: ../src/guestfs.pod:1903 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." +"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:1862 +#. type: textblock +#: ../src/guestfs.pod:1907 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." +"C and C is an array of 64 bit unsigned integers. At the " +"moment this is only used for progress messages." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1866 -msgid "INTERNALS" +#. type: =head3 +#: ../src/guestfs.pod:1910 +msgid "EXAMPLE: CAPTURING LOG MESSAGES" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1868 -msgid "COMMUNICATION PROTOCOL" +#. type: textblock +#: ../src/guestfs.pod:1912 +msgid "" +"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:1870 +#. type: textblock +#: ../src/guestfs.pod:1916 msgid "" -"Don't rely on using this protocol directly. This section documents how it " -"currently works, but it may change at any 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: textblock -#: ../src/guestfs.pod:1873 +#. type: textblock +#: ../src/guestfs.pod:1921 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)." +"Programs have to set up a callback to capture the classes of events of " +"interest:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1877 +#. type: verbatim +#: ../src/guestfs.pod:1924 +#, no-wrap msgid "" -"The detailed format of structures is in C (note: " -"this file is automatically generated)." +" 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:1880 +#. type: textblock +#: ../src/guestfs.pod:1934 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." +"The callback can then direct messages to the appropriate place. In this " +"example, messages are directed to syslog:" msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1887 -msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" +#. 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:1889 -msgid "For ordinary functions, the request message is:" +#. type: =head1 +#: ../src/guestfs.pod:1952 +msgid "PRIVATE DATA AREA" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1891 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1954 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" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1896 -msgid "" -"The total length field allows the daemon to allocate a fixed size buffer " -"into which it slurps the rest of the message. As a result, the total length " -"is limited to C bytes (currently 4MB), which means the " -"effective size of any request is limited to somewhere under this size." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1902 -msgid "" -"Note also that many functions don't take any arguments, in which case the " -"C_args> is completely omitted." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1905 -msgid "" -"The header contains the procedure number (C) which is how the " -"receiver knows what type of args structure to expect, or none at all." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1909 -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." +"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:1917 -msgid "The reply message for ordinary functions is:" +#. type: textblock +#: ../src/guestfs.pod:1959 +msgid "To attach a named piece of data, use the following call:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1919 +#. type: verbatim +#: ../src/guestfs.pod:1961 #, no-wrap msgid "" -" total length (header + ret,\n" -" but not including the length word itself)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs__ret (encoded as XDR)\n" +" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1924 +#. type: textblock +#: ../src/guestfs.pod:1963 msgid "" -"As above the C_ret> structure may be completely omitted for " -"functions that return no formal return values." +"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:1927 -msgid "As above the total length of the reply is limited to C." +#. type: textblock +#: ../src/guestfs.pod:1967 +msgid "" +"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: textblock -#: ../src/guestfs.pod:1930 -msgid "" -"In the case of an error, a flag is set in the header, and the reply message " -"is slightly changed:" +#. type: textblock +#: ../src/guestfs.pod:1973 +msgid "To retrieve the pointer, use:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1933 +#. type: verbatim +#: ../src/guestfs.pod:1975 #, 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" +" void *guestfs_get_private (guestfs_h *g, const char *key);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1938 +#. type: textblock +#: ../src/guestfs.pod:1977 msgid "" -"The C structure contains the error message as a " -"string." +"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: =head3 -#: ../src/guestfs.pod:1941 -msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" +#. type: textblock +#: ../src/guestfs.pod:1981 +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)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1943 -msgid "" -"A C parameter indicates that we transfer a file I the guest. " -"The normal request message is sent (see above). However this is followed by " -"a sequence of file chunks." +#. type: textblock +#: ../src/guestfs.pod:1988 +msgid "To walk over all entries, use these two functions:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1947 +#. type: verbatim +#: ../src/guestfs.pod:1990 #, no-wrap msgid "" -" total length (header + arguments,\n" -" but not including the length word itself,\n" -" and not including the chunks)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs__args (encoded as XDR)\n" -" sequence of chunks for FileIn param #0\n" -" sequence of chunks for FileIn param #1 etc.\n" +" void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1955 -msgid "The \"sequence of chunks\" is:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:1957 +#. type: verbatim +#: ../src/guestfs.pod:1992 #, no-wrap msgid "" -" length of chunk (not including length word itself)\n" -" struct guestfs_chunk (encoded as XDR)\n" -" length of chunk\n" -" struct guestfs_chunk (encoded as XDR)\n" -" ...\n" -" length of chunk\n" -" struct guestfs_chunk (with data.data_len == 0)\n" +" void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1965 +#. type: textblock +#: ../src/guestfs.pod:1994 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." +"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:1969 +#. type: textblock +#: ../src/guestfs.pod:2000 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)." +"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:1974 -msgid "" -"Both the library (sender) I the daemon (receiver) may cancel the " -"transfer. The library does this by sending a chunk with a special flag set " -"to indicate cancellation. When the daemon sees this, it cancels the whole " -"RPC, does I send any reply, and goes back to reading the next request." +#. type: textblock +#: ../src/guestfs.pod:2004 +msgid "Notes about walking over entries:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1980 -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." +#. type: textblock +#: ../src/guestfs.pod:2010 +msgid "You must not call C while walking over the entries." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1989 +#. type: textblock +#: ../src/guestfs.pod:2015 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 handle maintains an internal iterator which is reset when you call " +"C. This internal iterator is invalidated when you " +"call C." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1995 -msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1997 -msgid "" -"The protocol for FileOut parameters is exactly the same as for FileIn " -"parameters, but with the roles of daemon and library reversed." +#. type: textblock +#: ../src/guestfs.pod:2021 +msgid "If you have set the data pointer associated with a key to C, ie:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:2000 +#. type: verbatim +#: ../src/guestfs.pod:2023 #, no-wrap msgid "" -" total length (header + ret,\n" -" but not including the length word itself,\n" -" and not including the chunks)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs__ret (encoded as XDR)\n" -" sequence of chunks for FileOut param #0\n" -" sequence of chunks for FileOut param #1 etc.\n" +" guestfs_set_private (g, key, NULL);\n" "\n" msgstr "" -# type: =head3 -#: ../src/guestfs.pod:2008 -msgid "INITIAL MESSAGE" +#. type: textblock +#: ../src/guestfs.pod:2025 +msgid "then that C is not returned when walking." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2010 +#. type: textblock +#: ../src/guestfs.pod:2029 msgid "" -"When the daemon launches it sends an initial word (C) " -"which indicates that the guest and daemon is alive. This is what " -"L waits for." -msgstr "" - -# type: =head3 -#: ../src/guestfs.pod:2014 -msgid "PROGRESS NOTIFICATION MESSAGES" +"C<*key_rtn> is only valid until the next call to C, " +"C or C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2016 +#. type: textblock +#: ../src/guestfs.pod:2035 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 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:2020 +#. type: verbatim +#: ../src/guestfs.pod:2038 +#, no-wrap msgid "" -"The library turns them into progress callbacks (see " -"C) if there is a callback registered, or " -"discards them if not." +" 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: textblock -#: ../src/guestfs.pod:2024 +#. type: textblock +#: ../src/guestfs.pod:2046 msgid "" -"The daemon self-limits the frequency of progress messages it sends (see " -"C). Not all calls generate progress " -"messages." +"More commonly you are only interested in keys that begin with an " +"application-specific prefix C. Modify the loop like so:" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:2028 -msgid "LIBGUESTFS VERSION NUMBERS" +#. 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:2030 +#. type: textblock +#: ../src/guestfs.pod:2058 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:" +"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: verbatim -#: ../src/guestfs.pod:2035 +#. type: verbatim +#: ../src/guestfs.pod:2062 #, 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" +" 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:2046 -msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:2048 +#. type: textblock +#: ../src/guestfs.pod:2078 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." +"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: textblock -#: ../src/guestfs.pod:2054 -msgid "Our criteria for backporting changes are:" +#. type: =end +#: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088 +msgid "html" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2060 +#. type: textblock +#: ../src/guestfs.pod:2085 msgid "" -"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.pod:2066 -msgid "" -"Bug fixes which are not controversial, fix obvious problems, and have been " -"well tested are backported." +#. type: =head1 +#: ../src/guestfs.pod:2090 +msgid "ARCHITECTURE" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2071 +#. type: textblock +#: ../src/guestfs.pod:2092 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." +"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.pod:2077 +#. type: verbatim +#: ../src/guestfs.pod:2096 +#, no-wrap msgid "" -"We I backport new features, new APIs, new tools etc, except in one " -"exceptional case: the new feature is required in order to implement an " -"important bug fix." +" ___________________\n" +" / \\\n" +" | main program |\n" +" | |\n" +" | | child process / appliance\n" +" | | __________________________\n" +" | | / qemu \\\n" +" +-------------------+ RPC | +-----------------+ |\n" +" | libguestfs <--------------------> guestfsd | |\n" +" | | | +-----------------+ |\n" +" \\___________________/ | | Linux kernel | |\n" +" | +--^--------------+ |\n" +" \\_________|________________/\n" +" |\n" +" _______v______\n" +" / \\\n" +" | Device or |\n" +" | disk image |\n" +" \\______________/\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2083 +#. type: textblock +#: ../src/guestfs.pod:2116 msgid "" -"A new stable branch starts when we think the new features in development are " -"substantial and compelling enough over the current stable branch to warrant " -"it. When that happens we create new stable and development versions 1.N.0 " -"and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so " -"stable at this point, but by backporting fixes from development, that branch " -"will stabilize over time." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:2091 ../fish/guestfish.pod:965 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 -msgid "ENVIRONMENT VARIABLES" -msgstr "" - -# type: =item -#: ../src/guestfs.pod:2095 ../fish/guestfish.pod:991 -msgid "LIBGUESTFS_APPEND" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:2097 ../fish/guestfish.pod:993 -msgid "Pass additional options to the guest kernel." +"The library, linked to the main program, creates the child process and hence " +"the appliance in the L function." msgstr "" -# type: =item -#: ../src/guestfs.pod:2099 ../fish/guestfish.pod:995 -msgid "LIBGUESTFS_DEBUG" +#. type: textblock +#: ../src/guestfs.pod:2119 +msgid "" +"Inside the appliance is a Linux kernel and a complete stack of userspace " +"tools (such as LVM and ext2 programs) and a small controlling daemon called " +"L. The library talks to L using remote procedure " +"calls (RPC). There is a mostly one-to-one correspondence between libguestfs " +"API calls and RPC calls to the daemon. Lastly the disk image(s) are " +"attached to the qemu process which translates device access by the " +"appliance's Linux kernel into accesses to the image." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2101 +#. type: textblock +#: ../src/guestfs.pod:2128 msgid "" -"Set C to enable verbose messages. This has the same " -"effect as calling C." +"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: =item -#: ../src/guestfs.pod:2104 ../fish/guestfish.pod:1000 -msgid "LIBGUESTFS_MEMSIZE" +#. type: =head1 +#: ../src/guestfs.pod:2135 +msgid "STATE MACHINE" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2106 ../fish/guestfish.pod:1002 -msgid "Set the memory allocated to the qemu process, in megabytes. For example:" +#. type: textblock +#: ../src/guestfs.pod:2137 +msgid "libguestfs uses a state machine to model the child process:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:2109 ../fish/guestfish.pod:1005 +#. type: verbatim +#: ../src/guestfs.pod:2139 #, no-wrap msgid "" -" LIBGUESTFS_MEMSIZE=700\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: =item -#: ../src/guestfs.pod:2111 ../fish/guestfish.pod:1007 -msgid "LIBGUESTFS_PATH" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:2113 +#. type: textblock +#: ../src/guestfs.pod:2161 msgid "" -"Set the path that libguestfs uses to search for kernel and initrd.img. See " -"the discussion of paths in section PATH above." +"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: =item -#: ../src/guestfs.pod:2116 ../fish/guestfish.pod:1012 -msgid "LIBGUESTFS_QEMU" +#. type: textblock +#: ../src/guestfs.pod:2166 +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:2118 ../fish/guestfish.pod:1014 +#. type: textblock +#: ../src/guestfs.pod:2170 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." +"Configuration commands for qemu such as L can only be " +"issued when in the CONFIG state." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2122 -msgid "See also L above." +#. type: textblock +#: ../src/guestfs.pod:2173 +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." msgstr "" -# type: =item -#: ../src/guestfs.pod:2124 ../fish/guestfish.pod:1018 -msgid "LIBGUESTFS_TRACE" +#. type: textblock +#: ../src/guestfs.pod:2179 +msgid "" +"API actions such as L can only be issued when in the READY " +"state. These API calls block waiting for the command to be carried out " +"(ie. the state to transition to BUSY and then back to READY). There are no " +"non-blocking versions, and no way to issue more than one command per handle " +"at the same time." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2126 +#. type: textblock +#: ../src/guestfs.pod:2185 msgid "" -"Set C to enable command traces. This has the same " -"effect as calling C." +"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: =item -#: ../src/guestfs.pod:2129 ../fish/guestfish.pod:1027 -msgid "TMPDIR" +#. type: =head1 +#: ../src/guestfs.pod:2189 +msgid "INTERNALS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2131 ../fish/guestfish.pod:1029 -msgid "Location of temporary directory, defaults to C." +#. type: =head2 +#: ../src/guestfs.pod:2191 +msgid "COMMUNICATION PROTOCOL" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2133 ../fish/guestfish.pod:1031 +#. type: textblock +#: ../src/guestfs.pod:2193 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." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:2141 ../fish/guestfish.pod:1089 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:572 ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:257 -msgid "SEE ALSO" +"Don't rely on using this protocol directly. This section documents how it " +"currently works, but it may change at any time." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2143 +#. type: textblock +#: ../src/guestfs.pod:2196 msgid "" -"L, L, L, " -"L, L, L, L, " -"L, L, L, " -"L, L, " -"L, L, L, " -"L, L, L, L, " -"L, L, L." +"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.pod:2166 +#. type: textblock +#: ../src/guestfs.pod:2200 msgid "" -"Tools with a similar purpose: L, L, L, " -"L, L." +"The detailed format of structures is in C (note: " +"this file is automatically generated)." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:2173 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:548 -msgid "BUGS" +#. type: textblock +#: ../src/guestfs.pod:2203 +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: textblock -#: ../src/guestfs.pod:2175 -msgid "To get a list of bugs against libguestfs use this link:" +#. type: =head3 +#: ../src/guestfs.pod:2210 +msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2177 -msgid "L" +#. type: textblock +#: ../src/guestfs.pod:2212 +msgid "For ordinary functions, the request message is:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2179 -msgid "To report a new bug against libguestfs use this link:" +#. type: verbatim +#: ../src/guestfs.pod:2214 +#, 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" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2181 -msgid "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: textblock -#: ../src/guestfs.pod:2183 -msgid "When reporting a bug, please check:" +#. 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: textblock -#: ../src/guestfs.pod:2189 -msgid "That the bug hasn't been reported already." +#. type: textblock +#: ../src/guestfs.pod:2228 +msgid "" +"The header contains the procedure number (C) which is how the " +"receiver knows what type of args structure to expect, or none at all." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2193 -msgid "That you are testing a recent version." +#. 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: textblock -#: ../src/guestfs.pod:2197 -msgid "Describe the bug accurately, and give a way to reproduce it." +#. type: textblock +#: ../src/guestfs.pod:2240 +msgid "The reply message for ordinary functions is:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2201 +#. type: verbatim +#: ../src/guestfs.pod:2242 +#, no-wrap msgid "" -"Run libguestfs-test-tool and paste the B output into the " -"bug report." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:2206 ../fish/guestfish.pod:1108 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244 -msgid "AUTHORS" +" 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.pod:2208 ../fish/guestfish.pod:1110 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246 -msgid "Richard W.M. Jones (C)" +#. type: textblock +#: ../src/guestfs.pod:2247 +msgid "" +"As above the C_ret> structure may be completely omitted for " +"functions that return no formal return values." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:2210 ../fish/guestfish.pod:1112 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:602 ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:273 -msgid "COPYRIGHT" +#. type: textblock +#: ../src/guestfs.pod:2250 +msgid "As above the total length of the reply is limited to C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2212 ../fish/guestfish.pod:1114 ../fuse/guestmount.pod:250 -msgid "Copyright (C) 2009-2010 Red Hat Inc. L" +#. 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: textblock -#: ../src/guestfs.pod:2215 +#. type: verbatim +#: ../src/guestfs.pod:2256 +#, no-wrap 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." +" 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.pod:2220 +#. type: textblock +#: ../src/guestfs.pod:2261 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." +"The C structure contains the error message as a " +"string." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2225 -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" +#. type: =head3 +#: ../src/guestfs.pod:2264 +msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1 -msgid "guestfs_add_cdrom" +#. 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:3 +#. type: verbatim +#: ../src/guestfs.pod:2270 #, no-wrap msgid "" -" int\n" -" guestfs_add_cdrom (guestfs_h *g,\n" -" const char *filename);\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:7 ../fish/guestfish-actions.pod:5 -msgid "This function adds a virtual CD-ROM disk image to the guest." +#. type: textblock +#: ../src/guestfs.pod:2278 +msgid "The \"sequence of chunks\" is:" 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: verbatim +#: ../src/guestfs.pod:2280 +#, no-wrap +msgid "" +" length of chunk (not including length word itself)\n" +" struct guestfs_chunk (encoded as XDR)\n" +" length of chunk\n" +" struct guestfs_chunk (encoded as XDR)\n" +" ...\n" +" length of chunk\n" +" struct guestfs_chunk (with data.data_len == 0)\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:17 +#. type: textblock +#: ../src/guestfs.pod:2288 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." +"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:24 +#. type: textblock +#: ../src/guestfs.pod:2292 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." +"At time of writing there are no functions that have more than one FileIn " +"parameter. However this is (theoretically) supported, by sending the " +"sequence of chunks for each FileIn parameter one after another (from left to " +"right)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:189 ../src/guestfs-actions.pod:226 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535 ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781 ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:970 ../src/guestfs-actions.pod:990 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1326 ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1466 ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2387 ../src/guestfs-actions.pod:2448 ../src/guestfs-actions.pod:2483 ../src/guestfs-actions.pod:3222 ../src/guestfs-actions.pod:3237 ../src/guestfs-actions.pod:3257 ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:3437 ../src/guestfs-actions.pod:3451 ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3502 ../src/guestfs-actions.pod:3574 ../src/guestfs-actions.pod:3594 ../src/guestfs-actions.pod:3611 ../src/guestfs-actions.pod:3634 ../src/guestfs-actions.pod:3657 ../src/guestfs-actions.pod:3689 ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:3727 ../src/guestfs-actions.pod:3762 ../src/guestfs-actions.pod:3774 ../src/guestfs-actions.pod:3810 ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3839 ../src/guestfs-actions.pod:3854 ../src/guestfs-actions.pod:3871 ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:3984 ../src/guestfs-actions.pod:3997 ../src/guestfs-actions.pod:4048 ../src/guestfs-actions.pod:4066 ../src/guestfs-actions.pod:4084 ../src/guestfs-actions.pod:4100 ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4128 ../src/guestfs-actions.pod:4145 ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:4180 ../src/guestfs-actions.pod:4224 ../src/guestfs-actions.pod:4295 ../src/guestfs-actions.pod:4326 ../src/guestfs-actions.pod:4345 ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4376 ../src/guestfs-actions.pod:4393 ../src/guestfs-actions.pod:4406 ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:4436 ../src/guestfs-actions.pod:4471 ../src/guestfs-actions.pod:4486 ../src/guestfs-actions.pod:4506 ../src/guestfs-actions.pod:4520 ../src/guestfs-actions.pod:4537 ../src/guestfs-actions.pod:4586 ../src/guestfs-actions.pod:4623 ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4665 ../src/guestfs-actions.pod:4682 ../src/guestfs-actions.pod:4700 ../src/guestfs-actions.pod:4834 ../src/guestfs-actions.pod:4891 ../src/guestfs-actions.pod:4913 ../src/guestfs-actions.pod:4931 ../src/guestfs-actions.pod:4963 ../src/guestfs-actions.pod:5029 ../src/guestfs-actions.pod:5046 ../src/guestfs-actions.pod:5059 ../src/guestfs-actions.pod:5073 ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:5395 ../src/guestfs-actions.pod:5407 ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:5433 ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:5463 ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5503 ../src/guestfs-actions.pod:5522 ../src/guestfs-actions.pod:5540 ../src/guestfs-actions.pod:5563 ../src/guestfs-actions.pod:5581 ../src/guestfs-actions.pod:5600 ../src/guestfs-actions.pod:5621 ../src/guestfs-actions.pod:5640 ../src/guestfs-actions.pod:5657 ../src/guestfs-actions.pod:5685 ../src/guestfs-actions.pod:5709 ../src/guestfs-actions.pod:5728 ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5767 ../src/guestfs-actions.pod:5782 ../src/guestfs-actions.pod:5801 ../src/guestfs-actions.pod:5838 ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5887 ../src/guestfs-actions.pod:5995 ../src/guestfs-actions.pod:6116 ../src/guestfs-actions.pod:6128 ../src/guestfs-actions.pod:6141 ../src/guestfs-actions.pod:6154 ../src/guestfs-actions.pod:6176 ../src/guestfs-actions.pod:6189 ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6215 ../src/guestfs-actions.pod:6230 ../src/guestfs-actions.pod:6289 ../src/guestfs-actions.pod:6306 ../src/guestfs-actions.pod:6322 ../src/guestfs-actions.pod:6338 ../src/guestfs-actions.pod:6355 ../src/guestfs-actions.pod:6368 ../src/guestfs-actions.pod:6388 ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6438 ../src/guestfs-actions.pod:6479 ../src/guestfs-actions.pod:6492 ../src/guestfs-actions.pod:6510 ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:6699 ../src/guestfs-actions.pod:6717 ../src/guestfs-actions.pod:6731 ../src/guestfs-actions.pod:6786 ../src/guestfs-actions.pod:6799 ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6877 ../src/guestfs-actions.pod:6931 ../src/guestfs-actions.pod:6957 ../src/guestfs-actions.pod:7023 ../src/guestfs-actions.pod:7042 ../src/guestfs-actions.pod:7071 -msgid "This function returns 0 on success or -1 on error." +#. 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: textblock -#: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:242 ../src/guestfs-actions.pod:263 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167 +#. type: textblock +#: ../src/guestfs.pod:2303 msgid "" -"This function is deprecated. In new code, use the C call " -"instead." +"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:35 ../src/guestfs-actions.pod:245 ../src/guestfs-actions.pod:266 ../src/guestfs-actions.pod:1437 ../src/guestfs-actions.pod:1923 ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:4185 ../src/guestfs-actions.pod:6965 ../src/guestfs-actions.pod:7134 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156 ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951 ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322 ../fish/guestfish-actions.pod:2818 ../fish/guestfish-actions.pod:4620 ../fish/guestfish-actions.pod:4717 +#. type: textblock +#: ../src/guestfs.pod:2312 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." +"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:39 ../src/guestfs-actions.pod:130 ../src/guestfs-actions.pod:1094 ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:2096 ../src/guestfs-actions.pod:3224 ../src/guestfs-actions.pod:3239 ../src/guestfs-actions.pod:4473 ../src/guestfs-actions.pod:5542 ../src/guestfs-actions.pod:5659 ../src/guestfs-actions.pod:5769 ../src/guestfs-actions.pod:6232 ../src/guestfs-actions.pod:6357 ../src/guestfs-actions.pod:6879 -msgid "(Added in 0.3)" +#. type: =head3 +#: ../src/guestfs.pod:2318 +msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:41 -msgid "guestfs_add_domain" +#. 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:43 +#. type: verbatim +#: ../src/guestfs.pod:2323 #, no-wrap msgid "" -" int\n" -" guestfs_add_domain (guestfs_h *g,\n" -" const char *dom,\n" -" ...);\n" -"\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:48 ../src/guestfs-actions.pod:139 ../src/guestfs-actions.pod:4199 -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." +#. type: =head3 +#: ../src/guestfs.pod:2331 +msgid "INITIAL MESSAGE" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:53 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2333 msgid "" -" GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n" -" GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n" -" GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n" -"\n" +"When the daemon launches it sends an initial word (C) " +"which indicates that the guest and daemon is alive. This is what " +"L waits for." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:57 -msgid "" -"This function adds the disk(s) attached to the named libvirt domain C. " -"It works by connecting to libvirt, requesting the domain and domain XML from " -"libvirt, parsing it for disks, and calling C on each " -"one." +#. type: =head3 +#: ../src/guestfs.pod:2337 +msgid "PROGRESS NOTIFICATION MESSAGES" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46 +#. type: textblock +#: ../src/guestfs.pod:2339 msgid "" -"The number of disks added is returned. This operation is atomic: if an " -"error is returned, then no disks are added." +"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:65 ../fish/guestfish-actions.pod:49 +#. type: textblock +#: ../src/guestfs.pod:2343 msgid "" -"This function does some minimal checks to make sure the libvirt domain is " -"not running (unless C is true). In a future version we will try " -"to acquire the libvirt lock on each disk." +"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:69 ../fish/guestfish-actions.pod:53 +#. type: textblock +#: ../src/guestfs.pod:2347 msgid "" -"Disks must be accessible locally. This often means that adding disks from a " -"remote libvirt connection (see L) will fail " -"unless those disks are accessible via the same device path locally too." +"The daemon self-limits the frequency of progress messages it sends (see " +"C). Not all calls generate progress " +"messages." +msgstr "" + +#. type: =head1 +#: ../src/guestfs.pod:2351 +msgid "LIBGUESTFS VERSION NUMBERS" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:74 +#. type: textblock +#: ../src/guestfs.pod:2353 msgid "" -"The optional C parameter sets the libvirt URI (see " -"L). If this is not set then we connect to the " -"default libvirt URI (or one set through an environment variable, see the " -"libvirt documentation for full details). If you are using the C API " -"directly then it is more flexible to create the libvirt connection object " -"yourself, get the domain object, and call C." +"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: textblock -#: ../src/guestfs-actions.pod:82 +#. type: verbatim +#: ../src/guestfs.pod:2358 +#, no-wrap msgid "" -"The other optional parameters are passed directly through to " -"C." +" 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:85 ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:681 ../src/guestfs-actions.pod:712 ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2005 ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2662 ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:4609 ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:5143 ../src/guestfs-actions.pod:5169 ../src/guestfs-actions.pod:6465 ../src/guestfs-actions.pod:6890 ../src/guestfs-actions.pod:6903 ../src/guestfs-actions.pod:6916 -msgid "On error this function returns -1." +#. 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:87 -msgid "(Added in 1.7.4)" +#. type: textblock +#: ../src/guestfs.pod:2371 +msgid "" +"As time passes we cherry pick fixes from the development branch and backport " +"those into the stable branch, the effect being that the stable branch should " +"get more stable and less buggy over time. So the stable releases are ideal " +"for people who don't need new features but would just like the software to " +"work." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:89 -msgid "guestfs_add_domain_va" +#. type: textblock +#: ../src/guestfs.pod:2377 +msgid "Our criteria for backporting changes are:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:91 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2383 msgid "" -" int\n" -" guestfs_add_domain_va (guestfs_h *g,\n" -" const char *dom,\n" -" va_list args);\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:96 -msgid "This is the \"va_list variant\" of L." +#. type: textblock +#: ../src/guestfs.pod:2389 +msgid "" +"Bug fixes which are not controversial, fix obvious problems, and have been " +"well tested are backported." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:98 ../src/guestfs-actions.pod:109 ../src/guestfs-actions.pod:202 ../src/guestfs-actions.pod:213 ../src/guestfs-actions.pod:4236 ../src/guestfs-actions.pod:4248 -msgid "See L." +#. 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: =head2 -#: ../src/guestfs-actions.pod:100 -msgid "guestfs_add_domain_argv" +#. 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: verbatim -#: ../src/guestfs-actions.pod:102 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2406 msgid "" -" int\n" -" guestfs_add_domain_argv (guestfs_h *g,\n" -" const char *dom,\n" -" const struct guestfs_add_domain_argv *optargs);\n" -"\n" +"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: textblock -#: ../src/guestfs-actions.pod:107 -msgid "This is the \"argv variant\" of L." +#. type: =head1 +#: ../src/guestfs.pod:2414 +msgid "EXTENDING LIBGUESTFS" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:111 -msgid "guestfs_add_drive" +#. type: =head2 +#: ../src/guestfs.pod:2416 +msgid "ADDING A NEW API ACTION" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:113 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2418 msgid "" -" int\n" -" guestfs_add_drive (guestfs_h *g,\n" -" const char *filename);\n" -"\n" +"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:117 -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." +#. type: textblock +#: ../src/guestfs.pod:2422 +msgid "To add a new API action there are two changes:" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:121 +#. type: textblock +#: ../src/guestfs.pod:2428 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." +"You need to add a description of the call (name, parameters, return type, " +"tests, documentation) to C." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:132 -msgid "guestfs_add_drive_opts" +#. 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: verbatim -#: ../src/guestfs-actions.pod:134 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2439 msgid "" -" int\n" -" guestfs_add_drive_opts (guestfs_h *g,\n" -" const char *filename,\n" -" ...);\n" -"\n" +"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: verbatim -#: ../src/guestfs-actions.pod:144 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2445 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" +"For library-only actions of the second type, add to the " +"C list. Since these functions are serviced by the " +"library and do not travel over the RPC mechanism to the daemon, these " +"functions do not need a procedure number, and so the procedure number is set " +"to C<-1>." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:148 ../fish/guestfish-actions.pod:92 -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." +#. type: textblock +#: ../src/guestfs.pod:2453 +msgid "Implement the action (in C):" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:153 ../fish/guestfish-actions.pod:97 +#. type: textblock +#: ../src/guestfs.pod:2455 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)." +"For daemon actions, implement the function CnameE> in the " +"C directory." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:103 -msgid "This call checks that C exists." +#. 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:161 ../src/guestfs-actions.pod:4209 ../fish/guestfish-actions.pod:105 ../fish/guestfish-actions.pod:2829 -msgid "The optional arguments are:" +#. type: textblock +#: ../src/guestfs.pod:2461 +msgid "In either case, use another function as an example of what to do." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2465 +msgid "After making these changes, use C to compile." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:167 ../fish/guestfish-actions.pod:111 +#. type: textblock +#: ../src/guestfs.pod:2467 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." +"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: =item -#: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:115 -msgid "C" +#. type: =head2 +#: ../src/guestfs.pod:2471 +msgid "ADDING TESTS FOR AN API ACTION" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:173 +#. type: textblock +#: ../src/guestfs.pod:2473 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." +"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:177 ../fish/guestfish-actions.pod:121 +#. type: textblock +#: ../src/guestfs.pod:2479 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." +"The following describes the test environment used when you add an API test " +"in C." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:182 ../fish/guestfish-actions.pod:126 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2482 +msgid "The test environment has 4 block devices:" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:184 -msgid "" -"This rarely-used option lets you emulate the behaviour of the deprecated " -"C call (q.v.)" +#. type: =item +#: ../src/guestfs.pod:2486 +msgid "C 500MB" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:191 -msgid "(Added in 1.5.23)" +#. type: textblock +#: ../src/guestfs.pod:2488 +msgid "General block device for testing." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:193 -msgid "guestfs_add_drive_opts_va" +#. type: =item +#: ../src/guestfs.pod:2490 +msgid "C 50MB" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:195 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2492 msgid "" -" int\n" -" guestfs_add_drive_opts_va (guestfs_h *g,\n" -" const char *filename,\n" -" va_list args);\n" -"\n" -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:200 -msgid "This is the \"va_list variant\" of L." +"C is an ext2 filesystem used for testing filesystem write " +"operations." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:204 -msgid "guestfs_add_drive_opts_argv" +#. type: =item +#: ../src/guestfs.pod:2495 +msgid "C 10MB" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:206 -#, no-wrap -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" +#. type: textblock +#: ../src/guestfs.pod:2497 +msgid "Used in a few tests where two block devices are needed." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:211 -msgid "This is the \"argv variant\" of L." +#. type: =item +#: ../src/guestfs.pod:2499 +msgid "C" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:215 -msgid "guestfs_add_drive_ro" +#. type: textblock +#: ../src/guestfs.pod:2501 +msgid "ISO with fixed content (see C)." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:217 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2505 msgid "" -" int\n" -" guestfs_add_drive_ro (guestfs_h *g,\n" -" const char *filename);\n" -"\n" +"To be able to run the tests in a reasonable amount of time, the libguestfs " +"appliance and block devices are reused between tests. So don't try testing " +"L :-x" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:221 +#. type: textblock +#: ../src/guestfs.pod:2509 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." +"Each test starts with an initial scenario, selected using one of the " +"C expressions, described in C. These " +"initialize the disks mentioned above in a particular way as documented in " +"C. You should not assume anything about the previous " +"contents of other disks that are not initialized." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:228 -msgid "(Added in 1.0.38)" +#. type: textblock +#: ../src/guestfs.pod:2515 +msgid "" +"You can add a prerequisite clause to any individual test. This is a " +"run-time check, which, if it fails, causes the test to be skipped. Useful " +"if testing a command which might not work on all variations of libguestfs " +"builds. A test that has prerequisite of C means to run " +"unconditionally." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:230 -msgid "guestfs_add_drive_ro_with_if" +#. type: textblock +#: ../src/guestfs.pod:2521 +msgid "" +"In addition, packagers can skip individual tests by setting environment " +"variables before running C." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:232 +#. type: verbatim +#: ../src/guestfs.pod:2524 #, no-wrap msgid "" -" int\n" -" guestfs_add_drive_ro_with_if (guestfs_h *g,\n" -" const char *filename,\n" -" const char *iface);\n" +" SKIP_TEST__=1\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:237 -msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:249 ../src/guestfs-actions.pod:270 ../src/guestfs-actions.pod:2333 -msgid "(Added in 1.0.84)" +#. type: textblock +#: ../src/guestfs.pod:2526 +msgid "eg: C skips test #3 of L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:251 -msgid "guestfs_add_drive_with_if" +#. type: textblock +#: ../src/guestfs.pod:2528 +msgid "or:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:253 +#. type: verbatim +#: ../src/guestfs.pod:2530 #, no-wrap msgid "" -" int\n" -" guestfs_add_drive_with_if (guestfs_h *g,\n" -" const char *filename,\n" -" const char *iface);\n" +" SKIP_TEST_=1\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:258 -msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." +#. type: textblock +#: ../src/guestfs.pod:2532 +msgid "eg: C skips all L tests." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:272 -msgid "guestfs_aug_clear" +#. type: textblock +#: ../src/guestfs.pod:2534 +msgid "Packagers can run only certain tests by setting for example:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:274 +#. type: verbatim +#: ../src/guestfs.pod:2536 #, no-wrap msgid "" -" int\n" -" guestfs_aug_clear (guestfs_h *g,\n" -" const char *augpath);\n" +" TEST_ONLY=\"vfs_type zerofree\"\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:178 +#. type: textblock +#: ../src/guestfs.pod:2538 msgid "" -"Set the value associated with C to C. This is the same as the " -"L C command." +"See C for more details of how these environment variables " +"work." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:283 ../src/guestfs-actions.pod:2085 -msgid "(Added in 1.3.4)" +#. type: =head2 +#: ../src/guestfs.pod:2541 +msgid "DEBUGGING NEW API ACTIONS" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:285 -msgid "guestfs_aug_close" +#. type: textblock +#: ../src/guestfs.pod:2543 +msgid "Test new actions work before submitting them." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:287 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2545 +msgid "You can use guestfish to try out new commands." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2547 msgid "" -" int\n" -" guestfs_aug_close (guestfs_h *g);\n" -"\n" +"Debugging the daemon is a problem because it runs inside a minimal " +"environment. However you can fprintf messages in the daemon to stderr, and " +"they will show up if you use C." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:2551 +msgid "FORMATTING CODE AND OTHER CONVENTIONS" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:290 +#. type: textblock +#: ../src/guestfs.pod:2553 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." +"Our C source code generally adheres to some basic code-formatting " +"conventions. The existing code base is not totally consistent on this " +"front, but we do prefer that contributed code be formatted similarly. In " +"short, use spaces-not-TABs for indentation, use 2 spaces for each " +"indentation level, and other than that, follow the K&R style." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:297 ../src/guestfs-actions.pod:322 ../src/guestfs-actions.pod:340 ../src/guestfs-actions.pod:354 ../src/guestfs-actions.pod:412 ../src/guestfs-actions.pod:432 ../src/guestfs-actions.pod:446 ../src/guestfs-actions.pod:477 ../src/guestfs-actions.pod:491 ../src/guestfs-actions.pod:505 ../src/guestfs-actions.pod:519 ../src/guestfs-actions.pod:537 ../src/guestfs-actions.pod:5220 -msgid "(Added in 0.7)" +#. type: textblock +#: ../src/guestfs.pod:2559 +msgid "" +"If you use Emacs, add the following to one of one of your start-up files " +"(e.g., ~/.emacs), to help ensure that you get indentation right:" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:299 -msgid "guestfs_aug_defnode" +#. type: verbatim +#: ../src/guestfs.pod:2562 +#, no-wrap +msgid "" +" ;;; In libguestfs, indent with spaces everywhere (not TABs).\n" +" ;;; Exceptions: Makefile and ChangeLog modes.\n" +" (add-hook 'find-file-hook\n" +" '(lambda () (if (and buffer-file-name\n" +" (string-match \"/libguestfs\\\\>\"\n" +" (buffer-file-name))\n" +" (not (string-equal mode-name \"Change Log\"))\n" +" (not (string-equal mode-name \"Makefile\")))\n" +" (setq indent-tabs-mode nil))))\n" +" \n" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:301 +#. type: verbatim +#: ../src/guestfs.pod:2572 #, 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" +" ;;; When editing C sources in libguestfs, use this style.\n" +" (defun libguestfs-c-mode ()\n" +" \"C mode with adjusted defaults for use with libguestfs.\"\n" +" (interactive)\n" +" (c-set-style \"K&R\")\n" +" (setq c-indent-level 2)\n" +" (setq c-basic-offset 2))\n" +" (add-hook 'c-mode-hook\n" +" '(lambda () (if (string-match \"/libguestfs\\\\>\"\n" +" (buffer-file-name))\n" +" (libguestfs-c-mode))))\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:307 ../fish/guestfish-actions.pod:194 -msgid "Defines a variable C whose value is the result of evaluating C." +#. type: textblock +#: ../src/guestfs.pod:2584 +msgid "Enable warnings when compiling (and fix any problems this finds):" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:310 +#. type: verbatim +#: ../src/guestfs.pod:2587 +#, no-wrap 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." +" ./configure --enable-gcc-warnings\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:314 ../fish/guestfish-actions.pod:201 -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: textblock +#: ../src/guestfs.pod:2589 +msgid "Useful targets are:" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:318 +#. type: verbatim +#: ../src/guestfs.pod:2591 +#, no-wrap msgid "" -"This function returns a C, or NULL if there was " -"an error. I after use>." +" make syntax-check # checks the syntax of the C code\n" +" make check # runs the test suite\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:324 -msgid "guestfs_aug_defvar" +#. type: =head2 +#: ../src/guestfs.pod:2594 +msgid "DAEMON CUSTOM PRINTF FORMATTERS" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:326 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2596 msgid "" -" int\n" -" guestfs_aug_defvar (guestfs_h *g,\n" -" const char *name,\n" -" const char *expr);\n" -"\n" +"In the daemon code we have created custom printf formatters C<%Q> and C<%R>, " +"which are used to do shell quoting." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2601 +msgid "%Q" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:331 ../fish/guestfish-actions.pod:209 +#. type: textblock +#: ../src/guestfs.pod:2603 msgid "" -"Defines an Augeas variable C whose value is the result of evaluating " -"C. If C is NULL, then C is undefined." +"Simple shell quoted string. Any spaces or other shell characters are " +"escaped for you." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2606 +msgid "%R" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:335 ../fish/guestfish-actions.pod:213 +#. type: textblock +#: ../src/guestfs.pod:2608 msgid "" -"On success this returns the number of nodes in C, or C<0> if C " -"evaluates to something which is not a nodeset." +"Same as C<%Q> except the string is treated as a path which is prefixed by " +"the sysroot." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:342 -msgid "guestfs_aug_get" +#. type: textblock +#: ../src/guestfs.pod:2613 ../fish/guestfish.pod:242 ../fish/guestfish.pod:615 +msgid "For example:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:344 +#. type: verbatim +#: ../src/guestfs.pod:2615 #, no-wrap msgid "" -" char *\n" -" guestfs_aug_get (guestfs_h *g,\n" -" const char *augpath);\n" +" asprintf (&cmd, \"cat %R\", path);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:348 ../fish/guestfish-actions.pod:220 -msgid "" -"Look up the value associated with C. If C matches exactly one " -"node, the C is returned." +#. type: textblock +#: ../src/guestfs.pod:2617 +msgid "would produce C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:351 ../src/guestfs-actions.pod:851 ../src/guestfs-actions.pod:869 ../src/guestfs-actions.pod:929 ../src/guestfs-actions.pod:945 ../src/guestfs-actions.pod:1048 ../src/guestfs-actions.pod:1178 ../src/guestfs-actions.pod:1195 ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1343 ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1809 ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:1938 ../src/guestfs-actions.pod:2108 ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2744 ../src/guestfs-actions.pod:2775 ../src/guestfs-actions.pod:2799 ../src/guestfs-actions.pod:2861 ../src/guestfs-actions.pod:2884 ../src/guestfs-actions.pod:3396 ../src/guestfs-actions.pod:3746 ../src/guestfs-actions.pod:3916 ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:4948 ../src/guestfs-actions.pod:5118 ../src/guestfs-actions.pod:5296 ../src/guestfs-actions.pod:5345 ../src/guestfs-actions.pod:5908 ../src/guestfs-actions.pod:5924 ../src/guestfs-actions.pod:5941 ../src/guestfs-actions.pod:5965 ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:6658 ../src/guestfs-actions.pod:6676 ../src/guestfs-actions.pod:6856 ../src/guestfs-actions.pod:7128 +#. type: textblock +#: ../src/guestfs.pod:2619 msgid "" -"This function returns a string, or NULL on error. I." +"I Do I use these when you are passing parameters to the " +"C functions. These parameters do NOT need to be quoted " +"because they are not passed via the shell (instead, straight to exec). You " +"probably want to use the C function however." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:356 -msgid "guestfs_aug_init" +#. type: =head2 +#: ../src/guestfs.pod:2625 +msgid "SUBMITTING YOUR NEW API ACTIONS" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:358 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2627 msgid "" -" int\n" -" guestfs_aug_init (guestfs_h *g,\n" -" const char *root,\n" -" int flags);\n" -"\n" +"Submit patches to the mailing list: " +"L and CC to " +"L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:363 ../fish/guestfish-actions.pod:227 -msgid "" -"Create a new Augeas handle for editing configuration files. If there was " -"any previous Augeas handle associated with this guestfs session, then it is " -"closed." +#. type: =head2 +#: ../src/guestfs.pod:2631 +msgid "INTERNATIONALIZATION (I18N) SUPPORT" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:367 -msgid "You must call this before using any other C commands." +#. type: textblock +#: ../src/guestfs.pod:2633 +msgid "We support i18n (gettext anyhow) in the library." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:370 ../fish/guestfish-actions.pod:234 -msgid "C is the filesystem root. C must not be NULL, use C instead." +#. type: textblock +#: ../src/guestfs.pod:2635 +msgid "" +"However many messages come from the daemon, and we don't translate those at " +"the moment. One reason is that the appliance generally has all locale files " +"removed from it, because they take up a lot of space. So we'd have to readd " +"some of those, as well as copying our PO files into the appliance." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:373 ../fish/guestfish-actions.pod:237 +#. type: textblock +#: ../src/guestfs.pod:2641 msgid "" -"The flags are the same as the flags defined in Eaugeas.hE, the " -"logical I of the following integers:" +"Debugging messages are never translated, since they are intended for the " +"programmers." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243 -msgid "C = 1" +#. type: =head2 +#: ../src/guestfs.pod:2644 +msgid "SOURCE CODE SUBDIRECTORIES" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245 -msgid "Keep the original file with a C<.augsave> extension." +#. type: =item +#: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5820 ../fish/guestfish-actions.pod:3913 +msgid "C" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247 -msgid "C = 2" +#. type: textblock +#: ../src/guestfs.pod:2650 +msgid "The libguestfs appliance, build scripts and so on." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:249 -msgid "" -"Save changes into a file with extension C<.augnew>, and do not overwrite " -"original. Overrides C." +#. type: =item +#: ../src/guestfs.pod:2652 +msgid "C" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252 -msgid "C = 4" +#. type: textblock +#: ../src/guestfs.pod:2654 +msgid "Automated tests of the C API." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254 -msgid "Typecheck lenses (can be expensive)." +#. type: =item +#: ../src/guestfs.pod:2656 +msgid "C" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256 -msgid "C = 8" +#. type: textblock +#: ../src/guestfs.pod:2658 +msgid "" +"The L, L and L commands and " +"documentation." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258 -msgid "Do not use standard load path for modules." +#. type: =item +#: ../src/guestfs.pod:2661 +msgid "C" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260 -msgid "C = 16" +#. type: textblock +#: ../src/guestfs.pod:2663 +msgid "Outside contributions, experimental parts." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262 -msgid "Make save a no-op, just record what would have been changed." +#. type: =item +#: ../src/guestfs.pod:2665 +msgid "C" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:264 -msgid "C = 32" +#. type: textblock +#: ../src/guestfs.pod:2667 +msgid "" +"The daemon that runs inside the libguestfs appliance and carries out " +"actions." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:402 -msgid "Do not load the tree in C." +#. type: =item +#: ../src/guestfs.pod:2670 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:406 -msgid "To close the handle, you can call C." +#. type: textblock +#: ../src/guestfs.pod:2672 +msgid "L command and documentation." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:272 -msgid "To find out more about Augeas, see L." +#. type: =item +#: ../src/guestfs.pod:2674 +msgid "C" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:414 -msgid "guestfs_aug_insert" +#. type: textblock +#: ../src/guestfs.pod:2676 +msgid "C API example code." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:416 -#, no-wrap -msgid "" -" int\n" -" guestfs_aug_insert (guestfs_h *g,\n" -" const char *augpath,\n" -" const char *label,\n" -" int before);\n" -"\n" +#. type: =item +#: ../src/guestfs.pod:2678 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:422 ../fish/guestfish-actions.pod:278 +#. type: textblock +#: ../src/guestfs.pod:2680 msgid "" -"Create a new sibling C