X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=po-docs%2Fja.po;h=d32eaa6bc1a1f2701f1b0510baee7cd14fbe180b;hp=e6ad7e49fe2c4fb61c223c2e6a45352558ccf04c;hb=2a8cf3aab32c45b327c6b6c1fe6d4e61c7c95909;hpb=0e896a490c46825e2ef998143d338dda5736223e diff --git a/po-docs/ja.po b/po-docs/ja.po index e6ad7e4..d32eaa6 100644 --- a/po-docs/ja.po +++ b/po-docs/ja.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: libguestfs@redhat.com\n" -"POT-Creation-Date: 2010-10-27 12:50+0200\n" +"POT-Creation-Date: 2011-05-09 15:21+0200\n" "PO-Revision-Date: 2010-09-02 14:46+0100\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,45 +16,34 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -# type: =encoding -#: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 -#: ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 -#: ../inspector/virt-inspector.pl:36 ../tools/virt-edit.pl:31 -#: ../tools/virt-win-reg.pl:34 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:31 -#: ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 -#: ../tools/virt-cat.pl:30 ../tools/virt-tar.pl:30 ../tools/virt-rescue.pl:29 -#: ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28 -msgid "utf8" -msgstr "" - # type: =head1 +#. type: =head1 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 -#: ../inspector/virt-inspector.pl:38 ../tools/virt-edit.pl:33 -#: ../tools/virt-win-reg.pl:36 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:33 -#: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 -#: ../tools/virt-cat.pl:32 ../tools/virt-tar.pl:32 ../tools/virt-rescue.pl:31 -#: ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 +#: ../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 +#. type: =head1 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 -#: ../inspector/virt-inspector.pl:42 ../tools/virt-edit.pl:37 -#: ../tools/virt-win-reg.pl:40 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:37 -#: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 -#: ../tools/virt-cat.pl:36 ../tools/virt-tar.pl:36 ../tools/virt-rescue.pl:35 -#: ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 +#: ../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 "" @@ -63,6 +52,7 @@ msgid "" msgstr "" # type: verbatim +#. type: verbatim #: ../src/guestfs.pod:11 #, no-wrap msgid "" @@ -72,13 +62,13 @@ msgid "" " guestfs_mount (g, \"/dev/sda1\", \"/\");\n" " guestfs_touch (g, \"/hello\");\n" " guestfs_umount (g, \"/\");\n" -" guestfs_sync (g);\n" " guestfs_close (g);\n" "\n" msgstr "" # type: verbatim -#: ../src/guestfs.pod:20 +#. type: verbatim +#: ../src/guestfs.pod:19 #, no-wrap msgid "" " cc prog.c -o prog -lguestfs\n" @@ -88,18 +78,18 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 +#. type: =head1 +#: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 -#: ../inspector/virt-inspector.pl:48 ../tools/virt-edit.pl:51 -#: ../tools/virt-win-reg.pl:64 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:43 -#: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 -#: ../tools/virt-cat.pl:42 ../tools/virt-tar.pl:73 ../tools/virt-rescue.pl:51 -#: ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40 +#: ../tools/virt-win-reg.pl:63 ../tools/virt-list-filesystems.pl:40 +#: ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47 +#: ../tools/virt-list-partitions.pl:40 msgid "DESCRIPTION" msgstr "" # type: textblock -#: ../src/guestfs.pod:26 +#. type: textblock +#: ../src/guestfs.pod:25 msgid "" "Libguestfs is a library for accessing and modifying guest disk images. " "Amongst the things this is good for: making batch configuration changes to " @@ -110,7 +100,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:34 +#. type: textblock +#: ../src/guestfs.pod:33 msgid "" "Libguestfs uses Linux kernel and qemu code, and can access any type of guest " "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, " @@ -119,7 +110,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:39 +#. type: textblock +#: ../src/guestfs.pod:38 msgid "" "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, " "what filesystem is in each LV, etc.). It can also run commands in the " @@ -127,7 +119,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:44 +#. type: textblock +#: ../src/guestfs.pod:43 msgid "" "Libguestfs is a library that can be linked with C and C++ management " "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, " @@ -136,26 +129,38 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:49 +#. type: textblock +#: ../src/guestfs.pod:48 msgid "" "You don't need to be root to use libguestfs, although obviously you do need " "enough permissions to access the disk images." msgstr "" # type: textblock -#: ../src/guestfs.pod:52 +#. type: textblock +#: ../src/guestfs.pod:51 msgid "" "Libguestfs is a large API because it can do many things. For a gentle " "introduction, please read the L section next." msgstr "" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:54 +msgid "" +"There are also some example programs in the L manual " +"page." +msgstr "" + # type: =head1 -#: ../src/guestfs.pod:55 +#. type: =head1 +#: ../src/guestfs.pod:57 msgid "API OVERVIEW" msgstr "" # type: textblock -#: ../src/guestfs.pod:57 +#. type: textblock +#: ../src/guestfs.pod:59 msgid "" "This section provides a gentler overview of the libguestfs API. We also try " "to group API calls together, where that may not be obvious from reading " @@ -163,12 +168,14 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:62 +#. type: =head2 +#: ../src/guestfs.pod:64 msgid "HANDLES" msgstr "" # type: textblock -#: ../src/guestfs.pod:64 +#. type: textblock +#: ../src/guestfs.pod:66 msgid "" "Before you can use libguestfs calls, you have to create a handle. Then you " "must add at least one disk image to the handle, followed by launching the " @@ -178,12 +185,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:71 +#. type: textblock +#: ../src/guestfs.pod:73 msgid "The general structure of all libguestfs-using programs looks like this:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:74 +#. type: verbatim +#: ../src/guestfs.pod:76 #, no-wrap msgid "" " guestfs_h *g = guestfs_create ();\n" @@ -191,7 +200,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:76 +#. type: verbatim +#: ../src/guestfs.pod:78 #, no-wrap msgid "" " /* Call guestfs_add_drive additional times if there are\n" @@ -202,7 +212,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:81 +#. type: verbatim +#: ../src/guestfs.pod:83 #, no-wrap msgid "" " /* Most manipulation calls won't work until you've launched\n" @@ -214,7 +225,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:87 +#. type: verbatim +#: ../src/guestfs.pod:89 #, no-wrap msgid "" " /* Now you can examine what partitions, LVs etc are available.\n" @@ -225,7 +237,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:92 +#. type: verbatim +#: ../src/guestfs.pod:94 #, no-wrap msgid "" " /* To access a filesystem in the image, you must mount it.\n" @@ -234,8 +247,8 @@ msgid "" " \n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:96 +#. type: verbatim +#: ../src/guestfs.pod:98 #, no-wrap msgid "" " /* Now you can perform filesystem actions on the guest\n" @@ -246,20 +259,21 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:101 +#. type: verbatim +#: ../src/guestfs.pod:103 #, no-wrap msgid "" -" /* You only need to call guestfs_sync if you have made\n" -" * changes to the guest image. (But if you've made changes\n" -" * then you *must* sync). See also: guestfs_umount and\n" -" * guestfs_umount_all calls.\n" +" /* This is only needed for libguestfs < 1.5.24. Since then\n" +" * it is done automatically when you close the handle. See\n" +" * discussion of autosync in this page.\n" " */\n" " guestfs_sync (g);\n" " \n" msgstr "" # type: verbatim -#: ../src/guestfs.pod:108 +#. type: verbatim +#: ../src/guestfs.pod:109 #, no-wrap msgid "" " /* Close the handle 'g'. */\n" @@ -268,23 +282,27 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:111 +#. type: textblock +#: ../src/guestfs.pod:112 msgid "" "The code above doesn't include any error checking. In real code you should " "check return values carefully for errors. In general all functions that " "return integers return C<-1> on error, and all functions that return " "pointers return C on error. See section L below for " "how to handle errors, and consult the documentation for each function call " -"below to see precisely how they return error indications." +"below to see precisely how they return error indications. See L for fully worked examples." msgstr "" # type: =head2 -#: ../src/guestfs.pod:119 +#. type: =head2 +#: ../src/guestfs.pod:121 msgid "DISK IMAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:121 +#. type: textblock +#: ../src/guestfs.pod:123 msgid "" "The image filename (C<\"guest.img\"> in the example above) could be a disk " "image from a virtual machine, a L copy of a physical hard disk, an " @@ -294,7 +312,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:127 +#. type: textblock +#: ../src/guestfs.pod:129 msgid "" "The call you should use in modern code for adding drives is L. To add a disk image, allowing writes, and " @@ -302,7 +321,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:131 +#. type: verbatim +#: ../src/guestfs.pod:133 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -312,12 +332,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:135 +#. type: textblock +#: ../src/guestfs.pod:137 msgid "You can add a disk read-only using:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:137 +#. type: verbatim +#: ../src/guestfs.pod:139 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -328,14 +350,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:142 +#. type: textblock +#: ../src/guestfs.pod:144 msgid "" "or by calling the older function L. In either case " "libguestfs won't modify the file." msgstr "" # type: textblock -#: ../src/guestfs.pod:145 +#. type: textblock +#: ../src/guestfs.pod:147 msgid "" "Be extremely cautious if the disk image is in use, eg. if it is being used " "by a virtual machine. Adding it read-write will almost certainly cause disk " @@ -343,7 +367,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:149 +#. type: textblock +#: ../src/guestfs.pod:151 msgid "" "You must add at least one disk image, and you may add multiple disk images. " "In the API, the disk images are usually referred to as C (for the " @@ -351,7 +376,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:154 +#. type: textblock +#: ../src/guestfs.pod:156 msgid "" "Once L has been called you cannot add any more images. You " "can call L to get a list of the device names, in the " @@ -359,63 +385,74 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:159 +#. type: =head2 +#: ../src/guestfs.pod:161 msgid "MOUNTING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:161 +#. type: textblock +#: ../src/guestfs.pod:163 msgid "" "Before you can read or write files, create directories and so on in a disk " "image that contains filesystems, you have to mount those filesystems using " -"L. If you already know that a disk image contains (for " -"example) one partition with a filesystem on that partition, then you can " -"mount it directly:" +"L or L. If you already know that " +"a disk image contains (for example) one partition with a filesystem on that " +"partition, then you can mount it directly:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:167 +#. type: verbatim +#: ../src/guestfs.pod:170 #, no-wrap msgid "" -" guestfs_mount (g, \"/dev/sda1\", \"/\");\n" +" guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:169 +#. type: textblock +#: ../src/guestfs.pod:172 msgid "" "where C means literally the first partition (C<1>) of the first " "disk image that we added (C). If the disk contains Linux LVM2 " -"logical volumes you could refer to those instead (eg. C)." +"logical volumes you could refer to those instead (eg. C). Note " +"that these are libguestfs virtual devices, and are nothing to do with host " +"devices." msgstr "" -# type: textblock -#: ../src/guestfs.pod:173 +#. type: textblock +#: ../src/guestfs.pod:178 msgid "" "If you are given a disk image and you don't know what it contains then you " "have to find out. Libguestfs can do that too: use L and L to list possible partitions and " "LVs, and either try mounting each to see what is mountable, or else examine " -"them with L or L. Libguestfs also has a " -"set of APIs for inspection of disk images (see L below). But " -"you might find it easier to look at higher level programs built on top of " -"libguestfs, in particular L." +"them with L or L. To list just " +"filesystems, use L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:183 +#. 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:191 msgid "" -"To mount a disk image read-only, use L. There are " +"To mount a filesystem read-only, use L. There are " "several other variations of the C call." msgstr "" # type: =head2 -#: ../src/guestfs.pod:186 +#. type: =head2 +#: ../src/guestfs.pod:194 msgid "FILESYSTEM ACCESS AND MODIFICATION" msgstr "" # type: textblock -#: ../src/guestfs.pod:188 +#. type: textblock +#: ../src/guestfs.pod:196 msgid "" "The majority of the libguestfs API consists of fairly low-level calls for " "accessing and modifying the files, directories, symlinks etc on mounted " @@ -425,21 +462,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:194 +#. type: textblock +#: ../src/guestfs.pod:202 msgid "" "Specify filenames as full paths, starting with C<\"/\"> and including the " "mount point." msgstr "" # type: textblock -#: ../src/guestfs.pod:197 +#. type: textblock +#: ../src/guestfs.pod:205 msgid "" "For example, if you mounted a filesystem at C<\"/\"> and you want to read " "the file called C<\"etc/passwd\"> then you could do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:200 +#. type: verbatim +#: ../src/guestfs.pod:208 #, no-wrap msgid "" " char *data = guestfs_cat (g, \"/etc/passwd\");\n" @@ -447,7 +487,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:202 +#. type: textblock +#: ../src/guestfs.pod:210 msgid "" "This would return C as a newly allocated buffer containing the full " "content of that file (with some conditions: see also L below), " @@ -455,14 +496,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:206 +#. type: textblock +#: ../src/guestfs.pod:214 msgid "" "As another example, to create a top-level directory on that filesystem " "called C<\"var\"> you would do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:209 +#. type: verbatim +#: ../src/guestfs.pod:217 #, no-wrap msgid "" " guestfs_mkdir (g, \"/var\");\n" @@ -470,12 +513,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:211 +#. type: textblock +#: ../src/guestfs.pod:219 msgid "To create a symlink you could do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:213 +#. type: verbatim +#: ../src/guestfs.pod:221 #, no-wrap msgid "" " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n" @@ -484,14 +529,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:216 +#. type: textblock +#: ../src/guestfs.pod:224 msgid "" "Libguestfs will reject attempts to use relative paths and there is no " "concept of a current working directory." msgstr "" # type: textblock -#: ../src/guestfs.pod:219 +#. type: textblock +#: ../src/guestfs.pod:227 msgid "" "Libguestfs can return errors in many situations: for example if the " "filesystem isn't writable, or if a file or directory that you requested " @@ -501,33 +548,38 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:225 +#. type: textblock +#: ../src/guestfs.pod:233 msgid "" "File writes are affected by the per-handle umask, set by calling L and defaulting to 022. See L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:228 +#. type: =head2 +#: ../src/guestfs.pod:236 msgid "PARTITIONING" msgstr "" # type: textblock -#: ../src/guestfs.pod:230 +#. type: textblock +#: ../src/guestfs.pod:238 msgid "" "Libguestfs contains API calls to read, create and modify partition tables on " "disk images." msgstr "" # type: textblock -#: ../src/guestfs.pod:233 +#. type: textblock +#: ../src/guestfs.pod:241 msgid "" "In the common case where you want to create a single partition covering the " "whole disk, you should use the L call:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:237 +#. type: verbatim +#: ../src/guestfs.pod:245 #, no-wrap msgid "" " const char *parttype = \"mbr\";\n" @@ -538,18 +590,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:242 +#. type: textblock +#: ../src/guestfs.pod:250 msgid "" "Obviously this effectively wipes anything that was on that disk image before." msgstr "" # type: =head2 -#: ../src/guestfs.pod:245 +#. type: =head2 +#: ../src/guestfs.pod:253 msgid "LVM2" msgstr "" # type: textblock -#: ../src/guestfs.pod:247 +#. type: textblock +#: ../src/guestfs.pod:255 msgid "" "Libguestfs provides access to a large part of the LVM2 API, such as L and L. It won't make much sense unless " @@ -558,27 +613,30 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:252 +#. type: textblock +#: ../src/guestfs.pod:260 msgid "" "This author strongly recommends reading the LVM HOWTO, online at L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:255 +#. type: =head2 +#: ../src/guestfs.pod:263 msgid "DOWNLOADING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:257 +#. type: textblock +#: ../src/guestfs.pod:265 msgid "" "Use L to download small, text only files. This call is " "limited to files which are less than 2 MB and which cannot contain any ASCII " -"NUL (C<\\0>) characters. However it has a very simple to use API." +"NUL (C<\\0>) characters. However the API is very simple to use." msgstr "" # type: textblock -#: ../src/guestfs.pod:262 +#. type: textblock +#: ../src/guestfs.pod:269 msgid "" "L can be used to read files which contain arbitrary 8 " "bit data, since it returns a (pointer, size) pair. However it is still " @@ -586,31 +644,36 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:266 +#. type: textblock +#: ../src/guestfs.pod:273 msgid "" "L can be used to download any file, with no limits on " "content or size (even files larger than 4 GB)." msgstr "" # type: textblock -#: ../src/guestfs.pod:269 +#. type: textblock +#: ../src/guestfs.pod:276 msgid "" "To download multiple files, see L and L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:272 +#. type: =head2 +#: ../src/guestfs.pod:279 msgid "UPLOADING" msgstr "" # type: textblock -#: ../src/guestfs.pod:274 +#. type: textblock +#: ../src/guestfs.pod:281 msgid "" "It's often the case that you want to write a file or files to the disk image." msgstr "" # type: textblock -#: ../src/guestfs.pod:277 +#. type: textblock +#: ../src/guestfs.pod:284 msgid "" "To write a small file with fixed content, use L. To create " "a file of all zeroes, use L (sparse) or L. This call has no limits on " "file content or size (even files larger than 4 GB)." msgstr "" # type: textblock -#: ../src/guestfs.pod:286 +#. type: textblock +#: ../src/guestfs.pod:293 msgid "" "To upload multiple files, see L and L." msgstr "" # type: textblock -#: ../src/guestfs.pod:288 +#. type: textblock +#: ../src/guestfs.pod:295 msgid "" "However the fastest way to upload I is to " "turn them into a squashfs or CD ISO (see L and L to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:309 +#. type: textblock +#: ../src/guestfs.pod:316 msgid "" "Use L to copy a single file, or L to copy " "directories recursively." msgstr "" # type: =item -#: ../src/guestfs.pod:312 +#. type: =item +#: ../src/guestfs.pod:319 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:314 +#. type: textblock +#: ../src/guestfs.pod:321 msgid "" "Use L which efficiently uses L to copy between files and " "devices in the guest." msgstr "" # type: textblock -#: ../src/guestfs.pod:317 +#. type: textblock +#: ../src/guestfs.pod:324 msgid "Example: duplicate the contents of an LV:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:319 +#. type: verbatim +#: ../src/guestfs.pod:326 #, no-wrap msgid "" " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n" @@ -697,7 +771,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:321 +#. type: textblock +#: ../src/guestfs.pod:328 msgid "" "The destination (C) must be at least as large as the source " "(C). To copy less than the whole source device, use L to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:327 +#. type: textblock +#: ../src/guestfs.pod:334 msgid "Use L. See L above." msgstr "" # type: =item -#: ../src/guestfs.pod:329 +#. type: =item +#: ../src/guestfs.pod:336 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:331 +#. type: textblock +#: ../src/guestfs.pod:338 msgid "Use L. See L above." msgstr "" # type: =head2 -#: ../src/guestfs.pod:335 +#. type: =head2 +#: ../src/guestfs.pod:342 +msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:344 +msgid "" +"Calls like L, L, L, L etc appear to only take filenames as arguments, so it " +"appears you can only upload and download to files. However many Un*x-like " +"hosts let you use the special device files C, C, C and C to read and write from stdin, stdout, stderr, " +"and arbitrary file descriptor N." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:352 +msgid "For example, L writes its output to stdout by doing:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:355 +#, no-wrap +msgid "" +" guestfs_download (g, filename, \"/dev/stdout\");\n" +"\n" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:357 +msgid "and you can write tar output to a file descriptor C by doing:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:359 +#, no-wrap +msgid "" +" char devfd[64];\n" +" snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n" +" guestfs_tar_out (g, \"/\", devfd);\n" +"\n" +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:363 msgid "LISTING FILES" msgstr "" # type: textblock -#: ../src/guestfs.pod:337 +#. type: textblock +#: ../src/guestfs.pod:365 msgid "" "L is just designed for humans to read (mainly when using the " "L-equivalent command C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:340 +#. type: textblock +#: ../src/guestfs.pod:368 msgid "" "L is a quick way to get a list of files in a directory from " "programs, as a flat list of strings." msgstr "" # type: textblock -#: ../src/guestfs.pod:343 +#. type: textblock +#: ../src/guestfs.pod:371 msgid "" "L is a programmatic way to get a list of files in a " "directory, plus additional information about each one. It is more " @@ -752,18 +882,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:347 +#. type: textblock +#: ../src/guestfs.pod:375 msgid "" "L and L can be used to recursively list files." msgstr "" # type: =head2 -#: ../src/guestfs.pod:350 +#. type: =head2 +#: ../src/guestfs.pod:378 msgid "RUNNING COMMANDS" msgstr "" # type: textblock -#: ../src/guestfs.pod:352 +#. type: textblock +#: ../src/guestfs.pod:380 msgid "" "Although libguestfs is primarily an API for manipulating files inside guest " "images, we also provide some limited facilities for running commands inside " @@ -771,116 +904,156 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:356 +#. type: textblock +#: ../src/guestfs.pod:384 msgid "There are many limitations to this:" msgstr "" # type: =item -#: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370 -#: ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383 -#: ../src/guestfs.pod:388 ../src/guestfs.pod:1143 ../src/guestfs.pod:1148 -#: ../src/guestfs.pod:1152 ../src/guestfs.pod:1368 ../src/guestfs.pod:1373 -#: ../src/guestfs.pod:1377 ../src/guestfs.pod:1479 ../src/guestfs.pod:1483 -#: ../src/guestfs.pod:1487 ../src/guestfs.pod:1492 ../src/guestfs.pod:1500 -#: ../src/guestfs.pod:1519 ../src/guestfs.pod:1527 ../src/guestfs.pod:1757 -#: ../src/guestfs.pod:1763 ../src/guestfs.pod:1768 ../src/guestfs.pod:1774 -#: ../src/guestfs.pod:1881 ../src/guestfs.pod:1885 ../src/guestfs.pod:1889 -#: ../src/guestfs.pod:1893 ../src/guestfs-actions.pod:14 -#: ../src/guestfs-actions.pod:21 ../src/guestfs-actions.pod:438 -#: ../src/guestfs-actions.pod:446 ../src/guestfs-actions.pod:453 -#: ../src/guestfs-actions.pod:460 ../src/guestfs-actions.pod:1351 -#: ../src/guestfs-actions.pod:1355 ../src/guestfs-actions.pod:1359 -#: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1371 -#: ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1379 -#: ../src/guestfs-actions.pod:1389 ../src/guestfs-actions.pod:1393 -#: ../src/guestfs-actions.pod:1397 ../src/guestfs-actions.pod:1520 -#: ../src/guestfs-actions.pod:1524 ../src/guestfs-actions.pod:1529 -#: ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1586 -#: ../src/guestfs-actions.pod:1590 ../src/guestfs-actions.pod:1595 -#: ../fish/guestfish.pod:364 ../fish/guestfish.pod:368 -#: ../fish/guestfish.pod:372 ../fish/guestfish.pod:376 +#. 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:2967 ../src/guestfs.pod:2971 ../src/guestfs.pod:2975 +#: ../src/guestfs.pod:2979 ../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:339 ../fish/guestfish-actions.pod:347 -#: ../fish/guestfish-actions.pod:354 ../fish/guestfish-actions.pod:361 -#: ../fish/guestfish-actions.pod:1056 ../fish/guestfish-actions.pod:1060 -#: ../fish/guestfish-actions.pod:1064 ../fish/guestfish-actions.pod:1068 -#: ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080 -#: ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1094 -#: ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102 -#: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1196 -#: ../fish/guestfish-actions.pod:1201 ../fish/guestfish-actions.pod:1206 -#: ../fish/guestfish-actions.pod:1248 ../fish/guestfish-actions.pod:1252 -#: ../fish/guestfish-actions.pod:1257 ../tools/virt-df.pl:161 -#: ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348 -#: ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363 +#: ../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-win-reg.pl:536 +#: ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 msgid "*" msgstr "" # type: textblock -#: ../src/guestfs.pod:362 +#. type: textblock +#: ../src/guestfs.pod:390 msgid "" "The kernel version that the command runs under will be different from what " "it expects." msgstr "" # type: textblock -#: ../src/guestfs.pod:367 +#. type: textblock +#: ../src/guestfs.pod:395 msgid "" "If the command needs to communicate with daemons, then most likely they " "won't be running." msgstr "" # type: textblock -#: ../src/guestfs.pod:372 +#. type: textblock +#: ../src/guestfs.pod:400 msgid "The command will be running in limited memory." msgstr "" # type: textblock -#: ../src/guestfs.pod:376 +#. type: textblock +#: ../src/guestfs.pod:404 msgid "" "The network may not be available unless you enable it (see L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:381 +#. type: textblock +#: ../src/guestfs.pod:409 msgid "Only supports Linux guests (not Windows, BSD, etc)." msgstr "" # type: textblock -#: ../src/guestfs.pod:385 +#. type: textblock +#: ../src/guestfs.pod:413 msgid "" "Architecture limitations (eg. won't work for a PPC guest on an X86 host)." msgstr "" # type: textblock -#: ../src/guestfs.pod:390 +#. type: textblock +#: ../src/guestfs.pod:418 msgid "" "For SELinux guests, you may need to enable SELinux and load policy first. " "See L in this manpage." msgstr "" # type: textblock -#: ../src/guestfs.pod:395 +#. type: textblock +#: ../src/guestfs.pod:423 +msgid "" +"I It is not safe to run commands from untrusted, possibly " +"malicious guests. These commands may attempt to exploit your program by " +"sending unexpected output. They could also try to exploit the Linux kernel " +"or qemu provided by the libguestfs appliance. They could use the network " +"provided by the libguestfs appliance to bypass ordinary network partitions " +"and firewalls. They could use the elevated privileges or different SELinux " +"context of your program to their advantage." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:432 +msgid "" +"A secure alternative is to use libguestfs to install a \"firstboot\" script " +"(a script which runs when the guest next boots normally), and to have this " +"script run the commands you want in the normal context of the running guest, " +"network security and so on. For information about other security issues, " +"see L." +msgstr "" + +# type: textblock +#. 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:398 +#. 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:401 +#. type: =head2 +#: ../src/guestfs.pod:446 msgid "CONFIGURATION FILES" msgstr "" # type: textblock -#: ../src/guestfs.pod:403 +#. 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 " @@ -889,7 +1062,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:408 +#. 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 " @@ -897,7 +1071,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:412 +#. 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 " @@ -905,29 +1080,35 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:416 +#. type: =head2 +#: ../src/guestfs.pod:461 msgid "SELINUX" msgstr "" # type: textblock -#: ../src/guestfs.pod:418 +#. 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:424 +#. 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:426 +#. type: textblock +#: ../src/guestfs.pod:471 msgid "Before launching, do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:428 +#. type: verbatim +#: ../src/guestfs.pod:473 #, no-wrap msgid "" " guestfs_set_selinux (g, 1);\n" @@ -935,19 +1116,23 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:430 +#. 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:432 +#. 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:436 +#. type: verbatim +#: ../src/guestfs.pod:481 #, no-wrap msgid "" " guestfs_sh (g, \"/usr/sbin/load_policy\");\n" @@ -955,26 +1140,30 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:438 +#. 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:441 +#. type: =item +#: ../src/guestfs.pod:486 ../src/guestfs.pod:1405 msgid "3." msgstr "" # type: textblock -#: ../src/guestfs.pod:443 +#. 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:447 +#. type: verbatim +#: ../src/guestfs.pod:492 #, no-wrap msgid "" " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n" @@ -982,24 +1171,28 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:451 +#. type: textblock +#: ../src/guestfs.pod:496 msgid "This will work for running commands and editing existing files." msgstr "" # type: textblock -#: ../src/guestfs.pod:453 +#. 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:457 +#. type: =head2 +#: ../src/guestfs.pod:502 msgid "UMASK" msgstr "" # type: textblock -#: ../src/guestfs.pod:459 +#. 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 " @@ -1009,14 +1202,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:465 +#. 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:468 +#. 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." msgstr "" # type: =head1 -#: ../src/guestfs.pod:474 ../fish/guestfish.pod:630 +#. type: =head1 +#: ../src/guestfs.pod:519 ../fish/guestfish.pod:767 msgid "ENCRYPTED DISKS" msgstr "" # type: textblock -#: ../src/guestfs.pod:476 +#. 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) " @@ -1043,21 +1241,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:482 +#. 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:485 +#. 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:488 +#. 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 L followed by L. The logical volume" @@ -1074,7 +1276,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:498 +#. 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:513 +#. 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:516 +#. 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 " @@ -1119,7 +1325,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:525 +#. 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 L /dev/sda1\n" @@ -1149,21 +1358,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:542 +#. 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:545 +#. 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:549 +#. 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 " @@ -1171,7 +1383,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:553 +#. 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 " @@ -1179,29 +1392,78 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:557 +#. type: textblock +#: ../src/guestfs.pod:603 msgid "" "A note on the implementation: The call L performs " "inspection and caches the results in the guest handle. Subsequent calls to " "C return this cached information, but I re-" "read the disks. If you change the content of the guest disks, you can redo " -"inspection by calling L again." +"inspection by calling L again. (L works a little differently from the other " +"calls and does read the disks. See documentation for that function for " +"details)." +msgstr "" + +#. type: =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:564 +#. type: =head2 +#: ../src/guestfs.pod:631 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:566 +#. type: textblock +#: ../src/guestfs.pod:633 msgid "" "Libguestfs can mount NTFS partitions. It does this using the L driver." msgstr "" +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:636 +msgid "DRIVE LETTERS AND PATHS" +msgstr "" + # type: textblock -#: ../src/guestfs.pod:569 +#. 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 " @@ -1210,31 +1472,37 @@ msgid "" "might be referred to as C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:575 +#. 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:580 +#. 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:583 +#. 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 +#. type: =head3 +#: ../src/guestfs.pod:654 +msgid "ACCESSING THE WINDOWS REGISTRY" msgstr "" # type: textblock -#: ../src/guestfs.pod:586 +#. 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 " @@ -1244,36 +1512,106 @@ msgid "" "reg(1)> for more help on this issue." msgstr "" +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:664 +msgid "SYMLINKS ON NTFS-3G FILESYSTEMS" +msgstr "" + +# type: textblock +#. 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 +#. type: textblock +#: ../src/guestfs.pod:670 +msgid "" +"L" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:672 +msgid "" +"The essential problem is that ntfs-3g simply does not have enough " +"information to do a correct job. NTFS links can contain drive letters and " +"references to external device GUIDs that ntfs-3g has no way of resolving. " +"It is almost certainly the case that libguestfs callers should ignore what " +"ntfs-3g does (ie. don't use L on NTFS volumes)." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:679 +msgid "" +"Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L to read the C extended " +"attribute, and read the raw reparse data from that (you can find the format " +"documented in various places around the web)." +msgstr "" + +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:684 +msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS" +msgstr "" + +# type: textblock +#. 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 +#. type: textblock +#: ../src/guestfs.pod:689 +msgid "" +"L" +msgstr "" + # type: =head2 -#: ../src/guestfs.pod:594 +#. type: =head2 +#: ../src/guestfs.pod:691 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:596 +#. 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:599 +#. 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:605 +#. 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:608 +#. 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 " @@ -1281,36 +1619,42 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:614 +#. type: =item +#: ../src/guestfs.pod:711 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:616 +#. 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:620 +#. type: =item +#: ../src/guestfs.pod:717 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:622 +#. 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:625 +#. type: =item +#: ../src/guestfs.pod:722 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:627 +#. 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 " @@ -1318,103 +1662,103 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:631 +#. type: =item +#: ../src/guestfs.pod:728 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:633 +#. 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:636 +#. type: =item +#: ../src/guestfs.pod:733 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:638 -msgid "For documentation see the file C." +#. type: textblock +#: ../src/guestfs.pod:735 +msgid "See L." msgstr "" # type: =item -#: ../src/guestfs.pod:640 +#. type: =item +#: ../src/guestfs.pod:737 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:642 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:739 +msgid "See L and L." msgstr "" # type: =item -#: ../src/guestfs.pod:644 +#. type: =item +#: ../src/guestfs.pod:741 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:646 +#. 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:649 +#. type: textblock +#: ../src/guestfs.pod:746 msgid "The PHP binding only works correctly on 64 bit machines." msgstr "" # type: =item -#: ../src/guestfs.pod:651 +#. type: =item +#: ../src/guestfs.pod:748 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:653 -msgid "For documentation do:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:655 -#, no-wrap -msgid "" -" $ python\n" -" >>> import guestfs\n" -" >>> help (guestfs)\n" -"\n" +#. type: textblock +#: ../src/guestfs.pod:750 +msgid "See L." msgstr "" # type: =item -#: ../src/guestfs.pod:659 +#. type: =item +#: ../src/guestfs.pod:752 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:661 -msgid "" -"Use the Guestfs module. There is no Ruby-specific documentation, but you " -"can find examples written in Ruby in the libguestfs source." +#. type: textblock +#: ../src/guestfs.pod:754 +msgid "See L." msgstr "" # type: =item -#: ../src/guestfs.pod:664 +#. type: =item +#: ../src/guestfs.pod:756 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:666 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:758 +msgid "See L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:670 +#. type: =head2 +#: ../src/guestfs.pod:762 msgid "LIBGUESTFS GOTCHAS" msgstr "" # type: textblock -#: ../src/guestfs.pod:672 +#. type: textblock +#: ../src/guestfs.pod:764 msgid "" "L: \"A feature of a " "system [...] that works in the way it is documented but is counterintuitive " @@ -1422,7 +1766,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:676 +#. 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 " @@ -1431,12 +1776,21 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:684 +#. type: =item +#: ../src/guestfs.pod:776 msgid "Autosync / forgetting to sync." msgstr "" +#. 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:686 +#. 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 " @@ -1444,7 +1798,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:690 +#. type: verbatim +#: ../src/guestfs.pod:785 #, no-wrap msgid "" " guestfs_set_autosync (g, 1);\n" @@ -1452,14 +1807,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:692 +#. 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:696 +#. 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 " @@ -1467,27 +1824,23 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:700 +#. 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:704 -msgid "" -"Update: Autosync is enabled by default for all API users starting from " -"libguestfs 1.5.24." -msgstr "" - # type: =item -#: ../src/guestfs.pod:707 +#. type: =item +#: ../src/guestfs.pod:799 msgid "Mount option C<-o sync> should not be the default." msgstr "" # type: textblock -#: ../src/guestfs.pod:709 +#. 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 " @@ -1495,31 +1848,36 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:713 +#. 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:716 +#. type: =item +#: ../src/guestfs.pod:808 msgid "Read-only should be the default." msgstr "" # type: textblock -#: ../src/guestfs.pod:718 +#. 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:721 +#. type: textblock +#: ../src/guestfs.pod:813 msgid "This would reduce the potential to corrupt live VM images." msgstr "" # type: textblock -#: ../src/guestfs.pod:723 +#. 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 doesn't do what people expect (open C for " "examination). It tries to run a guestfish command C which doesn't " @@ -1542,12 +1902,14 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:736 +#. type: =item +#: ../src/guestfs.pod:828 msgid "guestfish megabyte modifiers don't work right on all commands" msgstr "" # type: textblock -#: ../src/guestfs.pod:738 +#. 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 " @@ -1557,12 +1919,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:745 +#. type: textblock +#: ../src/guestfs.pod:837 msgid "The most common is L. The guestfish command:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:747 +#. type: verbatim +#: ../src/guestfs.pod:839 #, no-wrap msgid "" " lvcreate LV VG 100M\n" @@ -1570,7 +1934,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:749 +#. 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 " @@ -1579,40 +1944,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:754 +#. 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:757 -msgid "Library should return errno with error messages." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:759 -msgid "" -"It would be a nice-to-have to be able to get the original value of 'errno' " -"from inside the appliance along error paths (where set). Currently " -"L goes through hoops to try to reverse the error message " -"string into an errno, see the function error() in fuse/guestmount.c." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:765 -msgid "" -"In libguestfs 1.5.4, the protocol was changed so that the Linux errno is " -"sent back from the daemon." -msgstr "" - -# type: =item -#: ../src/guestfs.pod:768 +#. type: =item +#: ../src/guestfs.pod:849 msgid "Ambiguity between devices and paths" msgstr "" # type: textblock -#: ../src/guestfs.pod:770 +#. 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 " @@ -1620,7 +1967,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:775 +#. 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. " @@ -1629,7 +1977,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:781 +#. 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 " @@ -1639,7 +1988,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:787 +#. type: verbatim +#: ../src/guestfs.pod:868 #, no-wrap msgid "" " type path = Path of string | Device of int | Partition of int * int\n" @@ -1647,12 +1997,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:789 +#. type: textblock +#: ../src/guestfs.pod:870 msgid "which would allow you to pass arguments like:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:791 +#. type: verbatim +#: ../src/guestfs.pod:872 #, no-wrap msgid "" " Path \"/foo/bar\"\n" @@ -1663,66 +2015,30 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:796 +#. 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:801 -msgid "PROTOCOL LIMITS" +#. type: =head2 +#: ../src/guestfs.pod:882 +msgid "KEYS AND PASSPHRASES" msgstr "" # type: textblock -#: ../src/guestfs.pod:803 +#. type: textblock +#: ../src/guestfs.pod:884 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." +"Certain libguestfs calls take a parameter that contains sensitive key " +"material, passed in as a C string." msgstr "" # type: textblock -#: ../src/guestfs.pod:811 -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:817 -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:821 -msgid "" -"You might also consider mounting the disk image using our FUSE filesystem " -"support (L)." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:824 -msgid "KEYS AND PASSPHRASES" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:826 -msgid "" -"Certain libguestfs calls take a parameter that contains sensitive key " -"material, passed in as a C string." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:829 +#. 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 " @@ -1731,7 +2047,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:834 +#. 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, " @@ -1739,25210 +2056,31348 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:839 -msgid "CONNECTION MANAGEMENT" +#. type: =head2 +#: ../src/guestfs.pod:897 +msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:841 -msgid "guestfs_h *" +# type: textblock +#. 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:843 +#. type: textblock +#: ../src/guestfs.pod:902 msgid "" -"C is the opaque type representing a connection handle. Create a " -"handle by calling L. Call L to free the " -"handle and release all resources used." +"Only use the handle from a single thread. Either use the handle exclusively " +"from one thread, or provide your own mutex so that two threads cannot issue " +"calls on the same handle at the same time." msgstr "" # type: textblock -#: ../src/guestfs.pod:847 +#. type: textblock +#: ../src/guestfs.pod:906 msgid "" -"For information on using multiple handles and threads, see the section L below." +"See the graphical program guestfs-browser for one possible architecture for " +"multithreaded programs using libvirt and libguestfs." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:850 -msgid "guestfs_create" +# type: =head1 +#. type: =head2 +#: ../src/guestfs.pod:909 +msgid "PATH" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:852 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:911 msgid "" -" guestfs_h *guestfs_create (void);\n" -"\n" +"Libguestfs needs a supermin appliance, which it finds by looking along an " +"internal path." msgstr "" # type: textblock -#: ../src/guestfs.pod:854 -msgid "Create a connection handle." +#. 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:856 +#. type: textblock +#: ../src/guestfs.pod:917 msgid "" -"You have to call L (or one of the equivalent calls) " -"on the handle at least once." +"Use L or set the environment variable L " +"to change the directories that libguestfs will search in. The value is a " +"colon-separated list of paths. The current directory is I searched " +"unless the path contains an empty element or C<.>. For example " +"C would search the current directory and " +"then C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:859 -msgid "" -"This function returns a non-NULL pointer to a handle on success or NULL on " -"error." +# type: =head1 +#. type: =head2 +#: ../src/guestfs.pod:924 +msgid "QEMU WRAPPERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:862 -msgid "After configuring the handle, you have to call L." +#. 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:864 +#. type: textblock +#: ../src/guestfs.pod:930 msgid "" -"You may also want to configure error handling for the handle. See L section below." +"There is one important rule to remember: you I> as the " +"last command in the shell script (so that qemu replaces the shell and " +"becomes the direct child of the libguestfs-using program). If you don't do " +"this, then the qemu process won't be cleaned up correctly." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:867 -msgid "guestfs_close" +# type: textblock +#. 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:869 +#. type: verbatim +#: ../src/guestfs.pod:938 #, no-wrap msgid "" -" void guestfs_close (guestfs_h *g);\n" +" #!/bin/sh -\n" +" qemudir=/home/rjones/d/qemu\n" +" exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:871 -msgid "This closes the connection handle and frees up all resources used." +#. 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: =head1 -#: ../src/guestfs.pod:873 -msgid "ERROR HANDLING" +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:946 +#, no-wrap +msgid "" +" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:875 +#. type: textblock +#: ../src/guestfs.pod:948 msgid "" -"The convention in all functions that return C is that they return C<-1> " -"to indicate an error. You can get additional information on errors by " -"calling L and/or by setting up an error handler with L." +"Note that libguestfs also calls qemu with the -help and -version options in " +"order to determine features." msgstr "" -# type: textblock -#: ../src/guestfs.pod:880 -msgid "The default error handler prints the information string to C." +#. type: =head2 +#: ../src/guestfs.pod:951 +msgid "ATTACHING TO RUNNING DAEMONS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:882 +#. type: textblock +#: ../src/guestfs.pod:953 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." +"I This is B and has a tendency to eat " +"babies. Use with caution." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:886 -msgid "guestfs_last_error" +#. 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: verbatim -#: ../src/guestfs.pod:888 -#, no-wrap +#. type: =head3 +#: ../src/guestfs.pod:960 +msgid "Using guestfs_set_attach_method" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:962 msgid "" -" const char *guestfs_last_error (guestfs_h *g);\n" -"\n" +"By calling L you can change how the library " +"connects to the C daemon in L (read L for some background)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:890 +#. type: textblock +#: ../src/guestfs.pod:966 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." +"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:894 +#. type: textblock +#: ../src/guestfs.pod:969 msgid "" -"The lifetime of the returned string is until the next error occurs, or L is called." +"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:897 +#. type: textblock +#: ../src/guestfs.pod:973 msgid "" -"The error string is not localized (ie. is always in English), because this " -"makes searching for error messages in search engines give the largest number " -"of results." +"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: =head2 -#: ../src/guestfs.pod:901 -msgid "guestfs_set_error_handler" +#. type: =head3 +#: ../src/guestfs.pod:977 +msgid "Using guestfs_add_domain with live flag" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:903 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:979 msgid "" -" typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" -" void *opaque,\n" -" const char *msg);\n" -" void guestfs_set_error_handler (guestfs_h *g,\n" -" guestfs_error_handler_cb cb,\n" -" void *opaque);\n" -"\n" +"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: textblock -#: ../src/guestfs.pod:910 +#. type: verbatim +#: ../src/guestfs.pod:985 +#, no-wrap 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." +" \n" +" ...\n" +" \n" +" ...\n" +" \n" +" \n" +" \n" +" \n" +" ...\n" +" \n" +" \n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:914 +#. type: textblock +#: ../src/guestfs.pod:997 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." +"L extracts C and sets the attach " +"method to C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:918 -msgid "The default handler prints messages on C." +#. 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:920 -msgid "If you set C to C then I handler is called." +#. 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:922 -msgid "guestfs_get_error_handler" +#. type: =head2 +#: ../src/guestfs.pod:1008 +msgid "ABI GUARANTEE" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:924 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1010 msgid "" -" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" -" void **opaque_rtn);\n" -"\n" +"We guarantee the libguestfs ABI (binary interface), for public, high-level " +"actions as outlined in this section. Although we will deprecate some " +"actions, for example if they get replaced by newer calls, we will keep the " +"old actions forever. This allows you the developer to program in confidence " +"against the libguestfs API." msgstr "" -# type: textblock -#: ../src/guestfs.pod:927 -msgid "Returns the current error handler callback." +# type: =head1 +#. type: =head2 +#: ../src/guestfs.pod:1016 +msgid "BLOCK DEVICE NAMING" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:929 -msgid "guestfs_set_out_of_memory_handler" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1018 +msgid "" +"In the kernel there is now quite a profusion of schemata for naming block " +"devices (in this context, by I I mean a physical or virtual " +"hard drive). The original Linux IDE driver used names starting with C. SCSI devices have historically used a different naming scheme, C. When the Linux kernel I driver became a popular replacement " +"for the old IDE driver (particularly for SATA devices) those devices also " +"used the C scheme. Additionally we now have virtual machines with " +"paravirtualized drivers. This has created several different naming systems, " +"such as C for virtio disks and C for Xen PV disks." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:931 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1030 msgid "" -" typedef void (*guestfs_abort_cb) (void);\n" -" int guestfs_set_out_of_memory_handler (guestfs_h *g,\n" -" guestfs_abort_cb);\n" -"\n" +"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:935 +#. type: textblock +#: ../src/guestfs.pod:1034 msgid "" -"The callback C will be called if there is an out of memory situation. " -"I." +"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:938 -msgid "The default is to call L." +#. 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 " +"required. For example, under RHEL 5 which uses the C scheme, any " +"device parameter C is translated to C transparently." msgstr "" # type: textblock -#: ../src/guestfs.pod:940 +#. type: textblock +#: ../src/guestfs.pod:1045 msgid "" -"You cannot set C to C. You can't ignore out of memory situations." +"Note that this I applies to parameters. The L, " +"L and similar calls return the true names of the " +"devices and partitions as known to the appliance." msgstr "" # type: =head2 -#: ../src/guestfs.pod:943 -msgid "guestfs_get_out_of_memory_handler" +#. type: =head3 +#: ../src/guestfs.pod:1050 +msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:945 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1052 msgid "" -" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" -"\n" +"Usually this translation is transparent. However in some (very rare) cases " +"you may need to know the exact algorithm. Such cases include where you use " +"L to add a mixture of virtio and IDE devices to the qemu-" +"based appliance, so have a mixture of C and C devices." msgstr "" # type: textblock -#: ../src/guestfs.pod:947 -msgid "This returns the current out of memory handler." +#. 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: =head1 -#: ../src/guestfs.pod:949 -msgid "PATH" +# type: textblock +#. 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:951 -msgid "" -"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " -"internal path." +#. type: textblock +#: ../src/guestfs.pod:1070 +msgid "Does the string begin with C?" msgstr "" # type: textblock -#: ../src/guestfs.pod:954 +#. type: textblock +#: ../src/guestfs.pod:1074 msgid "" -"By default it looks for these in the directory C<$libdir/guestfs> (eg. C or C)." +"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:957 -msgid "" -"Use L or set the environment variable L " -"to change the directories that libguestfs will search in. The value is a " -"colon-separated list of paths. The current directory is I searched " -"unless the path contains an empty element or C<.>. For example " -"C would search the current directory and " -"then C." +#. type: textblock +#: ../src/guestfs.pod:1079 +msgid "Replace initial C string with C." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:964 -msgid "HIGH-LEVEL API ACTIONS" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1081 +msgid "For example, change C to C." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:966 -msgid "ABI GUARANTEE" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1083 +msgid "If that named device exists, use it. If not, continue." msgstr "" # type: textblock -#: ../src/guestfs.pod:968 -msgid "" -"We guarantee the libguestfs ABI (binary interface), for public, high-level " -"actions as outlined in this section. Although we will deprecate some " -"actions, for example if they get replaced by newer calls, we will keep the " -"old actions forever. This allows you the developer to program in confidence " -"against the libguestfs API." +#. type: textblock +#: ../src/guestfs.pod:1087 +msgid "Replace initial C string with C." msgstr "" # type: textblock -#: ../src/guestfs.pod:974 ../fish/guestfish.pod:860 -msgid "@ACTIONS@" +#. type: textblock +#: ../src/guestfs.pod:1089 +msgid "If that named device exists, use it. If not, return an error." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:976 -msgid "STRUCTURES" +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:1093 +msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING" msgstr "" # type: textblock -#: ../src/guestfs.pod:978 -msgid "@STRUCTS@" +#. 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: =head1 -#: ../src/guestfs.pod:980 -msgid "AVAILABILITY" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1099 +msgid "" +"Where possible for maximum future portability programs using libguestfs " +"should use these future-proof techniques:" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:982 -msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" +# type: textblock +#. 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:984 +#. type: textblock +#: ../src/guestfs.pod:1109 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." +"Since those device names exist by definition, they will never be translated." msgstr "" # type: textblock -#: ../src/guestfs.pod:989 -msgid "@AVAILABILITY@" +#. type: textblock +#: ../src/guestfs.pod:1114 +msgid "" +"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " +"filesystem labels." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:991 -msgid "GUESTFISH supported COMMAND" +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1119 +msgid "SECURITY" msgstr "" # type: textblock -#: ../src/guestfs.pod:993 +#. type: textblock +#: ../src/guestfs.pod:1121 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." +"This section discusses security implications of using libguestfs, " +"particularly with untrusted or malicious guests or disk images." msgstr "" # type: =head2 -#: ../src/guestfs.pod:998 -msgid "SINGLE CALLS AT COMPILE TIME" +#. type: =head2 +#: ../src/guestfs.pod:1124 +msgid "GENERAL SECURITY CONSIDERATIONS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1000 +#. type: textblock +#: ../src/guestfs.pod:1126 msgid "" -"Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " -"function, such as:" +"Be careful with any files or data that you download from a guest (by " +"\"download\" we mean not just the L command but any " +"command that reads files, filenames, directories or anything else from a " +"disk image). An attacker could manipulate the data to fool your program " +"into doing the wrong thing. Consider cases such as:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1003 -#, no-wrap -msgid "" -" #define LIBGUESTFS_HAVE_DD 1\n" -"\n" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1136 +msgid "the data (file etc) not being present" msgstr "" # type: textblock -#: ../src/guestfs.pod:1005 -msgid "if L is available." +#. type: textblock +#: ../src/guestfs.pod:1140 +msgid "being present but empty" msgstr "" # type: textblock -#: ../src/guestfs.pod:1007 -msgid "" -"Before version 1.5.8, if you needed to test whether a single libguestfs " -"function is available at compile time, we recommended using build tools such " -"as autoconf or cmake. For example in autotools you could use:" +#. type: textblock +#: ../src/guestfs.pod:1144 +msgid "being much larger than normal" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1012 -#, no-wrap -msgid "" -" AC_CHECK_LIB([guestfs],[guestfs_create])\n" -" AC_CHECK_FUNCS([guestfs_dd])\n" -"\n" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1148 +msgid "containing arbitrary 8 bit data" msgstr "" # type: textblock -#: ../src/guestfs.pod:1015 -msgid "" -"which would result in C being either defined or not defined " -"in your program." +#. type: textblock +#: ../src/guestfs.pod:1152 +msgid "being in an unexpected character encoding" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1156 +msgid "containing homoglyphs." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1018 -msgid "SINGLE CALLS AT RUN TIME" +#. type: =head2 +#: ../src/guestfs.pod:1160 +msgid "SECURITY OF MOUNTING FILESYSTEMS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1020 +#. type: textblock +#: ../src/guestfs.pod:1162 msgid "" -"Testing at compile time doesn't guarantee that a function really exists in " -"the library. The reason is that you might be dynamically linked against a " -"previous I (dynamic library) which doesn't have the call. " -"This situation unfortunately results in a segmentation fault, which is a " -"shortcoming of the C dynamic linking system itself." +"When you mount a filesystem under Linux, mistakes in the kernel filesystem " +"(VFS) module can sometimes be escalated into exploits by deliberately " +"creating a malicious, malformed filesystem. These exploits are very severe " +"for two reasons. Firstly there are very many filesystem drivers in the " +"kernel, and many of them are infrequently used and not much developer " +"attention has been paid to the code. Linux userspace helps potential " +"crackers by detecting the filesystem type and automatically choosing the " +"right VFS driver, even if that filesystem type is obscure or unexpected for " +"the administrator. Secondly, a kernel-level exploit is like a local root " +"exploit (worse in some ways), giving immediate and total access to the " +"system right down to the hardware level." msgstr "" # type: textblock -#: ../src/guestfs.pod:1027 +#. type: textblock +#: ../src/guestfs.pod:1175 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):" +"That explains why you should never mount a filesystem from an untrusted " +"guest on your host kernel. How about libguestfs? We run a Linux kernel " +"inside a qemu virtual machine, usually running as a non-root user. The " +"attacker would need to write a filesystem which first exploited the kernel, " +"and then exploited either qemu virtualization (eg. a faulty qemu driver) or " +"the libguestfs protocol, and finally to be as serious as the host kernel " +"exploit it would need to escalate its privileges to root. This multi-step " +"escalation, performed by a static piece of data, is thought to be extremely " +"hard to do, although we never say 'never' about security issues." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1031 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1186 msgid "" -" #include \n" -" #include \n" -" #include \n" -" #include \n" -" #include \n" -" \n" +"In any case callers can reduce the attack surface by forcing the filesystem " +"type when mounting (use L)." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1037 -#, no-wrap -msgid "" -" main ()\n" -" {\n" -" #ifdef LIBGUESTFS_HAVE_DD\n" -" void *dl;\n" -" int has_function;\n" -" \n" +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1189 +msgid "PROTOCOL SECURITY" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1043 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1191 msgid "" -" /* Test if the function guestfs_dd is really available. */\n" -" dl = dlopen (NULL, RTLD_LAZY);\n" -" if (!dl) {\n" -" fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n" -" exit (EXIT_FAILURE);\n" -" }\n" -" has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n" -" dlclose (dl);\n" -" \n" +"The protocol is designed to be secure, being based on RFC 4506 (XDR) with a " +"defined upper message size. However a program that uses libguestfs must " +"also take care - for example you can write a program that downloads a binary " +"from a disk image and executes it locally, and no amount of protocol " +"security will save you from the consequences." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1052 -#, no-wrap +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1197 +msgid "INSPECTION SECURITY" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1199 msgid "" -" if (!has_function)\n" -" printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n" -" else {\n" -" printf (\"this libguestfs.so has guestfs_dd function\\n\");\n" -" /* Now it's safe to call\n" -" guestfs_dd (g, \"foo\", \"bar\");\n" -" */\n" -" }\n" -" #else\n" -" printf (\"guestfs_dd function was not found at compile time\\n\");\n" -" #endif\n" -" }\n" -"\n" +"Parts of the inspection API (see L) return untrusted strings " +"directly from the guest, and these could contain any 8 bit data. Callers " +"should be careful to escape these before printing them to a structured file " +"(for example, use HTML escaping if creating a web page)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1065 +#. type: textblock +#: ../src/guestfs.pod:1205 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:" +"Guest configuration may be altered in unusual ways by the administrator of " +"the virtual machine, and may not reflect reality (particularly for untrusted " +"or actively malicious guests). For example we parse the hostname from " +"configuration files like C that we find in the " +"guest, but the guest administrator can easily manipulate these files to " +"provide the wrong hostname." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1070 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1213 msgid "" -" Requires: libguestfs >= 1.0.80\n" -"\n" +"The inspection API parses guest configuration using two external libraries: " +"Augeas (Linux configuration) and hivex (Windows Registry). Both are " +"designed to be robust in the face of malicious data, although denial of " +"service attacks are still possible, for example with oversized configuration " +"files." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1072 -msgid "CALLS WITH OPTIONAL ARGUMENTS" +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1219 +msgid "RUNNING UNTRUSTED GUEST COMMANDS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1074 +#. type: textblock +#: ../src/guestfs.pod:1221 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:" +"Be very cautious about running commands from the guest. By running a " +"command in the guest, you are giving CPU time to a binary that you do not " +"control, under the same user account as the library, albeit wrapped in qemu " +"virtualization. More information and alternatives can be found in the " +"section L." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1079 -#, no-wrap +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1227 +msgid "CVE-2010-3851" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1229 +msgid "https://bugzilla.redhat.com/642934" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1231 msgid "" -" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" -"\n" +"This security bug concerns the automatic disk format detection that qemu " +"does on disk images." msgstr "" # type: textblock -#: ../src/guestfs.pod:1081 +#. type: textblock +#: ../src/guestfs.pod:1234 msgid "" -"Call this with a list of optional arguments, terminated by C<-1>. So to " -"call with no optional arguments specified:" +"A raw disk image is just the raw bytes, there is no header. Other disk " +"images like qcow2 contain a special header. Qemu deals with this by looking " +"for one of the known headers, and if none is found then assuming the disk " +"image must be raw." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1084 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1239 msgid "" -" guestfs_add_drive_opts (g, filename, -1);\n" -"\n" +"This allows a guest which has been given a raw disk image to write some " +"other header. At next boot (or when the disk image is accessed by " +"libguestfs) qemu would do autodetection and think the disk image format was, " +"say, qcow2 based on the header written by the guest." msgstr "" # type: textblock -#: ../src/guestfs.pod:1086 -msgid "With a single optional argument:" +#. 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 " +"\"backing disk\"). It does this by placing the path to the backing disk " +"into the qcow2 header. This path is not validated and could point to any " +"host file (eg. \"/etc/passwd\"). The backing disk is then exposed through " +"\"holes\" in the qcow2 disk image, which of course is completely under the " +"control of the attacker." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1088 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1252 msgid "" -" guestfs_add_drive_opts (g, filename,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" -" -1);\n" -"\n" +"In libguestfs this is rather hard to exploit except under two circumstances:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1092 -msgid "With two:" +#. type: textblock +#: ../src/guestfs.pod:1259 +msgid "You have enabled the network or have opened the disk in write mode." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1094 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1263 msgid "" -" guestfs_add_drive_opts (g, filename,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" -" GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n" -" -1);\n" -"\n" +"You are also running untrusted code from the guest (see L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1099 +#. type: textblock +#: ../src/guestfs.pod:1268 msgid "" -"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " -"happen!" +"The way to avoid this is to specify the expected disk format when adding " +"disks (the optional C option to L). You " +"should always do this if the disk is raw format, and it's a good idea for " +"other cases too." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1102 -msgid "USING va_list FOR OPTIONAL ARGUMENTS" +# type: textblock +#. 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:1104 +#. type: textblock +#: ../src/guestfs.pod:1276 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:" +"For libguestfs tools, use the I<--format> command line parameter as " +"appropriate." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1108 -#, no-wrap -msgid "" -" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" -" va_list args);\n" -"\n" +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1279 +msgid "CONNECTION MANAGEMENT" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1111 -msgid "CONSTRUCTING OPTIONAL ARGUMENTS" +#. type: =head2 +#: ../src/guestfs.pod:1281 +msgid "guestfs_h *" msgstr "" # type: textblock -#: ../src/guestfs.pod:1113 +#. type: textblock +#: ../src/guestfs.pod:1283 msgid "" -"The third variant is useful where you need to construct these calls. You " -"pass in a structure where you fill in the optional fields. The structure " -"has a bitmask as the first element which you must set to indicate which " -"fields you have filled in. For our example function the structure and call " -"are declared:" +"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: verbatim -#: ../src/guestfs.pod:1119 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1287 msgid "" -" struct guestfs_add_drive_opts_argv {\n" -" uint64_t bitmask;\n" -" int readonly;\n" -" const char *format;\n" -" /* ... */\n" -" };\n" -" int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n" -" const struct guestfs_add_drive_opts_argv *optargs);\n" -"\n" +"For information on using multiple handles and threads, see the section L above." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1128 -msgid "You could call it like this:" +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1290 +msgid "guestfs_create" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1130 +#. type: verbatim +#: ../src/guestfs.pod:1292 #, no-wrap msgid "" -" struct guestfs_add_drive_opts_argv optargs = {\n" -" .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n" -" .readonly = 1,\n" -" .format = \"qcow2\"\n" -" };\n" -" \n" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:1137 -#, no-wrap -msgid "" -" guestfs_add_drive_opts_argv (g, filename, &optargs);\n" +" guestfs_h *guestfs_create (void);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1139 ../src/guestfs-actions.pod:10 -#: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:9 -#: ../fish/guestfish-actions.pod:1244 -msgid "Notes:" +#. type: textblock +#: ../src/guestfs.pod:1294 +msgid "Create a connection handle." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1145 -msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." +#. type: textblock +#: ../src/guestfs.pod:1296 +msgid "" +"On success this returns a non-NULL pointer to a handle. On error it returns " +"NULL." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1150 -msgid "You do not need to fill in all fields of the structure." +#. type: textblock +#: ../src/guestfs.pod:1299 +msgid "" +"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:1154 +#. type: textblock +#: ../src/guestfs.pod:1303 +msgid "After configuring the handle, you have to call L." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1305 msgid "" -"There must be a one-to-one correspondence between fields of the structure " -"that are filled in, and bits set in the bitmask." +"You may also want to configure error handling for the handle. See the L section below." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1159 -msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" +#. type: =head2 +#: ../src/guestfs.pod:1308 +msgid "guestfs_close" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1161 +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1310 +#, no-wrap 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." +" void guestfs_close (guestfs_h *g);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1165 -msgid "For guestfish, see L." +#. type: textblock +#: ../src/guestfs.pod:1312 +msgid "This closes the connection handle and frees up all resources used." msgstr "" -# type: =end -#: ../src/guestfs.pod:1167 ../src/guestfs.pod:1172 -msgid "html" +#. 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 +#. type: =head1 +#: ../src/guestfs.pod:1320 +msgid "ERROR HANDLING" msgstr "" # type: textblock -#: ../src/guestfs.pod:1169 +#. 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: =head1 -#: ../src/guestfs.pod:1174 -msgid "ARCHITECTURE" +# type: textblock +#. 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:1176 +#. type: textblock +#: ../src/guestfs.pod:1329 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." +"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 +#. 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:1180 +#. type: verbatim +#: ../src/guestfs.pod:1338 #, no-wrap msgid "" -" ___________________\n" -" / \\\n" -" | main program |\n" -" | |\n" -" | | child process / appliance\n" -" | | __________________________\n" -" | | / qemu \\\n" -" +-------------------+ RPC | +-----------------+ |\n" -" | libguestfs <--------------------> guestfsd | |\n" -" | | | +-----------------+ |\n" -" \\___________________/ | | Linux kernel | |\n" -" | +--^--------------+ |\n" -" \\_________|________________/\n" -" |\n" -" _______v______\n" -" / \\\n" -" | Device or |\n" -" | disk image |\n" -" \\______________/\n" +" if (guestfs_launch (g) == -1)\n" +" exit (EXIT_FAILURE);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1200 +#. type: textblock +#: ../src/guestfs.pod:1341 msgid "" -"The library, linked to the main program, creates the child process and hence " -"the appliance in the L function." +"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:1203 +#. type: textblock +#: ../src/guestfs.pod:1344 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." +"For other programs the caller will almost certainly want to install an " +"alternate error handler or do error handling in-line like this:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1212 +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1347 +#, no-wrap 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)." +" g = guestfs_create ();\n" +" \n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1219 -msgid "STATE MACHINE" +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1349 +#, no-wrap +msgid "" +" /* This disables the default behaviour of printing errors\n" +" on stderr. */\n" +" guestfs_set_error_handler (g, NULL, NULL);\n" +" \n" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1353 +#, no-wrap +msgid "" +" if (guestfs_launch (g) == -1) {\n" +" /* Examine the error message and print it etc. */\n" +" char *msg = guestfs_last_error (g);\n" +" int errnum = guestfs_last_errno (g);\n" +" fprintf (stderr, \"%s\\n\", msg);\n" +" /* ... */\n" +" }\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1221 -msgid "libguestfs uses a state machine to model the child process:" +#. 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 +#. type: textblock +#: ../src/guestfs.pod:1365 +msgid "" +"L returns C if the handle cannot be created, and " +"because there is no handle if this happens there is no way to get additional " +"error information. However L is supposed to be a " +"lightweight operation which can only fail because of insufficient memory (it " +"returns NULL in this case)." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1371 +msgid "guestfs_last_error" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1223 +#. type: verbatim +#: ../src/guestfs.pod:1373 #, 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" +" const char *guestfs_last_error (guestfs_h *g);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1245 +#. type: textblock +#: ../src/guestfs.pod:1375 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." +"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:1250 +#. type: textblock +#: ../src/guestfs.pod:1379 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." +"The lifetime of the returned string is until the next error occurs, or L is called." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1254 +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1382 +msgid "guestfs_last_errno" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1384 +#, no-wrap msgid "" -"Configuration commands for qemu such as L can only be " -"issued when in the CONFIG state." +" int guestfs_last_errno (guestfs_h *g);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1257 -msgid "" -"The API offers one call that goes from CONFIG through LAUNCHING to READY. " -"L blocks until the child process is READY to accept " -"commands (or until some failure or timeout). L internally " -"moves the state from CONFIG to LAUNCHING while it is running." +#. type: textblock +#: ../src/guestfs.pod:1386 +msgid "This returns the last error number (errno) that happened on C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1263 -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." +#. type: textblock +#: ../src/guestfs.pod:1388 +msgid "If successful, an errno integer not equal to zero is returned." msgstr "" # type: textblock -#: ../src/guestfs.pod:1269 +#. type: textblock +#: ../src/guestfs.pod:1390 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." +"If no error, this returns 0. This call can return 0 in three situations:" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1273 -msgid "SETTING CALLBACKS TO HANDLE EVENTS" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1397 +msgid "There has not been any error on the handle." msgstr "" # type: textblock -#: ../src/guestfs.pod:1275 +#. type: textblock +#: ../src/guestfs.pod:1401 msgid "" -"The child process generates events in some situations. Current events " -"include: receiving a log message, the child process exits." +"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:1278 +#. type: textblock +#: ../src/guestfs.pod:1407 msgid "" -"Use the C functions to set a callback for different " -"types of events." +"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:1281 +#. type: textblock +#: ../src/guestfs.pod:1413 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." +"Libguestfs tries to convert the errno from inside the applicance into a " +"corresponding errno for the caller (not entirely trivial: the appliance " +"might be running a completely different operating system from the library " +"and error numbers are not standardized across Un*xen). If this could not be " +"done, then the error is translated to C. In practice this should " +"only happen in very rare circumstances." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1286 -msgid "guestfs_set_log_message_callback" +#. type: =head2 +#: ../src/guestfs.pod:1421 +msgid "guestfs_set_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1288 +#. type: verbatim +#: ../src/guestfs.pod:1423 #, no-wrap msgid "" -" typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n" -" char *buf, int len);\n" -" void guestfs_set_log_message_callback (guestfs_h *g,\n" -" guestfs_log_message_cb cb,\n" -" void *opaque);\n" +" typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" +" void *opaque,\n" +" const char *msg);\n" +" void guestfs_set_error_handler (guestfs_h *g,\n" +" guestfs_error_handler_cb cb,\n" +" void *opaque);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1294 +#. type: textblock +#: ../src/guestfs.pod:1430 msgid "" -"The callback function C will be called whenever qemu or the guest writes " -"anything to the console." +"The callback C will be called if there is an error. The parameters " +"passed to the callback are an opaque data pointer and the error message " +"string." msgstr "" # type: textblock -#: ../src/guestfs.pod:1297 -msgid "Use this function to capture kernel messages and similar." +#. 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:1299 +#. type: textblock +#: ../src/guestfs.pod:1437 msgid "" -"Normally there is no log message handler, and log messages are just " -"discarded." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1302 -msgid "guestfs_set_subprocess_quit_callback" +"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: verbatim -#: ../src/guestfs.pod:1304 -#, no-wrap -msgid "" -" typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n" -" void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n" -" guestfs_subprocess_quit_cb cb,\n" -" void *opaque);\n" -"\n" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1441 +msgid "The default handler prints messages on C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1309 -msgid "" -"The callback function C will be called when the child process quits, " -"either asynchronously or if killed by L. (This " -"corresponds to a transition from any state to the CONFIG state)." +#. type: textblock +#: ../src/guestfs.pod:1443 +msgid "If you set C to C then I handler is called." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1314 -msgid "guestfs_set_launch_done_callback" +#. type: =head2 +#: ../src/guestfs.pod:1445 +msgid "guestfs_get_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1316 +#. type: verbatim +#: ../src/guestfs.pod:1447 #, 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" +" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" +" void **opaque_rtn);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1321 -msgid "" -"The callback function C will be called when the child process becomes " -"ready first time after it has been launched. (This corresponds to a " -"transition from LAUNCHING to the READY state)." +#. type: textblock +#: ../src/guestfs.pod:1450 +msgid "Returns the current error handler callback." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1325 -msgid "guestfs_set_close_callback" +#. type: =head2 +#: ../src/guestfs.pod:1452 +msgid "guestfs_set_out_of_memory_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1327 +#. type: verbatim +#: ../src/guestfs.pod:1454 #, 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" +" typedef void (*guestfs_abort_cb) (void);\n" +" int guestfs_set_out_of_memory_handler (guestfs_h *g,\n" +" guestfs_abort_cb);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1332 +#. type: textblock +#: ../src/guestfs.pod:1458 msgid "" -"The callback function C will be called while the handle is being closed " -"(synchronously from L)." +"The callback C will be called if there is an out of memory situation. " +"I." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1461 +msgid "The default is to call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1335 +#. type: textblock +#: ../src/guestfs.pod:1463 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)." +"You cannot set C to C. You can't ignore out of memory situations." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1343 -msgid "guestfs_set_progress_callback" +#. type: =head2 +#: ../src/guestfs.pod:1466 +msgid "guestfs_get_out_of_memory_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1345 +#. type: verbatim +#: ../src/guestfs.pod:1468 #, 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" +" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1352 -msgid "" -"Some long-running operations can generate progress messages. If this " -"callback is registered, then it will be called each time a progress message " -"is generated (usually two seconds after the operation started, and three " -"times per second thereafter until it completes, although the frequency may " -"change in future versions)." +#. type: textblock +#: ../src/guestfs.pod:1470 +msgid "This returns the current out of memory handler." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1358 -msgid "" -"The callback receives two numbers: C and C. The units of " -"C are not defined, although for some operations C may relate " -"in some way to the amount of data to be transferred (eg. in bytes or " -"megabytes), and C may be the portion which has been transferred." +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1472 +msgid "API CALLS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1364 -msgid "The only defined and stable parts of the API are:" +#. type: textblock +#: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1010 +msgid "@ACTIONS@" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1370 -msgid "" -"The callback can display to the user some type of progress bar or indicator " -"which shows the ratio of C:C." +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1476 +msgid "STRUCTURES" msgstr "" # type: textblock -#: ../src/guestfs.pod:1375 -msgid "0 E= C E= C" +#. type: textblock +#: ../src/guestfs.pod:1478 +msgid "@STRUCTS@" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1379 -msgid "" -"If any progress notification is sent during a call, then a final progress " -"notification is always sent when C = C." +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1480 +msgid "AVAILABILITY" +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1482 +msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1382 +#. type: textblock +#: ../src/guestfs.pod:1484 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." +"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:1388 -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." +#. type: textblock +#: ../src/guestfs.pod:1489 +msgid "@AVAILABILITY@" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1393 -msgid "PRIVATE DATA AREA" +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1491 +msgid "GUESTFISH supported COMMAND" msgstr "" # type: textblock -#: ../src/guestfs.pod:1395 +#. type: textblock +#: ../src/guestfs.pod:1493 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." +"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 +#. type: =head2 +#: ../src/guestfs.pod:1498 +msgid "SINGLE CALLS AT COMPILE TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:1399 -msgid "To attach a named piece of data, use the following call:" +#. 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:1401 +#. type: verbatim +#: ../src/guestfs.pod:1503 #, no-wrap msgid "" -" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" +" #define LIBGUESTFS_HAVE_DD 1\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1403 -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." +#. type: textblock +#: ../src/guestfs.pod:1505 +msgid "if L is available." msgstr "" # type: textblock -#: ../src/guestfs.pod:1407 +#. type: textblock +#: ../src/guestfs.pod:1507 msgid "" -"You can use any C you want, but names beginning with an underscore " -"character are reserved for internal libguestfs purposes (for implementing " -"language bindings). It is recommended to prefix the name with some unique " -"string to avoid collisions with other users." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1412 -msgid "To retrieve the pointer, use:" +"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:1414 +#. type: verbatim +#: ../src/guestfs.pod:1512 #, no-wrap msgid "" -" void *guestfs_get_private (guestfs_h *g, const char *key);\n" +" AC_CHECK_LIB([guestfs],[guestfs_create])\n" +" AC_CHECK_FUNCS([guestfs_dd])\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1416 +#. type: textblock +#: ../src/guestfs.pod:1515 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." +"which would result in C being either defined or not defined " +"in your program." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1518 +msgid "SINGLE CALLS AT RUN TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:1420 +#. type: textblock +#: ../src/guestfs.pod:1520 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)." +"Testing at compile time doesn't guarantee that a function really exists in " +"the library. The reason is that you might be dynamically linked against a " +"previous I (dynamic library) which doesn't have the call. " +"This situation unfortunately results in a segmentation fault, which is a " +"shortcoming of the C dynamic linking system itself." msgstr "" # type: textblock -#: ../src/guestfs.pod:1428 +#. type: textblock +#: ../src/guestfs.pod:1527 msgid "" -"The private data area is implemented using a hash table, and should be " -"reasonably efficient for moderate numbers of keys." +"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: =head1 -#: ../src/guestfs.pod:1431 -msgid "BLOCK DEVICE NAMING" +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1531 +#, no-wrap +msgid "" +" #include \n" +" #include \n" +" #include \n" +" #include \n" +" #include \n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1433 +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1537 +#, no-wrap msgid "" -"In the kernel there is now quite a profusion of schemata for naming block " -"devices (in this context, by I I mean a physical or virtual " -"hard drive). The original Linux IDE driver used names starting with C. SCSI devices have historically used a different naming scheme, C. When the Linux kernel I driver became a popular replacement " -"for the old IDE driver (particularly for SATA devices) those devices also " -"used the C scheme. Additionally we now have virtual machines with " -"paravirtualized drivers. This has created several different naming systems, " -"such as C for virtio disks and C for Xen PV disks." +" main ()\n" +" {\n" +" #ifdef LIBGUESTFS_HAVE_DD\n" +" void *dl;\n" +" int has_function;\n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1445 +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1543 +#, no-wrap 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." +" /* Test if the function guestfs_dd is really available. */\n" +" dl = dlopen (NULL, RTLD_LAZY);\n" +" if (!dl) {\n" +" fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n" +" exit (EXIT_FAILURE);\n" +" }\n" +" has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n" +" dlclose (dl);\n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1449 +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1552 +#, no-wrap msgid "" -"This causes a problem for libguestfs because many API calls use device or " -"partition names. Working scripts and the recipe (example) scripts that we " -"make available over the internet could fail if the naming scheme changes." +" if (!has_function)\n" +" printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n" +" else {\n" +" printf (\"this libguestfs.so has guestfs_dd function\\n\");\n" +" /* Now it's safe to call\n" +" guestfs_dd (g, \"foo\", \"bar\");\n" +" */\n" +" }\n" +" #else\n" +" printf (\"guestfs_dd function was not found at compile time\\n\");\n" +" #endif\n" +" }\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1454 +#. type: textblock +#: ../src/guestfs.pod:1565 msgid "" -"Therefore libguestfs defines C as the I. " -"Internally C names are translated, if necessary, to other names as " -"required. For example, under RHEL 5 which uses the C scheme, any " -"device parameter C is translated to C transparently." +"You may think the above is an awful lot of hassle, and it is. There are " +"other ways outside of the C linking system to ensure that this kind of " +"incompatibility never arises, such as using package versioning:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1460 +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1570 +#, no-wrap msgid "" -"Note that this I applies to parameters. The L, " -"L and similar calls return the true names of the " -"devices and partitions as known to the appliance." +" Requires: libguestfs >= 1.0.80\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1465 -msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1572 +msgid "CALLS WITH OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1467 +#. type: textblock +#: ../src/guestfs.pod:1574 msgid "" -"Usually this translation is transparent. However in some (very rare) cases " -"you may need to know the exact algorithm. Such cases include where you use " -"L to add a mixture of virtio and IDE devices to the qemu-" -"based appliance, so have a mixture of C and C devices." +"A recent feature of the API is the introduction of calls which take optional " +"arguments. In C these are declared 3 ways. The main way is as a call which " +"takes variable arguments (ie. C<...>), as in this example:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1473 +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1579 +#, no-wrap 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:1481 -msgid "Is the string a parameter which is a device or partition name?" +" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1485 -msgid "Does the string begin with C?" +#. 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: textblock -#: ../src/guestfs.pod:1489 +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1584 +#, no-wrap msgid "" -"Does the named device exist? If so, we use that device. However if I " -"then we continue with this algorithm." +" guestfs_add_drive_opts (g, filename, -1);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1494 -msgid "Replace initial C string with C." +#. type: textblock +#: ../src/guestfs.pod:1586 +msgid "With a single optional argument:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1496 -msgid "For example, change C to C." +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1588 +#, no-wrap +msgid "" +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" +" -1);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1498 -msgid "If that named device exists, use it. If not, continue." +#. type: textblock +#: ../src/guestfs.pod:1592 +msgid "With two:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1502 -msgid "Replace initial C string with C." +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1594 +#, no-wrap +msgid "" +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" +" GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n" +" -1);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1504 -msgid "If that named device exists, use it. If not, return an error." +#. 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:1508 -msgid "PORTABILITY CONCERNS" +#. type: =head2 +#: ../src/guestfs.pod:1602 +msgid "USING va_list FOR OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1510 +#. type: textblock +#: ../src/guestfs.pod:1604 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." +"The second variant has the same name with the suffix C<_va>, which works the " +"same way but takes a C. See the C manual for details. For the " +"example function, this is declared:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1514 +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1608 +#, no-wrap msgid "" -"Where possible for maximum future portability programs using libguestfs " -"should use these future-proof techniques:" +" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" +" va_list args);\n" +"\n" +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1611 +msgid "CONSTRUCTING OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1521 +#. type: textblock +#: ../src/guestfs.pod:1613 msgid "" -"Use L or L to list actual " -"device names, and then use those names directly." +"The third variant is useful where you need to construct these calls. You " +"pass in a structure where you fill in the optional fields. The structure " +"has a bitmask as the first element which you must set to indicate which " +"fields you have filled in. For our example function the structure and call " +"are declared:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1524 +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1619 +#, no-wrap msgid "" -"Since those device names exist by definition, they will never be translated." +" struct guestfs_add_drive_opts_argv {\n" +" uint64_t bitmask;\n" +" int readonly;\n" +" const char *format;\n" +" /* ... */\n" +" };\n" +" int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n" +" const struct guestfs_add_drive_opts_argv *optargs);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1529 +#. type: textblock +#: ../src/guestfs.pod:1628 +msgid "You could call it like this:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1630 +#, no-wrap msgid "" -"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " -"filesystem labels." +" struct guestfs_add_drive_opts_argv optargs = {\n" +" .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n" +" .readonly = 1,\n" +" .format = \"qcow2\"\n" +" };\n" +" \n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1534 -msgid "INTERNALS" +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1637 +#, no-wrap +msgid "" +" guestfs_add_drive_opts_argv (g, filename, &optargs);\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1536 -msgid "COMMUNICATION PROTOCOL" +# type: textblock +#. 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:1538 -msgid "" -"Don't rely on using this protocol directly. This section documents how it " -"currently works, but it may change at any time." +#. 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:1541 -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)." +#. 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:1545 +#. type: textblock +#: ../src/guestfs.pod:1654 msgid "" -"The detailed format of structures is in C (note: " -"this file is automatically generated)." +"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 +#. type: =head2 +#: ../src/guestfs.pod:1659 +msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:1548 +#. type: textblock +#: ../src/guestfs.pod:1661 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." +"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: =head3 -#: ../src/guestfs.pod:1555 -msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1665 +msgid "For guestfish, see L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1557 -msgid "For ordinary functions, the request message is:" +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1667 +msgid "SETTING CALLBACKS TO HANDLE EVENTS" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1559 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1669 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" +"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:1564 +#. type: textblock +#: ../src/guestfs.pod:1678 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." +"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:1570 +#. type: textblock +#: ../src/guestfs.pod:1686 msgid "" -"Note also that many functions don't take any arguments, in which case the " -"C_args> is completely omitted." +"In the current implementation, events are only generated synchronously: that " +"means that events (and hence callbacks) can only happen while you are in the " +"middle of making another libguestfs call. The callback is called in the " +"same thread." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1573 +#. type: textblock +#: ../src/guestfs.pod:1691 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." +"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:1577 -msgid "The reply message for ordinary functions is:" +#. type: =head3 +#: ../src/guestfs.pod:1695 +msgid "CLASSES OF EVENTS" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1579 -#, 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" -"\n" +#. type: =item +#: ../src/guestfs.pod:1699 +msgid "GUESTFS_EVENT_CLOSE (payload type: void)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1584 +#. type: textblock +#: ../src/guestfs.pod:1702 msgid "" -"As above the C_ret> structure may be completely omitted for " -"functions that return no formal return values." +"The callback function will be called while the handle is being closed " +"(synchronously from L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1587 +#. type: textblock +#: ../src/guestfs.pod:1705 msgid "" -"As above the total length of the reply is limited to C." +"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:1590 +#. type: textblock +#: ../src/guestfs.pod:1712 msgid "" -"In the case of an error, a flag is set in the header, and the reply message " -"is slightly changed:" +"If no callback is registered: the handle is closed without any callback " +"being invoked." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1593 -#, no-wrap -msgid "" -" total length (header + error,\n" -" but not including the length word itself)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs_message_error (encoded as XDR)\n" -"\n" +#. type: =item +#: ../src/guestfs.pod:1715 +msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1598 +#. type: textblock +#: ../src/guestfs.pod:1718 msgid "" -"The C structure contains the error message as a " -"string." +"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: =head3 -#: ../src/guestfs.pod:1601 -msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" +#. 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:1603 -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: =item +#: ../src/guestfs.pod:1724 +msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1607 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1727 msgid "" -" total length (header + arguments,\n" -" but not including the length word itself,\n" -" and not including the chunks)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs__args (encoded as XDR)\n" -" sequence of chunks for FileIn param #0\n" -" sequence of chunks for FileIn param #1 etc.\n" -"\n" +"The callback 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: =item +#: ../src/guestfs.pod:1733 +msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)" msgstr "" # type: textblock -#: ../src/guestfs.pod:1615 -msgid "The \"sequence of chunks\" is:" +#. 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 " +"is generated (usually two seconds after the operation started, and three " +"times per second thereafter until it completes, although the frequency may " +"change in future versions)." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1617 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1742 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" +"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:1625 +#. type: textblock +#: ../src/guestfs.pod:1745 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." +"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:1629 -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)." +#. type: textblock +#: ../src/guestfs.pod:1750 +msgid "The only defined and stable parts of the API are:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1634 +#. type: textblock +#: ../src/guestfs.pod:1756 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." +"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:1640 +#. type: textblock +#: ../src/guestfs.pod:1761 +msgid "0 E= C E= C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1765 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." +"If any progress notification is sent during a call, then a final progress " +"notification is always sent when C = C (I the call " +"fails with an error)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1649 +#. type: textblock +#: ../src/guestfs.pod:1769 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." +"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: =head3 -#: ../src/guestfs.pod:1655 -msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" +#. type: textblock +#: ../src/guestfs.pod:1775 +msgid "" +"For some calls we are unable to estimate the progress of the call, but we " +"can still generate progress messages to indicate activity. This is known as " +"\"pulse mode\", and is directly supported by certain progress bar " +"implementations (eg. GtkProgressBar)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1657 +#. type: textblock +#: ../src/guestfs.pod:1780 msgid "" -"The protocol for FileOut parameters is exactly the same as for FileIn " -"parameters, but with the roles of daemon and library reversed." +"For these calls, zero or more progress messages are generated with " +"C and C, followed by a final message with " +"C." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1660 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1784 msgid "" -" total length (header + ret,\n" -" but not including the length word itself,\n" -" and not including the chunks)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs__ret (encoded as XDR)\n" -" sequence of chunks for FileOut param #0\n" -" sequence of chunks for FileOut param #1 etc.\n" -"\n" +"As noted above, if the call fails with an error then the final message may " +"not be generated." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1668 -msgid "INITIAL MESSAGE" +#. 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: textblock -#: ../src/guestfs.pod:1670 -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." +#. type: textblock +#: ../src/guestfs.pod:1795 +msgid "If no callback is registered: progress messages are discarded." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1674 -msgid "PROGRESS NOTIFICATION MESSAGES" +#. type: =item +#: ../src/guestfs.pod:1797 +msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1676 +#. type: textblock +#: ../src/guestfs.pod:1800 msgid "" -"The daemon may send progress notification messages at any time. These are " -"distinguished by the normal length word being replaced by " -"C, followed by a fixed size progress message." +"The callback function is called whenever a log message is generated by qemu, " +"the appliance kernel, guestfsd (daemon), or utility programs." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1680 +#. type: textblock +#: ../src/guestfs.pod:1803 msgid "" -"The library turns them into progress callbacks (see " -"C) if there is a callback registered, or " -"discards them if not." +"If the verbose flag (L) is set before launch (L) then additional debug messages are generated." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1684 +#. type: textblock +#: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820 msgid "" -"The daemon self-limits the frequency of progress messages it sends (see " -"C). Not all calls generate progress " -"messages." +"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: =head1 -#: ../src/guestfs.pod:1688 -msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1690 -msgid "" -"All high-level libguestfs actions are synchronous. If you want to use " -"libguestfs asynchronously then you must create a thread." +#. type: =item +#: ../src/guestfs.pod:1811 +msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1693 +#. type: textblock +#: ../src/guestfs.pod:1814 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." +"The callback function is called whenever a log message is generated by the " +"library part of libguestfs." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1697 +#. type: textblock +#: ../src/guestfs.pod:1817 msgid "" -"See the graphical program guestfs-browser for one possible architecture for " -"multithreaded programs using libvirt and libguestfs." +"If the verbose flag (L) is set then additional debug " +"messages are generated." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1700 -msgid "QEMU WRAPPERS" +#. type: =item +#: ../src/guestfs.pod:1825 +msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1702 +#. type: textblock +#: ../src/guestfs.pod:1828 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." +"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:1706 +#. type: textblock +#: ../src/guestfs.pod:1831 msgid "" -"There is one important rule to remember: you I> as the " -"last command in the shell script (so that qemu replaces the shell and " -"becomes the direct child of the libguestfs-using program). If you don't do " -"this, then the qemu process won't be cleaned up correctly." +"If no callback is registered: the messages are sent to stderr. You can " +"override the printing of trace messages to stderr by setting up a callback." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1711 -msgid "" -"Here is an example of a wrapper, where I have built my own copy of qemu from " -"source:" +#. type: =head3 +#: ../src/guestfs.pod:1837 +msgid "guestfs_set_event_callback" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1714 +#. type: verbatim +#: ../src/guestfs.pod:1839 #, no-wrap msgid "" -" #!/bin/sh -\n" -" qemudir=/home/rjones/d/qemu\n" -" exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n" +" int guestfs_set_event_callback (guestfs_h *g,\n" +" guestfs_event_callback cb,\n" +" uint64_t event_bitmask,\n" +" int flags,\n" +" void *opaque);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1718 +#. type: textblock +#: ../src/guestfs.pod:1845 msgid "" -"Save this script as C (or wherever), C, and " -"then use it by setting the LIBGUESTFS_QEMU environment variable. For " -"example:" +"This function registers a callback (C) for all event classes in the " +"C." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1722 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1848 msgid "" -" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" -"\n" +"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: textblock -#: ../src/guestfs.pod:1724 -msgid "" -"Note that libguestfs also calls qemu with the -help and -version options in " -"order to determine features." +#. type: textblock +#: ../src/guestfs.pod:1854 +msgid "C should always be passed as 0." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1727 -msgid "LIBGUESTFS VERSION NUMBERS" +#. type: textblock +#: ../src/guestfs.pod:1856 +msgid "" +"C is an opaque pointer which is passed to the callback. You can use " +"it for any purpose." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1729 +#. type: textblock +#: ../src/guestfs.pod:1859 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:" +"The return value is the event handle (an integer) which you can use to " +"delete the callback (see below)." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1734 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1862 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" -"\n" +"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:1745 -msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." +#. type: textblock +#: ../src/guestfs.pod:1865 +msgid "" +"Callbacks remain in effect until they are deleted, or until the handle is " +"closed." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1747 +#. type: textblock +#: ../src/guestfs.pod:1868 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." +"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:1753 -msgid "Our criteria for backporting changes are:" +#. type: =head3 +#: ../src/guestfs.pod:1872 +msgid "guestfs_delete_event_callback" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1759 +#. type: verbatim +#: ../src/guestfs.pod:1874 +#, no-wrap msgid "" -"Documentation changes which don't affect any code are backported unless the " -"documentation refers to a future feature which is not in stable." +" void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1765 +#. type: textblock +#: ../src/guestfs.pod:1876 msgid "" -"Bug fixes which are not controversial, fix obvious problems, and have been " -"well tested are backported." +"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:1770 +#. type: =head3 +#: ../src/guestfs.pod:1880 +msgid "guestfs_event_callback" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:1882 +#, no-wrap 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." +" 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:1776 +#. type: textblock +#: ../src/guestfs.pod:1891 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." +"This is the type of the event callback function that you have to provide." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1782 +#. type: textblock +#: ../src/guestfs.pod:1894 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." +"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: =head1 -#: ../src/guestfs.pod:1790 ../fish/guestfish.pod:867 -#: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 -#: ../tools/virt-rescue.pl:255 -msgid "ENVIRONMENT VARIABLES" +#. type: textblock +#: ../src/guestfs.pod:1898 +msgid "" +"The remaining parameters contain the event payload (if any). Each event may " +"contain a payload, which usually relates to the event class, but for future " +"proofing your code should be written to handle any payload for any event " +"class." msgstr "" -# type: =item -#: ../src/guestfs.pod:1794 ../fish/guestfish.pod:893 -msgid "LIBGUESTFS_APPEND" +#. type: textblock +#: ../src/guestfs.pod:1903 +msgid "" +"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:1796 ../fish/guestfish.pod:895 -msgid "Pass additional options to the guest kernel." +#. type: textblock +#: ../src/guestfs.pod:1907 +msgid "" +"C and C is an array of 64 bit unsigned integers. At the " +"moment this is only used for progress messages." msgstr "" -# type: =item -#: ../src/guestfs.pod:1798 ../fish/guestfish.pod:897 -msgid "LIBGUESTFS_DEBUG" +#. type: =head3 +#: ../src/guestfs.pod:1910 +msgid "EXAMPLE: CAPTURING LOG MESSAGES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1800 +#. type: textblock +#: ../src/guestfs.pod:1912 msgid "" -"Set C to enable verbose messages. This has the same " -"effect as calling C." +"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: =item -#: ../src/guestfs.pod:1803 ../fish/guestfish.pod:902 -msgid "LIBGUESTFS_MEMSIZE" +#. type: textblock +#: ../src/guestfs.pod:1916 +msgid "" +"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:1805 ../fish/guestfish.pod:904 +#. type: textblock +#: ../src/guestfs.pod:1921 msgid "" -"Set the memory allocated to the qemu process, in megabytes. For example:" +"Programs have to set up a callback to capture the classes of events of " +"interest:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1808 ../fish/guestfish.pod:907 +#. type: verbatim +#: ../src/guestfs.pod:1924 #, no-wrap msgid "" -" LIBGUESTFS_MEMSIZE=700\n" +" 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: =item -#: ../src/guestfs.pod:1810 ../fish/guestfish.pod:909 -msgid "LIBGUESTFS_PATH" +#. type: textblock +#: ../src/guestfs.pod:1934 +msgid "" +"The callback can then direct messages to the appropriate place. In this " +"example, messages are directed to syslog:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1812 +#. type: verbatim +#: ../src/guestfs.pod:1937 +#, no-wrap msgid "" -"Set the path that libguestfs uses to search for kernel and initrd.img. See " -"the discussion of paths in section PATH above." +" 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: =item -#: ../src/guestfs.pod:1815 ../fish/guestfish.pod:914 -msgid "LIBGUESTFS_QEMU" +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1952 +msgid "PRIVATE DATA AREA" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1817 ../fish/guestfish.pod:916 +#. type: textblock +#: ../src/guestfs.pod:1954 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." +"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:1821 -msgid "See also L above." +#. type: textblock +#: ../src/guestfs.pod:1959 +msgid "To attach a named piece of data, use the following call:" msgstr "" -# type: =item -#: ../src/guestfs.pod:1823 ../fish/guestfish.pod:920 -msgid "LIBGUESTFS_TRACE" +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1961 +#, no-wrap +msgid "" +" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1825 +#. type: textblock +#: ../src/guestfs.pod:1963 msgid "" -"Set C to enable command traces. This has the same " -"effect as calling C." +"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: =item -#: ../src/guestfs.pod:1828 ../fish/guestfish.pod:929 -msgid "TMPDIR" +#. 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:1830 ../fish/guestfish.pod:931 -msgid "Location of temporary directory, defaults to C." +#. type: textblock +#: ../src/guestfs.pod:1973 +msgid "To retrieve the pointer, use:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1832 ../fish/guestfish.pod:933 +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1975 +#, no-wrap 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:1840 ../fish/guestfish.pod:991 -#: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:214 -#: ../inspector/virt-inspector.pl:884 ../tools/virt-edit.pl:350 -#: ../tools/virt-win-reg.pl:487 ../tools/virt-df.pl:640 -#: ../tools/virt-ls.pl:235 ../tools/virt-resize.pl:1486 -#: ../tools/virt-list-filesystems.pl:216 ../tools/virt-cat.pl:188 -#: ../tools/virt-tar.pl:283 ../tools/virt-rescue.pl:267 -#: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:254 -msgid "SEE ALSO" +" void *guestfs_get_private (guestfs_h *g, const char *key);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1842 +#. type: textblock +#: ../src/guestfs.pod:1977 msgid "" -"L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, " -"L." +"This function returns C if either no data is found associated with " +"C, or if the user previously set the C's C pointer to " +"C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1860 +#. type: textblock +#: ../src/guestfs.pod:1981 msgid "" -"Tools with a similar purpose: L, L, L, L, L." +"Libguestfs does not try to look at or interpret the C pointer in any " +"way. As far as libguestfs is concerned, it need not be a valid pointer at " +"all. In particular, libguestfs does I try to free the data when the " +"handle is closed. If the data must be freed, then the caller must either " +"free it before calling L or must set up a close callback to " +"do it (see L)." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1867 ../tools/virt-win-reg.pl:502 -#: ../tools/virt-make-fs.pl:548 -msgid "BUGS" +#. type: textblock +#: ../src/guestfs.pod:1988 +msgid "To walk over all entries, use these two functions:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1869 -msgid "To get a list of bugs against libguestfs use this link:" +#. type: verbatim +#: ../src/guestfs.pod:1990 +#, no-wrap +msgid "" +" void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1871 +#. type: verbatim +#: ../src/guestfs.pod:1992 +#, no-wrap msgid "" -"L" +" void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1873 -msgid "To report a new bug against libguestfs use this link:" +#. type: textblock +#: ../src/guestfs.pod:1994 +msgid "" +"C returns the first key, pointer pair (\"first\" does " +"not have any particular meaning -- keys are not returned in any defined " +"order). A pointer to the key is returned in C<*key_rtn> and the " +"corresponding data pointer is returned from the function. C is " +"returned if there are no keys stored in the handle." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1875 +#. type: textblock +#: ../src/guestfs.pod:2000 msgid "" -"L" +"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:1877 -msgid "When reporting a bug, please check:" +#. type: textblock +#: ../src/guestfs.pod:2004 +msgid "Notes about walking over entries:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1883 -msgid "That the bug hasn't been reported already." +#. type: textblock +#: ../src/guestfs.pod:2010 +msgid "" +"You must not call C while walking over the entries." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1887 -msgid "That you are testing a recent version." +#. type: textblock +#: ../src/guestfs.pod:2015 +msgid "" +"The handle maintains an internal iterator which is reset when you call " +"C. This internal iterator is invalidated when you " +"call C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1891 -msgid "Describe the bug accurately, and give a way to reproduce it." +#. type: textblock +#: ../src/guestfs.pod:2021 +msgid "If you have set the data pointer associated with a key to C, ie:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1895 +#. type: verbatim +#: ../src/guestfs.pod:2023 +#, no-wrap msgid "" -"Run libguestfs-test-tool and paste the B output into the " -"bug report." +" guestfs_set_private (g, key, NULL);\n" +"\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1900 ../fish/guestfish.pod:1008 -#: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:225 -#: ../inspector/virt-inspector.pl:893 -msgid "AUTHORS" +#. type: textblock +#: ../src/guestfs.pod:2025 +msgid "then that C is not returned when walking." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1902 ../fish/guestfish.pod:1010 -#: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:227 -msgid "Richard W.M. Jones (C)" +#. type: textblock +#: ../src/guestfs.pod:2029 +msgid "" +"C<*key_rtn> is only valid until the next call to C, " +"C or C." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1904 ../fish/guestfish.pod:1012 -#: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:229 -#: ../inspector/virt-inspector.pl:899 ../tools/virt-edit.pl:366 -#: ../tools/virt-win-reg.pl:517 ../tools/virt-df.pl:653 -#: ../tools/virt-ls.pl:250 ../tools/virt-resize.pl:1512 -#: ../tools/virt-list-filesystems.pl:232 ../tools/virt-cat.pl:202 -#: ../tools/virt-tar.pl:298 ../tools/virt-rescue.pl:281 -#: ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:269 -msgid "COPYRIGHT" +#. type: textblock +#: ../src/guestfs.pod:2035 +msgid "" +"The following example code shows how to print all keys and data pointers " +"that are associated with the handle C:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1906 ../fish/guestfish.pod:1014 -#: ../fuse/guestmount.pod:231 -msgid "Copyright (C) 2009-2010 Red Hat Inc. L" +#. type: verbatim +#: ../src/guestfs.pod:2038 +#, no-wrap +msgid "" +" const char *key;\n" +" void *data = guestfs_first_private (g, &key);\n" +" while (data != NULL)\n" +" {\n" +" printf (\"key = %s, data = %p\\n\", key, data);\n" +" data = guestfs_next_private (g, &key);\n" +" }\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1909 +#. type: textblock +#: ../src/guestfs.pod:2046 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." +"More commonly you are only interested in keys that begin with an application-" +"specific prefix C. Modify the loop like so:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1914 +#. type: verbatim +#: ../src/guestfs.pod:2049 +#, no-wrap msgid "" -"This library is distributed in the hope that it will be useful, but WITHOUT " -"ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or " -"FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License " -"for more details." +" const char *key;\n" +" void *data = 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:1919 +#. type: textblock +#: ../src/guestfs.pod:2058 msgid "" -"You should have received a copy of the GNU Lesser General Public License " -"along with this library; if not, write to the Free Software Foundation, " -"Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA" -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:1 -msgid "guestfs_add_cdrom" +"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-actions.pod:3 +#. type: verbatim +#: ../src/guestfs.pod:2062 #, no-wrap msgid "" -" int guestfs_add_cdrom (guestfs_h *g,\n" -"\t\tconst char *filename);\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-actions.pod:6 ../fish/guestfish-actions.pod:5 -msgid "This function adds a virtual CD-ROM disk image to the guest." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:8 ../fish/guestfish-actions.pod:7 -msgid "This is equivalent to the qemu parameter C<-cdrom filename>." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:16 +#. type: textblock +#: ../src/guestfs.pod:2078 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." +"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-actions.pod:23 -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." +# type: =end +#. type: =end +#: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088 +msgid "html" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:54 -#: ../src/guestfs-actions.pod:112 ../src/guestfs-actions.pod:144 -#: ../src/guestfs-actions.pod:155 ../src/guestfs-actions.pod:173 -#: ../src/guestfs-actions.pod:190 ../src/guestfs-actions.pod:201 -#: ../src/guestfs-actions.pod:304 ../src/guestfs-actions.pod:321 -#: ../src/guestfs-actions.pod:332 ../src/guestfs-actions.pod:368 -#: ../src/guestfs-actions.pod:390 ../src/guestfs-actions.pod:405 -#: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:496 -#: ../src/guestfs-actions.pod:507 ../src/guestfs-actions.pod:519 -#: ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:615 -#: ../src/guestfs-actions.pod:626 ../src/guestfs-actions.pod:637 -#: ../src/guestfs-actions.pod:783 ../src/guestfs-actions.pod:800 -#: ../src/guestfs-actions.pod:815 ../src/guestfs-actions.pod:890 -#: ../src/guestfs-actions.pod:905 ../src/guestfs-actions.pod:921 -#: ../src/guestfs-actions.pod:932 ../src/guestfs-actions.pod:949 -#: ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1040 -#: ../src/guestfs-actions.pod:1068 ../src/guestfs-actions.pod:1090 -#: ../src/guestfs-actions.pod:1121 ../src/guestfs-actions.pod:1209 -#: ../src/guestfs-actions.pod:1240 ../src/guestfs-actions.pod:1440 -#: ../src/guestfs-actions.pod:1459 ../src/guestfs-actions.pod:1540 -#: ../src/guestfs-actions.pod:1888 ../src/guestfs-actions.pod:2011 -#: ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2096 -#: ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2517 -#: ../src/guestfs-actions.pod:2534 ../src/guestfs-actions.pod:2642 -#: ../src/guestfs-actions.pod:2653 ../src/guestfs-actions.pod:2663 -#: ../src/guestfs-actions.pod:2674 ../src/guestfs-actions.pod:2686 -#: ../src/guestfs-actions.pod:2716 ../src/guestfs-actions.pod:2780 -#: ../src/guestfs-actions.pod:2797 ../src/guestfs-actions.pod:2811 -#: ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:2851 -#: ../src/guestfs-actions.pod:2880 ../src/guestfs-actions.pod:2896 -#: ../src/guestfs-actions.pod:2912 ../src/guestfs-actions.pod:2941 -#: ../src/guestfs-actions.pod:2950 ../src/guestfs-actions.pod:2983 -#: ../src/guestfs-actions.pod:2996 ../src/guestfs-actions.pod:3006 -#: ../src/guestfs-actions.pod:3018 ../src/guestfs-actions.pod:3032 -#: ../src/guestfs-actions.pod:3112 ../src/guestfs-actions.pod:3129 -#: ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3184 -#: ../src/guestfs-actions.pod:3199 ../src/guestfs-actions.pod:3214 -#: ../src/guestfs-actions.pod:3227 ../src/guestfs-actions.pod:3238 -#: ../src/guestfs-actions.pod:3249 ../src/guestfs-actions.pod:3263 -#: ../src/guestfs-actions.pod:3275 ../src/guestfs-actions.pod:3292 -#: ../src/guestfs-actions.pod:3338 ../src/guestfs-actions.pod:3366 -#: ../src/guestfs-actions.pod:3382 ../src/guestfs-actions.pod:3398 -#: ../src/guestfs-actions.pod:3407 ../src/guestfs-actions.pod:3421 -#: ../src/guestfs-actions.pod:3431 ../src/guestfs-actions.pod:3443 -#: ../src/guestfs-actions.pod:3455 ../src/guestfs-actions.pod:3487 -#: ../src/guestfs-actions.pod:3499 ../src/guestfs-actions.pod:3516 -#: ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:3541 -#: ../src/guestfs-actions.pod:3581 ../src/guestfs-actions.pod:3612 -#: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3648 -#: ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3677 -#: ../src/guestfs-actions.pod:3799 ../src/guestfs-actions.pod:3851 -#: ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:3885 -#: ../src/guestfs-actions.pod:3911 ../src/guestfs-actions.pod:3968 -#: ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:3992 -#: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4258 -#: ../src/guestfs-actions.pod:4274 ../src/guestfs-actions.pod:4285 -#: ../src/guestfs-actions.pod:4294 ../src/guestfs-actions.pod:4305 -#: ../src/guestfs-actions.pod:4314 ../src/guestfs-actions.pod:4325 -#: ../src/guestfs-actions.pod:4338 ../src/guestfs-actions.pod:4356 -#: ../src/guestfs-actions.pod:4372 ../src/guestfs-actions.pod:4388 -#: ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4423 -#: ../src/guestfs-actions.pod:4438 ../src/guestfs-actions.pod:4454 -#: ../src/guestfs-actions.pod:4472 ../src/guestfs-actions.pod:4488 -#: ../src/guestfs-actions.pod:4502 ../src/guestfs-actions.pod:4527 -#: ../src/guestfs-actions.pod:4548 ../src/guestfs-actions.pod:4564 -#: ../src/guestfs-actions.pod:4585 ../src/guestfs-actions.pod:4597 -#: ../src/guestfs-actions.pod:4609 ../src/guestfs-actions.pod:4625 -#: ../src/guestfs-actions.pod:4659 ../src/guestfs-actions.pod:4679 -#: ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:4792 -#: ../src/guestfs-actions.pod:4898 ../src/guestfs-actions.pod:4907 -#: ../src/guestfs-actions.pod:4917 ../src/guestfs-actions.pod:4927 -#: ../src/guestfs-actions.pod:4946 ../src/guestfs-actions.pod:4956 -#: ../src/guestfs-actions.pod:4966 ../src/guestfs-actions.pod:4976 -#: ../src/guestfs-actions.pod:4988 ../src/guestfs-actions.pod:5038 -#: ../src/guestfs-actions.pod:5052 ../src/guestfs-actions.pod:5065 -#: ../src/guestfs-actions.pod:5078 ../src/guestfs-actions.pod:5092 -#: ../src/guestfs-actions.pod:5102 ../src/guestfs-actions.pod:5119 -#: ../src/guestfs-actions.pod:5149 ../src/guestfs-actions.pod:5160 -#: ../src/guestfs-actions.pod:5195 ../src/guestfs-actions.pod:5205 -#: ../src/guestfs-actions.pod:5220 ../src/guestfs-actions.pod:5246 -#: ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5378 -#: ../src/guestfs-actions.pod:5393 ../src/guestfs-actions.pod:5404 -#: ../src/guestfs-actions.pod:5450 ../src/guestfs-actions.pod:5460 -#: ../src/guestfs-actions.pod:5497 ../src/guestfs-actions.pod:5524 -#: ../src/guestfs-actions.pod:5566 ../src/guestfs-actions.pod:5589 -#: ../src/guestfs-actions.pod:5646 ../src/guestfs-actions.pod:5662 -#: ../src/guestfs-actions.pod:5688 -msgid "This function returns 0 on success or -1 on error." +#. type: textblock +#: ../src/guestfs.pod:2085 +msgid "" +" " msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:31 ../src/guestfs-actions.pod:157 -#: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:28 -#: ../fish/guestfish-actions.pod:117 ../fish/guestfish-actions.pod:131 -msgid "" -"This function is deprecated. In new code, use the C call " -"instead." +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:2090 +msgid "ARCHITECTURE" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:34 ../src/guestfs-actions.pod:160 -#: ../src/guestfs-actions.pod:178 ../src/guestfs-actions.pod:1214 -#: ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1667 -#: ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:5742 -#: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:120 -#: ../fish/guestfish-actions.pod:134 ../fish/guestfish-actions.pod:940 -#: ../fish/guestfish-actions.pod:1297 ../fish/guestfish-actions.pod:1311 -#: ../fish/guestfish-actions.pod:4317 ../fish/guestfish-actions.pod:4414 +#. type: textblock +#: ../src/guestfs.pod:2092 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." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:38 -msgid "guestfs_add_drive" +"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: verbatim -#: ../src/guestfs-actions.pod:40 +#. type: verbatim +#: ../src/guestfs.pod:2096 #, no-wrap msgid "" -" int guestfs_add_drive (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" ___________________\n" +" / \\\n" +" | main program |\n" +" | |\n" +" | | child process / appliance\n" +" | | __________________________\n" +" | | / qemu \\\n" +" +-------------------+ RPC | +-----------------+ |\n" +" | libguestfs <--------------------> guestfsd | |\n" +" | | | +-----------------+ |\n" +" \\___________________/ | | Linux kernel | |\n" +" | +--^--------------+ |\n" +" \\_________|________________/\n" +" |\n" +" _______v______\n" +" / \\\n" +" | Device or |\n" +" | disk image |\n" +" \\______________/\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:43 +#. type: textblock +#: ../src/guestfs.pod:2116 msgid "" -"This function is the equivalent of calling C with no " -"optional parameters, so the disk is added writable, with the format being " -"detected automatically." +"The library, linked to the main program, creates the child process and hence " +"the appliance in the L function." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:47 +#. type: textblock +#: ../src/guestfs.pod:2119 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." +"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: =head2 -#: ../src/guestfs-actions.pod:56 -msgid "guestfs_add_drive_opts" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2128 +msgid "" +"A common misunderstanding is that the appliance \"is\" the virtual machine. " +"Although the disk image you are attached to might also be used by some " +"virtual machine, libguestfs doesn't know or care about this. (But you will " +"care if both libguestfs's qemu process and your virtual machine are trying " +"to update the disk image at the same time, since these usually results in " +"massive disk corruption)." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:58 -#, no-wrap -msgid "" -" int guestfs_add_drive_opts (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\t...);\n" -"\n" +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:2135 +msgid "STATE MACHINE" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:62 -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: textblock +#: ../src/guestfs.pod:2137 +msgid "libguestfs uses a state machine to model the child process:" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:67 +#. type: verbatim +#: ../src/guestfs.pod:2139 #, no-wrap 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" +" guestfs_create\n" +" |\n" +" |\n" +" ____V_____\n" +" / \\\n" +" | CONFIG |\n" +" \\__________/\n" +" ^ ^ ^ \\\n" +" / | \\ \\ guestfs_launch\n" +" / | _\\__V______\n" +" / | / \\\n" +" / | | LAUNCHING |\n" +" / | \\___________/\n" +" / | /\n" +" / | guestfs_launch\n" +" / | /\n" +" ______ / __|____V\n" +" / \\ ------> / \\\n" +" | BUSY | | READY |\n" +" \\______/ <------ \\________/\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:56 +#. type: textblock +#: ../src/guestfs.pod:2161 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." +"The normal transitions are (1) CONFIG (when the handle is created, but there " +"is no child process), (2) LAUNCHING (when the child process is booting up), " +"(3) alternating between READY and BUSY as commands are issued to, and " +"carried out by, the child process." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:61 +#. type: textblock +#: ../src/guestfs.pod:2166 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)." +"The guest may be killed by L, or may die " +"asynchronously at any time (eg. due to some internal error), and that causes " +"the state to transition back to CONFIG." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:67 -msgid "This call checks that C exists." +#. type: textblock +#: ../src/guestfs.pod:2170 +msgid "" +"Configuration commands for qemu such as L can only be " +"issued when in the CONFIG state." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:84 ../fish/guestfish-actions.pod:69 -msgid "The optional arguments are:" -msgstr "" - -# type: =item -#: ../src/guestfs-actions.pod:88 ../fish/guestfish-actions.pod:73 -msgid "C" +#. 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: textblock -#: ../src/guestfs-actions.pod:90 ../fish/guestfish-actions.pod:75 +#. type: textblock +#: ../src/guestfs.pod:2179 msgid "" -"If true then the image is treated as read-only. Writes are still allowed, " -"but they are stored in a temporary snapshot overlay which is discarded at " -"the end. The disk that you add is not modified." -msgstr "" - -# type: =item -#: ../src/guestfs-actions.pod:94 ../fish/guestfish-actions.pod:79 -msgid "C" +"API actions such as L can only be issued when in the READY " +"state. These API calls block waiting for the command to be carried out (ie. " +"the state to transition to BUSY and then back to READY). There are no non-" +"blocking versions, and no way to issue more than one command per handle at " +"the same time." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:96 +#. type: textblock +#: ../src/guestfs.pod:2185 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." +"Finally, the child process sends asynchronous messages back to the main " +"program, such as kernel log messages. You can register a callback to " +"receive these messages." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:100 ../fish/guestfish-actions.pod:85 -msgid "" -"Automatic detection of the format opens you up to a potential security hole " -"when dealing with untrusted raw-format images. See CVE-2010-3851 and " -"RHBZ#642934. Specifying the format closes this security hole." +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:2189 +msgid "INTERNALS" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:105 ../fish/guestfish-actions.pod:90 -msgid "C" +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:2191 +msgid "COMMUNICATION PROTOCOL" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:107 +#. type: textblock +#: ../src/guestfs.pod:2193 msgid "" -"This rarely-used option lets you emulate the behaviour of the deprecated " -"C call (q.v.)" +"Don't rely on using this protocol directly. This section documents how it " +"currently works, but it may change at any time." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:114 -msgid "guestfs_add_drive_opts_va" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2196 +msgid "" +"The protocol used to talk between the library and the daemon running inside " +"the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC " +"1014, RFC 1832, RFC 4506)." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:116 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2200 msgid "" -" int guestfs_add_drive_opts_va (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tva_list args);\n" -"\n" +"The detailed format of structures is in C (note: " +"this file is automatically generated)." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:120 -msgid "This is the \"va_list variant\" of L." +#. 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-actions.pod:122 ../src/guestfs-actions.pod:132 -msgid "See L." +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:2210 +msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:124 -msgid "guestfs_add_drive_opts_argv" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2212 +msgid "For ordinary functions, the request message is:" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:126 +#. type: verbatim +#: ../src/guestfs.pod:2214 #, no-wrap msgid "" -" int guestfs_add_drive_opts_argv (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst struct guestfs_add_drive_opts_argv *optargs);\n" +" total length (header + arguments,\n" +" but not including the length word itself)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs__args (encoded as XDR)\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:130 -msgid "This is the \"argv variant\" of L." +#. type: textblock +#: ../src/guestfs.pod:2219 +msgid "" +"The total length field allows the daemon to allocate a fixed size buffer " +"into which it slurps the rest of the message. As a result, the total length " +"is limited to C bytes (currently 4MB), which means the " +"effective size of any request is limited to somewhere under this size." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:134 -msgid "guestfs_add_drive_ro" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2225 +msgid "" +"Note also that many functions don't take any arguments, in which case the " +"C_args> is completely omitted." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:136 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2228 msgid "" -" int guestfs_add_drive_ro (guestfs_h *g,\n" -"\t\tconst char *filename);\n" -"\n" +"The header contains the procedure number (C) which is how the " +"receiver knows what type of args structure to expect, or none at all." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:139 +#. type: textblock +#: ../src/guestfs.pod:2232 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." +"For functions that take optional arguments, the optional arguments are " +"encoded in the C_args> structure in the same way as ordinary " +"arguments. A bitmask in the header indicates which optional arguments are " +"meaningful. The bitmask is also checked to see if it contains bits set " +"which the daemon does not know about (eg. if more optional arguments were " +"added in a later version of the library), and this causes the call to be " +"rejected." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:146 -msgid "guestfs_add_drive_ro_with_if" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2240 +msgid "The reply message for ordinary functions is:" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:148 +#. type: verbatim +#: ../src/guestfs.pod:2242 #, no-wrap msgid "" -" int guestfs_add_drive_ro_with_if (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst char *iface);\n" +" total length (header + ret,\n" +" but not including the length word itself)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs__ret (encoded as XDR)\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:152 +#. type: textblock +#: ../src/guestfs.pod:2247 msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:164 -msgid "guestfs_add_drive_with_if" +"As above the C_ret> structure may be completely omitted for " +"functions that return no formal return values." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:166 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2250 msgid "" -" int guestfs_add_drive_with_if (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst char *iface);\n" -"\n" +"As above the total length of the reply is limited to C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:170 +#. type: textblock +#: ../src/guestfs.pod:2253 msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:182 -msgid "guestfs_aug_clear" +"In the case of an error, a flag is set in the header, and the reply message " +"is slightly changed:" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:184 +#. type: verbatim +#: ../src/guestfs.pod:2256 #, no-wrap msgid "" -" int guestfs_aug_clear (guestfs_h *g,\n" -"\t\tconst char *augpath);\n" +" total length (header + error,\n" +" but not including the length word itself)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs_message_error (encoded as XDR)\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:187 ../fish/guestfish-actions.pod:142 +#. type: textblock +#: ../src/guestfs.pod:2261 msgid "" -"Set the value associated with C to C. This is the same as the " -"L C command." +"The C structure contains the error message as a " +"string." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:192 -msgid "guestfs_aug_close" +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:2264 +msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" +msgstr "" + +# type: textblock +#. 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:194 +#. type: verbatim +#: ../src/guestfs.pod:2270 #, no-wrap msgid "" -" int guestfs_aug_close (guestfs_h *g);\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:196 -msgid "" -"Close the current Augeas handle and free up any resources used by it. After " -"calling this, you have to call C again before you can use " -"any other Augeas functions." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:203 -msgid "guestfs_aug_defnode" +#. type: textblock +#: ../src/guestfs.pod:2278 +msgid "The \"sequence of chunks\" is:" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:205 +#. type: verbatim +#: ../src/guestfs.pod:2280 #, no-wrap msgid "" -" struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *g,\n" -"\t\tconst char *name,\n" -"\t\tconst char *expr,\n" -"\t\tconst char *val);\n" +" 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:210 ../fish/guestfish-actions.pod:158 +#. type: textblock +#: ../src/guestfs.pod:2288 msgid "" -"Defines a variable C whose value is the result of evaluating C." +"The final chunk has the C field set to zero. Additionally a flag " +"is set in the final chunk to indicate either successful completion or early " +"cancellation." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:213 +#. type: textblock +#: ../src/guestfs.pod:2292 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." +"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:217 ../fish/guestfish-actions.pod:165 +#. type: textblock +#: ../src/guestfs.pod:2297 msgid "" -"On success this returns a pair containing the number of nodes in the " -"nodeset, and a boolean flag if a node was created." +"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:221 +#. type: textblock +#: ../src/guestfs.pod:2303 msgid "" -"This function returns a C, or NULL if there was " -"an error. I after use>." +"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: =head2 -#: ../src/guestfs-actions.pod:225 -msgid "guestfs_aug_defvar" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2312 +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." +msgstr "" + +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:2318 +msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" +msgstr "" + +# type: textblock +#. 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:227 +#. type: verbatim +#: ../src/guestfs.pod:2323 #, no-wrap msgid "" -" int guestfs_aug_defvar (guestfs_h *g,\n" -"\t\tconst char *name,\n" -"\t\tconst char *expr);\n" +" total length (header + ret,\n" +" but not including the length word itself,\n" +" and not including the chunks)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs__ret (encoded as XDR)\n" +" sequence of chunks for FileOut param #0\n" +" sequence of chunks for FileOut param #1 etc.\n" "\n" msgstr "" +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:2331 +msgid "INITIAL MESSAGE" +msgstr "" + # type: textblock -#: ../src/guestfs-actions.pod:231 ../fish/guestfish-actions.pod:173 +#. type: textblock +#: ../src/guestfs.pod:2333 msgid "" -"Defines an Augeas variable C whose value is the result of evaluating " -"C. If C is NULL, then C is undefined." +"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 +#. type: =head3 +#: ../src/guestfs.pod:2337 +msgid "PROGRESS NOTIFICATION MESSAGES" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:235 ../fish/guestfish-actions.pod:177 +#. type: textblock +#: ../src/guestfs.pod:2339 msgid "" -"On success this returns the number of nodes in C, or C<0> if C " -"evaluates to something which is not a nodeset." +"The daemon 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.pod:2343 +msgid "" +"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:238 ../src/guestfs-actions.pod:379 -#: ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:558 -#: ../src/guestfs-actions.pod:573 ../src/guestfs-actions.pod:589 -#: ../src/guestfs-actions.pod:1107 ../src/guestfs-actions.pod:1422 -#: ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1685 -#: ../src/guestfs-actions.pod:1716 ../src/guestfs-actions.pod:1759 -#: ../src/guestfs-actions.pod:1776 ../src/guestfs-actions.pod:2001 -#: ../src/guestfs-actions.pod:2213 ../src/guestfs-actions.pod:2231 -#: ../src/guestfs-actions.pod:3601 ../src/guestfs-actions.pod:3708 -#: ../src/guestfs-actions.pod:4062 ../src/guestfs-actions.pod:4085 -#: ../src/guestfs-actions.pod:5184 ../src/guestfs-actions.pod:5534 -#: ../src/guestfs-actions.pod:5544 ../src/guestfs-actions.pod:5554 -msgid "On error this function returns -1." +#. type: textblock +#: ../src/guestfs.pod:2347 +msgid "" +"The daemon self-limits the frequency of progress messages it sends (see " +"C). Not all calls generate progress " +"messages." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:240 -msgid "guestfs_aug_get" +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:2351 +msgid "LIBGUESTFS VERSION NUMBERS" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2353 +msgid "" +"Since April 2010, libguestfs has started to make separate development and " +"stable releases, along with corresponding branches in our git repository. " +"These separate releases can be identified by version number:" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:242 +#. type: verbatim +#: ../src/guestfs.pod:2358 #, no-wrap msgid "" -" char *guestfs_aug_get (guestfs_h *g,\n" -"\t\tconst char *augpath);\n" +" even numbers for stable: 1.2.x, 1.4.x, ...\n" +" .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n" +" |\n" +" v\n" +" 1 . 3 . 5\n" +" ^ ^\n" +" | |\n" +" | `-------- sub-version\n" +" |\n" +" `------ always '1' because we don't change the ABI\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:245 ../fish/guestfish-actions.pod:184 -msgid "" -"Look up the value associated with C. If C matches exactly one " -"node, the C is returned." +#. type: textblock +#: ../src/guestfs.pod:2369 +msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:248 ../src/guestfs-actions.pod:676 -#: ../src/guestfs-actions.pod:691 ../src/guestfs-actions.pod:748 -#: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:852 -#: ../src/guestfs-actions.pod:965 ../src/guestfs-actions.pod:994 -#: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1024 -#: ../src/guestfs-actions.pod:1135 ../src/guestfs-actions.pod:1299 -#: ../src/guestfs-actions.pod:1408 ../src/guestfs-actions.pod:1553 -#: ../src/guestfs-actions.pod:1567 ../src/guestfs-actions.pod:1643 -#: ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1795 -#: ../src/guestfs-actions.pod:1934 ../src/guestfs-actions.pod:2115 -#: ../src/guestfs-actions.pod:2165 ../src/guestfs-actions.pod:2281 -#: ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2631 -#: ../src/guestfs-actions.pod:2928 ../src/guestfs-actions.pod:3069 -#: ../src/guestfs-actions.pod:3165 ../src/guestfs-actions.pod:3723 -#: ../src/guestfs-actions.pod:3899 ../src/guestfs-actions.pod:4040 -#: ../src/guestfs-actions.pod:4201 ../src/guestfs-actions.pod:4244 -#: ../src/guestfs-actions.pod:4720 ../src/guestfs-actions.pod:4733 -#: ../src/guestfs-actions.pod:4747 ../src/guestfs-actions.pod:4768 -#: ../src/guestfs-actions.pod:5327 ../src/guestfs-actions.pod:5343 -#: ../src/guestfs-actions.pod:5358 ../src/guestfs-actions.pod:5506 -#: ../src/guestfs-actions.pod:5736 +#. type: textblock +#: ../src/guestfs.pod:2371 msgid "" -"This function returns a string, or NULL on error. I." +"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:251 -msgid "guestfs_aug_init" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2377 +msgid "Our criteria for backporting changes are:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:253 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2383 msgid "" -" int guestfs_aug_init (guestfs_h *g,\n" -"\t\tconst char *root,\n" -"\t\tint flags);\n" -"\n" +"Documentation changes which don't affect any code are backported unless the " +"documentation refers to a future feature which is not in stable." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:257 ../fish/guestfish-actions.pod:191 +#. type: textblock +#: ../src/guestfs.pod:2389 msgid "" -"Create a new Augeas handle for editing configuration files. If there was " -"any previous Augeas handle associated with this guestfs session, then it is " -"closed." +"Bug fixes which are not controversial, fix obvious problems, and have been " +"well tested are backported." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:261 -msgid "You must call this before using any other C commands." +#. type: textblock +#: ../src/guestfs.pod:2394 +msgid "" +"Simple rearrangements of code which shouldn't affect how it works get " +"backported. This is so that the code in the two branches doesn't get too " +"far out of step, allowing us to backport future fixes more easily." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:264 ../fish/guestfish-actions.pod:198 +#. type: textblock +#: ../src/guestfs.pod:2400 msgid "" -"C is the filesystem root. C must not be NULL, use C instead." +"We I backport new features, new APIs, new tools etc, except in one " +"exceptional case: the new feature is required in order to implement an " +"important bug fix." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:267 ../fish/guestfish-actions.pod:201 +#. type: textblock +#: ../src/guestfs.pod:2406 msgid "" -"The flags are the same as the flags defined in Eaugeas.hE, the " -"logical I of the following integers:" +"A new stable branch starts when we think the new features in development are " +"substantial and compelling enough over the current stable branch to warrant " +"it. When that happens we create new stable and development versions 1.N.0 " +"and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so " +"stable at this point, but by backporting fixes from development, that branch " +"will stabilize over time." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:273 ../fish/guestfish-actions.pod:207 -msgid "C = 1" +#. type: =head1 +#: ../src/guestfs.pod:2414 +msgid "EXTENDING LIBGUESTFS" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:209 -msgid "Keep the original file with a C<.augsave> extension." +#. type: =head2 +#: ../src/guestfs.pod:2416 +msgid "ADDING A NEW API ACTION" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:277 ../fish/guestfish-actions.pod:211 -msgid "C = 2" +#. type: textblock +#: ../src/guestfs.pod:2418 +msgid "" +"Large amounts of boilerplate code in libguestfs (RPC, bindings, " +"documentation) are generated, and this makes it easy to extend the " +"libguestfs API." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:279 ../fish/guestfish-actions.pod:213 -msgid "" -"Save changes into a file with extension C<.augnew>, and do not overwrite " -"original. Overrides C." +#. type: textblock +#: ../src/guestfs.pod:2422 +msgid "To add a new API action there are two changes:" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:282 ../fish/guestfish-actions.pod:216 -msgid "C = 4" +#. type: textblock +#: ../src/guestfs.pod:2428 +msgid "" +"You need to add a description of the call (name, parameters, return type, " +"tests, documentation) to C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:218 -msgid "Typecheck lenses (can be expensive)." +#. type: textblock +#: ../src/guestfs.pod:2431 +msgid "" +"There are two sorts of API action, depending on whether the call goes " +"through to the daemon in the appliance, or is serviced entirely by the " +"library (see L above). L is an example of the " +"former, since the sync is done in the appliance. L is " +"an example of the latter, since a trace flag is maintained in the handle and " +"all tracing is done on the library side." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:286 ../fish/guestfish-actions.pod:220 -msgid "C = 8" +#. type: textblock +#: ../src/guestfs.pod:2439 +msgid "" +"Most new actions are of the first type, and get added to the " +"C list. Each function has a unique procedure number used " +"in the RPC protocol which is assigned to that action when we publish " +"libguestfs and cannot be reused. Take the latest procedure number and " +"increment it." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:288 ../fish/guestfish-actions.pod:222 -msgid "Do not use standard load path for modules." +#. type: textblock +#: ../src/guestfs.pod:2445 +msgid "" +"For library-only actions of the second type, add to the " +"C list. Since these functions are serviced by the " +"library and do not travel over the RPC mechanism to the daemon, these " +"functions do not need a procedure number, and so the procedure number is set " +"to C<-1>." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:224 -msgid "C = 16" +#. type: textblock +#: ../src/guestfs.pod:2453 +msgid "Implement the action (in C):" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:292 ../fish/guestfish-actions.pod:226 -msgid "Make save a no-op, just record what would have been changed." +#. type: textblock +#: ../src/guestfs.pod:2455 +msgid "" +"For daemon actions, implement the function CnameE> in the " +"C directory." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:294 ../fish/guestfish-actions.pod:228 -msgid "C = 32" +#. type: textblock +#: ../src/guestfs.pod:2458 +msgid "" +"For library actions, implement the function CnameE> " +"(note: double underscore) in the C directory." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:296 -msgid "Do not load the tree in C." +#. type: textblock +#: ../src/guestfs.pod:2461 +msgid "In either case, use another function as an example of what to do." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:300 -msgid "To close the handle, you can call C." +#. type: textblock +#: ../src/guestfs.pod:2465 +msgid "After making these changes, use C to compile." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:302 ../fish/guestfish-actions.pod:236 -msgid "To find out more about Augeas, see L." +#. type: textblock +#: ../src/guestfs.pod:2467 +msgid "" +"Note that you don't need to implement the RPC, language bindings, manual " +"pages or anything else. It's all automatically generated from the OCaml " +"description." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:306 -msgid "guestfs_aug_insert" +#. type: =head2 +#: ../src/guestfs.pod:2471 +msgid "ADDING TESTS FOR AN API ACTION" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:308 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2473 msgid "" -" int guestfs_aug_insert (guestfs_h *g,\n" -"\t\tconst char *augpath,\n" -"\t\tconst char *label,\n" -"\t\tint before);\n" -"\n" +"You can supply zero or as many tests as you want per API call. The tests " +"can either be added as part of the API description (C), or in some rarer cases you may want to drop a script " +"into C. Note that adding a script to C is " +"slower, so if possible use the first method." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:242 +#. type: textblock +#: ../src/guestfs.pod:2479 msgid "" -"Create a new sibling C