X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=po-docs%2Flibguestfs-docs.pot;h=08347012e21062f177d8554f6a54e592582eb3fc;hp=d8d5d1f7bad591c57c870b985d2fcd03a2547223;hb=8ae40fa990b38005379c1c831f56c07b6b452bee;hpb=12cf2f732a275928a7ce727840e1f5ba6684754d;ds=sidebyside diff --git a/po-docs/libguestfs-docs.pot b/po-docs/libguestfs-docs.pot index d8d5d1f..0834701 100644 --- a/po-docs/libguestfs-docs.pot +++ b/po-docs/libguestfs-docs.pot @@ -6,9 +6,9 @@ #, fuzzy msgid "" msgstr "" -"Project-Id-Version: libguestfs 1.7.2\n" +"Project-Id-Version: libguestfs 1.7.24\n" "Report-Msgid-Bugs-To: libguestfs@redhat.com\n" -"POT-Creation-Date: 2010-11-05 12:18+0000\n" +"POT-Creation-Date: 2010-12-16 23:16+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -17,12 +17,12 @@ msgstr "" "Content-Transfer-Encoding: ENCODING" # type: =encoding -#: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 ../inspector/virt-inspector.pl:31 ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:30 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-cat.pl:29 ../tools/virt-tar.pl:29 ../tools/virt-rescue.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28 +#: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-tar.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28 msgid "utf8" msgstr "" # type: =head1 -#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pl:33 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:32 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-cat.pl:31 ../tools/virt-tar.pl:31 ../tools/virt-rescue.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 +#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 msgid "NAME" msgstr "" @@ -32,7 +32,7 @@ msgid "guestfs - Library for accessing and modifying virtual machine images" msgstr "" # type: =head1 -#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pl:37 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:36 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-cat.pl:35 ../tools/virt-tar.pl:35 ../tools/virt-rescue.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 +#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 msgid "SYNOPSIS" msgstr "" @@ -54,13 +54,12 @@ msgid "" " guestfs_mount (g, \"/dev/sda1\", \"/\");\n" " guestfs_touch (g, \"/hello\");\n" " guestfs_umount (g, \"/\");\n" -" guestfs_sync (g);\n" " guestfs_close (g);\n" "\n" msgstr "" # type: verbatim -#: ../src/guestfs.pod:20 +#: ../src/guestfs.pod:19 #, no-wrap msgid "" " cc prog.c -o prog -lguestfs\n" @@ -70,12 +69,12 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../inspector/virt-inspector.pl:43 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:42 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-cat.pl:41 ../tools/virt-tar.pl:72 ../tools/virt-rescue.pl:51 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40 +#: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:72 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40 msgid "DESCRIPTION" msgstr "" # type: textblock -#: ../src/guestfs.pod:26 +#: ../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 " @@ -86,7 +85,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:34 +#: ../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, " @@ -95,7 +94,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:39 +#: ../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 " @@ -103,7 +102,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:44 +#: ../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, " @@ -112,26 +111,33 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:49 +#: ../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 +#: ../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 +#: ../src/guestfs.pod:54 +msgid "" +"There are also some example programs in the L manual " +"page." +msgstr "" + # type: =head1 -#: ../src/guestfs.pod:55 +#: ../src/guestfs.pod:57 msgid "API OVERVIEW" msgstr "" # type: textblock -#: ../src/guestfs.pod:57 +#: ../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 " @@ -139,12 +145,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:62 +#: ../src/guestfs.pod:64 msgid "HANDLES" msgstr "" # type: textblock -#: ../src/guestfs.pod:64 +#: ../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 " @@ -154,12 +160,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:71 +#: ../src/guestfs.pod:73 msgid "The general structure of all libguestfs-using programs looks like this:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:74 +#: ../src/guestfs.pod:76 #, no-wrap msgid "" " guestfs_h *g = guestfs_create ();\n" @@ -167,7 +173,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:76 +#: ../src/guestfs.pod:78 #, no-wrap msgid "" " /* Call guestfs_add_drive additional times if there are\n" @@ -178,7 +184,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:81 +#: ../src/guestfs.pod:83 #, no-wrap msgid "" " /* Most manipulation calls won't work until you've launched\n" @@ -190,7 +196,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:87 +#: ../src/guestfs.pod:89 #, no-wrap msgid "" " /* Now you can examine what partitions, LVs etc are available.\n" @@ -201,7 +207,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:92 +#: ../src/guestfs.pod:94 #, no-wrap msgid "" " /* To access a filesystem in the image, you must mount it.\n" @@ -211,31 +217,30 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:96 +#: ../src/guestfs.pod:98 #, no-wrap msgid "" " /* Now you can perform filesystem actions on the guest\n" " * disk image.\n" " */\n" " guestfs_touch (g, \"/hello\");\n" -" \n" +"\n" msgstr "" # type: verbatim -#: ../src/guestfs.pod:101 +#: ../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 +#: ../src/guestfs.pod:109 #, no-wrap msgid "" " /* Close the handle 'g'. */\n" @@ -244,23 +249,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:111 +#: ../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 +#: ../src/guestfs.pod:121 msgid "DISK IMAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:121 +#: ../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 " @@ -270,7 +276,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:127 +#: ../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 " @@ -278,7 +284,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:131 +#: ../src/guestfs.pod:133 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -288,12 +294,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:135 +#: ../src/guestfs.pod:137 msgid "You can add a disk read-only using:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:137 +#: ../src/guestfs.pod:139 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -304,14 +310,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:142 +#: ../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 +#: ../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 " @@ -319,7 +325,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:149 +#: ../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 " @@ -327,7 +333,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:154 +#: ../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 " @@ -335,12 +341,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:159 +#: ../src/guestfs.pod:161 msgid "MOUNTING" msgstr "" # type: textblock -#: ../src/guestfs.pod:161 +#: ../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 " @@ -350,7 +356,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:167 +#: ../src/guestfs.pod:169 #, no-wrap msgid "" " guestfs_mount (g, \"/dev/sda1\", \"/\");\n" @@ -358,7 +364,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:169 +#: ../src/guestfs.pod:171 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 " @@ -366,7 +372,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:173 +#: ../src/guestfs.pod:175 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 " @@ -379,19 +385,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:183 +#: ../src/guestfs.pod:185 msgid "" "To mount a disk image read-only, use L. There are " "several other variations of the C call." msgstr "" # type: =head2 -#: ../src/guestfs.pod:186 +#: ../src/guestfs.pod:188 msgid "FILESYSTEM ACCESS AND MODIFICATION" msgstr "" # type: textblock -#: ../src/guestfs.pod:188 +#: ../src/guestfs.pod:190 msgid "" "The majority of the libguestfs API consists of fairly low-level calls for " "accessing and modifying the files, directories, symlinks etc on mounted " @@ -401,21 +407,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:194 +#: ../src/guestfs.pod:196 msgid "" "Specify filenames as full paths, starting with C<\"/\"> and including the " "mount point." msgstr "" # type: textblock -#: ../src/guestfs.pod:197 +#: ../src/guestfs.pod:199 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 +#: ../src/guestfs.pod:202 #, no-wrap msgid "" " char *data = guestfs_cat (g, \"/etc/passwd\");\n" @@ -423,7 +429,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:202 +#: ../src/guestfs.pod:204 msgid "" "This would return C as a newly allocated buffer containing the full " "content of that file (with some conditions: see also L below), " @@ -431,14 +437,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:206 +#: ../src/guestfs.pod:208 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 +#: ../src/guestfs.pod:211 #, no-wrap msgid "" " guestfs_mkdir (g, \"/var\");\n" @@ -446,12 +452,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:211 +#: ../src/guestfs.pod:213 msgid "To create a symlink you could do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:213 +#: ../src/guestfs.pod:215 #, no-wrap msgid "" " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n" @@ -460,14 +466,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:216 +#: ../src/guestfs.pod:218 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 +#: ../src/guestfs.pod:221 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 " @@ -477,33 +483,33 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:225 +#: ../src/guestfs.pod:227 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 +#: ../src/guestfs.pod:230 msgid "PARTITIONING" msgstr "" # type: textblock -#: ../src/guestfs.pod:230 +#: ../src/guestfs.pod:232 msgid "" "Libguestfs contains API calls to read, create and modify partition tables on " "disk images." msgstr "" # type: textblock -#: ../src/guestfs.pod:233 +#: ../src/guestfs.pod:235 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 +#: ../src/guestfs.pod:239 #, no-wrap msgid "" " const char *parttype = \"mbr\";\n" @@ -514,19 +520,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:242 +#: ../src/guestfs.pod:244 msgid "" "Obviously this effectively wipes anything that was on that disk image " "before." msgstr "" # type: =head2 -#: ../src/guestfs.pod:245 +#: ../src/guestfs.pod:247 msgid "LVM2" msgstr "" # type: textblock -#: ../src/guestfs.pod:247 +#: ../src/guestfs.pod:249 msgid "" "Libguestfs provides access to a large part of the LVM2 API, such as " "L and L. It won't make much sense " @@ -535,19 +541,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:252 +#: ../src/guestfs.pod:254 msgid "" "This author strongly recommends reading the LVM HOWTO, online at " "L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:255 +#: ../src/guestfs.pod:257 msgid "DOWNLOADING" msgstr "" # type: textblock -#: ../src/guestfs.pod:257 +#: ../src/guestfs.pod:259 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 " @@ -555,7 +561,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:262 +#: ../src/guestfs.pod:264 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 " @@ -563,31 +569,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:266 +#: ../src/guestfs.pod:268 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 +#: ../src/guestfs.pod:271 msgid "To download multiple files, see L and L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:272 +#: ../src/guestfs.pod:274 msgid "UPLOADING" msgstr "" # type: textblock -#: ../src/guestfs.pod:274 +#: ../src/guestfs.pod:276 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 +#: ../src/guestfs.pod:279 msgid "" "To write a small file with fixed content, use L. To create " "a file of all zeroes, use L (sparse) or " @@ -597,19 +603,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:283 +#: ../src/guestfs.pod:285 msgid "" "To upload a single file, use L. This call has no limits on " "file content or size (even files larger than 4 GB)." msgstr "" # type: textblock -#: ../src/guestfs.pod:286 +#: ../src/guestfs.pod:288 msgid "To upload multiple files, see L and L." msgstr "" # type: textblock -#: ../src/guestfs.pod:288 +#: ../src/guestfs.pod:290 msgid "" "However the fastest way to upload I is to " "turn them into a squashfs or CD ISO (see L and " @@ -623,12 +629,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:299 +#: ../src/guestfs.pod:301 msgid "COPYING" msgstr "" # type: textblock -#: ../src/guestfs.pod:301 +#: ../src/guestfs.pod:303 msgid "" "There are various different commands for copying between files and devices " "and in and out of the guest filesystem. These are summarised in the table " @@ -636,36 +642,36 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:307 +#: ../src/guestfs.pod:309 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:309 +#: ../src/guestfs.pod:311 msgid "" "Use L to copy a single file, or L to copy " "directories recursively." msgstr "" # type: =item -#: ../src/guestfs.pod:312 +#: ../src/guestfs.pod:314 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:314 +#: ../src/guestfs.pod:316 msgid "" "Use L which efficiently uses L to copy between files and " "devices in the guest." msgstr "" # type: textblock -#: ../src/guestfs.pod:317 +#: ../src/guestfs.pod:319 msgid "Example: duplicate the contents of an LV:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:319 +#: ../src/guestfs.pod:321 #, no-wrap msgid "" " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n" @@ -673,7 +679,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:321 +#: ../src/guestfs.pod:323 msgid "" "The destination (C) must be at least as large as the source " "(C). To copy less than the whole source device, use " @@ -681,46 +687,46 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:325 +#: ../src/guestfs.pod:327 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:327 +#: ../src/guestfs.pod:329 msgid "Use L. See L above." msgstr "" # type: =item -#: ../src/guestfs.pod:329 +#: ../src/guestfs.pod:331 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:331 +#: ../src/guestfs.pod:333 msgid "Use L. See L above." msgstr "" # type: =head2 -#: ../src/guestfs.pod:335 +#: ../src/guestfs.pod:337 msgid "LISTING FILES" msgstr "" # type: textblock -#: ../src/guestfs.pod:337 +#: ../src/guestfs.pod:339 msgid "" "L is just designed for humans to read (mainly when using the " "L-equivalent command C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:340 +#: ../src/guestfs.pod:342 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 +#: ../src/guestfs.pod:345 msgid "" "L is a programmatic way to get a list of files in a " "directory, plus additional information about each one. It is more " @@ -728,19 +734,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:347 +#: ../src/guestfs.pod:349 msgid "" "L and L can be used to recursively list " "files." msgstr "" # type: =head2 -#: ../src/guestfs.pod:350 +#: ../src/guestfs.pod:352 msgid "RUNNING COMMANDS" msgstr "" # type: textblock -#: ../src/guestfs.pod:352 +#: ../src/guestfs.pod:354 msgid "" "Although libguestfs is primarily an API for manipulating files inside guest " "images, we also provide some limited facilities for running commands inside " @@ -748,60 +754,60 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:356 +#: ../src/guestfs.pod:358 msgid "There are many limitations to this:" msgstr "" # type: =item -#: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370 ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383 ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:1224 ../src/guestfs.pod:1229 ../src/guestfs.pod:1233 ../src/guestfs.pod:1449 ../src/guestfs.pod:1454 ../src/guestfs.pod:1458 ../src/guestfs.pod:1560 ../src/guestfs.pod:1564 ../src/guestfs.pod:1568 ../src/guestfs.pod:1573 ../src/guestfs.pod:1581 ../src/guestfs.pod:1600 ../src/guestfs.pod:1608 ../src/guestfs.pod:1838 ../src/guestfs.pod:1844 ../src/guestfs.pod:1849 ../src/guestfs.pod:1855 ../src/guestfs.pod:1962 ../src/guestfs.pod:1966 ../src/guestfs.pod:1970 ../src/guestfs.pod:1974 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:516 ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:1558 ../src/guestfs-actions.pod:1562 ../src/guestfs-actions.pod:1566 ../src/guestfs-actions.pod:1570 ../src/guestfs-actions.pod:1578 ../src/guestfs-actions.pod:1582 ../src/guestfs-actions.pod:1586 ../src/guestfs-actions.pod:1596 ../src/guestfs-actions.pod:1600 ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1742 ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:1751 ../src/guestfs-actions.pod:1756 ../src/guestfs-actions.pod:1817 ../src/guestfs-actions.pod:1821 ../src/guestfs-actions.pod:1826 ../fish/guestfish.pod:364 ../fish/guestfish.pod:368 ../fish/guestfish.pod:372 ../fish/guestfish.pod:376 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:339 ../fish/guestfish-actions.pod:347 ../fish/guestfish-actions.pod:354 ../fish/guestfish-actions.pod:361 ../fish/guestfish-actions.pod:1056 ../fish/guestfish-actions.pod:1060 ../fish/guestfish-actions.pod:1064 ../fish/guestfish-actions.pod:1068 ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1094 ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102 ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1196 ../fish/guestfish-actions.pod:1201 ../fish/guestfish-actions.pod:1206 ../fish/guestfish-actions.pod:1248 ../fish/guestfish-actions.pod:1252 ../fish/guestfish-actions.pod:1257 ../inspector/virt-inspector.pl:584 ../inspector/virt-inspector.pl:588 ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348 ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363 +#: ../src/guestfs.pod:362 ../src/guestfs.pod:367 ../src/guestfs.pod:372 ../src/guestfs.pod:376 ../src/guestfs.pod:381 ../src/guestfs.pod:385 ../src/guestfs.pod:390 ../src/guestfs.pod:395 ../src/guestfs.pod:985 ../src/guestfs.pod:989 ../src/guestfs.pod:993 ../src/guestfs.pod:998 ../src/guestfs.pod:1006 ../src/guestfs.pod:1025 ../src/guestfs.pod:1033 ../src/guestfs.pod:1055 ../src/guestfs.pod:1059 ../src/guestfs.pod:1063 ../src/guestfs.pod:1067 ../src/guestfs.pod:1071 ../src/guestfs.pod:1075 ../src/guestfs.pod:1557 ../src/guestfs.pod:1562 ../src/guestfs.pod:1566 ../src/guestfs.pod:1676 ../src/guestfs.pod:1681 ../src/guestfs.pod:1685 ../src/guestfs.pod:2037 ../src/guestfs.pod:2043 ../src/guestfs.pod:2048 ../src/guestfs.pod:2054 ../src/guestfs.pod:2166 ../src/guestfs.pod:2170 ../src/guestfs.pod:2174 ../src/guestfs.pod:2178 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:579 ../src/guestfs-actions.pod:586 ../src/guestfs-actions.pod:593 ../src/guestfs-actions.pod:1589 ../src/guestfs-actions.pod:1593 ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1613 ../src/guestfs-actions.pod:1617 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1635 ../src/guestfs-actions.pod:1773 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1787 ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1852 ../src/guestfs-actions.pod:1857 ../fish/guestfish.pod:427 ../fish/guestfish.pod:431 ../fish/guestfish.pod:435 ../fish/guestfish.pod:439 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:375 ../fish/guestfish-actions.pod:383 ../fish/guestfish-actions.pod:390 ../fish/guestfish-actions.pod:397 ../fish/guestfish-actions.pod:1067 ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075 ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087 ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095 ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109 ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203 ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259 ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360 msgid "*" msgstr "" # type: textblock -#: ../src/guestfs.pod:362 +#: ../src/guestfs.pod:364 msgid "" "The kernel version that the command runs under will be different from what " "it expects." msgstr "" # type: textblock -#: ../src/guestfs.pod:367 +#: ../src/guestfs.pod:369 msgid "" "If the command needs to communicate with daemons, then most likely they " "won't be running." msgstr "" # type: textblock -#: ../src/guestfs.pod:372 +#: ../src/guestfs.pod:374 msgid "The command will be running in limited memory." msgstr "" # type: textblock -#: ../src/guestfs.pod:376 +#: ../src/guestfs.pod:378 msgid "" "The network may not be available unless you enable it (see " "L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:381 +#: ../src/guestfs.pod:383 msgid "Only supports Linux guests (not Windows, BSD, etc)." msgstr "" # type: textblock -#: ../src/guestfs.pod:385 +#: ../src/guestfs.pod:387 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)." msgstr "" # type: textblock -#: ../src/guestfs.pod:390 +#: ../src/guestfs.pod:392 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 +#: ../src/guestfs.pod:397 msgid "" "I It is not safe to run commands from untrusted, possibly " "malicious guests. These commands may attempt to exploit your program by " @@ -813,35 +819,36 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:404 +#: ../src/guestfs.pod:406 msgid "" "A secure alternative is to use libguestfs to install a \"firstboot\" script " "(a script which runs when the guest next boots normally), and to have this " "script run the commands you want in the normal context of the running guest, " -"network security and so on." +"network security and so on. For information about other security issues, " +"see L." msgstr "" # type: textblock -#: ../src/guestfs.pod:411 +#: ../src/guestfs.pod:414 msgid "" "The two main API calls to run commands are L and " "L (there are also variations)." msgstr "" # type: textblock -#: ../src/guestfs.pod:414 +#: ../src/guestfs.pod:417 msgid "" "The difference is that L runs commands using the shell, so any " "shell globs, redirections, etc will work." msgstr "" # type: =head2 -#: ../src/guestfs.pod:417 +#: ../src/guestfs.pod:420 msgid "CONFIGURATION FILES" msgstr "" # type: textblock -#: ../src/guestfs.pod:419 +#: ../src/guestfs.pod:422 msgid "" "To read and write configuration files in Linux guest filesystems, we " "strongly recommend using Augeas. For example, Augeas understands how to " @@ -850,7 +857,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:424 +#: ../src/guestfs.pod:427 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 " @@ -858,7 +865,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:428 +#: ../src/guestfs.pod:431 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 " @@ -866,29 +873,29 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:432 +#: ../src/guestfs.pod:435 msgid "SELINUX" msgstr "" # type: textblock -#: ../src/guestfs.pod:434 +#: ../src/guestfs.pod:437 msgid "" "We support SELinux guests. To ensure that labeling happens correctly in " "SELinux guests, you need to enable SELinux and load the guest's policy:" msgstr "" # type: =item -#: ../src/guestfs.pod:440 ../src/guestfs.pod:953 +#: ../src/guestfs.pod:443 ../src/guestfs.pod:1178 ../src/guestfs.pod:1309 msgid "1." msgstr "" # type: textblock -#: ../src/guestfs.pod:442 +#: ../src/guestfs.pod:445 msgid "Before launching, do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:444 +#: ../src/guestfs.pod:447 #, no-wrap msgid "" " guestfs_set_selinux (g, 1);\n" @@ -896,19 +903,19 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:446 ../src/guestfs.pod:957 +#: ../src/guestfs.pod:449 ../src/guestfs.pod:1182 ../src/guestfs.pod:1313 msgid "2." msgstr "" # type: textblock -#: ../src/guestfs.pod:448 +#: ../src/guestfs.pod:451 msgid "" "After mounting the guest's filesystem(s), load the policy. This is best " "done by running the L command in the guest itself:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:452 +#: ../src/guestfs.pod:455 #, no-wrap msgid "" " guestfs_sh (g, \"/usr/sbin/load_policy\");\n" @@ -916,26 +923,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:454 +#: ../src/guestfs.pod:457 msgid "" "(Older versions of C require you to specify the name of the " "policy file)." msgstr "" # type: =item -#: ../src/guestfs.pod:457 ../src/guestfs.pod:963 +#: ../src/guestfs.pod:460 ../src/guestfs.pod:1319 msgid "3." msgstr "" # type: textblock -#: ../src/guestfs.pod:459 +#: ../src/guestfs.pod:462 msgid "" "Optionally, set the security context for the API. The correct security " "context to use can only be known by inspecting the guest. As an example:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:463 +#: ../src/guestfs.pod:466 #, no-wrap msgid "" " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n" @@ -943,24 +950,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:467 +#: ../src/guestfs.pod:470 msgid "This will work for running commands and editing existing files." msgstr "" # type: textblock -#: ../src/guestfs.pod:469 +#: ../src/guestfs.pod:472 msgid "" "When new files are created, you may need to label them explicitly, for " "example by running the external command C." msgstr "" # type: =head2 -#: ../src/guestfs.pod:473 +#: ../src/guestfs.pod:476 msgid "UMASK" msgstr "" # type: textblock -#: ../src/guestfs.pod:475 +#: ../src/guestfs.pod:478 msgid "" "Certain calls are affected by the current file mode creation mask (the " "\"umask\"). In particular ones which create files or directories, such as " @@ -970,14 +977,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:481 +#: ../src/guestfs.pod:484 msgid "" "The default umask is C<022>, so files are created with modes such as C<0644> " "and directories with C<0755>." msgstr "" # type: textblock -#: ../src/guestfs.pod:484 +#: ../src/guestfs.pod:487 msgid "" "There are two ways to avoid being affected by umask. Either set umask to 0 " "(call C early after launching). Or call " @@ -985,17 +992,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:488 +#: ../src/guestfs.pod:491 msgid "For more information about umask, see L." msgstr "" # type: =head1 -#: ../src/guestfs.pod:490 ../fish/guestfish.pod:630 +#: ../src/guestfs.pod:493 ../fish/guestfish.pod:720 msgid "ENCRYPTED DISKS" msgstr "" # type: textblock -#: ../src/guestfs.pod:492 +#: ../src/guestfs.pod:495 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) " @@ -1004,21 +1011,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:498 +#: ../src/guestfs.pod:501 msgid "" "Use L to identify LUKS-encrypted block devices (it " "returns the string C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:501 +#: ../src/guestfs.pod:504 msgid "" "Then open these devices by calling L. Obviously you " "will require the passphrase!" msgstr "" # type: textblock -#: ../src/guestfs.pod:504 +#: ../src/guestfs.pod:507 msgid "" "Opening a LUKS device creates a new device mapper device called " "C (where C is the string you supply to " @@ -1027,7 +1034,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:510 +#: ../src/guestfs.pod:513 msgid "" "LVM volume groups on the device can be made visible by calling " "L followed by L. The logical " @@ -1035,7 +1042,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:514 +#: ../src/guestfs.pod:517 msgid "" "Use the reverse process to close a LUKS device. Unmount any logical volumes " "on it, deactivate the volume groups by caling C in the usual way." msgstr "" # type: textblock -#: ../src/guestfs.pod:532 +#: ../src/guestfs.pod:535 msgid "" "Then call L. This function uses other libguestfs calls " "and certain heuristics, and returns a list of operating systems that were " @@ -1080,7 +1087,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:541 +#: ../src/guestfs.pod:544 msgid "" "For each root, you can then call various C functions " "to get additional details about that operating system. For example, call " @@ -1089,7 +1096,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:547 +#: ../src/guestfs.pod:550 msgid "" "Un*x-like and Linux-based operating systems usually consist of several " "filesystems which are mounted at boot time (for example, a separate boot " @@ -1100,7 +1107,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:554 +#: ../src/guestfs.pod:557 #, no-wrap msgid "" " /boot => /dev/sda1\n" @@ -1110,14 +1117,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:558 +#: ../src/guestfs.pod:561 msgid "" "The caller can then make calls to L to mount the " "filesystems as suggested." msgstr "" # type: textblock -#: ../src/guestfs.pod:561 +#: ../src/guestfs.pod:564 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 " @@ -1125,7 +1132,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:565 +#: ../src/guestfs.pod:568 msgid "" "Inspection currently only works for some common operating systems. " "Contributors are welcome to send patches for other operating systems that we " @@ -1133,7 +1140,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:569 +#: ../src/guestfs.pod:572 msgid "" "Encrypted disks must be opened before inspection. See L " "for more details. The L function just ignores any " @@ -1141,29 +1148,37 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:573 +#: ../src/guestfs.pod:576 msgid "" "A note on the implementation: The call L performs " "inspection and caches the results in the guest handle. Subsequent calls to " "C return this cached information, but I " "re-read the disks. If you change the content of the guest disks, you can " -"redo inspection by calling L again." +"redo inspection by calling L again. " +"(L works a little differently from the " +"other calls and does read the disks. See documentation for that function " +"for details)." msgstr "" # type: =head2 -#: ../src/guestfs.pod:580 +#: ../src/guestfs.pod:585 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:582 +#: ../src/guestfs.pod:587 msgid "" "Libguestfs can mount NTFS partitions. It does this using the " "L driver." msgstr "" +# type: =head3 +#: ../src/guestfs.pod:590 +msgid "DRIVE LETTERS AND PATHS" +msgstr "" + # type: textblock -#: ../src/guestfs.pod:585 +#: ../src/guestfs.pod:592 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 " @@ -1173,7 +1188,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:591 +#: ../src/guestfs.pod:598 msgid "" "Drive letter mappings are outside the scope of libguestfs. You have to use " "libguestfs to read the appropriate Windows Registry and configuration files, " @@ -1182,21 +1197,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:596 +#: ../src/guestfs.pod:603 msgid "" "Replacing backslash characters with forward slash characters is also outside " "the scope of libguestfs, but something that you can easily do." msgstr "" # type: textblock -#: ../src/guestfs.pod:599 +#: ../src/guestfs.pod:606 msgid "" "Where we can help is in resolving the case insensitivity of paths. For " "this, call L." msgstr "" +# type: =head3 +#: ../src/guestfs.pod:609 +msgid "ACCESSING THE WINDOWS REGISTRY" +msgstr "" + # type: textblock -#: ../src/guestfs.pod:602 +#: ../src/guestfs.pod:611 msgid "" "Libguestfs also provides some help for decoding Windows Registry \"hive\" " "files, through the library C which is part of the libguestfs project " @@ -1206,20 +1226,74 @@ msgid "" "L for more help on this issue." msgstr "" +# type: =head3 +#: ../src/guestfs.pod:619 +msgid "SYMLINKS ON NTFS-3G FILESYSTEMS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:621 +msgid "" +"Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to " +"provide something which looks like a Linux symlink. The way it tries to do " +"the rewriting is described here:" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:625 +msgid "L" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:627 +msgid "" +"The essential problem is that ntfs-3g simply does not have enough " +"information to do a correct job. NTFS links can contain drive letters and " +"references to external device GUIDs that ntfs-3g has no way of resolving. " +"It is almost certainly the case that libguestfs callers should ignore what " +"ntfs-3g does (ie. don't use L on NTFS volumes)." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:634 +msgid "" +"Instead if you encounter a symbolic link on an ntfs-3g filesystem, use " +"L to read the C extended " +"attribute, and read the raw reparse data from that (you can find the format " +"documented in various places around the web)." +msgstr "" + +# type: =head3 +#: ../src/guestfs.pod:639 +msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:641 +msgid "" +"There are other useful extended attributes that can be read from ntfs-3g " +"filesystems (using L). See:" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:644 +msgid "L" +msgstr "" + # type: =head2 -#: ../src/guestfs.pod:610 +#: ../src/guestfs.pod:646 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:612 +#: ../src/guestfs.pod:648 msgid "" "Although we don't want to discourage you from using the C API, we will " "mention here that the same API is also available in other languages." msgstr "" # type: textblock -#: ../src/guestfs.pod:615 +#: ../src/guestfs.pod:651 msgid "" "The API is broadly identical in all supported languages. This means that " "the C call C is C<$g-Emount($path)> in Perl, " @@ -1228,14 +1302,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:621 +#: ../src/guestfs.pod:657 msgid "" "Error messages are automatically transformed into exceptions if the language " "supports it." msgstr "" # type: textblock -#: ../src/guestfs.pod:624 +#: ../src/guestfs.pod:660 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 " @@ -1243,36 +1317,36 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:630 +#: ../src/guestfs.pod:666 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:632 +#: ../src/guestfs.pod:668 msgid "" "You can use the I header file from C++ programs. The C++ API is " "identical to the C API. C++ classes and exceptions are not used." msgstr "" # type: =item -#: ../src/guestfs.pod:636 +#: ../src/guestfs.pod:672 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:638 +#: ../src/guestfs.pod:674 msgid "" "The C# bindings are highly experimental. Please read the warnings at the " "top of C." msgstr "" # type: =item -#: ../src/guestfs.pod:641 +#: ../src/guestfs.pod:677 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:643 +#: ../src/guestfs.pod:679 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 " @@ -1280,103 +1354,91 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:647 +#: ../src/guestfs.pod:683 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:649 +#: ../src/guestfs.pod:685 msgid "" "Full documentation is contained in the Javadoc which is distributed with " "libguestfs." msgstr "" # type: =item -#: ../src/guestfs.pod:652 +#: ../src/guestfs.pod:688 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:654 -msgid "For documentation see the file C." +#: ../src/guestfs.pod:690 +msgid "For documentation see L." msgstr "" # type: =item -#: ../src/guestfs.pod:656 +#: ../src/guestfs.pod:692 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:658 +#: ../src/guestfs.pod:694 msgid "For documentation see L." msgstr "" # type: =item -#: ../src/guestfs.pod:660 +#: ../src/guestfs.pod:696 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:662 +#: ../src/guestfs.pod:698 msgid "" "For documentation see C supplied with libguestfs sources or in " "the php-libguestfs package for your distribution." msgstr "" # type: textblock -#: ../src/guestfs.pod:665 +#: ../src/guestfs.pod:701 msgid "The PHP binding only works correctly on 64 bit machines." msgstr "" # type: =item -#: ../src/guestfs.pod:667 +#: ../src/guestfs.pod:703 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:669 -msgid "For documentation do:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:671 -#, no-wrap -msgid "" -" $ python\n" -" >>> import guestfs\n" -" >>> help (guestfs)\n" -"\n" +#: ../src/guestfs.pod:705 +msgid "For documentation see L." msgstr "" # type: =item -#: ../src/guestfs.pod:675 +#: ../src/guestfs.pod:707 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:677 -msgid "" -"Use the Guestfs module. There is no Ruby-specific documentation, but you " -"can find examples written in Ruby in the libguestfs source." +#: ../src/guestfs.pod:709 +msgid "For documentation see L." msgstr "" # type: =item -#: ../src/guestfs.pod:680 +#: ../src/guestfs.pod:711 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:682 +#: ../src/guestfs.pod:713 msgid "For documentation see L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:686 +#: ../src/guestfs.pod:717 msgid "LIBGUESTFS GOTCHAS" msgstr "" # type: textblock -#: ../src/guestfs.pod:688 +#: ../src/guestfs.pod:719 msgid "" "L: \"A feature of a " "system [...] that works in the way it is documented but is counterintuitive " @@ -1384,7 +1446,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:692 +#: ../src/guestfs.pod:723 msgid "" "Since we developed libguestfs and the associated tools, there are several " "things we would have designed differently, but are now stuck with for " @@ -1393,12 +1455,12 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:700 +#: ../src/guestfs.pod:731 msgid "Autosync / forgetting to sync." msgstr "" # type: textblock -#: ../src/guestfs.pod:702 +#: ../src/guestfs.pod:733 msgid "" "When modifying a filesystem from C or another language, you B unmount " "all filesystems and call L explicitly before you close the " @@ -1406,7 +1468,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:706 +#: ../src/guestfs.pod:737 #, no-wrap msgid "" " guestfs_set_autosync (g, 1);\n" @@ -1414,7 +1476,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:708 +#: ../src/guestfs.pod:739 msgid "" "to have the unmount/sync done automatically for you when the handle 'g' is " "closed. (This feature is called \"autosync\", L " @@ -1422,7 +1484,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:712 +#: ../src/guestfs.pod:743 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 " @@ -1430,7 +1492,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:716 +#: ../src/guestfs.pod:747 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 " @@ -1438,19 +1500,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:720 +#: ../src/guestfs.pod:751 msgid "" "Update: Autosync is enabled by default for all API users starting from " "libguestfs 1.5.24." msgstr "" # type: =item -#: ../src/guestfs.pod:723 +#: ../src/guestfs.pod:754 msgid "Mount option C<-o sync> should not be the default." msgstr "" # type: textblock -#: ../src/guestfs.pod:725 +#: ../src/guestfs.pod:756 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 " @@ -1458,31 +1520,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:729 +#: ../src/guestfs.pod:760 msgid "" "The work around is to use L and set the mount " "options that you actually want to use." msgstr "" # type: =item -#: ../src/guestfs.pod:732 +#: ../src/guestfs.pod:763 msgid "Read-only should be the default." msgstr "" # type: textblock -#: ../src/guestfs.pod:734 +#: ../src/guestfs.pod:765 msgid "" "In L, I<--ro> should be the default, and you should have to " "specify I<--rw> if you want to make changes to the image." msgstr "" # type: textblock -#: ../src/guestfs.pod:737 +#: ../src/guestfs.pod:768 msgid "This would reduce the potential to corrupt live VM images." msgstr "" # type: textblock -#: ../src/guestfs.pod:739 +#: ../src/guestfs.pod:770 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 " @@ -1490,12 +1552,12 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:743 +#: ../src/guestfs.pod:774 msgid "guestfish command line is hard to use." msgstr "" # type: textblock -#: ../src/guestfs.pod:745 +#: ../src/guestfs.pod:776 msgid "" "C doesn't do what people expect (open C for " "examination). It tries to run a guestfish command C which doesn't " @@ -1505,12 +1567,12 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:752 +#: ../src/guestfs.pod:783 msgid "guestfish megabyte modifiers don't work right on all commands" msgstr "" # type: textblock -#: ../src/guestfs.pod:754 +#: ../src/guestfs.pod:785 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 " @@ -1520,12 +1582,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:761 +#: ../src/guestfs.pod:792 msgid "The most common is L. The guestfish command:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:763 +#: ../src/guestfs.pod:794 #, no-wrap msgid "" " lvcreate LV VG 100M\n" @@ -1533,7 +1595,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:765 +#: ../src/guestfs.pod:796 msgid "" "does not do what you might expect. Instead because L is " "already expecting megabytes, this tries to create a 100 I (100 " @@ -1542,19 +1604,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:770 +#: ../src/guestfs.pod:801 msgid "" "This could be fixed in the generator by specially marking parameters and " "return values which take bytes or other units." msgstr "" # type: =item -#: ../src/guestfs.pod:773 +#: ../src/guestfs.pod:804 msgid "Ambiguity between devices and paths" msgstr "" # type: textblock -#: ../src/guestfs.pod:775 +#: ../src/guestfs.pod:806 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 " @@ -1562,7 +1624,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:780 +#: ../src/guestfs.pod:811 msgid "" "In the current API we usually resolve this ambiguity by having two separate " "calls, for example L and L. " @@ -1571,7 +1633,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:786 +#: ../src/guestfs.pod:817 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 " @@ -1581,7 +1643,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:792 +#: ../src/guestfs.pod:823 #, no-wrap msgid "" " type path = Path of string | Device of int | Partition of int * int\n" @@ -1589,12 +1651,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:794 +#: ../src/guestfs.pod:825 msgid "which would allow you to pass arguments like:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:796 +#: ../src/guestfs.pod:827 #, no-wrap msgid "" " Path \"/foo/bar\"\n" @@ -1605,19 +1667,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:801 +#: ../src/guestfs.pod:832 msgid "" "As you can see there are still problems to resolve even with this " "representation. Also consider how it might work in guestfish." msgstr "" # type: =head2 -#: ../src/guestfs.pod:806 +#: ../src/guestfs.pod:837 msgid "PROTOCOL LIMITS" msgstr "" # type: textblock -#: ../src/guestfs.pod:808 +#: ../src/guestfs.pod:839 msgid "" "Internally libguestfs uses a message-based protocol to pass API calls and " "their responses to and from a small \"appliance\" (see L for " @@ -1628,7 +1690,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:816 +#: ../src/guestfs.pod:847 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 " @@ -1637,7 +1699,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:822 +#: ../src/guestfs.pod:853 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 " @@ -1645,26 +1707,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:826 +#: ../src/guestfs.pod:857 msgid "" "You might also consider mounting the disk image using our FUSE filesystem " "support (L)." msgstr "" # type: =head2 -#: ../src/guestfs.pod:829 +#: ../src/guestfs.pod:860 msgid "KEYS AND PASSPHRASES" msgstr "" # type: textblock -#: ../src/guestfs.pod:831 +#: ../src/guestfs.pod:862 msgid "" "Certain libguestfs calls take a parameter that contains sensitive key " "material, passed in as a C string." msgstr "" # type: textblock -#: ../src/guestfs.pod:834 +#: ../src/guestfs.pod:865 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 " @@ -1673,122 +1735,665 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:839 +#: ../src/guestfs.pod:870 msgid "" "Therefore you should be aware that any key parameter you pass to libguestfs " "might end up being written out to the swap partition. If this is a concern, " "scrub the swap partition or don't use libguestfs on encrypted devices." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:844 -msgid "CONNECTION MANAGEMENT" +# type: =head2 +#: ../src/guestfs.pod:875 +msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:846 -msgid "guestfs_h *" +# type: textblock +#: ../src/guestfs.pod:877 +msgid "" +"All high-level libguestfs actions are synchronous. If you want to use " +"libguestfs asynchronously then you must create a thread." msgstr "" # type: textblock -#: ../src/guestfs.pod:848 +#: ../src/guestfs.pod:880 msgid "" -"C is the opaque type representing a connection handle. Create a " -"handle by calling L. Call L to free the " -"handle and release all resources used." +"Only use the handle from a single thread. Either use the handle exclusively " +"from one thread, or provide your own mutex so that two threads cannot issue " +"calls on the same handle at the same time." msgstr "" # type: textblock -#: ../src/guestfs.pod:852 +#: ../src/guestfs.pod:884 msgid "" -"For information on using multiple handles and threads, see the section " -"L below." +"See the graphical program guestfs-browser for one possible architecture for " +"multithreaded programs using libvirt and libguestfs." msgstr "" # type: =head2 -#: ../src/guestfs.pod:855 -msgid "guestfs_create" +#: ../src/guestfs.pod:887 +msgid "PATH" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:857 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:889 msgid "" -" guestfs_h *guestfs_create (void);\n" -"\n" +"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " +"internal path." msgstr "" # type: textblock -#: ../src/guestfs.pod:859 -msgid "Create a connection handle." +#: ../src/guestfs.pod:892 +msgid "" +"By default it looks for these in the directory C<$libdir/guestfs> " +"(eg. C or C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:861 +#: ../src/guestfs.pod:895 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:864 -msgid "" -"This function returns a non-NULL pointer to a handle on success or NULL on " -"error." +# type: =head2 +#: ../src/guestfs.pod:902 +msgid "QEMU WRAPPERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:867 -msgid "After configuring the handle, you have to call L." +#: ../src/guestfs.pod:904 +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:869 +#: ../src/guestfs.pod:908 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:872 -msgid "guestfs_close" +# type: textblock +#: ../src/guestfs.pod:913 +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:874 +#: ../src/guestfs.pod:916 #, 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:876 -msgid "This closes the connection handle and frees up all resources used." +#: ../src/guestfs.pod:920 +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:878 -msgid "ERROR HANDLING" +# type: verbatim +#: ../src/guestfs.pod:924 +#, no-wrap +msgid "" +" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:880 +#: ../src/guestfs.pod:926 msgid "" -"API functions can return errors. For example, almost all functions that " -"return C will return C<-1> to indicate an error." +"Note that libguestfs also calls qemu with the -help and -version options in " +"order to determine features." msgstr "" -# type: textblock -#: ../src/guestfs.pod:883 -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." +# type: =head2 +#: ../src/guestfs.pod:929 +msgid "ABI GUARANTEE" msgstr "" # type: textblock -#: ../src/guestfs.pod:887 +#: ../src/guestfs.pod:931 +msgid "" +"We guarantee the libguestfs ABI (binary interface), for public, high-level " +"actions as outlined in this section. Although we will deprecate some " +"actions, for example if they get replaced by newer calls, we will keep the " +"old actions forever. This allows you the developer to program in confidence " +"against the libguestfs API." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:937 +msgid "BLOCK DEVICE NAMING" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:939 +msgid "" +"In the kernel there is now quite a profusion of schemata for naming block " +"devices (in this context, by I I mean a physical or virtual " +"hard drive). The original Linux IDE driver used names starting with " +"C. SCSI devices have historically used a different naming scheme, " +"C. When the Linux kernel I driver became a popular " +"replacement for the old IDE driver (particularly for SATA devices) those " +"devices also used the C scheme. Additionally we now have virtual " +"machines with paravirtualized drivers. This has created several different " +"naming systems, such as C for virtio disks and C for " +"Xen PV disks." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:951 +msgid "" +"As discussed above, libguestfs uses a qemu appliance running an embedded " +"Linux kernel to access block devices. We can run a variety of appliances " +"based on a variety of Linux kernels." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:955 +msgid "" +"This causes a problem for libguestfs because many API calls use device or " +"partition names. Working scripts and the recipe (example) scripts that we " +"make available over the internet could fail if the naming scheme changes." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:960 +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:966 +msgid "" +"Note that this I applies to parameters. The L, " +"L and similar calls return the true names of the " +"devices and partitions as known to the appliance." +msgstr "" + +# type: =head3 +#: ../src/guestfs.pod:971 +msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:973 +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." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:979 +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:987 +msgid "Is the string a parameter which is a device or partition name?" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:991 +msgid "Does the string begin with C?" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:995 +msgid "" +"Does the named device exist? If so, we use that device. However if I " +"then we continue with this algorithm." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1000 +msgid "Replace initial C string with C." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1002 +msgid "For example, change C to C." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1004 +msgid "If that named device exists, use it. If not, continue." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1008 +msgid "Replace initial C string with C." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1010 +msgid "If that named device exists, use it. If not, return an error." +msgstr "" + +# type: =head3 +#: ../src/guestfs.pod:1014 +msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1016 +msgid "" +"Although the standard naming scheme and automatic translation is useful for " +"simple programs and guestfish scripts, for larger programs it is best not to " +"rely on this mechanism." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1020 +msgid "" +"Where possible for maximum future portability programs using libguestfs " +"should use these future-proof techniques:" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1027 +msgid "" +"Use L or L to list actual " +"device names, and then use those names directly." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1030 +msgid "Since those device names exist by definition, they will never be translated." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1035 +msgid "" +"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " +"filesystem labels." +msgstr "" + +# type: =head1 +#: ../src/guestfs.pod:1040 +msgid "SECURITY" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1042 +msgid "" +"This section discusses security implications of using libguestfs, " +"particularly with untrusted or malicious guests or disk images." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1045 +msgid "GENERAL SECURITY CONSIDERATIONS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1047 +msgid "" +"Be careful with any files or data that you download from a guest (by " +"\"download\" we mean not just the L command but any " +"command that reads files, filenames, directories or anything else from a " +"disk image). An attacker could manipulate the data to fool your program " +"into doing the wrong thing. Consider cases such as:" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1057 +msgid "the data (file etc) not being present" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1061 +msgid "being present but empty" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1065 +msgid "being much larger than normal" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1069 +msgid "containing arbitrary 8 bit data" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1073 +msgid "being in an unexpected character encoding" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1077 +msgid "containing homoglyphs." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1081 +msgid "SECURITY OF MOUNTING FILESYSTEMS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1083 +msgid "" +"When you mount a filesystem under Linux, mistakes in the kernel filesystem " +"(VFS) module can sometimes be escalated into exploits by deliberately " +"creating a malicious, malformed filesystem. These exploits are very severe " +"for two reasons. Firstly there are very many filesystem drivers in the " +"kernel, and many of them are infrequently used and not much developer " +"attention has been paid to the code. Linux userspace helps potential " +"crackers by detecting the filesystem type and automatically choosing the " +"right VFS driver, even if that filesystem type is obscure or unexpected for " +"the administrator. Secondly, a kernel-level exploit is like a local root " +"exploit (worse in some ways), giving immediate and total access to the " +"system right down to the hardware level." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1096 +msgid "" +"That explains why you should never mount a filesystem from an untrusted " +"guest on your host kernel. How about libguestfs? We run a Linux kernel " +"inside a qemu virtual machine, usually running as a non-root user. The " +"attacker would need to write a filesystem which first exploited the kernel, " +"and then exploited either qemu virtualization (eg. a faulty qemu driver) or " +"the libguestfs protocol, and finally to be as serious as the host kernel " +"exploit it would need to escalate its privileges to root. This multi-step " +"escalation, performed by a static piece of data, is thought to be extremely " +"hard to do, although we never say 'never' about security issues." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1107 +msgid "" +"In any case callers can reduce the attack surface by forcing the filesystem " +"type when mounting (use L)." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1110 +msgid "PROTOCOL SECURITY" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1112 +msgid "" +"The protocol is designed to be secure, being based on RFC 4506 (XDR) with a " +"defined upper message size. However a program that uses libguestfs must " +"also take care - for example you can write a program that downloads a binary " +"from a disk image and executes it locally, and no amount of protocol " +"security will save you from the consequences." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1118 +msgid "INSPECTION SECURITY" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1120 +msgid "" +"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:1126 +msgid "" +"Guest configuration may be altered in unusual ways by the administrator of " +"the virtual machine, and may not reflect reality (particularly for untrusted " +"or actively malicious guests). For example we parse the hostname from " +"configuration files like C that we find in the " +"guest, but the guest administrator can easily manipulate these files to " +"provide the wrong hostname." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1134 +msgid "" +"The inspection API parses guest configuration using two external libraries: " +"Augeas (Linux configuration) and hivex (Windows Registry). Both are " +"designed to be robust in the face of malicious data, although denial of " +"service attacks are still possible, for example with oversized configuration " +"files." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1140 +msgid "RUNNING UNTRUSTED GUEST COMMANDS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1142 +msgid "" +"Be very cautious about running commands from the guest. By running a " +"command in the guest, you are giving CPU time to a binary that you do not " +"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: =head2 +#: ../src/guestfs.pod:1148 +msgid "CVE-2010-3851" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1150 +msgid "https://bugzilla.redhat.com/642934" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1152 +msgid "" +"This security bug concerns the automatic disk format detection that qemu " +"does on disk images." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1155 +msgid "" +"A raw disk image is just the raw bytes, there is no header. Other disk " +"images like qcow2 contain a special header. Qemu deals with this by looking " +"for one of the known headers, and if none is found then assuming the disk " +"image must be raw." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1160 +msgid "" +"This allows a guest which has been given a raw disk image to write some " +"other header. At next boot (or when the disk image is accessed by " +"libguestfs) qemu would do autodetection and think the disk image format was, " +"say, qcow2 based on the header written by the guest." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1165 +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: textblock +#: ../src/guestfs.pod:1173 +msgid "In libguestfs this is rather hard to exploit except under two circumstances:" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1180 +msgid "You have enabled the network or have opened the disk in write mode." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1184 +msgid "" +"You are also running untrusted code from the guest (see L)." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1189 +msgid "" +"The way to avoid this is to specify the expected disk format when adding " +"disks (the optional C option to L). You " +"should always do this if the disk is raw format, and it's a good idea for " +"other cases too." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1194 +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:1197 +msgid "" +"For libguestfs tools, use the I<--format> command line parameter as " +"appropriate." +msgstr "" + +# type: =head1 +#: ../src/guestfs.pod:1200 +msgid "CONNECTION MANAGEMENT" +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1202 +msgid "guestfs_h *" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1204 +msgid "" +"C is the opaque type representing a connection handle. Create a " +"handle by calling L. Call L to free the " +"handle and release all resources used." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1208 +msgid "" +"For information on using multiple handles and threads, see the section " +"L below." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1211 +msgid "guestfs_create" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1213 +#, no-wrap +msgid "" +" guestfs_h *guestfs_create (void);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1215 +msgid "Create a connection handle." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1217 +msgid "" +"You have to call L (or one of the equivalent calls) " +"on the handle at least once." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1220 +msgid "" +"This function returns a non-NULL pointer to a handle on success or NULL on " +"error." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1223 +msgid "After configuring the handle, you have to call L." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1225 +msgid "" +"You may also want to configure error handling for the handle. See L section below." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1228 +msgid "guestfs_close" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1230 +#, no-wrap +msgid "" +" void guestfs_close (guestfs_h *g);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1232 +msgid "This closes the connection handle and frees up all resources used." +msgstr "" + +# type: =head1 +#: ../src/guestfs.pod:1234 +msgid "ERROR HANDLING" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1236 +msgid "" +"API functions can return errors. For example, almost all functions that " +"return C will return C<-1> to indicate an error." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1239 +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:1243 msgid "" "You can get at the additional information about the last error on the handle " "by calling L, L, and/or by setting " @@ -1796,7 +2401,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:892 +#: ../src/guestfs.pod:1248 msgid "" "When the handle is created, a default error handler is installed which " "prints the error message string to C. For small short-running " @@ -1804,7 +2409,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:896 +#: ../src/guestfs.pod:1252 #, no-wrap msgid "" " if (guestfs_launch (g) == -1)\n" @@ -1813,21 +2418,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:899 +#: ../src/guestfs.pod:1255 msgid "" "since the default error handler will ensure that an error message has been " "printed to C before the program exits." msgstr "" # type: textblock -#: ../src/guestfs.pod:902 +#: ../src/guestfs.pod:1258 msgid "" "For other programs the caller will almost certainly want to install an " "alternate error handler or do error handling in-line like this:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:905 +#: ../src/guestfs.pod:1261 #, no-wrap msgid "" " g = guestfs_create ();\n" @@ -1835,7 +2440,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:907 +#: ../src/guestfs.pod:1263 #, no-wrap msgid "" " /* This disables the default behaviour of printing errors\n" @@ -1845,7 +2450,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:911 +#: ../src/guestfs.pod:1267 #, no-wrap msgid "" " if (guestfs_launch (g) == -1) {\n" @@ -1859,7 +2464,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:919 +#: ../src/guestfs.pod:1275 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 " @@ -1867,7 +2472,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:923 +#: ../src/guestfs.pod:1279 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 " @@ -1877,12 +2482,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:929 +#: ../src/guestfs.pod:1285 msgid "guestfs_last_error" msgstr "" # type: verbatim -#: ../src/guestfs.pod:931 +#: ../src/guestfs.pod:1287 #, no-wrap msgid "" " const char *guestfs_last_error (guestfs_h *g);\n" @@ -1890,26 +2495,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:933 +#: ../src/guestfs.pod:1289 msgid "" "This returns the last error message that happened on C. If there has not " "been an error since the handle was created, then this returns C." msgstr "" # type: textblock -#: ../src/guestfs.pod:937 +#: ../src/guestfs.pod:1293 msgid "" "The lifetime of the returned string is until the next error occurs, or " "L is called." msgstr "" # type: =head2 -#: ../src/guestfs.pod:940 +#: ../src/guestfs.pod:1296 msgid "guestfs_last_errno" msgstr "" # type: verbatim -#: ../src/guestfs.pod:942 +#: ../src/guestfs.pod:1298 #, no-wrap msgid "" " int guestfs_last_errno (guestfs_h *g);\n" @@ -1917,27 +2522,27 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:944 +#: ../src/guestfs.pod:1300 msgid "This returns the last error number (errno) that happened on C." msgstr "" # type: textblock -#: ../src/guestfs.pod:946 +#: ../src/guestfs.pod:1302 msgid "If successful, an errno integer not equal to zero is returned." msgstr "" # type: textblock -#: ../src/guestfs.pod:948 +#: ../src/guestfs.pod:1304 msgid "If no error, this returns 0. This call can return 0 in three situations:" msgstr "" # type: textblock -#: ../src/guestfs.pod:955 +#: ../src/guestfs.pod:1311 msgid "There has not been any error on the handle." msgstr "" # type: textblock -#: ../src/guestfs.pod:959 +#: ../src/guestfs.pod:1315 msgid "" "There has been an error but the errno was meaningless. This corresponds to " "the case where the error did not come from a failed system call, but for " @@ -1945,14 +2550,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:965 +#: ../src/guestfs.pod:1321 msgid "" "There was an error from a failed system call, but for some reason the errno " "was not captured and returned. This usually indicates a bug in libguestfs." msgstr "" # type: textblock -#: ../src/guestfs.pod:971 +#: ../src/guestfs.pod:1327 msgid "" "Libguestfs tries to convert the errno from inside the applicance into a " "corresponding errno for the caller (not entirely trivial: the appliance " @@ -1963,12 +2568,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:979 +#: ../src/guestfs.pod:1335 msgid "guestfs_set_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:981 +#: ../src/guestfs.pod:1337 #, no-wrap msgid "" " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" @@ -1981,7 +2586,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:988 +#: ../src/guestfs.pod:1344 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 " @@ -1989,14 +2594,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:992 +#: ../src/guestfs.pod:1348 msgid "" "C is not passed to the callback. To get that the callback must call " "L." msgstr "" # type: textblock -#: ../src/guestfs.pod:995 +#: ../src/guestfs.pod:1351 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 " @@ -2004,22 +2609,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:999 +#: ../src/guestfs.pod:1355 msgid "The default handler prints messages on C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1001 +#: ../src/guestfs.pod:1357 msgid "If you set C to C then I handler is called." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1003 +#: ../src/guestfs.pod:1359 msgid "guestfs_get_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1005 +#: ../src/guestfs.pod:1361 #, no-wrap msgid "" " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" @@ -2028,17 +2633,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1008 +#: ../src/guestfs.pod:1364 msgid "Returns the current error handler callback." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1010 +#: ../src/guestfs.pod:1366 msgid "guestfs_set_out_of_memory_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1012 +#: ../src/guestfs.pod:1368 #, no-wrap msgid "" " typedef void (*guestfs_abort_cb) (void);\n" @@ -2048,29 +2653,29 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1016 +#: ../src/guestfs.pod:1372 msgid "" "The callback C will be called if there is an out of memory situation. " "I." msgstr "" # type: textblock -#: ../src/guestfs.pod:1019 +#: ../src/guestfs.pod:1375 msgid "The default is to call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1021 +#: ../src/guestfs.pod:1377 msgid "You cannot set C to C. You can't ignore out of memory situations." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1024 +#: ../src/guestfs.pod:1380 msgid "guestfs_get_out_of_memory_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1026 +#: ../src/guestfs.pod:1382 #, no-wrap msgid "" " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" @@ -2078,87 +2683,42 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1028 +#: ../src/guestfs.pod:1384 msgid "This returns the current out of memory handler." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1030 -msgid "PATH" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1032 -msgid "" -"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " -"internal path." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1035 -msgid "" -"By default it looks for these in the directory C<$libdir/guestfs> " -"(eg. C or C)." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1038 -msgid "" -"Use L or set the environment variable L " -"to change the directories that libguestfs will search in. The value is a " -"colon-separated list of paths. The current directory is I searched " -"unless the path contains an empty element or C<.>. For example " -"C would search the current directory and " -"then C." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1045 -msgid "HIGH-LEVEL API ACTIONS" -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1047 -msgid "ABI GUARANTEE" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1049 -msgid "" -"We guarantee the libguestfs ABI (binary interface), for public, high-level " -"actions as outlined in this section. Although we will deprecate some " -"actions, for example if they get replaced by newer calls, we will keep the " -"old actions forever. This allows you the developer to program in confidence " -"against the libguestfs API." +#: ../src/guestfs.pod:1386 +msgid "API CALLS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1055 ../fish/guestfish.pod:861 +#: ../src/guestfs.pod:1388 ../fish/guestfish.pod:958 msgid "@ACTIONS@" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1057 +#: ../src/guestfs.pod:1390 msgid "STRUCTURES" msgstr "" # type: textblock -#: ../src/guestfs.pod:1059 +#: ../src/guestfs.pod:1392 msgid "@STRUCTS@" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1061 +#: ../src/guestfs.pod:1394 msgid "AVAILABILITY" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1063 +#: ../src/guestfs.pod:1396 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1065 +#: ../src/guestfs.pod:1398 msgid "" "Using L you can test availability of the following " "groups of functions. This test queries the appliance to see if the " @@ -2166,17 +2726,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1070 +#: ../src/guestfs.pod:1403 msgid "@AVAILABILITY@" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1072 +#: ../src/guestfs.pod:1405 msgid "GUESTFISH supported COMMAND" msgstr "" # type: textblock -#: ../src/guestfs.pod:1074 +#: ../src/guestfs.pod:1407 msgid "" "In L there is a handy interactive command C which " "prints out the available groups and whether they are supported by this build " @@ -2184,19 +2744,19 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1079 +#: ../src/guestfs.pod:1412 msgid "SINGLE CALLS AT COMPILE TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:1081 +#: ../src/guestfs.pod:1414 msgid "" "Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " "function, such as:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1084 +#: ../src/guestfs.pod:1417 #, no-wrap msgid "" " #define LIBGUESTFS_HAVE_DD 1\n" @@ -2204,12 +2764,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1086 +#: ../src/guestfs.pod:1419 msgid "if L is available." msgstr "" # type: textblock -#: ../src/guestfs.pod:1088 +#: ../src/guestfs.pod:1421 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 " @@ -2217,7 +2777,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1093 +#: ../src/guestfs.pod:1426 #, no-wrap msgid "" " AC_CHECK_LIB([guestfs],[guestfs_create])\n" @@ -2226,19 +2786,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1096 +#: ../src/guestfs.pod:1429 msgid "" "which would result in C being either defined or not defined " "in your program." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1099 +#: ../src/guestfs.pod:1432 msgid "SINGLE CALLS AT RUN TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:1101 +#: ../src/guestfs.pod:1434 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 " @@ -2248,7 +2808,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1108 +#: ../src/guestfs.pod:1441 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 " @@ -2256,7 +2816,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1112 +#: ../src/guestfs.pod:1445 #, no-wrap msgid "" " #include \n" @@ -2268,7 +2828,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1118 +#: ../src/guestfs.pod:1451 #, no-wrap msgid "" " main ()\n" @@ -2280,7 +2840,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1124 +#: ../src/guestfs.pod:1457 #, no-wrap msgid "" " /* Test if the function guestfs_dd is really available. */\n" @@ -2295,7 +2855,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1133 +#: ../src/guestfs.pod:1466 #, no-wrap msgid "" " if (!has_function)\n" @@ -2314,7 +2874,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1146 +#: ../src/guestfs.pod:1479 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 " @@ -2322,7 +2882,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1151 +#: ../src/guestfs.pod:1484 #, no-wrap msgid "" " Requires: libguestfs >= 1.0.80\n" @@ -2330,12 +2890,12 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1153 +#: ../src/guestfs.pod:1486 msgid "CALLS WITH OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1155 +#: ../src/guestfs.pod:1488 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 " @@ -2343,7 +2903,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1160 +#: ../src/guestfs.pod:1493 #, no-wrap msgid "" " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" @@ -2351,14 +2911,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1162 +#: ../src/guestfs.pod:1495 msgid "" "Call this with a list of optional arguments, terminated by C<-1>. So to " "call with no optional arguments specified:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1165 +#: ../src/guestfs.pod:1498 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename, -1);\n" @@ -2366,12 +2926,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1167 +#: ../src/guestfs.pod:1500 msgid "With a single optional argument:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1169 +#: ../src/guestfs.pod:1502 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -2381,12 +2941,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1173 +#: ../src/guestfs.pod:1506 msgid "With two:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1175 +#: ../src/guestfs.pod:1508 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -2397,19 +2957,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1180 +#: ../src/guestfs.pod:1513 msgid "" "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " "happen!" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1183 +#: ../src/guestfs.pod:1516 msgid "USING va_list FOR OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1185 +#: ../src/guestfs.pod:1518 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 " @@ -2417,301 +2977,131 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1189 +#: ../src/guestfs.pod:1522 #, no-wrap msgid "" " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" " va_list args);\n" "\n" msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1192 -msgid "CONSTRUCTING OPTIONAL ARGUMENTS" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1194 -msgid "" -"The third variant is useful where you need to construct these calls. You " -"pass in a structure where you fill in the optional fields. The structure " -"has a bitmask as the first element which you must set to indicate which " -"fields you have filled in. For our example function the structure and call " -"are declared:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:1200 -#, no-wrap -msgid "" -" struct guestfs_add_drive_opts_argv {\n" -" uint64_t bitmask;\n" -" int readonly;\n" -" const char *format;\n" -" /* ... */\n" -" };\n" -" int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n" -" const struct guestfs_add_drive_opts_argv *optargs);\n" -"\n" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1209 -msgid "You could call it like this:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:1211 -#, 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:1218 -#, no-wrap -msgid "" -" guestfs_add_drive_opts_argv (g, filename, &optargs);\n" -"\n" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1220 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1813 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1244 -msgid "Notes:" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1226 -msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1231 -msgid "You do not need to fill in all fields of the structure." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1235 -msgid "" -"There must be a one-to-one correspondence between fields of the structure " -"that are filled in, and bits set in the bitmask." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1240 -msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1242 -msgid "" -"In other languages, optional arguments are expressed in the way that is " -"natural for that language. We refer you to the language-specific " -"documentation for more details on that." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1246 -msgid "For guestfish, see L." -msgstr "" - -# type: =end -#: ../src/guestfs.pod:1248 ../src/guestfs.pod:1253 -msgid "html" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1250 -msgid "" -" " -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1255 -msgid "ARCHITECTURE" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1257 -msgid "" -"Internally, libguestfs is implemented by running an appliance (a special " -"type of small virtual machine) using L. Qemu runs as a child " -"process of the main program." -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:1261 -#, no-wrap -msgid "" -" ___________________\n" -" / \\\n" -" | main program |\n" -" | |\n" -" | | child process / appliance\n" -" | | __________________________\n" -" | | / qemu \\\n" -" +-------------------+ RPC | +-----------------+ |\n" -" | libguestfs <--------------------> guestfsd | |\n" -" | | | +-----------------+ |\n" -" \\___________________/ | | Linux kernel | |\n" -" | +--^--------------+ |\n" -" \\_________|________________/\n" -" |\n" -" _______v______\n" -" / \\\n" -" | Device or |\n" -" | disk image |\n" -" \\______________/\n" -"\n" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1281 -msgid "" -"The library, linked to the main program, creates the child process and hence " -"the appliance in the L function." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1284 -msgid "" -"Inside the appliance is a Linux kernel and a complete stack of userspace " -"tools (such as LVM and ext2 programs) and a small controlling daemon called " -"L. The library talks to L using remote procedure " -"calls (RPC). There is a mostly one-to-one correspondence between libguestfs " -"API calls and RPC calls to the daemon. Lastly the disk image(s) are " -"attached to the qemu process which translates device access by the " -"appliance's Linux kernel into accesses to the image." + +# type: =head2 +#: ../src/guestfs.pod:1525 +msgid "CONSTRUCTING OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1293 +#: ../src/guestfs.pod:1527 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)." +"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: =head1 -#: ../src/guestfs.pod:1300 -msgid "STATE MACHINE" +# type: verbatim +#: ../src/guestfs.pod:1533 +#, no-wrap +msgid "" +" struct guestfs_add_drive_opts_argv {\n" +" uint64_t bitmask;\n" +" int readonly;\n" +" const char *format;\n" +" /* ... */\n" +" };\n" +" int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n" +" const struct guestfs_add_drive_opts_argv *optargs);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1302 -msgid "libguestfs uses a state machine to model the child process:" +#: ../src/guestfs.pod:1542 +msgid "You could call it like this:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1304 +#: ../src/guestfs.pod:1544 #, 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" +" 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:1551 +#, no-wrap +msgid "" +" guestfs_add_drive_opts_argv (g, filename, &optargs);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1326 -msgid "" -"The normal transitions are (1) CONFIG (when the handle is created, but there " -"is no child process), (2) LAUNCHING (when the child process is booting up), " -"(3) alternating between READY and BUSY as commands are issued to, and " -"carried out by, the child process." +#: ../src/guestfs.pod:1553 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255 ../tools/virt-win-reg.pl:532 +msgid "Notes:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1331 -msgid "" -"The guest may be killed by L, or may die " -"asynchronously at any time (eg. due to some internal error), and that causes " -"the state to transition back to CONFIG." +#: ../src/guestfs.pod:1559 +msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." msgstr "" # type: textblock -#: ../src/guestfs.pod:1335 -msgid "" -"Configuration commands for qemu such as L can only be " -"issued when in the CONFIG state." +#: ../src/guestfs.pod:1564 +msgid "You do not need to fill in all fields of the structure." msgstr "" # type: textblock -#: ../src/guestfs.pod:1338 +#: ../src/guestfs.pod:1568 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." +"There must be a one-to-one correspondence between fields of the structure " +"that are filled in, and bits set in the bitmask." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1573 +msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:1344 +#: ../src/guestfs.pod:1575 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." +"In other languages, optional arguments are expressed in the way that is " +"natural for that language. We refer you to the language-specific " +"documentation for more details on that." msgstr "" # type: textblock -#: ../src/guestfs.pod:1350 -msgid "" -"Finally, the child process sends asynchronous messages back to the main " -"program, such as kernel log messages. You can register a callback to " -"receive these messages." +#: ../src/guestfs.pod:1579 +msgid "For guestfish, see L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1354 +#: ../src/guestfs.pod:1581 msgid "SETTING CALLBACKS TO HANDLE EVENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1356 +#: ../src/guestfs.pod:1583 msgid "" "The child process generates events in some situations. Current events " "include: receiving a log message, the child process exits." msgstr "" # type: textblock -#: ../src/guestfs.pod:1359 +#: ../src/guestfs.pod:1586 msgid "" "Use the C functions to set a callback for different " "types of events." msgstr "" # type: textblock -#: ../src/guestfs.pod:1362 +#: ../src/guestfs.pod:1589 msgid "" "Only I can be registered for each handle. " "Calling C again overwrites the previous callback of " @@ -2720,12 +3110,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1367 +#: ../src/guestfs.pod:1594 msgid "guestfs_set_log_message_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1369 +#: ../src/guestfs.pod:1596 #, no-wrap msgid "" " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n" @@ -2737,31 +3127,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1375 +#: ../src/guestfs.pod:1602 msgid "" "The callback function C will be called whenever qemu or the guest writes " "anything to the console." msgstr "" # type: textblock -#: ../src/guestfs.pod:1378 +#: ../src/guestfs.pod:1605 msgid "Use this function to capture kernel messages and similar." msgstr "" # type: textblock -#: ../src/guestfs.pod:1380 +#: ../src/guestfs.pod:1607 msgid "" "Normally there is no log message handler, and log messages are just " "discarded." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1383 +#: ../src/guestfs.pod:1610 msgid "guestfs_set_subprocess_quit_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1385 +#: ../src/guestfs.pod:1612 #, no-wrap msgid "" " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n" @@ -2772,7 +3162,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1390 +#: ../src/guestfs.pod:1617 msgid "" "The callback function C will be called when the child process quits, " "either asynchronously or if killed by L. (This " @@ -2780,12 +3170,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1395 +#: ../src/guestfs.pod:1622 msgid "guestfs_set_launch_done_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1397 +#: ../src/guestfs.pod:1624 #, no-wrap msgid "" " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n" @@ -2796,7 +3186,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1402 +#: ../src/guestfs.pod:1629 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 " @@ -2804,12 +3194,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1406 +#: ../src/guestfs.pod:1633 msgid "guestfs_set_close_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1408 +#: ../src/guestfs.pod:1635 #, no-wrap msgid "" " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n" @@ -2820,14 +3210,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1413 +#: ../src/guestfs.pod:1640 msgid "" "The callback function C will be called while the handle is being closed " "(synchronously from L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1416 +#: ../src/guestfs.pod:1643 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 " @@ -2838,12 +3228,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1424 +#: ../src/guestfs.pod:1651 msgid "guestfs_set_progress_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1426 +#: ../src/guestfs.pod:1653 #, no-wrap msgid "" " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n" @@ -2856,7 +3246,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1433 +#: ../src/guestfs.pod:1660 msgid "" "Some long-running operations can generate progress messages. If this " "callback is registered, then it will be called each time a progress message " @@ -2866,7 +3256,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1439 +#: ../src/guestfs.pod:1666 msgid "" "The callback receives two numbers: C and C. The units of " "C are not defined, although for some operations C may relate " @@ -2875,31 +3265,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1445 +#: ../src/guestfs.pod:1672 msgid "The only defined and stable parts of the API are:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1451 +#: ../src/guestfs.pod:1678 msgid "" "The callback can display to the user some type of progress bar or indicator " "which shows the ratio of C:C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1456 +#: ../src/guestfs.pod:1683 msgid "0 E= C E= C" msgstr "" # type: textblock -#: ../src/guestfs.pod:1460 +#: ../src/guestfs.pod:1687 msgid "" "If any progress notification is sent during a call, then a final progress " "notification is always sent when C = C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1463 +#: ../src/guestfs.pod:1690 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 " @@ -2907,7 +3297,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1469 +#: ../src/guestfs.pod:1696 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 " @@ -2916,12 +3306,12 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1474 +#: ../src/guestfs.pod:1701 msgid "PRIVATE DATA AREA" msgstr "" # type: textblock -#: ../src/guestfs.pod:1476 +#: ../src/guestfs.pod:1703 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 " @@ -2929,12 +3319,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1480 +#: ../src/guestfs.pod:1707 msgid "To attach a named piece of data, use the following call:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1482 +#: ../src/guestfs.pod:1709 #, no-wrap msgid "" " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" @@ -2942,7 +3332,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1484 +#: ../src/guestfs.pod:1711 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 " @@ -2950,7 +3340,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1488 +#: ../src/guestfs.pod:1715 msgid "" "You can use any C you want, but names beginning with an underscore " "character are reserved for internal libguestfs purposes (for implementing " @@ -2959,12 +3349,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1493 +#: ../src/guestfs.pod:1720 msgid "To retrieve the pointer, use:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1495 +#: ../src/guestfs.pod:1722 #, no-wrap msgid "" " void *guestfs_get_private (guestfs_h *g, const char *key);\n" @@ -2972,7 +3362,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1497 +#: ../src/guestfs.pod:1724 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 " @@ -2980,7 +3370,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1501 +#: ../src/guestfs.pod:1728 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 " @@ -2992,188 +3382,201 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1509 +#: ../src/guestfs.pod:1736 msgid "" "The private data area is implemented using a hash table, and should be " "reasonably efficient for moderate numbers of keys." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1512 -msgid "BLOCK DEVICE NAMING" +# type: =end +#: ../src/guestfs.pod:1739 ../src/guestfs.pod:1744 +msgid "html" msgstr "" # type: textblock -#: ../src/guestfs.pod:1514 +#: ../src/guestfs.pod:1741 msgid "" -"In the kernel there is now quite a profusion of schemata for naming block " -"devices (in this context, by I I mean a physical or virtual " -"hard drive). The original Linux IDE driver used names starting with " -"C. SCSI devices have historically used a different naming scheme, " -"C. When the Linux kernel I driver became a popular " -"replacement for the old IDE driver (particularly for SATA devices) those " -"devices also used the C scheme. Additionally we now have virtual " -"machines with paravirtualized drivers. This has created several different " -"naming systems, such as C for virtio disks and C for " -"Xen PV disks." +" " msgstr "" -# type: textblock -#: ../src/guestfs.pod:1526 -msgid "" -"As discussed above, libguestfs uses a qemu appliance running an embedded " -"Linux kernel to access block devices. We can run a variety of appliances " -"based on a variety of Linux kernels." +# type: =head1 +#: ../src/guestfs.pod:1746 +msgid "ARCHITECTURE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1530 +#: ../src/guestfs.pod:1748 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." +"Internally, libguestfs is implemented by running an appliance (a special " +"type of small virtual machine) using L. Qemu runs as a child " +"process of the main program." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1535 +# type: verbatim +#: ../src/guestfs.pod:1752 +#, no-wrap 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." +" ___________________\n" +" / \\\n" +" | main program |\n" +" | |\n" +" | | child process / appliance\n" +" | | __________________________\n" +" | | / qemu \\\n" +" +-------------------+ RPC | +-----------------+ |\n" +" | libguestfs <--------------------> guestfsd | |\n" +" | | | +-----------------+ |\n" +" \\___________________/ | | Linux kernel | |\n" +" | +--^--------------+ |\n" +" \\_________|________________/\n" +" |\n" +" _______v______\n" +" / \\\n" +" | Device or |\n" +" | disk image |\n" +" \\______________/\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1541 +#: ../src/guestfs.pod:1772 msgid "" -"Note that this I applies to parameters. The L, " -"L and similar calls return the true names of the " -"devices and partitions as known to the appliance." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1546 -msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" +"The library, linked to the main program, creates the child process and hence " +"the appliance in the L function." msgstr "" # type: textblock -#: ../src/guestfs.pod:1548 +#: ../src/guestfs.pod:1775 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." +"Inside the appliance is a Linux kernel and a complete stack of userspace " +"tools (such as LVM and ext2 programs) and a small controlling daemon called " +"L. The library talks to L using remote procedure " +"calls (RPC). There is a mostly one-to-one correspondence between libguestfs " +"API calls and RPC calls to the daemon. Lastly the disk image(s) are " +"attached to the qemu process which translates device access by the " +"appliance's Linux kernel into accesses to the image." msgstr "" # type: textblock -#: ../src/guestfs.pod:1554 +#: ../src/guestfs.pod:1784 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." +"A common misunderstanding is that the appliance \"is\" the virtual machine. " +"Although the disk image you are attached to might also be used by some " +"virtual machine, libguestfs doesn't know or care about this. (But you will " +"care if both libguestfs's qemu process and your virtual machine are trying " +"to update the disk image at the same time, since these usually results in " +"massive disk corruption)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1562 -msgid "Is the string a parameter which is a device or partition name?" +# type: =head1 +#: ../src/guestfs.pod:1791 +msgid "STATE MACHINE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1566 -msgid "Does the string begin with C?" +#: ../src/guestfs.pod:1793 +msgid "libguestfs uses a state machine to model the child process:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1795 +#, 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" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1570 +#: ../src/guestfs.pod:1817 msgid "" -"Does the named device exist? If so, we use that device. However if I " -"then we continue with this algorithm." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1575 -msgid "Replace initial C string with C." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1577 -msgid "For example, change C to C." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1579 -msgid "If that named device exists, use it. If not, continue." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1583 -msgid "Replace initial C string with C." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1585 -msgid "If that named device exists, use it. If not, return an error." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1589 -msgid "PORTABILITY CONCERNS" +"The normal transitions are (1) CONFIG (when the handle is created, but there " +"is no child process), (2) LAUNCHING (when the child process is booting up), " +"(3) alternating between READY and BUSY as commands are issued to, and " +"carried out by, the child process." msgstr "" # type: textblock -#: ../src/guestfs.pod:1591 +#: ../src/guestfs.pod:1822 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 guest may be killed by L, or may die " +"asynchronously at any time (eg. due to some internal error), and that causes " +"the state to transition back to CONFIG." msgstr "" # type: textblock -#: ../src/guestfs.pod:1595 +#: ../src/guestfs.pod:1826 msgid "" -"Where possible for maximum future portability programs using libguestfs " -"should use these future-proof techniques:" +"Configuration commands for qemu such as L can only be " +"issued when in the CONFIG state." msgstr "" # type: textblock -#: ../src/guestfs.pod:1602 +#: ../src/guestfs.pod:1829 msgid "" -"Use L or L to list actual " -"device names, and then use those names directly." +"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.pod:1605 -msgid "Since those device names exist by definition, they will never be translated." +#: ../src/guestfs.pod:1835 +msgid "" +"API actions such as L can only be issued when in the READY " +"state. These API calls block waiting for the command to be carried out " +"(ie. the state to transition to BUSY and then back to READY). There are no " +"non-blocking versions, and no way to issue more than one command per handle " +"at the same time." msgstr "" # type: textblock -#: ../src/guestfs.pod:1610 +#: ../src/guestfs.pod:1841 msgid "" -"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " -"filesystem labels." +"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: =head1 -#: ../src/guestfs.pod:1615 +#: ../src/guestfs.pod:1845 msgid "INTERNALS" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1617 +#: ../src/guestfs.pod:1847 msgid "COMMUNICATION PROTOCOL" msgstr "" # type: textblock -#: ../src/guestfs.pod:1619 +#: ../src/guestfs.pod:1849 msgid "" "Don't rely on using this protocol directly. This section documents how it " "currently works, but it may change at any time." msgstr "" # type: textblock -#: ../src/guestfs.pod:1622 +#: ../src/guestfs.pod:1852 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 " @@ -3181,14 +3584,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1626 +#: ../src/guestfs.pod:1856 msgid "" "The detailed format of structures is in C (note: " "this file is automatically generated)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1629 +#: ../src/guestfs.pod:1859 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 " @@ -3198,17 +3601,17 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1636 +#: ../src/guestfs.pod:1866 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" msgstr "" # type: textblock -#: ../src/guestfs.pod:1638 +#: ../src/guestfs.pod:1868 msgid "For ordinary functions, the request message is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1640 +#: ../src/guestfs.pod:1870 #, no-wrap msgid "" " total length (header + arguments,\n" @@ -3219,7 +3622,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1645 +#: ../src/guestfs.pod:1875 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 " @@ -3228,26 +3631,38 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1651 +#: ../src/guestfs.pod:1881 msgid "" "Note also that many functions don't take any arguments, in which case the " "C_args> is completely omitted." msgstr "" # type: textblock -#: ../src/guestfs.pod:1654 +#: ../src/guestfs.pod:1884 msgid "" "The header contains the procedure number (C) which is how the " "receiver knows what type of args structure to expect, or none at all." msgstr "" # type: textblock -#: ../src/guestfs.pod:1658 +#: ../src/guestfs.pod:1888 +msgid "" +"For functions that take optional arguments, the optional arguments are " +"encoded in the C_args> structure in the same way as ordinary " +"arguments. A bitmask in the header indicates which optional arguments are " +"meaningful. The bitmask is also checked to see if it contains bits set " +"which the daemon does not know about (eg. if more optional arguments were " +"added in a later version of the library), and this causes the call to be " +"rejected." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1896 msgid "The reply message for ordinary functions is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1660 +#: ../src/guestfs.pod:1898 #, no-wrap msgid "" " total length (header + ret,\n" @@ -3258,26 +3673,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1665 +#: ../src/guestfs.pod:1903 msgid "" "As above the C_ret> structure may be completely omitted for " "functions that return no formal return values." msgstr "" # type: textblock -#: ../src/guestfs.pod:1668 +#: ../src/guestfs.pod:1906 msgid "As above the total length of the reply is limited to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1671 +#: ../src/guestfs.pod:1909 msgid "" "In the case of an error, a flag is set in the header, and the reply message " "is slightly changed:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1674 +#: ../src/guestfs.pod:1912 #, no-wrap msgid "" " total length (header + error,\n" @@ -3288,19 +3703,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1679 +#: ../src/guestfs.pod:1917 msgid "" "The C structure contains the error message as a " "string." msgstr "" # type: =head3 -#: ../src/guestfs.pod:1682 +#: ../src/guestfs.pod:1920 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1684 +#: ../src/guestfs.pod:1922 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 " @@ -3308,7 +3723,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1688 +#: ../src/guestfs.pod:1926 #, no-wrap msgid "" " total length (header + arguments,\n" @@ -3322,12 +3737,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1696 +#: ../src/guestfs.pod:1934 msgid "The \"sequence of chunks\" is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1698 +#: ../src/guestfs.pod:1936 #, no-wrap msgid "" " length of chunk (not including length word itself)\n" @@ -3341,7 +3756,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1706 +#: ../src/guestfs.pod:1944 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 " @@ -3349,7 +3764,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1710 +#: ../src/guestfs.pod:1948 msgid "" "At time of writing there are no functions that have more than one FileIn " "parameter. However this is (theoretically) supported, by sending the " @@ -3358,7 +3773,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1715 +#: ../src/guestfs.pod:1953 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 " @@ -3367,7 +3782,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1721 +#: ../src/guestfs.pod:1959 msgid "" "The daemon may also cancel. It does this by writing a special word " "C to the socket. The library listens for this during " @@ -3379,7 +3794,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1730 +#: ../src/guestfs.pod:1968 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 " @@ -3389,19 +3804,19 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1736 +#: ../src/guestfs.pod:1974 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1738 +#: ../src/guestfs.pod:1976 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.pod:1741 +#: ../src/guestfs.pod:1979 #, no-wrap msgid "" " total length (header + ret,\n" @@ -3415,12 +3830,12 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1749 +#: ../src/guestfs.pod:1987 msgid "INITIAL MESSAGE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1751 +#: ../src/guestfs.pod:1989 msgid "" "When the daemon launches it sends an initial word (C) " "which indicates that the guest and daemon is alive. This is what " @@ -3428,12 +3843,12 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1755 +#: ../src/guestfs.pod:1993 msgid "PROGRESS NOTIFICATION MESSAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:1757 +#: ../src/guestfs.pod:1995 msgid "" "The daemon may send progress notification messages at any time. These are " "distinguished by the normal length word being replaced by " @@ -3441,7 +3856,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1761 +#: ../src/guestfs.pod:1999 msgid "" "The library turns them into progress callbacks (see " "C) if there is a callback registered, or " @@ -3449,7 +3864,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1765 +#: ../src/guestfs.pod:2003 msgid "" "The daemon self-limits the frequency of progress messages it sends (see " "C). Not all calls generate progress " @@ -3457,102 +3872,12 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1769 -msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1771 -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:1774 -msgid "" -"Only use the handle from a single thread. Either use the handle exclusively " -"from one thread, or provide your own mutex so that two threads cannot issue " -"calls on the same handle at the same time." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1778 -msgid "" -"See the graphical program guestfs-browser for one possible architecture for " -"multithreaded programs using libvirt and libguestfs." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1781 -msgid "QEMU WRAPPERS" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1783 -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:1787 -msgid "" -"There is one important rule to remember: you I> as the " -"last command in the shell script (so that qemu replaces the shell and " -"becomes the direct child of the libguestfs-using program). If you don't do " -"this, then the qemu process won't be cleaned up correctly." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1792 -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:1795 -#, no-wrap -msgid "" -" #!/bin/sh -\n" -" qemudir=/home/rjones/d/qemu\n" -" exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios " -"\"$@\"\n" -"\n" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1799 -msgid "" -"Save this script as C (or wherever), C, and " -"then use it by setting the LIBGUESTFS_QEMU environment variable. For " -"example:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:1803 -#, no-wrap -msgid "" -" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" -"\n" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1805 -msgid "" -"Note that libguestfs also calls qemu with the -help and -version options in " -"order to determine features." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1808 +#: ../src/guestfs.pod:2007 msgid "LIBGUESTFS VERSION NUMBERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1810 +#: ../src/guestfs.pod:2009 msgid "" "Since April 2010, libguestfs has started to make separate development and " "stable releases, along with corresponding branches in our git repository. " @@ -3560,7 +3885,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1815 +#: ../src/guestfs.pod:2014 #, no-wrap msgid "" " even numbers for stable: 1.2.x, 1.4.x, ...\n" @@ -3577,12 +3902,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1826 +#: ../src/guestfs.pod:2025 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." msgstr "" # type: textblock -#: ../src/guestfs.pod:1828 +#: ../src/guestfs.pod:2027 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 " @@ -3592,26 +3917,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1834 +#: ../src/guestfs.pod:2033 msgid "Our criteria for backporting changes are:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1840 +#: ../src/guestfs.pod:2039 msgid "" "Documentation changes which don't affect any code are backported unless the " "documentation refers to a future feature which is not in stable." msgstr "" # type: textblock -#: ../src/guestfs.pod:1846 +#: ../src/guestfs.pod:2045 msgid "" "Bug fixes which are not controversial, fix obvious problems, and have been " "well tested are backported." msgstr "" # type: textblock -#: ../src/guestfs.pod:1851 +#: ../src/guestfs.pod:2050 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 " @@ -3619,7 +3944,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1857 +#: ../src/guestfs.pod:2056 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 " @@ -3627,7 +3952,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1863 +#: ../src/guestfs.pod:2062 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 " @@ -3638,44 +3963,44 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1871 ../fish/guestfish.pod:868 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255 +#: ../src/guestfs.pod:2070 ../fish/guestfish.pod:965 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 msgid "ENVIRONMENT VARIABLES" msgstr "" # type: =item -#: ../src/guestfs.pod:1875 ../fish/guestfish.pod:894 +#: ../src/guestfs.pod:2074 ../fish/guestfish.pod:991 msgid "LIBGUESTFS_APPEND" msgstr "" # type: textblock -#: ../src/guestfs.pod:1877 ../fish/guestfish.pod:896 +#: ../src/guestfs.pod:2076 ../fish/guestfish.pod:993 msgid "Pass additional options to the guest kernel." msgstr "" # type: =item -#: ../src/guestfs.pod:1879 ../fish/guestfish.pod:898 +#: ../src/guestfs.pod:2078 ../fish/guestfish.pod:995 msgid "LIBGUESTFS_DEBUG" msgstr "" # type: textblock -#: ../src/guestfs.pod:1881 +#: ../src/guestfs.pod:2080 msgid "" "Set C to enable verbose messages. This has the same " "effect as calling C." msgstr "" # type: =item -#: ../src/guestfs.pod:1884 ../fish/guestfish.pod:903 +#: ../src/guestfs.pod:2083 ../fish/guestfish.pod:1000 msgid "LIBGUESTFS_MEMSIZE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1886 ../fish/guestfish.pod:905 +#: ../src/guestfs.pod:2085 ../fish/guestfish.pod:1002 msgid "Set the memory allocated to the qemu process, in megabytes. For example:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1889 ../fish/guestfish.pod:908 +#: ../src/guestfs.pod:2088 ../fish/guestfish.pod:1005 #, no-wrap msgid "" " LIBGUESTFS_MEMSIZE=700\n" @@ -3683,58 +4008,58 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:1891 ../fish/guestfish.pod:910 +#: ../src/guestfs.pod:2090 ../fish/guestfish.pod:1007 msgid "LIBGUESTFS_PATH" msgstr "" # type: textblock -#: ../src/guestfs.pod:1893 +#: ../src/guestfs.pod:2092 msgid "" "Set the path that libguestfs uses to search for kernel and initrd.img. See " "the discussion of paths in section PATH above." msgstr "" # type: =item -#: ../src/guestfs.pod:1896 ../fish/guestfish.pod:915 +#: ../src/guestfs.pod:2095 ../fish/guestfish.pod:1012 msgid "LIBGUESTFS_QEMU" msgstr "" # type: textblock -#: ../src/guestfs.pod:1898 ../fish/guestfish.pod:917 +#: ../src/guestfs.pod:2097 ../fish/guestfish.pod:1014 msgid "" "Set the default qemu binary that libguestfs uses. If not set, then the qemu " "which was found at compile time by the configure script is used." msgstr "" # type: textblock -#: ../src/guestfs.pod:1902 +#: ../src/guestfs.pod:2101 msgid "See also L above." msgstr "" # type: =item -#: ../src/guestfs.pod:1904 ../fish/guestfish.pod:921 +#: ../src/guestfs.pod:2103 ../fish/guestfish.pod:1018 msgid "LIBGUESTFS_TRACE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1906 +#: ../src/guestfs.pod:2105 msgid "" "Set C to enable command traces. This has the same " "effect as calling C." msgstr "" # type: =item -#: ../src/guestfs.pod:1909 ../fish/guestfish.pod:930 +#: ../src/guestfs.pod:2108 ../fish/guestfish.pod:1027 msgid "TMPDIR" msgstr "" # type: textblock -#: ../src/guestfs.pod:1911 ../fish/guestfish.pod:932 +#: ../src/guestfs.pod:2110 ../fish/guestfish.pod:1029 msgid "Location of temporary directory, defaults to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1913 ../fish/guestfish.pod:934 +#: ../src/guestfs.pod:2112 ../fish/guestfish.pod:1031 msgid "" "If libguestfs was compiled to use the supermin appliance then the real " "appliance is cached in this directory, shared between all handles belonging " @@ -3743,101 +4068,103 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1921 ../fish/guestfish.pod:992 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:226 ../inspector/virt-inspector.pl:570 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640 ../tools/virt-ls.pl:232 ../tools/virt-resize.pl:1486 ../tools/virt-list-filesystems.pl:186 ../tools/virt-cat.pl:185 ../tools/virt-tar.pl:281 ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:254 +#: ../src/guestfs.pod:2120 ../fish/guestfish.pod:1089 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:572 ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:257 msgid "SEE ALSO" msgstr "" # type: textblock -#: ../src/guestfs.pod:1923 +#: ../src/guestfs.pod:2122 msgid "" -"L, L, L, L, " -"L, L, L, " +"L, L, L, " +"L, L, L, L, " +"L, L, L, " +"L, L, " "L, L, L, " "L, L, L, L, " "L, L, L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1941 +#: ../src/guestfs.pod:2145 msgid "" "Tools with a similar purpose: L, L, L, " "L, L." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1948 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548 +#: ../src/guestfs.pod:2152 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:548 msgid "BUGS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1950 +#: ../src/guestfs.pod:2154 msgid "To get a list of bugs against libguestfs use this link:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1952 +#: ../src/guestfs.pod:2156 msgid "L" msgstr "" # type: textblock -#: ../src/guestfs.pod:1954 +#: ../src/guestfs.pod:2158 msgid "To report a new bug against libguestfs use this link:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1956 +#: ../src/guestfs.pod:2160 msgid "L" msgstr "" # type: textblock -#: ../src/guestfs.pod:1958 +#: ../src/guestfs.pod:2162 msgid "When reporting a bug, please check:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1964 +#: ../src/guestfs.pod:2168 msgid "That the bug hasn't been reported already." msgstr "" # type: textblock -#: ../src/guestfs.pod:1968 +#: ../src/guestfs.pod:2172 msgid "That you are testing a recent version." msgstr "" # type: textblock -#: ../src/guestfs.pod:1972 +#: ../src/guestfs.pod:2176 msgid "Describe the bug accurately, and give a way to reproduce it." msgstr "" # type: textblock -#: ../src/guestfs.pod:1976 +#: ../src/guestfs.pod:2180 msgid "" "Run libguestfs-test-tool and paste the B output into the " "bug report." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1981 ../fish/guestfish.pod:1009 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:237 ../inspector/virt-inspector.pl:580 +#: ../src/guestfs.pod:2185 ../fish/guestfish.pod:1108 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244 msgid "AUTHORS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1983 ../fish/guestfish.pod:1011 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:239 +#: ../src/guestfs.pod:2187 ../fish/guestfish.pod:1110 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246 msgid "Richard W.M. Jones (C)" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1985 ../fish/guestfish.pod:1013 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:241 ../inspector/virt-inspector.pl:594 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653 ../tools/virt-ls.pl:247 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:202 ../tools/virt-cat.pl:199 ../tools/virt-tar.pl:296 ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:269 +#: ../src/guestfs.pod:2189 ../fish/guestfish.pod:1112 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:602 ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:273 msgid "COPYRIGHT" msgstr "" # type: textblock -#: ../src/guestfs.pod:1987 ../fish/guestfish.pod:1015 ../fuse/guestmount.pod:243 +#: ../src/guestfs.pod:2191 ../fish/guestfish.pod:1114 ../fuse/guestmount.pod:250 msgid "Copyright (C) 2009-2010 Red Hat Inc. L" msgstr "" # type: textblock -#: ../src/guestfs.pod:1990 +#: ../src/guestfs.pod:2194 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 " @@ -3846,7 +4173,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1995 +#: ../src/guestfs.pod:2199 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 " @@ -3855,7 +4182,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:2000 +#: ../src/guestfs.pod:2204 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, " @@ -3896,46 +4223,187 @@ msgid "" "instead." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:24 +# type: textblock +#: ../src/guestfs-actions.pod:24 +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." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:189 ../src/guestfs-actions.pod:226 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535 ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781 ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:970 ../src/guestfs-actions.pod:990 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1326 ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1466 ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2387 ../src/guestfs-actions.pod:2448 ../src/guestfs-actions.pod:2483 ../src/guestfs-actions.pod:3222 ../src/guestfs-actions.pod:3237 ../src/guestfs-actions.pod:3257 ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:3437 ../src/guestfs-actions.pod:3451 ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3502 ../src/guestfs-actions.pod:3574 ../src/guestfs-actions.pod:3594 ../src/guestfs-actions.pod:3611 ../src/guestfs-actions.pod:3634 ../src/guestfs-actions.pod:3657 ../src/guestfs-actions.pod:3689 ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:3727 ../src/guestfs-actions.pod:3762 ../src/guestfs-actions.pod:3774 ../src/guestfs-actions.pod:3810 ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3839 ../src/guestfs-actions.pod:3854 ../src/guestfs-actions.pod:3871 ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:3984 ../src/guestfs-actions.pod:3997 ../src/guestfs-actions.pod:4048 ../src/guestfs-actions.pod:4066 ../src/guestfs-actions.pod:4084 ../src/guestfs-actions.pod:4100 ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4128 ../src/guestfs-actions.pod:4145 ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:4180 ../src/guestfs-actions.pod:4224 ../src/guestfs-actions.pod:4295 ../src/guestfs-actions.pod:4326 ../src/guestfs-actions.pod:4345 ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4376 ../src/guestfs-actions.pod:4393 ../src/guestfs-actions.pod:4406 ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:4436 ../src/guestfs-actions.pod:4471 ../src/guestfs-actions.pod:4486 ../src/guestfs-actions.pod:4506 ../src/guestfs-actions.pod:4520 ../src/guestfs-actions.pod:4537 ../src/guestfs-actions.pod:4586 ../src/guestfs-actions.pod:4623 ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4665 ../src/guestfs-actions.pod:4682 ../src/guestfs-actions.pod:4700 ../src/guestfs-actions.pod:4834 ../src/guestfs-actions.pod:4891 ../src/guestfs-actions.pod:4913 ../src/guestfs-actions.pod:4931 ../src/guestfs-actions.pod:4963 ../src/guestfs-actions.pod:5029 ../src/guestfs-actions.pod:5046 ../src/guestfs-actions.pod:5059 ../src/guestfs-actions.pod:5073 ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:5395 ../src/guestfs-actions.pod:5407 ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:5433 ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:5463 ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5503 ../src/guestfs-actions.pod:5522 ../src/guestfs-actions.pod:5540 ../src/guestfs-actions.pod:5563 ../src/guestfs-actions.pod:5581 ../src/guestfs-actions.pod:5600 ../src/guestfs-actions.pod:5621 ../src/guestfs-actions.pod:5640 ../src/guestfs-actions.pod:5657 ../src/guestfs-actions.pod:5685 ../src/guestfs-actions.pod:5709 ../src/guestfs-actions.pod:5728 ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5767 ../src/guestfs-actions.pod:5782 ../src/guestfs-actions.pod:5801 ../src/guestfs-actions.pod:5838 ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5887 ../src/guestfs-actions.pod:5995 ../src/guestfs-actions.pod:6116 ../src/guestfs-actions.pod:6128 ../src/guestfs-actions.pod:6141 ../src/guestfs-actions.pod:6154 ../src/guestfs-actions.pod:6176 ../src/guestfs-actions.pod:6189 ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6215 ../src/guestfs-actions.pod:6230 ../src/guestfs-actions.pod:6289 ../src/guestfs-actions.pod:6306 ../src/guestfs-actions.pod:6322 ../src/guestfs-actions.pod:6338 ../src/guestfs-actions.pod:6355 ../src/guestfs-actions.pod:6368 ../src/guestfs-actions.pod:6388 ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6438 ../src/guestfs-actions.pod:6479 ../src/guestfs-actions.pod:6492 ../src/guestfs-actions.pod:6510 ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:6699 ../src/guestfs-actions.pod:6717 ../src/guestfs-actions.pod:6731 ../src/guestfs-actions.pod:6786 ../src/guestfs-actions.pod:6799 ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6877 ../src/guestfs-actions.pod:6931 ../src/guestfs-actions.pod:6957 ../src/guestfs-actions.pod:7023 ../src/guestfs-actions.pod:7042 ../src/guestfs-actions.pod:7071 +msgid "This function returns 0 on success or -1 on error." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:242 ../src/guestfs-actions.pod:263 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167 +msgid "" +"This function is deprecated. In new code, use the C call " +"instead." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:245 ../src/guestfs-actions.pod:266 ../src/guestfs-actions.pod:1437 ../src/guestfs-actions.pod:1923 ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:4185 ../src/guestfs-actions.pod:6965 ../src/guestfs-actions.pod:7134 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156 ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951 ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322 ../fish/guestfish-actions.pod:2818 ../fish/guestfish-actions.pod:4620 ../fish/guestfish-actions.pod:4717 +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: textblock +#: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:130 ../src/guestfs-actions.pod:1094 ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:2096 ../src/guestfs-actions.pod:3224 ../src/guestfs-actions.pod:3239 ../src/guestfs-actions.pod:4473 ../src/guestfs-actions.pod:5542 ../src/guestfs-actions.pod:5659 ../src/guestfs-actions.pod:5769 ../src/guestfs-actions.pod:6232 ../src/guestfs-actions.pod:6357 ../src/guestfs-actions.pod:6879 +msgid "(Added in 0.3)" +msgstr "" + +# type: =head2 +#: ../src/guestfs-actions.pod:41 +msgid "guestfs_add_domain" +msgstr "" + +# type: verbatim +#: ../src/guestfs-actions.pod:43 +#, no-wrap +msgid "" +" int\n" +" guestfs_add_domain (guestfs_h *g,\n" +" const char *dom,\n" +" ...);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:139 ../src/guestfs-actions.pod:4199 +msgid "" +"You may supply a list of optional arguments to this call. Use zero or more " +"of the following pairs of parameters, and terminate the list with C<-1> on " +"its own. See L." +msgstr "" + +# type: verbatim +#: ../src/guestfs-actions.pod:53 +#, no-wrap +msgid "" +" GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n" +" GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n" +" GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:57 +msgid "" +"This function adds the disk(s) attached to the named libvirt domain C. " +"It works by connecting to libvirt, requesting the domain and domain XML from " +"libvirt, parsing it for disks, and calling C on each " +"one." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46 +msgid "" +"The number of disks added is returned. This operation is atomic: if an " +"error is returned, then no disks are added." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49 +msgid "" +"This function does some minimal checks to make sure the libvirt domain is " +"not running (unless C is true). In a future version we will try " +"to acquire the libvirt lock on each disk." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53 +msgid "" +"Disks must be accessible locally. This often means that adding disks from a " +"remote libvirt connection (see L) will fail " +"unless those disks are accessible via the same device path locally too." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:74 +msgid "" +"The optional C parameter sets the libvirt URI (see " +"L). If this is not set then we connect to the " +"default libvirt URI (or one set through an environment variable, see the " +"libvirt documentation for full details). If you are using the C API " +"directly then it is more flexible to create the libvirt connection object " +"yourself, get the domain object, and call C." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:82 +msgid "" +"The other optional parameters are passed directly through to " +"C." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:681 ../src/guestfs-actions.pod:712 ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2005 ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2662 ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:4609 ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:5143 ../src/guestfs-actions.pod:5169 ../src/guestfs-actions.pod:6465 ../src/guestfs-actions.pod:6890 ../src/guestfs-actions.pod:6903 ../src/guestfs-actions.pod:6916 +msgid "On error this function returns -1." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:87 +msgid "(Added in 1.7.4)" +msgstr "" + +# type: =head2 +#: ../src/guestfs-actions.pod:89 +msgid "guestfs_add_domain_va" +msgstr "" + +# type: verbatim +#: ../src/guestfs-actions.pod:91 +#, no-wrap msgid "" -"If you just want to add an ISO file (often you use this as an efficient way " -"to transfer large files into the guest), then you should probably use " -"C instead." +" int\n" +" guestfs_add_domain_va (guestfs_h *g,\n" +" const char *dom,\n" +" va_list args);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:58 ../src/guestfs-actions.pod:119 ../src/guestfs-actions.pod:156 ../src/guestfs-actions.pod:170 ../src/guestfs-actions.pod:191 ../src/guestfs-actions.pod:211 ../src/guestfs-actions.pod:225 ../src/guestfs-actions.pod:340 ../src/guestfs-actions.pod:360 ../src/guestfs-actions.pod:374 ../src/guestfs-actions.pod:419 ../src/guestfs-actions.pod:447 ../src/guestfs-actions.pod:465 ../src/guestfs-actions.pod:532 ../src/guestfs-actions.pod:565 ../src/guestfs-actions.pod:579 ../src/guestfs-actions.pod:594 ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:711 ../src/guestfs-actions.pod:725 ../src/guestfs-actions.pod:739 ../src/guestfs-actions.pod:900 ../src/guestfs-actions.pod:920 ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1040 ../src/guestfs-actions.pod:1059 ../src/guestfs-actions.pod:1073 ../src/guestfs-actions.pod:1093 ../src/guestfs-actions.pod:1132 ../src/guestfs-actions.pod:1202 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1258 ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1401 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1653 ../src/guestfs-actions.pod:1675 ../src/guestfs-actions.pod:1762 ../src/guestfs-actions.pod:2185 ../src/guestfs-actions.pod:2329 ../src/guestfs-actions.pod:2390 ../src/guestfs-actions.pod:2426 ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:2959 ../src/guestfs-actions.pod:2979 ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3132 ../src/guestfs-actions.pod:3146 ../src/guestfs-actions.pod:3161 ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3270 ../src/guestfs-actions.pod:3290 ../src/guestfs-actions.pod:3307 ../src/guestfs-actions.pod:3330 ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:3404 ../src/guestfs-actions.pod:3423 ../src/guestfs-actions.pod:3458 ../src/guestfs-actions.pod:3470 ../src/guestfs-actions.pod:3506 ../src/guestfs-actions.pod:3522 ../src/guestfs-actions.pod:3535 ../src/guestfs-actions.pod:3550 ../src/guestfs-actions.pod:3567 ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3682 ../src/guestfs-actions.pod:3695 ../src/guestfs-actions.pod:3746 ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:3782 ../src/guestfs-actions.pod:3798 ../src/guestfs-actions.pod:3812 ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3843 ../src/guestfs-actions.pod:3858 ../src/guestfs-actions.pod:3878 ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:3977 ../src/guestfs-actions.pod:3996 ../src/guestfs-actions.pod:4008 ../src/guestfs-actions.pod:4025 ../src/guestfs-actions.pod:4038 ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4068 ../src/guestfs-actions.pod:4103 ../src/guestfs-actions.pod:4118 ../src/guestfs-actions.pod:4138 ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:4169 ../src/guestfs-actions.pod:4218 ../src/guestfs-actions.pod:4255 ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:4297 ../src/guestfs-actions.pod:4314 ../src/guestfs-actions.pod:4332 ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4524 ../src/guestfs-actions.pod:4546 ../src/guestfs-actions.pod:4564 ../src/guestfs-actions.pod:4596 ../src/guestfs-actions.pod:4662 ../src/guestfs-actions.pod:4679 ../src/guestfs-actions.pod:4692 ../src/guestfs-actions.pod:4706 ../src/guestfs-actions.pod:4997 ../src/guestfs-actions.pod:5016 ../src/guestfs-actions.pod:5030 ../src/guestfs-actions.pod:5042 ../src/guestfs-actions.pod:5056 ../src/guestfs-actions.pod:5068 ../src/guestfs-actions.pod:5082 ../src/guestfs-actions.pod:5098 ../src/guestfs-actions.pod:5119 ../src/guestfs-actions.pod:5138 ../src/guestfs-actions.pod:5157 ../src/guestfs-actions.pod:5175 ../src/guestfs-actions.pod:5198 ../src/guestfs-actions.pod:5216 ../src/guestfs-actions.pod:5235 ../src/guestfs-actions.pod:5256 ../src/guestfs-actions.pod:5275 ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:5320 ../src/guestfs-actions.pod:5344 ../src/guestfs-actions.pod:5363 ../src/guestfs-actions.pod:5387 ../src/guestfs-actions.pod:5402 ../src/guestfs-actions.pod:5417 ../src/guestfs-actions.pod:5436 ../src/guestfs-actions.pod:5473 ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5522 ../src/guestfs-actions.pod:5630 ../src/guestfs-actions.pod:5751 ../src/guestfs-actions.pod:5763 ../src/guestfs-actions.pod:5776 ../src/guestfs-actions.pod:5789 ../src/guestfs-actions.pod:5811 ../src/guestfs-actions.pod:5824 ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5850 ../src/guestfs-actions.pod:5865 ../src/guestfs-actions.pod:5924 ../src/guestfs-actions.pod:5941 ../src/guestfs-actions.pod:5957 ../src/guestfs-actions.pod:5973 ../src/guestfs-actions.pod:5990 ../src/guestfs-actions.pod:6003 ../src/guestfs-actions.pod:6023 ../src/guestfs-actions.pod:6059 ../src/guestfs-actions.pod:6073 ../src/guestfs-actions.pod:6114 ../src/guestfs-actions.pod:6127 ../src/guestfs-actions.pod:6145 ../src/guestfs-actions.pod:6174 ../src/guestfs-actions.pod:6205 ../src/guestfs-actions.pod:6324 ../src/guestfs-actions.pod:6342 ../src/guestfs-actions.pod:6356 ../src/guestfs-actions.pod:6411 ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6470 ../src/guestfs-actions.pod:6503 ../src/guestfs-actions.pod:6557 ../src/guestfs-actions.pod:6583 ../src/guestfs-actions.pod:6649 ../src/guestfs-actions.pod:6668 ../src/guestfs-actions.pod:6697 -msgid "This function returns 0 on success or -1 on error." +#: ../src/guestfs-actions.pod:96 +msgid "This is the \"va_list variant\" of L." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:172 ../src/guestfs-actions.pod:193 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:117 ../fish/guestfish-actions.pod:131 -msgid "" -"This function is deprecated. In new code, use the C call " -"instead." +#: ../src/guestfs-actions.pod:98 ../src/guestfs-actions.pod:109 ../src/guestfs-actions.pod:202 ../src/guestfs-actions.pod:213 ../src/guestfs-actions.pod:4236 ../src/guestfs-actions.pod:4248 +msgid "See L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:175 ../src/guestfs-actions.pod:196 ../src/guestfs-actions.pod:1406 ../src/guestfs-actions.pod:1892 ../src/guestfs-actions.pod:1913 ../src/guestfs-actions.pod:6591 ../src/guestfs-actions.pod:6760 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:120 ../fish/guestfish-actions.pod:134 ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:1297 ../fish/guestfish-actions.pod:1311 ../fish/guestfish-actions.pod:4353 ../fish/guestfish-actions.pod:4450 +# type: =head2 +#: ../src/guestfs-actions.pod:100 +msgid "guestfs_add_domain_argv" +msgstr "" + +# type: verbatim +#: ../src/guestfs-actions.pod:102 +#, no-wrap 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." +" int\n" +" guestfs_add_domain_argv (guestfs_h *g,\n" +" const char *dom,\n" +" const struct guestfs_add_domain_argv *optargs);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:60 ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:1864 ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2065 ../src/guestfs-actions.pod:2946 ../src/guestfs-actions.pod:2961 ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:5294 ../src/guestfs-actions.pod:5404 ../src/guestfs-actions.pod:5867 ../src/guestfs-actions.pod:5992 ../src/guestfs-actions.pod:6505 -msgid "(Added in 0.3)" +#: ../src/guestfs-actions.pod:107 +msgid "This is the \"argv variant\" of L." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:41 +#: ../src/guestfs-actions.pod:111 msgid "guestfs_add_drive" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:43 +#: ../src/guestfs-actions.pod:113 #, no-wrap msgid "" " int\n" @@ -3945,7 +4413,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:47 +#: ../src/guestfs-actions.pod:117 msgid "" "This function is the equivalent of calling C with no " "optional parameters, so the disk is added writable, with the format being " @@ -3953,7 +4421,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:51 +#: ../src/guestfs-actions.pod:121 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 " @@ -3963,12 +4431,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:62 +#: ../src/guestfs-actions.pod:132 msgid "guestfs_add_drive_opts" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:64 +#: ../src/guestfs-actions.pod:134 #, no-wrap msgid "" " int\n" @@ -3978,16 +4446,8 @@ msgid "" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:69 -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." -msgstr "" - # type: verbatim -#: ../src/guestfs-actions.pod:74 +#: ../src/guestfs-actions.pod:144 #, no-wrap msgid "" " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n" @@ -3997,7 +4457,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:78 ../fish/guestfish-actions.pod:56 +#: ../src/guestfs-actions.pod:148 ../fish/guestfish-actions.pod:92 msgid "" "This function adds a virtual machine disk image C to libguestfs. " "The first time you call this function, the disk appears as C, the " @@ -4005,7 +4465,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:83 ../fish/guestfish-actions.pod:61 +#: ../src/guestfs-actions.pod:153 ../fish/guestfish-actions.pod:97 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 " @@ -4014,22 +4474,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:67 +#: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:103 msgid "This call checks that C exists." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:91 ../fish/guestfish-actions.pod:69 +#: ../src/guestfs-actions.pod:161 ../src/guestfs-actions.pod:4209 ../fish/guestfish-actions.pod:105 ../fish/guestfish-actions.pod:2829 msgid "The optional arguments are:" msgstr "" # type: =item -#: ../src/guestfs-actions.pod:95 ../fish/guestfish-actions.pod:73 +#: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109 msgid "C" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:97 ../fish/guestfish-actions.pod:75 +#: ../src/guestfs-actions.pod:167 ../fish/guestfish-actions.pod:111 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 " @@ -4037,12 +4497,12 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs-actions.pod:101 ../fish/guestfish-actions.pod:79 +#: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:115 msgid "C" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:103 +#: ../src/guestfs-actions.pod:173 msgid "" "This forces the image format. If you omit this (or use C " "or C) then the format is automatically detected. " @@ -4050,7 +4510,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:107 ../fish/guestfish-actions.pod:85 +#: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:121 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 " @@ -4058,29 +4518,29 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs-actions.pod:112 ../fish/guestfish-actions.pod:90 +#: ../src/guestfs-actions.pod:182 ../fish/guestfish-actions.pod:126 msgid "C" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:114 +#: ../src/guestfs-actions.pod:184 msgid "" "This rarely-used option lets you emulate the behaviour of the deprecated " "C call (q.v.)" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:121 +#: ../src/guestfs-actions.pod:191 msgid "(Added in 1.5.23)" msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:123 +#: ../src/guestfs-actions.pod:193 msgid "guestfs_add_drive_opts_va" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:125 +#: ../src/guestfs-actions.pod:195 #, no-wrap msgid "" " int\n" @@ -4091,22 +4551,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:130 +#: ../src/guestfs-actions.pod:200 msgid "This is the \"va_list variant\" of L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:132 ../src/guestfs-actions.pod:143 -msgid "See L." -msgstr "" - # type: =head2 -#: ../src/guestfs-actions.pod:134 +#: ../src/guestfs-actions.pod:204 msgid "guestfs_add_drive_opts_argv" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:136 +#: ../src/guestfs-actions.pod:206 #, no-wrap msgid "" " int\n" @@ -4118,17 +4573,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:141 +#: ../src/guestfs-actions.pod:211 msgid "This is the \"argv variant\" of L." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:145 +#: ../src/guestfs-actions.pod:215 msgid "guestfs_add_drive_ro" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:147 +#: ../src/guestfs-actions.pod:217 #, no-wrap msgid "" " int\n" @@ -4138,7 +4593,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:151 +#: ../src/guestfs-actions.pod:221 msgid "" "This function is the equivalent of calling C with " "the optional parameter C set to 1, so the " @@ -4146,17 +4601,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:158 +#: ../src/guestfs-actions.pod:228 msgid "(Added in 1.0.38)" msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:160 +#: ../src/guestfs-actions.pod:230 msgid "guestfs_add_drive_ro_with_if" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:162 +#: ../src/guestfs-actions.pod:232 #, no-wrap msgid "" " int\n" @@ -4167,24 +4622,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:167 +#: ../src/guestfs-actions.pod:237 msgid "" "This is the same as C but it allows you to specify the " "QEMU interface emulation to use at run time." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:179 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:2275 +#: ../src/guestfs-actions.pod:249 ../src/guestfs-actions.pod:270 ../src/guestfs-actions.pod:2333 msgid "(Added in 1.0.84)" msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:181 +#: ../src/guestfs-actions.pod:251 msgid "guestfs_add_drive_with_if" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:183 +#: ../src/guestfs-actions.pod:253 #, no-wrap msgid "" " int\n" @@ -4195,19 +4650,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:188 +#: ../src/guestfs-actions.pod:258 msgid "" "This is the same as C but it allows you to specify the " "QEMU interface emulation to use at run time." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:202 +#: ../src/guestfs-actions.pod:272 msgid "guestfs_aug_clear" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:204 +#: ../src/guestfs-actions.pod:274 #, no-wrap msgid "" " int\n" @@ -4217,24 +4672,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:208 ../fish/guestfish-actions.pod:142 +#: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:178 msgid "" "Set the value associated with C to C. This is the same as the " "L C command." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:213 ../src/guestfs-actions.pod:2054 +#: ../src/guestfs-actions.pod:283 ../src/guestfs-actions.pod:2085 msgid "(Added in 1.3.4)" msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:215 +#: ../src/guestfs-actions.pod:285 msgid "guestfs_aug_close" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:217 +#: ../src/guestfs-actions.pod:287 #, no-wrap msgid "" " int\n" @@ -4243,7 +4698,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:220 +#: ../src/guestfs-actions.pod:290 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 " @@ -4251,17 +4706,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:227 ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:270 ../src/guestfs-actions.pod:284 ../src/guestfs-actions.pod:342 ../src/guestfs-actions.pod:362 ../src/guestfs-actions.pod:376 ../src/guestfs-actions.pod:407 ../src/guestfs-actions.pod:421 ../src/guestfs-actions.pod:435 ../src/guestfs-actions.pod:449 ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:4854 +#: ../src/guestfs-actions.pod:297 ../src/guestfs-actions.pod:322 ../src/guestfs-actions.pod:340 ../src/guestfs-actions.pod:354 ../src/guestfs-actions.pod:412 ../src/guestfs-actions.pod:432 ../src/guestfs-actions.pod:446 ../src/guestfs-actions.pod:477 ../src/guestfs-actions.pod:491 ../src/guestfs-actions.pod:505 ../src/guestfs-actions.pod:519 ../src/guestfs-actions.pod:537 ../src/guestfs-actions.pod:5220 msgid "(Added in 0.7)" msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:229 +#: ../src/guestfs-actions.pod:299 msgid "guestfs_aug_defnode" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:231 +#: ../src/guestfs-actions.pod:301 #, no-wrap msgid "" " struct guestfs_int_bool *\n" @@ -4273,12 +4728,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:237 ../fish/guestfish-actions.pod:158 +#: ../src/guestfs-actions.pod:307 ../fish/guestfish-actions.pod:194 msgid "Defines a variable C whose value is the result of evaluating C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:240 +#: ../src/guestfs-actions.pod:310 msgid "" "If C evaluates to an empty nodeset, a node is created, equivalent to " "calling C C, C. C will be the nodeset " @@ -4286,26 +4741,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:244 ../fish/guestfish-actions.pod:165 +#: ../src/guestfs-actions.pod:314 ../fish/guestfish-actions.pod:201 msgid "" "On success this returns a pair containing the number of nodes in the " "nodeset, and a boolean flag if a node was created." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:248 +#: ../src/guestfs-actions.pod:318 msgid "" "This function returns a C, or NULL if there was " "an error. I after use>." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:254 +#: ../src/guestfs-actions.pod:324 msgid "guestfs_aug_defvar" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:256 +#: ../src/guestfs-actions.pod:326 #, no-wrap msgid "" " int\n" @@ -4316,31 +4771,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:173 +#: ../src/guestfs-actions.pod:331 ../fish/guestfish-actions.pod:209 msgid "" "Defines an Augeas variable C whose value is the result of evaluating " "C. If C is NULL, then C is undefined." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:265 ../fish/guestfish-actions.pod:177 +#: ../src/guestfs-actions.pod:335 ../fish/guestfish-actions.pod:213 msgid "" "On success this returns the number of nodes in C, or C<0> if C " "evaluates to something which is not a nodeset." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:433 ../src/guestfs-actions.pod:611 ../src/guestfs-actions.pod:642 ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1632 ../src/guestfs-actions.pod:1835 ../src/guestfs-actions.pod:1934 ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2575 ../src/guestfs-actions.pod:2596 ../src/guestfs-actions.pod:4241 ../src/guestfs-actions.pod:4369 ../src/guestfs-actions.pod:4777 ../src/guestfs-actions.pod:4803 ../src/guestfs-actions.pod:6100 ../src/guestfs-actions.pod:6516 ../src/guestfs-actions.pod:6529 ../src/guestfs-actions.pod:6542 -msgid "On error this function returns -1." -msgstr "" - # type: =head2 -#: ../src/guestfs-actions.pod:272 +#: ../src/guestfs-actions.pod:342 msgid "guestfs_aug_get" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:274 +#: ../src/guestfs-actions.pod:344 #, no-wrap msgid "" " char *\n" @@ -4350,26 +4800,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:184 +#: ../src/guestfs-actions.pod:348 ../fish/guestfish-actions.pod:220 msgid "" "Look up the value associated with C. If C matches exactly one " "node, the C is returned." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:781 ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:859 ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:978 ../src/guestfs-actions.pod:1112 ../src/guestfs-actions.pod:1147 ../src/guestfs-actions.pod:1164 ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1312 ../src/guestfs-actions.pod:1503 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1778 ../src/guestfs-actions.pod:1795 ../src/guestfs-actions.pod:1886 ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:2077 ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2448 ../src/guestfs-actions.pod:2521 ../src/guestfs-actions.pod:2652 ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2713 ../src/guestfs-actions.pod:3091 ../src/guestfs-actions.pod:3442 ../src/guestfs-actions.pod:3613 ../src/guestfs-actions.pod:3724 ../src/guestfs-actions.pod:4387 ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:4752 ../src/guestfs-actions.pod:4931 ../src/guestfs-actions.pod:4980 ../src/guestfs-actions.pod:5543 ../src/guestfs-actions.pod:5559 ../src/guestfs-actions.pod:5576 ../src/guestfs-actions.pod:5600 ../src/guestfs-actions.pod:6264 ../src/guestfs-actions.pod:6283 ../src/guestfs-actions.pod:6301 ../src/guestfs-actions.pod:6482 ../src/guestfs-actions.pod:6754 +#: ../src/guestfs-actions.pod:351 ../src/guestfs-actions.pod:851 ../src/guestfs-actions.pod:869 ../src/guestfs-actions.pod:929 ../src/guestfs-actions.pod:945 ../src/guestfs-actions.pod:1048 ../src/guestfs-actions.pod:1178 ../src/guestfs-actions.pod:1195 ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1343 ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1809 ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:1938 ../src/guestfs-actions.pod:2108 ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2744 ../src/guestfs-actions.pod:2775 ../src/guestfs-actions.pod:2799 ../src/guestfs-actions.pod:2861 ../src/guestfs-actions.pod:2884 ../src/guestfs-actions.pod:3396 ../src/guestfs-actions.pod:3746 ../src/guestfs-actions.pod:3916 ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:4948 ../src/guestfs-actions.pod:5118 ../src/guestfs-actions.pod:5296 ../src/guestfs-actions.pod:5345 ../src/guestfs-actions.pod:5908 ../src/guestfs-actions.pod:5924 ../src/guestfs-actions.pod:5941 ../src/guestfs-actions.pod:5965 ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:6658 ../src/guestfs-actions.pod:6676 ../src/guestfs-actions.pod:6856 ../src/guestfs-actions.pod:7128 msgid "" "This function returns a string, or NULL on error. I." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:286 +#: ../src/guestfs-actions.pod:356 msgid "guestfs_aug_init" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:288 +#: ../src/guestfs-actions.pod:358 #, no-wrap msgid "" " int\n" @@ -4380,7 +4830,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:293 ../fish/guestfish-actions.pod:191 +#: ../src/guestfs-actions.pod:363 ../fish/guestfish-actions.pod:227 msgid "" "Create a new Augeas handle for editing configuration files. If there was " "any previous Augeas handle associated with this guestfs session, then it is " @@ -4388,101 +4838,101 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:297 +#: ../src/guestfs-actions.pod:367 msgid "You must call this before using any other C commands." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:300 ../fish/guestfish-actions.pod:198 +#: ../src/guestfs-actions.pod:370 ../fish/guestfish-actions.pod:234 msgid "C is the filesystem root. C must not be NULL, use C instead." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:303 ../fish/guestfish-actions.pod:201 +#: ../src/guestfs-actions.pod:373 ../fish/guestfish-actions.pod:237 msgid "" "The flags are the same as the flags defined in Eaugeas.hE, the " "logical I of the following integers:" msgstr "" # type: =item -#: ../src/guestfs-actions.pod:309 ../fish/guestfish-actions.pod:207 +#: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243 msgid "C = 1" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:311 ../fish/guestfish-actions.pod:209 +#: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245 msgid "Keep the original file with a C<.augsave> extension." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:211 +#: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247 msgid "C = 2" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:315 ../fish/guestfish-actions.pod:213 +#: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:249 msgid "" "Save changes into a file with extension C<.augnew>, and do not overwrite " "original. Overrides C." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:318 ../fish/guestfish-actions.pod:216 +#: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252 msgid "C = 4" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:218 +#: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254 msgid "Typecheck lenses (can be expensive)." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:322 ../fish/guestfish-actions.pod:220 +#: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256 msgid "C = 8" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:324 ../fish/guestfish-actions.pod:222 +#: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258 msgid "Do not use standard load path for modules." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:224 +#: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260 msgid "C = 16" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:328 ../fish/guestfish-actions.pod:226 +#: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262 msgid "Make save a no-op, just record what would have been changed." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:330 ../fish/guestfish-actions.pod:228 +#: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:264 msgid "C = 32" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:332 +#: ../src/guestfs-actions.pod:402 msgid "Do not load the tree in C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:336 +#: ../src/guestfs-actions.pod:406 msgid "To close the handle, you can call C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:338 ../fish/guestfish-actions.pod:236 +#: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:272 msgid "To find out more about Augeas, see L." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:344 +#: ../src/guestfs-actions.pod:414 msgid "guestfs_aug_insert" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:346 +#: ../src/guestfs-actions.pod:416 #, no-wrap msgid "" " int\n" @@ -4494,26 +4944,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:352 ../fish/guestfish-actions.pod:242 +#: ../src/guestfs-actions.pod:422 ../fish/guestfish-actions.pod:278 msgid "" "Create a new sibling C