X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=po-docs%2Flibguestfs-docs.pot;h=666e0a91c5f4d82ada5d1c58cc157913f8eed893;hp=7c735aa8f4c7b3c37668b410cfa3c8286a7792d3;hb=ece3b30e4957b2d1d02377a82afb132e8061804d;hpb=dad3fcfefd7c013ecbe8fa04df032fefb619e7d6 diff --git a/po-docs/libguestfs-docs.pot b/po-docs/libguestfs-docs.pot index 7c735aa..666e0a9 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.5.22\n" +"Project-Id-Version: libguestfs 1.7.1\n" "Report-Msgid-Bugs-To: libguestfs@redhat.com\n" -"POT-Creation-Date: 2010-10-19 15:17+0200\n" +"POT-Creation-Date: 2010-11-03 21:09+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:36 ../tools/virt-edit.pl:31 ../tools/virt-win-reg.pl:34 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:31 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-cat.pl:30 ../tools/virt-tar.pl:30 ../tools/virt-rescue.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28 +#: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 ../inspector/virt-inspector.pl:31 ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:30 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-cat.pl:29 ../tools/virt-tar.pl:29 ../tools/virt-rescue.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28 msgid "utf8" msgstr "" # type: =head1 -#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pl:38 ../tools/virt-edit.pl:33 ../tools/virt-win-reg.pl:36 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:33 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-cat.pl:32 ../tools/virt-tar.pl:32 ../tools/virt-rescue.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 +#: ../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 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:42 ../tools/virt-edit.pl:37 ../tools/virt-win-reg.pl:40 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:37 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-cat.pl:36 ../tools/virt-tar.pl:36 ../tools/virt-rescue.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 +#: ../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 msgid "SYNOPSIS" msgstr "" @@ -70,7 +70,7 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:16 ../inspector/virt-inspector.pl:48 ../tools/virt-edit.pl:51 ../tools/virt-win-reg.pl:64 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:43 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-cat.pl:42 ../tools/virt-tar.pl:73 ../tools/virt-rescue.pl:51 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40 +#: ../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 msgid "DESCRIPTION" msgstr "" @@ -272,12 +272,46 @@ msgstr "" # type: textblock #: ../src/guestfs.pod:127 msgid "" -"You can add a disk read-only using L, in which case " +"The call you should use in modern code for adding drives is " +"L. To add a disk image, allowing writes, and " +"specifying that the format is raw, do:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:131 +#, no-wrap +msgid "" +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n" +" -1);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:135 +msgid "You can add a disk read-only using:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:137 +#, no-wrap +msgid "" +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n" +" GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n" +" -1);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:142 +msgid "" +"or by calling the older function L. In either case " "libguestfs won't modify the file." msgstr "" # type: textblock -#: ../src/guestfs.pod:130 +#: ../src/guestfs.pod:145 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 " @@ -285,7 +319,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:134 +#: ../src/guestfs.pod:149 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 " @@ -293,7 +327,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:139 +#: ../src/guestfs.pod:154 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 " @@ -301,12 +335,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:144 +#: ../src/guestfs.pod:159 msgid "MOUNTING" msgstr "" # type: textblock -#: ../src/guestfs.pod:146 +#: ../src/guestfs.pod:161 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 " @@ -316,7 +350,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:152 +#: ../src/guestfs.pod:167 #, no-wrap msgid "" " guestfs_mount (g, \"/dev/sda1\", \"/\");\n" @@ -324,7 +358,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:154 +#: ../src/guestfs.pod:169 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 " @@ -332,7 +366,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:158 +#: ../src/guestfs.pod:173 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 " @@ -345,19 +379,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:168 +#: ../src/guestfs.pod:183 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:171 +#: ../src/guestfs.pod:186 msgid "FILESYSTEM ACCESS AND MODIFICATION" msgstr "" # type: textblock -#: ../src/guestfs.pod:173 +#: ../src/guestfs.pod:188 msgid "" "The majority of the libguestfs API consists of fairly low-level calls for " "accessing and modifying the files, directories, symlinks etc on mounted " @@ -367,21 +401,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:179 +#: ../src/guestfs.pod:194 msgid "" "Specify filenames as full paths, starting with C<\"/\"> and including the " "mount point." msgstr "" # type: textblock -#: ../src/guestfs.pod:182 +#: ../src/guestfs.pod:197 msgid "" "For example, if you mounted a filesystem at C<\"/\"> and you want to read " "the file called C<\"etc/passwd\"> then you could do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:185 +#: ../src/guestfs.pod:200 #, no-wrap msgid "" " char *data = guestfs_cat (g, \"/etc/passwd\");\n" @@ -389,7 +423,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:187 +#: ../src/guestfs.pod:202 msgid "" "This would return C as a newly allocated buffer containing the full " "content of that file (with some conditions: see also L below), " @@ -397,14 +431,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:191 +#: ../src/guestfs.pod:206 msgid "" "As another example, to create a top-level directory on that filesystem " "called C<\"var\"> you would do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:194 +#: ../src/guestfs.pod:209 #, no-wrap msgid "" " guestfs_mkdir (g, \"/var\");\n" @@ -412,12 +446,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:196 +#: ../src/guestfs.pod:211 msgid "To create a symlink you could do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:198 +#: ../src/guestfs.pod:213 #, no-wrap msgid "" " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n" @@ -426,14 +460,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:201 +#: ../src/guestfs.pod:216 msgid "" "Libguestfs will reject attempts to use relative paths and there is no " "concept of a current working directory." msgstr "" # type: textblock -#: ../src/guestfs.pod:204 +#: ../src/guestfs.pod:219 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 " @@ -443,33 +477,33 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:210 +#: ../src/guestfs.pod:225 msgid "" "File writes are affected by the per-handle umask, set by calling " "L and defaulting to 022. See L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:213 +#: ../src/guestfs.pod:228 msgid "PARTITIONING" msgstr "" # type: textblock -#: ../src/guestfs.pod:215 +#: ../src/guestfs.pod:230 msgid "" "Libguestfs contains API calls to read, create and modify partition tables on " "disk images." msgstr "" # type: textblock -#: ../src/guestfs.pod:218 +#: ../src/guestfs.pod:233 msgid "" "In the common case where you want to create a single partition covering the " "whole disk, you should use the L call:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:222 +#: ../src/guestfs.pod:237 #, no-wrap msgid "" " const char *parttype = \"mbr\";\n" @@ -480,19 +514,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:227 +#: ../src/guestfs.pod:242 msgid "" "Obviously this effectively wipes anything that was on that disk image " "before." msgstr "" # type: =head2 -#: ../src/guestfs.pod:230 +#: ../src/guestfs.pod:245 msgid "LVM2" msgstr "" # type: textblock -#: ../src/guestfs.pod:232 +#: ../src/guestfs.pod:247 msgid "" "Libguestfs provides access to a large part of the LVM2 API, such as " "L and L. It won't make much sense " @@ -501,19 +535,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:237 +#: ../src/guestfs.pod:252 msgid "" "This author strongly recommends reading the LVM HOWTO, online at " "L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:240 +#: ../src/guestfs.pod:255 msgid "DOWNLOADING" msgstr "" # type: textblock -#: ../src/guestfs.pod:242 +#: ../src/guestfs.pod:257 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 " @@ -521,7 +555,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:247 +#: ../src/guestfs.pod:262 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 " @@ -529,31 +563,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:251 +#: ../src/guestfs.pod:266 msgid "" "L can be used to download any file, with no limits on " "content or size (even files larger than 4 GB)." msgstr "" # type: textblock -#: ../src/guestfs.pod:254 +#: ../src/guestfs.pod:269 msgid "To download multiple files, see L and L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:257 +#: ../src/guestfs.pod:272 msgid "UPLOADING" msgstr "" # type: textblock -#: ../src/guestfs.pod:259 +#: ../src/guestfs.pod:274 msgid "" "It's often the case that you want to write a file or files to the disk " "image." msgstr "" # type: textblock -#: ../src/guestfs.pod:262 +#: ../src/guestfs.pod:277 msgid "" "To write a small file with fixed content, use L. To create " "a file of all zeroes, use L (sparse) or " @@ -563,19 +597,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:268 +#: ../src/guestfs.pod:283 msgid "" "To upload a single file, use L. This call has no limits on " "file content or size (even files larger than 4 GB)." msgstr "" # type: textblock -#: ../src/guestfs.pod:271 +#: ../src/guestfs.pod:286 msgid "To upload multiple files, see L and L." msgstr "" # type: textblock -#: ../src/guestfs.pod:273 +#: ../src/guestfs.pod:288 msgid "" "However the fastest way to upload I is to " "turn them into a squashfs or CD ISO (see L and " @@ -589,12 +623,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:284 +#: ../src/guestfs.pod:299 msgid "COPYING" msgstr "" # type: textblock -#: ../src/guestfs.pod:286 +#: ../src/guestfs.pod:301 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 " @@ -602,36 +636,36 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:292 +#: ../src/guestfs.pod:307 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:294 +#: ../src/guestfs.pod:309 msgid "" "Use L to copy a single file, or L to copy " "directories recursively." msgstr "" # type: =item -#: ../src/guestfs.pod:297 +#: ../src/guestfs.pod:312 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:299 +#: ../src/guestfs.pod:314 msgid "" "Use L which efficiently uses L to copy between files and " "devices in the guest." msgstr "" # type: textblock -#: ../src/guestfs.pod:302 +#: ../src/guestfs.pod:317 msgid "Example: duplicate the contents of an LV:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:304 +#: ../src/guestfs.pod:319 #, no-wrap msgid "" " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n" @@ -639,7 +673,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:306 +#: ../src/guestfs.pod:321 msgid "" "The destination (C) must be at least as large as the source " "(C). To copy less than the whole source device, use " @@ -647,46 +681,46 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:310 +#: ../src/guestfs.pod:325 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:312 +#: ../src/guestfs.pod:327 msgid "Use L. See L above." msgstr "" # type: =item -#: ../src/guestfs.pod:314 +#: ../src/guestfs.pod:329 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:316 +#: ../src/guestfs.pod:331 msgid "Use L. See L above." msgstr "" # type: =head2 -#: ../src/guestfs.pod:320 +#: ../src/guestfs.pod:335 msgid "LISTING FILES" msgstr "" # type: textblock -#: ../src/guestfs.pod:322 +#: ../src/guestfs.pod:337 msgid "" "L is just designed for humans to read (mainly when using the " "L-equivalent command C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:325 +#: ../src/guestfs.pod:340 msgid "" "L is a quick way to get a list of files in a directory from " "programs, as a flat list of strings." msgstr "" # type: textblock -#: ../src/guestfs.pod:328 +#: ../src/guestfs.pod:343 msgid "" "L is a programmatic way to get a list of files in a " "directory, plus additional information about each one. It is more " @@ -694,19 +728,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:332 +#: ../src/guestfs.pod:347 msgid "" "L and L can be used to recursively list " "files." msgstr "" # type: =head2 -#: ../src/guestfs.pod:335 +#: ../src/guestfs.pod:350 msgid "RUNNING COMMANDS" msgstr "" # type: textblock -#: ../src/guestfs.pod:337 +#: ../src/guestfs.pod:352 msgid "" "Although libguestfs is primarily an API for manipulating files inside guest " "images, we also provide some limited facilities for running commands inside " @@ -714,79 +748,100 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:341 +#: ../src/guestfs.pod:356 msgid "There are many limitations to this:" msgstr "" # type: =item -#: ../src/guestfs.pod:345 ../src/guestfs.pod:350 ../src/guestfs.pod:355 ../src/guestfs.pod:359 ../src/guestfs.pod:364 ../src/guestfs.pod:368 ../src/guestfs.pod:373 ../src/guestfs.pod:1254 ../src/guestfs.pod:1259 ../src/guestfs.pod:1263 ../src/guestfs.pod:1365 ../src/guestfs.pod:1369 ../src/guestfs.pod:1373 ../src/guestfs.pod:1378 ../src/guestfs.pod:1386 ../src/guestfs.pod:1405 ../src/guestfs.pod:1413 ../src/guestfs.pod:1643 ../src/guestfs.pod:1649 ../src/guestfs.pod:1654 ../src/guestfs.pod:1660 ../src/guestfs.pod:1767 ../src/guestfs.pod:1771 ../src/guestfs.pod:1775 ../src/guestfs.pod:1779 ../src/guestfs-actions.pod:14 ../src/guestfs-actions.pod:21 ../src/guestfs-actions.pod:372 ../src/guestfs-actions.pod:380 ../src/guestfs-actions.pod:387 ../src/guestfs-actions.pod:394 ../src/guestfs-actions.pod:1285 ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1293 ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1305 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:1313 ../src/guestfs-actions.pod:1323 ../src/guestfs-actions.pod:1327 ../src/guestfs-actions.pod:1331 ../src/guestfs-actions.pod:1454 ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1463 ../src/guestfs-actions.pod:1468 ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1524 ../src/guestfs-actions.pod:1529 ../fish/guestfish.pod:338 ../fish/guestfish.pod:342 ../fish/guestfish.pod:346 ../fish/guestfish.pod:350 ../fish/guestfish-actions.pod:15 ../fish/guestfish-actions.pod:22 ../fish/guestfish-actions.pod:306 ../fish/guestfish-actions.pod:314 ../fish/guestfish-actions.pod:321 ../fish/guestfish-actions.pod:328 ../fish/guestfish-actions.pod:1023 ../fish/guestfish-actions.pod:1027 ../fish/guestfish-actions.pod:1031 ../fish/guestfish-actions.pod:1035 ../fish/guestfish-actions.pod:1043 ../fish/guestfish-actions.pod:1047 ../fish/guestfish-actions.pod:1051 ../fish/guestfish-actions.pod:1061 ../fish/guestfish-actions.pod:1065 ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1159 ../fish/guestfish-actions.pod:1163 ../fish/guestfish-actions.pod:1168 ../fish/guestfish-actions.pod:1173 ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1224 ../tools/virt-df.pl:144 ../tools/virt-df.pl:150 ../tools/virt-resize.pl:348 ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363 +#: ../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:461 ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:476 ../src/guestfs-actions.pod:483 ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1426 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1434 ../src/guestfs-actions.pod:1442 ../src/guestfs-actions.pod:1446 ../src/guestfs-actions.pod:1450 ../src/guestfs-actions.pod:1460 ../src/guestfs-actions.pod:1464 ../src/guestfs-actions.pod:1468 ../src/guestfs-actions.pod:1596 ../src/guestfs-actions.pod:1600 ../src/guestfs-actions.pod:1605 ../src/guestfs-actions.pod:1610 ../src/guestfs-actions.pod:1665 ../src/guestfs-actions.pod:1669 ../src/guestfs-actions.pod:1674 ../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 msgid "*" msgstr "" # type: textblock -#: ../src/guestfs.pod:347 +#: ../src/guestfs.pod:362 msgid "" "The kernel version that the command runs under will be different from what " "it expects." msgstr "" # type: textblock -#: ../src/guestfs.pod:352 +#: ../src/guestfs.pod:367 msgid "" "If the command needs to communicate with daemons, then most likely they " "won't be running." msgstr "" # type: textblock -#: ../src/guestfs.pod:357 +#: ../src/guestfs.pod:372 msgid "The command will be running in limited memory." msgstr "" # type: textblock -#: ../src/guestfs.pod:361 +#: ../src/guestfs.pod:376 msgid "" "The network may not be available unless you enable it (see " "L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:366 +#: ../src/guestfs.pod:381 msgid "Only supports Linux guests (not Windows, BSD, etc)." msgstr "" # type: textblock -#: ../src/guestfs.pod:370 +#: ../src/guestfs.pod:385 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)." msgstr "" # type: textblock -#: ../src/guestfs.pod:375 +#: ../src/guestfs.pod:390 msgid "" "For SELinux guests, you may need to enable SELinux and load policy first. " "See L in this manpage." msgstr "" # type: textblock -#: ../src/guestfs.pod:380 +#: ../src/guestfs.pod:395 +msgid "" +"I It is not safe to run commands from untrusted, possibly " +"malicious guests. These commands may attempt to exploit your program by " +"sending unexpected output. They could also try to exploit the Linux kernel " +"or qemu provided by the libguestfs appliance. They could use the network " +"provided by the libguestfs appliance to bypass ordinary network partitions " +"and firewalls. They could use the elevated privileges or different SELinux " +"context of your program to their advantage." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:404 +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." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:411 msgid "" "The two main API calls to run commands are L and " "L (there are also variations)." msgstr "" # type: textblock -#: ../src/guestfs.pod:383 +#: ../src/guestfs.pod:414 msgid "" "The difference is that L runs commands using the shell, so any " "shell globs, redirections, etc will work." msgstr "" # type: =head2 -#: ../src/guestfs.pod:386 +#: ../src/guestfs.pod:417 msgid "CONFIGURATION FILES" msgstr "" # type: textblock -#: ../src/guestfs.pod:388 +#: ../src/guestfs.pod:419 msgid "" "To read and write configuration files in Linux guest filesystems, we " "strongly recommend using Augeas. For example, Augeas understands how to " @@ -795,7 +850,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:393 +#: ../src/guestfs.pod:424 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 " @@ -803,7 +858,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:397 +#: ../src/guestfs.pod:428 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 " @@ -811,29 +866,29 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:401 +#: ../src/guestfs.pod:432 msgid "SELINUX" msgstr "" # type: textblock -#: ../src/guestfs.pod:403 +#: ../src/guestfs.pod:434 msgid "" "We support SELinux guests. To ensure that labeling happens correctly in " "SELinux guests, you need to enable SELinux and load the guest's policy:" msgstr "" # type: =item -#: ../src/guestfs.pod:409 +#: ../src/guestfs.pod:440 ../src/guestfs.pod:953 msgid "1." msgstr "" # type: textblock -#: ../src/guestfs.pod:411 +#: ../src/guestfs.pod:442 msgid "Before launching, do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:413 +#: ../src/guestfs.pod:444 #, no-wrap msgid "" " guestfs_set_selinux (g, 1);\n" @@ -841,19 +896,19 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:415 +#: ../src/guestfs.pod:446 ../src/guestfs.pod:957 msgid "2." msgstr "" # type: textblock -#: ../src/guestfs.pod:417 +#: ../src/guestfs.pod:448 msgid "" "After mounting the guest's filesystem(s), load the policy. This is best " "done by running the L command in the guest itself:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:421 +#: ../src/guestfs.pod:452 #, no-wrap msgid "" " guestfs_sh (g, \"/usr/sbin/load_policy\");\n" @@ -861,26 +916,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:423 +#: ../src/guestfs.pod:454 msgid "" "(Older versions of C require you to specify the name of the " "policy file)." msgstr "" # type: =item -#: ../src/guestfs.pod:426 +#: ../src/guestfs.pod:457 ../src/guestfs.pod:963 msgid "3." msgstr "" # type: textblock -#: ../src/guestfs.pod:428 +#: ../src/guestfs.pod:459 msgid "" "Optionally, set the security context for the API. The correct security " "context to use can only be known by inspecting the guest. As an example:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:432 +#: ../src/guestfs.pod:463 #, no-wrap msgid "" " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n" @@ -888,24 +943,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:436 +#: ../src/guestfs.pod:467 msgid "This will work for running commands and editing existing files." msgstr "" # type: textblock -#: ../src/guestfs.pod:438 +#: ../src/guestfs.pod:469 msgid "" "When new files are created, you may need to label them explicitly, for " "example by running the external command C." msgstr "" # type: =head2 -#: ../src/guestfs.pod:442 +#: ../src/guestfs.pod:473 msgid "UMASK" msgstr "" # type: textblock -#: ../src/guestfs.pod:444 +#: ../src/guestfs.pod:475 msgid "" "Certain calls are affected by the current file mode creation mask (the " "\"umask\"). In particular ones which create files or directories, such as " @@ -915,14 +970,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:450 +#: ../src/guestfs.pod:481 msgid "" "The default umask is C<022>, so files are created with modes such as C<0644> " "and directories with C<0755>." msgstr "" # type: textblock -#: ../src/guestfs.pod:453 +#: ../src/guestfs.pod:484 msgid "" "There are two ways to avoid being affected by umask. Either set umask to 0 " "(call C early after launching). Or call " @@ -930,17 +985,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:457 +#: ../src/guestfs.pod:488 msgid "For more information about umask, see L." msgstr "" # type: =head1 -#: ../src/guestfs.pod:459 ../fish/guestfish.pod:589 +#: ../src/guestfs.pod:490 ../fish/guestfish.pod:630 msgid "ENCRYPTED DISKS" msgstr "" # type: textblock -#: ../src/guestfs.pod:461 +#: ../src/guestfs.pod:492 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) " @@ -949,21 +1004,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:467 +#: ../src/guestfs.pod:498 msgid "" "Use L to identify LUKS-encrypted block devices (it " "returns the string C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:470 +#: ../src/guestfs.pod:501 msgid "" "Then open these devices by calling L. Obviously you " "will require the passphrase!" msgstr "" # type: textblock -#: ../src/guestfs.pod:473 +#: ../src/guestfs.pod:504 msgid "" "Opening a LUKS device creates a new device mapper device called " "C (where C is the string you supply to " @@ -972,7 +1027,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:479 +#: ../src/guestfs.pod:510 msgid "" "LVM volume groups on the device can be made visible by calling " "L followed by L. The logical " @@ -980,7 +1035,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:483 +#: ../src/guestfs.pod:514 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:501 +#: ../src/guestfs.pod:532 msgid "" "Then call L. This function uses other libguestfs calls " "and certain heuristics, and returns a list of operating systems that were " @@ -1025,7 +1080,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:510 +#: ../src/guestfs.pod:541 msgid "" "For each root, you can then call various C functions " "to get additional details about that operating system. For example, call " @@ -1034,7 +1089,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:516 +#: ../src/guestfs.pod:547 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 " @@ -1045,7 +1100,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:523 +#: ../src/guestfs.pod:554 #, no-wrap msgid "" " /boot => /dev/sda1\n" @@ -1055,14 +1110,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:527 +#: ../src/guestfs.pod:558 msgid "" "The caller can then make calls to L to mount the " "filesystems as suggested." msgstr "" # type: textblock -#: ../src/guestfs.pod:530 +#: ../src/guestfs.pod:561 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 " @@ -1070,7 +1125,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:534 +#: ../src/guestfs.pod:565 msgid "" "Inspection currently only works for some common operating systems. " "Contributors are welcome to send patches for other operating systems that we " @@ -1078,7 +1133,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:538 +#: ../src/guestfs.pod:569 msgid "" "Encrypted disks must be opened before inspection. See L " "for more details. The L function just ignores any " @@ -1086,7 +1141,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:542 +#: ../src/guestfs.pod:573 msgid "" "A note on the implementation: The call L performs " "inspection and caches the results in the guest handle. Subsequent calls to " @@ -1096,19 +1151,19 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:549 +#: ../src/guestfs.pod:580 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:551 +#: ../src/guestfs.pod:582 msgid "" "Libguestfs can mount NTFS partitions. It does this using the " "L driver." msgstr "" # type: textblock -#: ../src/guestfs.pod:554 +#: ../src/guestfs.pod:585 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 " @@ -1118,7 +1173,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:560 +#: ../src/guestfs.pod:591 msgid "" "Drive letter mappings are outside the scope of libguestfs. You have to use " "libguestfs to read the appropriate Windows Registry and configuration files, " @@ -1127,21 +1182,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:565 +#: ../src/guestfs.pod:596 msgid "" "Replacing backslash characters with forward slash characters is also outside " "the scope of libguestfs, but something that you can easily do." msgstr "" # type: textblock -#: ../src/guestfs.pod:568 +#: ../src/guestfs.pod:599 msgid "" "Where we can help is in resolving the case insensitivity of paths. For " "this, call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:571 +#: ../src/guestfs.pod:602 msgid "" "Libguestfs also provides some help for decoding Windows Registry \"hive\" " "files, through the library C which is part of the libguestfs project " @@ -1152,19 +1207,19 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:579 +#: ../src/guestfs.pod:610 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:581 +#: ../src/guestfs.pod:612 msgid "" "Although we don't want to discourage you from using the C API, we will " "mention here that the same API is also available in other languages." msgstr "" # type: textblock -#: ../src/guestfs.pod:584 +#: ../src/guestfs.pod:615 msgid "" "The API is broadly identical in all supported languages. This means that " "the C call C is C<$g-Emount($path)> in Perl, " @@ -1173,14 +1228,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:590 +#: ../src/guestfs.pod:621 msgid "" "Error messages are automatically transformed into exceptions if the language " "supports it." msgstr "" # type: textblock -#: ../src/guestfs.pod:593 +#: ../src/guestfs.pod:624 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 " @@ -1188,36 +1243,36 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:599 +#: ../src/guestfs.pod:630 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:601 +#: ../src/guestfs.pod:632 msgid "" "You can use the I header file from C++ programs. The C++ API is " "identical to the C API. C++ classes and exceptions are not used." msgstr "" # type: =item -#: ../src/guestfs.pod:605 +#: ../src/guestfs.pod:636 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:607 +#: ../src/guestfs.pod:638 msgid "" "The C# bindings are highly experimental. Please read the warnings at the " "top of C." msgstr "" # type: =item -#: ../src/guestfs.pod:610 +#: ../src/guestfs.pod:641 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:612 +#: ../src/guestfs.pod:643 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 " @@ -1225,66 +1280,66 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:616 +#: ../src/guestfs.pod:647 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:618 +#: ../src/guestfs.pod:649 msgid "" "Full documentation is contained in the Javadoc which is distributed with " "libguestfs." msgstr "" # type: =item -#: ../src/guestfs.pod:621 +#: ../src/guestfs.pod:652 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:623 +#: ../src/guestfs.pod:654 msgid "For documentation see the file C." msgstr "" # type: =item -#: ../src/guestfs.pod:625 +#: ../src/guestfs.pod:656 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:627 +#: ../src/guestfs.pod:658 msgid "For documentation see L." msgstr "" # type: =item -#: ../src/guestfs.pod:629 +#: ../src/guestfs.pod:660 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:631 +#: ../src/guestfs.pod:662 msgid "" "For documentation see C supplied with libguestfs sources or in " "the php-libguestfs package for your distribution." msgstr "" # type: textblock -#: ../src/guestfs.pod:634 +#: ../src/guestfs.pod:665 msgid "The PHP binding only works correctly on 64 bit machines." msgstr "" # type: =item -#: ../src/guestfs.pod:636 +#: ../src/guestfs.pod:667 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:638 +#: ../src/guestfs.pod:669 msgid "For documentation do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:640 +#: ../src/guestfs.pod:671 #, no-wrap msgid "" " $ python\n" @@ -1294,34 +1349,34 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:644 +#: ../src/guestfs.pod:675 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:646 +#: ../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." msgstr "" # type: =item -#: ../src/guestfs.pod:649 +#: ../src/guestfs.pod:680 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:651 +#: ../src/guestfs.pod:682 msgid "For documentation see L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:655 +#: ../src/guestfs.pod:686 msgid "LIBGUESTFS GOTCHAS" msgstr "" # type: textblock -#: ../src/guestfs.pod:657 +#: ../src/guestfs.pod:688 msgid "" "L: \"A feature of a " "system [...] that works in the way it is documented but is counterintuitive " @@ -1329,7 +1384,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:661 +#: ../src/guestfs.pod:692 msgid "" "Since we developed libguestfs and the associated tools, there are several " "things we would have designed differently, but are now stuck with for " @@ -1338,12 +1393,12 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:669 +#: ../src/guestfs.pod:700 msgid "Autosync / forgetting to sync." msgstr "" # type: textblock -#: ../src/guestfs.pod:671 +#: ../src/guestfs.pod:702 msgid "" "When modifying a filesystem from C or another language, you B unmount " "all filesystems and call L explicitly before you close the " @@ -1351,7 +1406,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:675 +#: ../src/guestfs.pod:706 #, no-wrap msgid "" " guestfs_set_autosync (g, 1);\n" @@ -1359,7 +1414,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:677 +#: ../src/guestfs.pod:708 msgid "" "to have the unmount/sync done automatically for you when the handle 'g' is " "closed. (This feature is called \"autosync\", L " @@ -1367,7 +1422,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:681 +#: ../src/guestfs.pod:712 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 " @@ -1375,20 +1430,27 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:685 +#: ../src/guestfs.pod:716 msgid "" "Note that in L autosync is the default. So quick and dirty " "guestfish scripts that forget to sync will work just fine, which can make " "this very puzzling if you are trying to debug a problem." msgstr "" +# type: textblock +#: ../src/guestfs.pod:720 +msgid "" +"Update: Autosync is enabled by default for all API users starting from " +"libguestfs 1.5.24." +msgstr "" + # type: =item -#: ../src/guestfs.pod:689 +#: ../src/guestfs.pod:723 msgid "Mount option C<-o sync> should not be the default." msgstr "" # type: textblock -#: ../src/guestfs.pod:691 +#: ../src/guestfs.pod:725 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 " @@ -1396,31 +1458,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:695 +#: ../src/guestfs.pod:729 msgid "" "The work around is to use L and set the mount " "options that you actually want to use." msgstr "" # type: =item -#: ../src/guestfs.pod:698 +#: ../src/guestfs.pod:732 msgid "Read-only should be the default." msgstr "" # type: textblock -#: ../src/guestfs.pod:700 +#: ../src/guestfs.pod:734 msgid "" "In L, I<--ro> should be the default, and you should have to " "specify I<--rw> if you want to make changes to the image." msgstr "" # type: textblock -#: ../src/guestfs.pod:703 +#: ../src/guestfs.pod:737 msgid "This would reduce the potential to corrupt live VM images." msgstr "" # type: textblock -#: ../src/guestfs.pod:705 +#: ../src/guestfs.pod:739 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 " @@ -1428,12 +1490,12 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:709 +#: ../src/guestfs.pod:743 msgid "guestfish command line is hard to use." msgstr "" # type: textblock -#: ../src/guestfs.pod:711 +#: ../src/guestfs.pod:745 msgid "" "C doesn't do what people expect (open C for " "examination). It tries to run a guestfish command C which doesn't " @@ -1443,12 +1505,12 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:718 +#: ../src/guestfs.pod:752 msgid "guestfish megabyte modifiers don't work right on all commands" msgstr "" # type: textblock -#: ../src/guestfs.pod:720 +#: ../src/guestfs.pod:754 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 " @@ -1458,12 +1520,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:727 +#: ../src/guestfs.pod:761 msgid "The most common is L. The guestfish command:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:729 +#: ../src/guestfs.pod:763 #, no-wrap msgid "" " lvcreate LV VG 100M\n" @@ -1471,7 +1533,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:731 +#: ../src/guestfs.pod:765 msgid "" "does not do what you might expect. Instead because L is " "already expecting megabytes, this tries to create a 100 I (100 " @@ -1480,40 +1542,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:736 +#: ../src/guestfs.pod:770 msgid "" "This could be fixed in the generator by specially marking parameters and " "return values which take bytes or other units." msgstr "" # type: =item -#: ../src/guestfs.pod:739 -msgid "Library should return errno with error messages." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:741 -msgid "" -"It would be a nice-to-have to be able to get the original value of 'errno' " -"from inside the appliance along error paths (where set). Currently " -"L goes through hoops to try to reverse the error message " -"string into an errno, see the function error() in fuse/guestmount.c." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:747 -msgid "" -"In libguestfs 1.5.4, the protocol was changed so that the Linux errno is " -"sent back from the daemon." -msgstr "" - -# type: =item -#: ../src/guestfs.pod:750 +#: ../src/guestfs.pod:773 msgid "Ambiguity between devices and paths" msgstr "" # type: textblock -#: ../src/guestfs.pod:752 +#: ../src/guestfs.pod:775 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 " @@ -1521,7 +1562,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:757 +#: ../src/guestfs.pod:780 msgid "" "In the current API we usually resolve this ambiguity by having two separate " "calls, for example L and L. " @@ -1530,7 +1571,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:763 +#: ../src/guestfs.pod:786 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 " @@ -1540,7 +1581,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:769 +#: ../src/guestfs.pod:792 #, no-wrap msgid "" " type path = Path of string | Device of int | Partition of int * int\n" @@ -1548,12 +1589,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:771 +#: ../src/guestfs.pod:794 msgid "which would allow you to pass arguments like:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:773 +#: ../src/guestfs.pod:796 #, no-wrap msgid "" " Path \"/foo/bar\"\n" @@ -1564,19 +1605,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:778 +#: ../src/guestfs.pod:801 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:783 +#: ../src/guestfs.pod:806 msgid "PROTOCOL LIMITS" msgstr "" # type: textblock -#: ../src/guestfs.pod:785 +#: ../src/guestfs.pod:808 msgid "" "Internally libguestfs uses a message-based protocol to pass API calls and " "their responses to and from a small \"appliance\" (see L for " @@ -1587,7 +1628,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:793 +#: ../src/guestfs.pod:816 msgid "" "A simple call such as L returns its result (the file data) in " "a simple string. Because this string is at some point internally encoded as " @@ -1596,7 +1637,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:799 +#: ../src/guestfs.pod:822 msgid "" "In order to transfer large files into and out of the guest filesystem, you " "need to use particular calls that support this. The sections L " @@ -1604,26 +1645,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:803 +#: ../src/guestfs.pod:826 msgid "" "You might also consider mounting the disk image using our FUSE filesystem " "support (L)." msgstr "" # type: =head2 -#: ../src/guestfs.pod:806 +#: ../src/guestfs.pod:829 msgid "KEYS AND PASSPHRASES" msgstr "" # type: textblock -#: ../src/guestfs.pod:808 +#: ../src/guestfs.pod:831 msgid "" "Certain libguestfs calls take a parameter that contains sensitive key " "material, passed in as a C string." msgstr "" # type: textblock -#: ../src/guestfs.pod:811 +#: ../src/guestfs.pod:834 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 " @@ -1632,7 +1673,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:816 +#: ../src/guestfs.pod:839 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, " @@ -1640,17 +1681,17 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:821 +#: ../src/guestfs.pod:844 msgid "CONNECTION MANAGEMENT" msgstr "" # type: =head2 -#: ../src/guestfs.pod:823 +#: ../src/guestfs.pod:846 msgid "guestfs_h *" msgstr "" # type: textblock -#: ../src/guestfs.pod:825 +#: ../src/guestfs.pod:848 msgid "" "C is the opaque type representing a connection handle. Create a " "handle by calling L. Call L to free the " @@ -1658,19 +1699,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:829 +#: ../src/guestfs.pod:852 msgid "" "For information on using multiple handles and threads, see the section " "L below." msgstr "" # type: =head2 -#: ../src/guestfs.pod:832 +#: ../src/guestfs.pod:855 msgid "guestfs_create" msgstr "" # type: verbatim -#: ../src/guestfs.pod:834 +#: ../src/guestfs.pod:857 #, no-wrap msgid "" " guestfs_h *guestfs_create (void);\n" @@ -1678,41 +1719,43 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:836 +#: ../src/guestfs.pod:859 msgid "Create a connection handle." msgstr "" # type: textblock -#: ../src/guestfs.pod:838 -msgid "You have to call L on the handle at least once." +#: ../src/guestfs.pod:861 +msgid "" +"You have to call L (or one of the equivalent calls) " +"on the handle at least once." msgstr "" # type: textblock -#: ../src/guestfs.pod:840 +#: ../src/guestfs.pod:864 msgid "" "This function returns a non-NULL pointer to a handle on success or NULL on " "error." msgstr "" # type: textblock -#: ../src/guestfs.pod:843 +#: ../src/guestfs.pod:867 msgid "After configuring the handle, you have to call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:845 +#: ../src/guestfs.pod:869 msgid "" "You may also want to configure error handling for the handle. See L section below." msgstr "" # type: =head2 -#: ../src/guestfs.pod:848 +#: ../src/guestfs.pod:872 msgid "guestfs_close" msgstr "" # type: verbatim -#: ../src/guestfs.pod:850 +#: ../src/guestfs.pod:874 #, no-wrap msgid "" " void guestfs_close (guestfs_h *g);\n" @@ -1720,44 +1763,126 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:852 +#: ../src/guestfs.pod:876 msgid "This closes the connection handle and frees up all resources used." msgstr "" # type: =head1 -#: ../src/guestfs.pod:854 +#: ../src/guestfs.pod:878 msgid "ERROR HANDLING" msgstr "" # type: textblock -#: ../src/guestfs.pod:856 +#: ../src/guestfs.pod:880 msgid "" -"The convention in all functions that return C is that they return C<-1> " -"to indicate an error. You can get additional information on errors by " -"calling L and/or by setting up an error handler with " -"L." +"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:861 -msgid "The default error handler prints the information string to C." +#: ../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." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:887 +msgid "" +"You can get at the additional information about the last error on the handle " +"by calling L, L, and/or by setting " +"up an error handler with L." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:892 +msgid "" +"When the handle is created, a default error handler is installed which " +"prints the error message string to C. For small short-running " +"command line programs it is sufficient to do:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:896 +#, no-wrap +msgid "" +" if (guestfs_launch (g) == -1)\n" +" exit (EXIT_FAILURE);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:899 +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 +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 +#, no-wrap +msgid "" +" g = guestfs_create ();\n" +" \n" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:907 +#, no-wrap +msgid "" +" /* This disables the default behaviour of printing errors\n" +" on stderr. */\n" +" guestfs_set_error_handler (g, NULL, NULL);\n" +" \n" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:911 +#, no-wrap +msgid "" +" if (guestfs_launch (g) == -1) {\n" +" /* Examine the error message and print it etc. */\n" +" char *msg = guestfs_last_error (g);\n" +" int errnum = guestfs_last_errno (g);\n" +" fprintf (stderr, \"%s\\n\", msg);\n" +" /* ... */\n" +" }\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:863 +#: ../src/guestfs.pod:919 msgid "" "Out of memory errors are handled differently. The default action is to call " "L. If this is undesirable, then you can set a handler using " "L." msgstr "" +# type: textblock +#: ../src/guestfs.pod:923 +msgid "" +"L returns C if the handle cannot be created, and " +"because there is no handle if this happens there is no way to get additional " +"error information. However L is supposed to be a " +"lightweight operation which can only fail because of insufficient memory (it " +"returns NULL in this case)." +msgstr "" + # type: =head2 -#: ../src/guestfs.pod:867 +#: ../src/guestfs.pod:929 msgid "guestfs_last_error" msgstr "" # type: verbatim -#: ../src/guestfs.pod:869 +#: ../src/guestfs.pod:931 #, no-wrap msgid "" " const char *guestfs_last_error (guestfs_h *g);\n" @@ -1765,34 +1890,85 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:871 +#: ../src/guestfs.pod:933 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:875 +#: ../src/guestfs.pod:937 msgid "" "The lifetime of the returned string is until the next error occurs, or " "L is called." msgstr "" +# type: =head2 +#: ../src/guestfs.pod:940 +msgid "guestfs_last_errno" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:942 +#, no-wrap +msgid "" +" int guestfs_last_errno (guestfs_h *g);\n" +"\n" +msgstr "" + # type: textblock -#: ../src/guestfs.pod:878 +#: ../src/guestfs.pod:944 +msgid "This returns the last error number (errno) that happened on C." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:946 +msgid "If successful, an errno integer not equal to zero is returned." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:948 +msgid "If no error, this returns 0. This call can return 0 in three situations:" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:955 +msgid "There has not been any error on the handle." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:959 msgid "" -"The error string is not localized (ie. is always in English), because this " -"makes searching for error messages in search engines give the largest number " -"of results." +"There has been an error but the errno was meaningless. This corresponds to " +"the case where the error did not come from a failed system call, but for " +"some other reason." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:965 +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 +msgid "" +"Libguestfs tries to convert the errno from inside the applicance into a " +"corresponding errno for the caller (not entirely trivial: the appliance " +"might be running a completely different operating system from the library " +"and error numbers are not standardized across Un*xen). If this could not be " +"done, then the error is translated to C. In practice this should " +"only happen in very rare circumstances." msgstr "" # type: =head2 -#: ../src/guestfs.pod:882 +#: ../src/guestfs.pod:979 msgid "guestfs_set_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:884 +#: ../src/guestfs.pod:981 #, no-wrap msgid "" " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" @@ -1805,7 +1981,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:891 +#: ../src/guestfs.pod:988 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 " @@ -1813,7 +1989,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:895 +#: ../src/guestfs.pod:992 +msgid "" +"C is not passed to the callback. To get that the callback must call " +"L." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:995 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 " @@ -1821,22 +2004,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:899 +#: ../src/guestfs.pod:999 msgid "The default handler prints messages on C." msgstr "" # type: textblock -#: ../src/guestfs.pod:901 +#: ../src/guestfs.pod:1001 msgid "If you set C to C then I handler is called." msgstr "" # type: =head2 -#: ../src/guestfs.pod:903 +#: ../src/guestfs.pod:1003 msgid "guestfs_get_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:905 +#: ../src/guestfs.pod:1005 #, no-wrap msgid "" " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" @@ -1845,17 +2028,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:908 +#: ../src/guestfs.pod:1008 msgid "Returns the current error handler callback." msgstr "" # type: =head2 -#: ../src/guestfs.pod:910 +#: ../src/guestfs.pod:1010 msgid "guestfs_set_out_of_memory_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:912 +#: ../src/guestfs.pod:1012 #, no-wrap msgid "" " typedef void (*guestfs_abort_cb) (void);\n" @@ -1865,29 +2048,29 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:916 +#: ../src/guestfs.pod:1016 msgid "" "The callback C will be called if there is an out of memory situation. " "I." msgstr "" # type: textblock -#: ../src/guestfs.pod:919 +#: ../src/guestfs.pod:1019 msgid "The default is to call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:921 +#: ../src/guestfs.pod:1021 msgid "You cannot set C to C. You can't ignore out of memory situations." msgstr "" # type: =head2 -#: ../src/guestfs.pod:924 +#: ../src/guestfs.pod:1024 msgid "guestfs_get_out_of_memory_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:926 +#: ../src/guestfs.pod:1026 #, no-wrap msgid "" " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" @@ -1895,31 +2078,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:928 +#: ../src/guestfs.pod:1028 msgid "This returns the current out of memory handler." msgstr "" # type: =head1 -#: ../src/guestfs.pod:930 +#: ../src/guestfs.pod:1030 msgid "PATH" msgstr "" # type: textblock -#: ../src/guestfs.pod:932 +#: ../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:935 +#: ../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:938 +#: ../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 " @@ -1930,17 +2113,17 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:945 +#: ../src/guestfs.pod:1045 msgid "HIGH-LEVEL API ACTIONS" msgstr "" # type: =head2 -#: ../src/guestfs.pod:947 +#: ../src/guestfs.pod:1047 msgid "ABI GUARANTEE" msgstr "" # type: textblock -#: ../src/guestfs.pod:949 +#: ../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 " @@ -1950,32 +2133,32 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:955 ../fish/guestfish.pod:819 +#: ../src/guestfs.pod:1055 ../fish/guestfish.pod:860 msgid "@ACTIONS@" msgstr "" # type: =head1 -#: ../src/guestfs.pod:957 +#: ../src/guestfs.pod:1057 msgid "STRUCTURES" msgstr "" # type: textblock -#: ../src/guestfs.pod:959 +#: ../src/guestfs.pod:1059 msgid "@STRUCTS@" msgstr "" # type: =head1 -#: ../src/guestfs.pod:961 +#: ../src/guestfs.pod:1061 msgid "AVAILABILITY" msgstr "" # type: =head2 -#: ../src/guestfs.pod:963 +#: ../src/guestfs.pod:1063 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" msgstr "" # type: textblock -#: ../src/guestfs.pod:965 +#: ../src/guestfs.pod:1065 msgid "" "Using L you can test availability of the following " "groups of functions. This test queries the appliance to see if the " @@ -1983,17 +2166,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:970 +#: ../src/guestfs.pod:1070 msgid "@AVAILABILITY@" msgstr "" # type: =head2 -#: ../src/guestfs.pod:972 +#: ../src/guestfs.pod:1072 msgid "GUESTFISH supported COMMAND" msgstr "" # type: textblock -#: ../src/guestfs.pod:974 +#: ../src/guestfs.pod:1074 msgid "" "In L there is a handy interactive command C which " "prints out the available groups and whether they are supported by this build " @@ -2001,19 +2184,19 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:979 +#: ../src/guestfs.pod:1079 msgid "SINGLE CALLS AT COMPILE TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:981 +#: ../src/guestfs.pod:1081 msgid "" "Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " "function, such as:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:984 +#: ../src/guestfs.pod:1084 #, no-wrap msgid "" " #define LIBGUESTFS_HAVE_DD 1\n" @@ -2021,12 +2204,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:986 +#: ../src/guestfs.pod:1086 msgid "if L is available." msgstr "" # type: textblock -#: ../src/guestfs.pod:988 +#: ../src/guestfs.pod:1088 msgid "" "Before version 1.5.8, if you needed to test whether a single libguestfs " "function is available at compile time, we recommended using build tools such " @@ -2034,7 +2217,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:993 +#: ../src/guestfs.pod:1093 #, no-wrap msgid "" " AC_CHECK_LIB([guestfs],[guestfs_create])\n" @@ -2043,19 +2226,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:996 +#: ../src/guestfs.pod:1096 msgid "" "which would result in C being either defined or not defined " "in your program." msgstr "" # type: =head2 -#: ../src/guestfs.pod:999 +#: ../src/guestfs.pod:1099 msgid "SINGLE CALLS AT RUN TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:1001 +#: ../src/guestfs.pod:1101 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 " @@ -2065,7 +2248,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1008 +#: ../src/guestfs.pod:1108 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 " @@ -2073,7 +2256,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1012 +#: ../src/guestfs.pod:1112 #, no-wrap msgid "" " #include \n" @@ -2085,7 +2268,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1018 +#: ../src/guestfs.pod:1118 #, no-wrap msgid "" " main ()\n" @@ -2097,7 +2280,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1024 +#: ../src/guestfs.pod:1124 #, no-wrap msgid "" " /* Test if the function guestfs_dd is really available. */\n" @@ -2112,7 +2295,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1033 +#: ../src/guestfs.pod:1133 #, no-wrap msgid "" " if (!has_function)\n" @@ -2131,7 +2314,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1046 +#: ../src/guestfs.pod:1146 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 " @@ -2139,32 +2322,224 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1051 +#: ../src/guestfs.pod:1151 #, no-wrap msgid "" " Requires: libguestfs >= 1.0.80\n" "\n" msgstr "" +# type: =head1 +#: ../src/guestfs.pod:1153 +msgid "CALLS WITH OPTIONAL ARGUMENTS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1155 +msgid "" +"A recent feature of the API is the introduction of calls which take optional " +"arguments. In C these are declared 3 ways. The main way is as a call which " +"takes variable arguments (ie. C<...>), as in this example:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1160 +#, no-wrap +msgid "" +" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1162 +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 +#, no-wrap +msgid "" +" guestfs_add_drive_opts (g, filename, -1);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1167 +msgid "With a single optional argument:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1169 +#, no-wrap +msgid "" +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" +" -1);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1173 +msgid "With two:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1175 +#, no-wrap +msgid "" +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" +" GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n" +" -1);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1180 +msgid "" +"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " +"happen!" +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1183 +msgid "USING va_list FOR OPTIONAL ARGUMENTS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1185 +msgid "" +"The second variant has the same name with the suffix C<_va>, which works the " +"same way but takes a C. See the C manual for details. For the " +"example function, this is declared:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1189 +#, 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:1661 ../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:1053 ../src/guestfs.pod:1058 +#: ../src/guestfs.pod:1248 ../src/guestfs.pod:1253 msgid "html" msgstr "" # type: textblock -#: ../src/guestfs.pod:1055 +#: ../src/guestfs.pod:1250 msgid "" " " msgstr "" # type: =head1 -#: ../src/guestfs.pod:1060 +#: ../src/guestfs.pod:1255 msgid "ARCHITECTURE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1062 +#: ../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 " @@ -2172,7 +2547,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1066 +#: ../src/guestfs.pod:1261 #, no-wrap msgid "" " ___________________\n" @@ -2198,14 +2573,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1086 +#: ../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:1089 +#: ../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 " @@ -2217,7 +2592,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1098 +#: ../src/guestfs.pod:1293 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 " @@ -2228,17 +2603,17 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1105 +#: ../src/guestfs.pod:1300 msgid "STATE MACHINE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1107 +#: ../src/guestfs.pod:1302 msgid "libguestfs uses a state machine to model the child process:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1109 +#: ../src/guestfs.pod:1304 #, no-wrap msgid "" " |\n" @@ -2266,7 +2641,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1131 +#: ../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), " @@ -2275,7 +2650,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1136 +#: ../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 " @@ -2283,14 +2658,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1140 +#: ../src/guestfs.pod:1335 msgid "" "Configuration commands for qemu such as L can only be " "issued when in the CONFIG state." msgstr "" # type: textblock -#: ../src/guestfs.pod:1143 +#: ../src/guestfs.pod:1338 msgid "" "The API offers one call that goes from CONFIG through LAUNCHING to READY. " "L blocks until the child process is READY to accept " @@ -2299,7 +2674,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1149 +#: ../src/guestfs.pod:1344 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 " @@ -2309,7 +2684,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1155 +#: ../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 " @@ -2317,26 +2692,26 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1159 +#: ../src/guestfs.pod:1354 msgid "SETTING CALLBACKS TO HANDLE EVENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1161 +#: ../src/guestfs.pod:1356 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:1164 +#: ../src/guestfs.pod:1359 msgid "" "Use the C functions to set a callback for different " "types of events." msgstr "" # type: textblock -#: ../src/guestfs.pod:1167 +#: ../src/guestfs.pod:1362 msgid "" "Only I can be registered for each handle. " "Calling C again overwrites the previous callback of " @@ -2345,12 +2720,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1172 +#: ../src/guestfs.pod:1367 msgid "guestfs_set_log_message_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1174 +#: ../src/guestfs.pod:1369 #, no-wrap msgid "" " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n" @@ -2362,31 +2737,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1180 +#: ../src/guestfs.pod:1375 msgid "" "The callback function C will be called whenever qemu or the guest writes " "anything to the console." msgstr "" # type: textblock -#: ../src/guestfs.pod:1183 +#: ../src/guestfs.pod:1378 msgid "Use this function to capture kernel messages and similar." msgstr "" # type: textblock -#: ../src/guestfs.pod:1185 +#: ../src/guestfs.pod:1380 msgid "" "Normally there is no log message handler, and log messages are just " "discarded." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1188 +#: ../src/guestfs.pod:1383 msgid "guestfs_set_subprocess_quit_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1190 +#: ../src/guestfs.pod:1385 #, no-wrap msgid "" " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n" @@ -2397,7 +2772,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1195 +#: ../src/guestfs.pod:1390 msgid "" "The callback function C will be called when the child process quits, " "either asynchronously or if killed by L. (This " @@ -2405,12 +2780,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1200 +#: ../src/guestfs.pod:1395 msgid "guestfs_set_launch_done_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1202 +#: ../src/guestfs.pod:1397 #, no-wrap msgid "" " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n" @@ -2421,7 +2796,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1207 +#: ../src/guestfs.pod:1402 msgid "" "The callback function C will be called when the child process becomes " "ready first time after it has been launched. (This corresponds to a " @@ -2429,12 +2804,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1211 +#: ../src/guestfs.pod:1406 msgid "guestfs_set_close_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1213 +#: ../src/guestfs.pod:1408 #, no-wrap msgid "" " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n" @@ -2445,14 +2820,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1218 +#: ../src/guestfs.pod:1413 msgid "" "The callback function C will be called while the handle is being closed " "(synchronously from L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1221 +#: ../src/guestfs.pod:1416 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 " @@ -2463,12 +2838,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1229 +#: ../src/guestfs.pod:1424 msgid "guestfs_set_progress_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1231 +#: ../src/guestfs.pod:1426 #, no-wrap msgid "" " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n" @@ -2481,7 +2856,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1238 +#: ../src/guestfs.pod:1433 msgid "" "Some long-running operations can generate progress messages. If this " "callback is registered, then it will be called each time a progress message " @@ -2491,7 +2866,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1244 +#: ../src/guestfs.pod:1439 msgid "" "The callback receives two numbers: C and C. The units of " "C are not defined, although for some operations C may relate " @@ -2500,31 +2875,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1250 +#: ../src/guestfs.pod:1445 msgid "The only defined and stable parts of the API are:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1256 +#: ../src/guestfs.pod:1451 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:1261 +#: ../src/guestfs.pod:1456 msgid "0 E= C E= C" msgstr "" # type: textblock -#: ../src/guestfs.pod:1265 +#: ../src/guestfs.pod:1460 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:1268 +#: ../src/guestfs.pod:1463 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 " @@ -2532,7 +2907,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1274 +#: ../src/guestfs.pod:1469 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 " @@ -2541,12 +2916,12 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1279 +#: ../src/guestfs.pod:1474 msgid "PRIVATE DATA AREA" msgstr "" # type: textblock -#: ../src/guestfs.pod:1281 +#: ../src/guestfs.pod:1476 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 " @@ -2554,12 +2929,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1285 +#: ../src/guestfs.pod:1480 msgid "To attach a named piece of data, use the following call:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1287 +#: ../src/guestfs.pod:1482 #, no-wrap msgid "" " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" @@ -2567,7 +2942,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1289 +#: ../src/guestfs.pod:1484 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 " @@ -2575,7 +2950,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1293 +#: ../src/guestfs.pod:1488 msgid "" "You can use any C you want, but names beginning with an underscore " "character are reserved for internal libguestfs purposes (for implementing " @@ -2584,12 +2959,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1298 +#: ../src/guestfs.pod:1493 msgid "To retrieve the pointer, use:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1300 +#: ../src/guestfs.pod:1495 #, no-wrap msgid "" " void *guestfs_get_private (guestfs_h *g, const char *key);\n" @@ -2597,7 +2972,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1302 +#: ../src/guestfs.pod:1497 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 " @@ -2605,7 +2980,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1306 +#: ../src/guestfs.pod:1501 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 " @@ -2617,19 +2992,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1314 +#: ../src/guestfs.pod:1509 msgid "" "The private data area is implemented using a hash table, and should be " "reasonably efficient for moderate numbers of keys." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1317 +#: ../src/guestfs.pod:1512 msgid "BLOCK DEVICE NAMING" msgstr "" # type: textblock -#: ../src/guestfs.pod:1319 +#: ../src/guestfs.pod:1514 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 " @@ -2644,7 +3019,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1331 +#: ../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 " @@ -2652,7 +3027,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1335 +#: ../src/guestfs.pod:1530 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 " @@ -2660,7 +3035,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1340 +#: ../src/guestfs.pod:1535 msgid "" "Therefore libguestfs defines C as the I. " "Internally C names are translated, if necessary, to other names as " @@ -2669,7 +3044,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1346 +#: ../src/guestfs.pod:1541 msgid "" "Note that this I applies to parameters. The L, " "L and similar calls return the true names of the " @@ -2677,12 +3052,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1351 +#: ../src/guestfs.pod:1546 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" msgstr "" # type: textblock -#: ../src/guestfs.pod:1353 +#: ../src/guestfs.pod:1548 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 " @@ -2692,7 +3067,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1359 +#: ../src/guestfs.pod:1554 msgid "" "The algorithm is applied only to I which are known to be either " "device or partition names. Return values from functions such as " @@ -2700,54 +3075,54 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1367 +#: ../src/guestfs.pod:1562 msgid "Is the string a parameter which is a device or partition name?" msgstr "" # type: textblock -#: ../src/guestfs.pod:1371 +#: ../src/guestfs.pod:1566 msgid "Does the string begin with C?" msgstr "" # type: textblock -#: ../src/guestfs.pod:1375 +#: ../src/guestfs.pod:1570 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:1380 +#: ../src/guestfs.pod:1575 msgid "Replace initial C string with C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1382 +#: ../src/guestfs.pod:1577 msgid "For example, change C to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1384 +#: ../src/guestfs.pod:1579 msgid "If that named device exists, use it. If not, continue." msgstr "" # type: textblock -#: ../src/guestfs.pod:1388 +#: ../src/guestfs.pod:1583 msgid "Replace initial C string with C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1390 +#: ../src/guestfs.pod:1585 msgid "If that named device exists, use it. If not, return an error." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1394 +#: ../src/guestfs.pod:1589 msgid "PORTABILITY CONCERNS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1396 +#: ../src/guestfs.pod:1591 msgid "" "Although the standard naming scheme and automatic translation is useful for " "simple programs and guestfish scripts, for larger programs it is best not to " @@ -2755,50 +3130,50 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1400 +#: ../src/guestfs.pod:1595 msgid "" "Where possible for maximum future portability programs using libguestfs " "should use these future-proof techniques:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1407 +#: ../src/guestfs.pod:1602 msgid "" "Use L or L to list actual " "device names, and then use those names directly." msgstr "" # type: textblock -#: ../src/guestfs.pod:1410 +#: ../src/guestfs.pod:1605 msgid "Since those device names exist by definition, they will never be translated." msgstr "" # type: textblock -#: ../src/guestfs.pod:1415 +#: ../src/guestfs.pod:1610 msgid "" "Use higher level ways to identify filesystems, such as LVM names, UUIDs and " "filesystem labels." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1420 +#: ../src/guestfs.pod:1615 msgid "INTERNALS" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1422 +#: ../src/guestfs.pod:1617 msgid "COMMUNICATION PROTOCOL" msgstr "" # type: textblock -#: ../src/guestfs.pod:1424 +#: ../src/guestfs.pod:1619 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:1427 +#: ../src/guestfs.pod:1622 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 " @@ -2806,14 +3181,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1431 +#: ../src/guestfs.pod:1626 msgid "" "The detailed format of structures is in C (note: " "this file is automatically generated)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1434 +#: ../src/guestfs.pod:1629 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 " @@ -2823,17 +3198,17 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1441 +#: ../src/guestfs.pod:1636 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" msgstr "" # type: textblock -#: ../src/guestfs.pod:1443 +#: ../src/guestfs.pod:1638 msgid "For ordinary functions, the request message is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1445 +#: ../src/guestfs.pod:1640 #, no-wrap msgid "" " total length (header + arguments,\n" @@ -2844,7 +3219,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1450 +#: ../src/guestfs.pod:1645 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 " @@ -2853,26 +3228,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1456 +#: ../src/guestfs.pod:1651 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:1459 +#: ../src/guestfs.pod:1654 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:1463 +#: ../src/guestfs.pod:1658 msgid "The reply message for ordinary functions is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1465 +#: ../src/guestfs.pod:1660 #, no-wrap msgid "" " total length (header + ret,\n" @@ -2883,26 +3258,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1470 +#: ../src/guestfs.pod:1665 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:1473 +#: ../src/guestfs.pod:1668 msgid "As above the total length of the reply is limited to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1476 +#: ../src/guestfs.pod:1671 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:1479 +#: ../src/guestfs.pod:1674 #, no-wrap msgid "" " total length (header + error,\n" @@ -2913,19 +3288,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1484 +#: ../src/guestfs.pod:1679 msgid "" "The C structure contains the error message as a " "string." msgstr "" # type: =head3 -#: ../src/guestfs.pod:1487 +#: ../src/guestfs.pod:1682 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1489 +#: ../src/guestfs.pod:1684 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 " @@ -2933,7 +3308,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1493 +#: ../src/guestfs.pod:1688 #, no-wrap msgid "" " total length (header + arguments,\n" @@ -2947,12 +3322,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1501 +#: ../src/guestfs.pod:1696 msgid "The \"sequence of chunks\" is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1503 +#: ../src/guestfs.pod:1698 #, no-wrap msgid "" " length of chunk (not including length word itself)\n" @@ -2966,7 +3341,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1511 +#: ../src/guestfs.pod:1706 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 " @@ -2974,7 +3349,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1515 +#: ../src/guestfs.pod:1710 msgid "" "At time of writing there are no functions that have more than one FileIn " "parameter. However this is (theoretically) supported, by sending the " @@ -2983,7 +3358,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1520 +#: ../src/guestfs.pod:1715 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 " @@ -2992,7 +3367,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1526 +#: ../src/guestfs.pod:1721 msgid "" "The daemon may also cancel. It does this by writing a special word " "C to the socket. The library listens for this during " @@ -3004,7 +3379,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1535 +#: ../src/guestfs.pod:1730 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 " @@ -3014,19 +3389,19 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1541 +#: ../src/guestfs.pod:1736 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1543 +#: ../src/guestfs.pod:1738 msgid "" "The protocol for FileOut parameters is exactly the same as for FileIn " "parameters, but with the roles of daemon and library reversed." msgstr "" # type: verbatim -#: ../src/guestfs.pod:1546 +#: ../src/guestfs.pod:1741 #, no-wrap msgid "" " total length (header + ret,\n" @@ -3040,12 +3415,12 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1554 +#: ../src/guestfs.pod:1749 msgid "INITIAL MESSAGE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1556 +#: ../src/guestfs.pod:1751 msgid "" "When the daemon launches it sends an initial word (C) " "which indicates that the guest and daemon is alive. This is what " @@ -3053,12 +3428,12 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1560 +#: ../src/guestfs.pod:1755 msgid "PROGRESS NOTIFICATION MESSAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:1562 +#: ../src/guestfs.pod:1757 msgid "" "The daemon may send progress notification messages at any time. These are " "distinguished by the normal length word being replaced by " @@ -3066,7 +3441,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1566 +#: ../src/guestfs.pod:1761 msgid "" "The library turns them into progress callbacks (see " "C) if there is a callback registered, or " @@ -3074,7 +3449,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1570 +#: ../src/guestfs.pod:1765 msgid "" "The daemon self-limits the frequency of progress messages it sends (see " "C). Not all calls generate progress " @@ -3082,19 +3457,19 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1574 +#: ../src/guestfs.pod:1769 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1576 +#: ../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:1579 +#: ../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 " @@ -3102,19 +3477,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1583 +#: ../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:1586 +#: ../src/guestfs.pod:1781 msgid "QEMU WRAPPERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1588 +#: ../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 " @@ -3122,7 +3497,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1592 +#: ../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 " @@ -3131,14 +3506,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1597 +#: ../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:1600 +#: ../src/guestfs.pod:1795 #, no-wrap msgid "" " #!/bin/sh -\n" @@ -3149,7 +3524,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1604 +#: ../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 " @@ -3157,7 +3532,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1608 +#: ../src/guestfs.pod:1803 #, no-wrap msgid "" " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" @@ -3165,19 +3540,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1610 +#: ../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:1613 +#: ../src/guestfs.pod:1808 msgid "LIBGUESTFS VERSION NUMBERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1615 +#: ../src/guestfs.pod:1810 msgid "" "Since April 2010, libguestfs has started to make separate development and " "stable releases, along with corresponding branches in our git repository. " @@ -3185,7 +3560,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1620 +#: ../src/guestfs.pod:1815 #, no-wrap msgid "" " even numbers for stable: 1.2.x, 1.4.x, ...\n" @@ -3202,12 +3577,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1631 +#: ../src/guestfs.pod:1826 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." msgstr "" # type: textblock -#: ../src/guestfs.pod:1633 +#: ../src/guestfs.pod:1828 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 " @@ -3217,26 +3592,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1639 +#: ../src/guestfs.pod:1834 msgid "Our criteria for backporting changes are:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1645 +#: ../src/guestfs.pod:1840 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:1651 +#: ../src/guestfs.pod:1846 msgid "" "Bug fixes which are not controversial, fix obvious problems, and have been " "well tested are backported." msgstr "" # type: textblock -#: ../src/guestfs.pod:1656 +#: ../src/guestfs.pod:1851 msgid "" "Simple rearrangements of code which shouldn't affect how it works get " "backported. This is so that the code in the two branches doesn't get too " @@ -3244,7 +3619,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1662 +#: ../src/guestfs.pod:1857 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 " @@ -3252,7 +3627,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1668 +#: ../src/guestfs.pod:1863 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 " @@ -3263,44 +3638,44 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1676 ../fish/guestfish.pod:826 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:312 ../tools/virt-rescue.pl:226 +#: ../src/guestfs.pod:1871 ../fish/guestfish.pod:867 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255 msgid "ENVIRONMENT VARIABLES" msgstr "" # type: =item -#: ../src/guestfs.pod:1680 ../fish/guestfish.pod:852 +#: ../src/guestfs.pod:1875 ../fish/guestfish.pod:893 msgid "LIBGUESTFS_APPEND" msgstr "" # type: textblock -#: ../src/guestfs.pod:1682 ../fish/guestfish.pod:854 +#: ../src/guestfs.pod:1877 ../fish/guestfish.pod:895 msgid "Pass additional options to the guest kernel." msgstr "" # type: =item -#: ../src/guestfs.pod:1684 ../fish/guestfish.pod:856 +#: ../src/guestfs.pod:1879 ../fish/guestfish.pod:897 msgid "LIBGUESTFS_DEBUG" msgstr "" # type: textblock -#: ../src/guestfs.pod:1686 +#: ../src/guestfs.pod:1881 msgid "" "Set C to enable verbose messages. This has the same " "effect as calling C." msgstr "" # type: =item -#: ../src/guestfs.pod:1689 ../fish/guestfish.pod:861 +#: ../src/guestfs.pod:1884 ../fish/guestfish.pod:902 msgid "LIBGUESTFS_MEMSIZE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1691 ../fish/guestfish.pod:863 +#: ../src/guestfs.pod:1886 ../fish/guestfish.pod:904 msgid "Set the memory allocated to the qemu process, in megabytes. For example:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1694 ../fish/guestfish.pod:866 +#: ../src/guestfs.pod:1889 ../fish/guestfish.pod:907 #, no-wrap msgid "" " LIBGUESTFS_MEMSIZE=700\n" @@ -3308,58 +3683,58 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:1696 ../fish/guestfish.pod:868 +#: ../src/guestfs.pod:1891 ../fish/guestfish.pod:909 msgid "LIBGUESTFS_PATH" msgstr "" # type: textblock -#: ../src/guestfs.pod:1698 +#: ../src/guestfs.pod:1893 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:1701 ../fish/guestfish.pod:873 +#: ../src/guestfs.pod:1896 ../fish/guestfish.pod:914 msgid "LIBGUESTFS_QEMU" msgstr "" # type: textblock -#: ../src/guestfs.pod:1703 ../fish/guestfish.pod:875 +#: ../src/guestfs.pod:1898 ../fish/guestfish.pod:916 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:1707 +#: ../src/guestfs.pod:1902 msgid "See also L above." msgstr "" # type: =item -#: ../src/guestfs.pod:1709 ../fish/guestfish.pod:879 +#: ../src/guestfs.pod:1904 ../fish/guestfish.pod:920 msgid "LIBGUESTFS_TRACE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1711 +#: ../src/guestfs.pod:1906 msgid "" "Set C to enable command traces. This has the same " "effect as calling C." msgstr "" # type: =item -#: ../src/guestfs.pod:1714 ../fish/guestfish.pod:888 +#: ../src/guestfs.pod:1909 ../fish/guestfish.pod:929 msgid "TMPDIR" msgstr "" # type: textblock -#: ../src/guestfs.pod:1716 ../fish/guestfish.pod:890 +#: ../src/guestfs.pod:1911 ../fish/guestfish.pod:931 msgid "Location of temporary directory, defaults to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1718 ../fish/guestfish.pod:892 +#: ../src/guestfs.pod:1913 ../fish/guestfish.pod:933 msgid "" "If libguestfs was compiled to use the supermin appliance then the real " "appliance is cached in this directory, shared between all handles belonging " @@ -3368,12 +3743,12 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1726 ../fish/guestfish.pod:950 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:178 ../inspector/virt-inspector.pl:853 ../tools/virt-edit.pl:332 ../tools/virt-win-reg.pl:468 ../tools/virt-df.pl:573 ../tools/virt-ls.pl:217 ../tools/virt-resize.pl:1447 ../tools/virt-list-filesystems.pl:198 ../tools/virt-cat.pl:170 ../tools/virt-tar.pl:264 ../tools/virt-rescue.pl:238 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:236 +#: ../src/guestfs.pod:1921 ../fish/guestfish.pod:991 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:214 ../inspector/virt-inspector.pl:570 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640 ../tools/virt-ls.pl:232 ../tools/virt-resize.pl:1486 ../tools/virt-list-filesystems.pl:186 ../tools/virt-cat.pl:185 ../tools/virt-tar.pl:281 ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:254 msgid "SEE ALSO" msgstr "" # type: textblock -#: ../src/guestfs.pod:1728 +#: ../src/guestfs.pod:1923 msgid "" "L, L, L, L, " "L, L, L, " @@ -3383,86 +3758,86 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1746 +#: ../src/guestfs.pod:1941 msgid "" "Tools with a similar purpose: L, L, L, " "L, L." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1753 ../tools/virt-win-reg.pl:483 ../tools/virt-make-fs.pl:548 +#: ../src/guestfs.pod:1948 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548 msgid "BUGS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1755 +#: ../src/guestfs.pod:1950 msgid "To get a list of bugs against libguestfs use this link:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1757 +#: ../src/guestfs.pod:1952 msgid "L" msgstr "" # type: textblock -#: ../src/guestfs.pod:1759 +#: ../src/guestfs.pod:1954 msgid "To report a new bug against libguestfs use this link:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1761 +#: ../src/guestfs.pod:1956 msgid "L" msgstr "" # type: textblock -#: ../src/guestfs.pod:1763 +#: ../src/guestfs.pod:1958 msgid "When reporting a bug, please check:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1769 +#: ../src/guestfs.pod:1964 msgid "That the bug hasn't been reported already." msgstr "" # type: textblock -#: ../src/guestfs.pod:1773 +#: ../src/guestfs.pod:1968 msgid "That you are testing a recent version." msgstr "" # type: textblock -#: ../src/guestfs.pod:1777 +#: ../src/guestfs.pod:1972 msgid "Describe the bug accurately, and give a way to reproduce it." msgstr "" # type: textblock -#: ../src/guestfs.pod:1781 +#: ../src/guestfs.pod:1976 msgid "" "Run libguestfs-test-tool and paste the B output into the " "bug report." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1786 ../fish/guestfish.pod:967 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:189 ../inspector/virt-inspector.pl:862 +#: ../src/guestfs.pod:1981 ../fish/guestfish.pod:1008 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:225 ../inspector/virt-inspector.pl:580 msgid "AUTHORS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1788 ../fish/guestfish.pod:969 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:191 +#: ../src/guestfs.pod:1983 ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:227 msgid "Richard W.M. Jones (C)" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1790 ../fish/guestfish.pod:971 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:193 ../inspector/virt-inspector.pl:868 ../tools/virt-edit.pl:348 ../tools/virt-win-reg.pl:498 ../tools/virt-df.pl:586 ../tools/virt-ls.pl:232 ../tools/virt-resize.pl:1473 ../tools/virt-list-filesystems.pl:214 ../tools/virt-cat.pl:184 ../tools/virt-tar.pl:279 ../tools/virt-rescue.pl:252 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:251 +#: ../src/guestfs.pod:1985 ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:229 ../inspector/virt-inspector.pl:594 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653 ../tools/virt-ls.pl:247 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:202 ../tools/virt-cat.pl:199 ../tools/virt-tar.pl:296 ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:269 msgid "COPYRIGHT" msgstr "" # type: textblock -#: ../src/guestfs.pod:1792 ../fish/guestfish.pod:973 +#: ../src/guestfs.pod:1987 ../fish/guestfish.pod:1014 ../fuse/guestmount.pod:231 msgid "Copyright (C) 2009-2010 Red Hat Inc. L" msgstr "" # type: textblock -#: ../src/guestfs.pod:1795 +#: ../src/guestfs.pod:1990 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 " @@ -3471,7 +3846,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1800 +#: ../src/guestfs.pod:1995 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 " @@ -3480,7 +3855,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1805 +#: ../src/guestfs.pod:2000 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, " @@ -3496,28 +3871,24 @@ msgstr "" #: ../src/guestfs-actions.pod:3 #, no-wrap msgid "" -" int guestfs_add_cdrom (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" int\n" +" guestfs_add_cdrom (guestfs_h *g,\n" +" const char *filename);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:6 ../fish/guestfish-actions.pod:7 +#: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5 msgid "This function adds a virtual CD-ROM disk image to the guest." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:8 ../fish/guestfish-actions.pod:9 +#: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7 msgid "This is equivalent to the qemu parameter C<-cdrom filename>." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:1516 ../fish/guestfish-actions.pod:11 ../fish/guestfish-actions.pod:1211 -msgid "Notes:" -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:16 +#: ../src/guestfs-actions.pod:17 msgid "" "This call checks for the existence of C. This stops you from " "specifying other types of drive which are supported by qemu such as C " @@ -3526,7 +3897,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:23 +#: ../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 " @@ -3534,34 +3905,102 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:63 ../src/guestfs-actions.pod:92 ../src/guestfs-actions.pod:103 ../src/guestfs-actions.pod:114 ../src/guestfs-actions.pod:124 ../src/guestfs-actions.pod:135 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:266 ../src/guestfs-actions.pod:302 ../src/guestfs-actions.pod:324 ../src/guestfs-actions.pod:339 ../src/guestfs-actions.pod:403 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:441 ../src/guestfs-actions.pod:453 ../src/guestfs-actions.pod:534 ../src/guestfs-actions.pod:549 ../src/guestfs-actions.pod:560 ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:717 ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:824 ../src/guestfs-actions.pod:839 ../src/guestfs-actions.pod:855 ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:883 ../src/guestfs-actions.pod:916 ../src/guestfs-actions.pod:974 ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:1055 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1174 ../src/guestfs-actions.pod:1374 ../src/guestfs-actions.pod:1393 ../src/guestfs-actions.pod:1474 ../src/guestfs-actions.pod:1822 ../src/guestfs-actions.pod:1945 ../src/guestfs-actions.pod:2000 ../src/guestfs-actions.pod:2030 ../src/guestfs-actions.pod:2439 ../src/guestfs-actions.pod:2451 ../src/guestfs-actions.pod:2468 ../src/guestfs-actions.pod:2576 ../src/guestfs-actions.pod:2587 ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:2650 ../src/guestfs-actions.pod:2714 ../src/guestfs-actions.pod:2731 ../src/guestfs-actions.pod:2745 ../src/guestfs-actions.pod:2765 ../src/guestfs-actions.pod:2785 ../src/guestfs-actions.pod:2814 ../src/guestfs-actions.pod:2830 ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2858 ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2900 ../src/guestfs-actions.pod:2913 ../src/guestfs-actions.pod:2923 ../src/guestfs-actions.pod:2935 ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:3029 ../src/guestfs-actions.pod:3046 ../src/guestfs-actions.pod:3056 ../src/guestfs-actions.pod:3101 ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3131 ../src/guestfs-actions.pod:3144 ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:3166 ../src/guestfs-actions.pod:3180 ../src/guestfs-actions.pod:3192 ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3284 ../src/guestfs-actions.pod:3300 ../src/guestfs-actions.pod:3309 ../src/guestfs-actions.pod:3323 ../src/guestfs-actions.pod:3333 ../src/guestfs-actions.pod:3345 ../src/guestfs-actions.pod:3357 ../src/guestfs-actions.pod:3389 ../src/guestfs-actions.pod:3401 ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3429 ../src/guestfs-actions.pod:3443 ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3514 ../src/guestfs-actions.pod:3525 ../src/guestfs-actions.pod:3550 ../src/guestfs-actions.pod:3564 ../src/guestfs-actions.pod:3579 ../src/guestfs-actions.pod:3701 ../src/guestfs-actions.pod:3753 ../src/guestfs-actions.pod:3772 ../src/guestfs-actions.pod:3787 ../src/guestfs-actions.pod:3813 ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:3884 ../src/guestfs-actions.pod:3894 ../src/guestfs-actions.pod:3905 ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:4176 ../src/guestfs-actions.pod:4187 ../src/guestfs-actions.pod:4196 ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4216 ../src/guestfs-actions.pod:4227 ../src/guestfs-actions.pod:4240 ../src/guestfs-actions.pod:4258 ../src/guestfs-actions.pod:4274 ../src/guestfs-actions.pod:4290 ../src/guestfs-actions.pod:4305 ../src/guestfs-actions.pod:4325 ../src/guestfs-actions.pod:4340 ../src/guestfs-actions.pod:4356 ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4390 ../src/guestfs-actions.pod:4404 ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:4450 ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4487 ../src/guestfs-actions.pod:4499 ../src/guestfs-actions.pod:4511 ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4561 ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:4604 ../src/guestfs-actions.pod:4694 ../src/guestfs-actions.pod:4800 ../src/guestfs-actions.pod:4809 ../src/guestfs-actions.pod:4819 ../src/guestfs-actions.pod:4829 ../src/guestfs-actions.pod:4848 ../src/guestfs-actions.pod:4858 ../src/guestfs-actions.pod:4868 ../src/guestfs-actions.pod:4878 ../src/guestfs-actions.pod:4890 ../src/guestfs-actions.pod:4940 ../src/guestfs-actions.pod:4954 ../src/guestfs-actions.pod:4967 ../src/guestfs-actions.pod:4980 ../src/guestfs-actions.pod:4994 ../src/guestfs-actions.pod:5004 ../src/guestfs-actions.pod:5021 ../src/guestfs-actions.pod:5051 ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5097 ../src/guestfs-actions.pod:5107 ../src/guestfs-actions.pod:5122 ../src/guestfs-actions.pod:5148 ../src/guestfs-actions.pod:5176 ../src/guestfs-actions.pod:5280 ../src/guestfs-actions.pod:5295 ../src/guestfs-actions.pod:5306 ../src/guestfs-actions.pod:5352 ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5399 ../src/guestfs-actions.pod:5426 ../src/guestfs-actions.pod:5468 ../src/guestfs-actions.pod:5491 ../src/guestfs-actions.pod:5548 ../src/guestfs-actions.pod:5564 ../src/guestfs-actions.pod:5590 +#: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:56 ../src/guestfs-actions.pod:115 ../src/guestfs-actions.pod:150 ../src/guestfs-actions.pod:162 ../src/guestfs-actions.pod:181 ../src/guestfs-actions.pod:199 ../src/guestfs-actions.pod:211 ../src/guestfs-actions.pod:318 ../src/guestfs-actions.pod:336 ../src/guestfs-actions.pod:348 ../src/guestfs-actions.pod:387 ../src/guestfs-actions.pod:411 ../src/guestfs-actions.pod:427 ../src/guestfs-actions.pod:492 ../src/guestfs-actions.pod:521 ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:546 ../src/guestfs-actions.pod:633 ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:673 ../src/guestfs-actions.pod:824 ../src/guestfs-actions.pod:842 ../src/guestfs-actions.pod:858 ../src/guestfs-actions.pod:936 ../src/guestfs-actions.pod:952 ../src/guestfs-actions.pod:969 ../src/guestfs-actions.pod:981 ../src/guestfs-actions.pod:999 ../src/guestfs-actions.pod:1034 ../src/guestfs-actions.pod:1096 ../src/guestfs-actions.pod:1125 ../src/guestfs-actions.pod:1148 ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1275 ../src/guestfs-actions.pod:1307 ../src/guestfs-actions.pod:1513 ../src/guestfs-actions.pod:1533 ../src/guestfs-actions.pod:1616 ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2119 ../src/guestfs-actions.pod:2176 ../src/guestfs-actions.pod:2208 ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2711 ../src/guestfs-actions.pod:2825 ../src/guestfs-actions.pod:2837 ../src/guestfs-actions.pod:2848 ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2873 ../src/guestfs-actions.pod:2905 ../src/guestfs-actions.pod:2972 ../src/guestfs-actions.pod:2990 ../src/guestfs-actions.pod:3005 ../src/guestfs-actions.pod:3026 ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3077 ../src/guestfs-actions.pod:3094 ../src/guestfs-actions.pod:3111 ../src/guestfs-actions.pod:3142 ../src/guestfs-actions.pod:3152 ../src/guestfs-actions.pod:3186 ../src/guestfs-actions.pod:3200 ../src/guestfs-actions.pod:3211 ../src/guestfs-actions.pod:3224 ../src/guestfs-actions.pod:3239 ../src/guestfs-actions.pod:3324 ../src/guestfs-actions.pod:3342 ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3400 ../src/guestfs-actions.pod:3416 ../src/guestfs-actions.pod:3432 ../src/guestfs-actions.pod:3446 ../src/guestfs-actions.pod:3458 ../src/guestfs-actions.pod:3470 ../src/guestfs-actions.pod:3485 ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3516 ../src/guestfs-actions.pod:3563 ../src/guestfs-actions.pod:3592 ../src/guestfs-actions.pod:3609 ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:3651 ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3675 ../src/guestfs-actions.pod:3688 ../src/guestfs-actions.pod:3721 ../src/guestfs-actions.pod:3734 ../src/guestfs-actions.pod:3752 ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:3779 ../src/guestfs-actions.pod:3822 ../src/guestfs-actions.pod:3855 ../src/guestfs-actions.pod:3867 ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3908 ../src/guestfs-actions.pod:3924 ../src/guestfs-actions.pod:4050 ../src/guestfs-actions.pod:4104 ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4140 ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4228 ../src/guestfs-actions.pod:4243 ../src/guestfs-actions.pod:4254 ../src/guestfs-actions.pod:4266 ../src/guestfs-actions.pod:4533 ../src/guestfs-actions.pod:4550 ../src/guestfs-actions.pod:4562 ../src/guestfs-actions.pod:4572 ../src/guestfs-actions.pod:4584 ../src/guestfs-actions.pod:4594 ../src/guestfs-actions.pod:4606 ../src/guestfs-actions.pod:4620 ../src/guestfs-actions.pod:4639 ../src/guestfs-actions.pod:4656 ../src/guestfs-actions.pod:4673 ../src/guestfs-actions.pod:4689 ../src/guestfs-actions.pod:4710 ../src/guestfs-actions.pod:4726 ../src/guestfs-actions.pod:4743 ../src/guestfs-actions.pod:4762 ../src/guestfs-actions.pod:4779 ../src/guestfs-actions.pod:4794 ../src/guestfs-actions.pod:4820 ../src/guestfs-actions.pod:4842 ../src/guestfs-actions.pod:4859 ../src/guestfs-actions.pod:4881 ../src/guestfs-actions.pod:4894 ../src/guestfs-actions.pod:4907 ../src/guestfs-actions.pod:4924 ../src/guestfs-actions.pod:4959 ../src/guestfs-actions.pod:4980 ../src/guestfs-actions.pod:5004 ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5211 ../src/guestfs-actions.pod:5221 ../src/guestfs-actions.pod:5232 ../src/guestfs-actions.pod:5243 ../src/guestfs-actions.pod:5263 ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5285 ../src/guestfs-actions.pod:5296 ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5377 ../src/guestfs-actions.pod:5391 ../src/guestfs-actions.pod:5405 ../src/guestfs-actions.pod:5420 ../src/guestfs-actions.pod:5431 ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5481 ../src/guestfs-actions.pod:5493 ../src/guestfs-actions.pod:5530 ../src/guestfs-actions.pod:5541 ../src/guestfs-actions.pod:5557 ../src/guestfs-actions.pod:5584 ../src/guestfs-actions.pod:5613 ../src/guestfs-actions.pod:5722 ../src/guestfs-actions.pod:5738 ../src/guestfs-actions.pod:5750 ../src/guestfs-actions.pod:5799 ../src/guestfs-actions.pod:5810 ../src/guestfs-actions.pod:5850 ../src/guestfs-actions.pod:5879 ../src/guestfs-actions.pod:5925 ../src/guestfs-actions.pod:5949 ../src/guestfs-actions.pod:6009 ../src/guestfs-actions.pod:6026 ../src/guestfs-actions.pod:6053 msgid "This function returns 0 on success or -1 on error." msgstr "" +# type: textblock +#: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:164 ../src/guestfs-actions.pod:183 ../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." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:186 ../src/guestfs-actions.pod:1280 ../src/guestfs-actions.pod:1732 ../src/guestfs-actions.pod:1751 ../src/guestfs-actions.pod:5957 ../src/guestfs-actions.pod:6110 ../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 +msgid "" +"Deprecated functions will not be removed from the API, but the fact that " +"they are deprecated indicates that there are problems with correct use of " +"these functions." +msgstr "" + # type: =head2 -#: ../src/guestfs-actions.pod:31 +#: ../src/guestfs-actions.pod:39 msgid "guestfs_add_drive" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:33 +#: ../src/guestfs-actions.pod:41 +#, no-wrap +msgid "" +" int\n" +" guestfs_add_drive (guestfs_h *g,\n" +" const char *filename);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:45 +msgid "" +"This function is the equivalent of calling C with no " +"optional parameters, so the disk is added writable, with the format being " +"detected automatically." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:49 +msgid "" +"Automatic detection of the format opens you up to a potential security hole " +"when dealing with untrusted raw-format images. See CVE-2010-3851 and " +"RHBZ#642934. Specifying the format closes this security hole. Therefore " +"you should think about replacing calls to this function with calls to " +"C, and specifying the format." +msgstr "" + +# type: =head2 +#: ../src/guestfs-actions.pod:58 +msgid "guestfs_add_drive_opts" +msgstr "" + +# type: verbatim +#: ../src/guestfs-actions.pod:60 +#, no-wrap +msgid "" +" int\n" +" guestfs_add_drive_opts (guestfs_h *g,\n" +" const char *filename,\n" +" ...);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:65 +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:70 #, no-wrap msgid "" -" int guestfs_add_drive (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n" +" GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:36 ../fish/guestfish-actions.pod:36 +#: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:56 msgid "" -"This function adds a virtual machine disk image C to the guest. " -"The first time you call this function, the disk appears as IDE disk 0 " -"(C) in the guest, the second time as C, and so on." +"This function adds a virtual machine disk image C to libguestfs. " +"The first time you call this function, the disk appears as C, the " +"second time as C, and so on." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:41 ../fish/guestfish-actions.pod:41 +#: ../src/guestfs-actions.pod:79 ../fish/guestfish-actions.pod:61 msgid "" "You don't necessarily need to be root when using libguestfs. However you " "obviously do need sufficient permissions to access the filename for whatever " @@ -3570,153 +4009,216 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:47 ../fish/guestfish-actions.pod:47 +#: ../src/guestfs-actions.pod:85 ../fish/guestfish-actions.pod:67 +msgid "This call checks that C exists." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:87 ../fish/guestfish-actions.pod:69 +msgid "The optional arguments are:" +msgstr "" + +# type: =item +#: ../src/guestfs-actions.pod:91 ../fish/guestfish-actions.pod:73 +msgid "C" +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:93 ../fish/guestfish-actions.pod:75 msgid "" -"This is equivalent to the qemu parameter C<-drive " -"file=filename,cache=off,if=...>." +"If true then the image is treated as read-only. Writes are still allowed, " +"but they are stored in a temporary snapshot overlay which is discarded at " +"the end. The disk that you add is not modified." +msgstr "" + +# type: =item +#: ../src/guestfs-actions.pod:97 ../fish/guestfish-actions.pod:79 +msgid "C" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:50 ../fish/guestfish-actions.pod:50 +#: ../src/guestfs-actions.pod:99 msgid "" -"C is omitted in cases where it is not supported by the underlying " -"filesystem." +"This forces the image format. If you omit this (or use C " +"or C) then the format is automatically detected. " +"Possible formats include C and C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:53 ../src/guestfs-actions.pod:82 +#: ../src/guestfs-actions.pod:103 ../fish/guestfish-actions.pod:85 msgid "" -"C is set at compile time by the configuration option C<./configure " -"--with-drive-if=...>. In the rare case where you might need to change this " -"at run time, use C or " -"C." +"Automatic detection of the format opens you up to a potential security hole " +"when dealing with untrusted raw-format images. See CVE-2010-3851 and " +"RHBZ#642934. Specifying the format closes this security hole." +msgstr "" + +# type: =item +#: ../src/guestfs-actions.pod:108 ../fish/guestfish-actions.pod:90 +msgid "C" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:58 ../src/guestfs-actions.pod:87 +#: ../src/guestfs-actions.pod:110 msgid "" -"Note that this call checks for the existence of C. This stops you " -"from specifying other types of drive which are supported by qemu such as " -"C and C URLs. To specify those, use the general " -"C call instead." +"This rarely-used option lets you emulate the behaviour of the deprecated " +"C call (q.v.)" msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:65 -msgid "guestfs_add_drive_ro" +#: ../src/guestfs-actions.pod:117 +msgid "guestfs_add_drive_opts_va" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:67 +#: ../src/guestfs-actions.pod:119 #, no-wrap msgid "" -" int guestfs_add_drive_ro (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" int\n" +"guestfs_add_drive_opts_va (guestfs_h *g,\n" +" const char *filename,\n" +" va_list args);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:69 -msgid "This adds a drive in snapshot mode, making it effectively read-only." +#: ../src/guestfs-actions.pod:124 +msgid "This is the \"va_list variant\" of L." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:126 ../src/guestfs-actions.pod:137 +msgid "See L." +msgstr "" + +# type: =head2 +#: ../src/guestfs-actions.pod:128 +msgid "guestfs_add_drive_opts_argv" +msgstr "" + +# type: verbatim +#: ../src/guestfs-actions.pod:130 +#, no-wrap +msgid "" +" int\n" +"guestfs_add_drive_opts_argv (guestfs_h *g,\n" +" const char *filename,\n" +" const struct guestfs_add_drive_opts_argv " +"*optargs);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:73 ../fish/guestfish-actions.pod:72 +#: ../src/guestfs-actions.pod:135 +msgid "This is the \"argv variant\" of L." +msgstr "" + +# type: =head2 +#: ../src/guestfs-actions.pod:139 +msgid "guestfs_add_drive_ro" +msgstr "" + +# type: verbatim +#: ../src/guestfs-actions.pod:141 +#, no-wrap msgid "" -"Note that writes to the device are allowed, and will be seen for the " -"duration of the guestfs handle, but they are written to a temporary file " -"which is discarded as soon as the guestfs handle is closed. We don't " -"currently have any method to enable changes to be committed, although qemu " -"can support this." +" int\n" +" guestfs_add_drive_ro (guestfs_h *g,\n" +" const char *filename);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:79 ../fish/guestfish-actions.pod:78 +#: ../src/guestfs-actions.pod:145 msgid "" -"This is equivalent to the qemu parameter C<-drive " -"file=filename,snapshot=on,if=...>." +"This function is the equivalent of calling C with " +"the optional parameter C set to 1, so the " +"disk is added read-only, with the format being detected automatically." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:94 +#: ../src/guestfs-actions.pod:152 msgid "guestfs_add_drive_ro_with_if" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:96 +#: ../src/guestfs-actions.pod:154 #, no-wrap msgid "" -" int guestfs_add_drive_ro_with_if (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst char *iface);\n" +" int\n" +" guestfs_add_drive_ro_with_if (guestfs_h *g,\n" +" const char *filename,\n" +" const char *iface);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:100 +#: ../src/guestfs-actions.pod:159 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:105 +#: ../src/guestfs-actions.pod:171 msgid "guestfs_add_drive_with_if" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:107 +#: ../src/guestfs-actions.pod:173 #, no-wrap msgid "" -" int guestfs_add_drive_with_if (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst char *iface);\n" +" int\n" +" guestfs_add_drive_with_if (guestfs_h *g,\n" +" const char *filename,\n" +" const char *iface);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:111 +#: ../src/guestfs-actions.pod:178 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:116 +#: ../src/guestfs-actions.pod:190 msgid "guestfs_aug_clear" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:118 +#: ../src/guestfs-actions.pod:192 #, no-wrap msgid "" -" int guestfs_aug_clear (guestfs_h *g,\n" -"\t\tconst char *augpath);\n" +" int\n" +" guestfs_aug_clear (guestfs_h *g,\n" +" const char *augpath);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:121 ../fish/guestfish-actions.pod:109 +#: ../src/guestfs-actions.pod:196 ../fish/guestfish-actions.pod:142 msgid "" "Set the value associated with C to C. This is the same as the " "L C command." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:126 +#: ../src/guestfs-actions.pod:201 msgid "guestfs_aug_close" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:128 +#: ../src/guestfs-actions.pod:203 #, no-wrap msgid "" -" int guestfs_aug_close (guestfs_h *g);\n" +" int\n" +" guestfs_aug_close (guestfs_h *g);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:130 +#: ../src/guestfs-actions.pod:206 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 " @@ -3724,28 +4226,29 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:137 +#: ../src/guestfs-actions.pod:213 msgid "guestfs_aug_defnode" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:139 +#: ../src/guestfs-actions.pod:215 #, no-wrap msgid "" -" struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *g,\n" -"\t\tconst char *name,\n" -"\t\tconst char *expr,\n" -"\t\tconst char *val);\n" +" struct guestfs_int_bool *\n" +" guestfs_aug_defnode (guestfs_h *g,\n" +" const char *name,\n" +" const char *expr,\n" +" const char *val);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:144 ../fish/guestfish-actions.pod:125 +#: ../src/guestfs-actions.pod:221 ../fish/guestfish-actions.pod:158 msgid "Defines a variable C whose value is the result of evaluating C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:147 +#: ../src/guestfs-actions.pod:224 msgid "" "If C evaluates to an empty nodeset, a node is created, equivalent to " "calling C C, C. C will be the nodeset " @@ -3753,98 +4256,101 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:132 +#: ../src/guestfs-actions.pod:228 ../fish/guestfish-actions.pod:165 msgid "" "On success this returns a pair containing the number of nodes in the " "nodeset, and a boolean flag if a node was created." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:155 +#: ../src/guestfs-actions.pod:232 msgid "" "This function returns a C, or NULL if there was " "an error. I after use>." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:159 +#: ../src/guestfs-actions.pod:236 msgid "guestfs_aug_defvar" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:161 +#: ../src/guestfs-actions.pod:238 #, no-wrap msgid "" -" int guestfs_aug_defvar (guestfs_h *g,\n" -"\t\tconst char *name,\n" -"\t\tconst char *expr);\n" +" int\n" +" guestfs_aug_defvar (guestfs_h *g,\n" +" const char *name,\n" +" const char *expr);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:140 +#: ../src/guestfs-actions.pod:243 ../fish/guestfish-actions.pod:173 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:169 ../fish/guestfish-actions.pod:144 +#: ../src/guestfs-actions.pod:247 ../fish/guestfish-actions.pod:177 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:172 ../src/guestfs-actions.pod:313 ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:492 ../src/guestfs-actions.pod:507 ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:1041 ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1538 ../src/guestfs-actions.pod:1619 ../src/guestfs-actions.pod:1650 ../src/guestfs-actions.pod:1693 ../src/guestfs-actions.pod:1710 ../src/guestfs-actions.pod:1935 ../src/guestfs-actions.pod:2147 ../src/guestfs-actions.pod:2165 ../src/guestfs-actions.pod:3503 ../src/guestfs-actions.pod:3610 ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:3987 ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5436 ../src/guestfs-actions.pod:5446 ../src/guestfs-actions.pod:5456 +#: ../src/guestfs-actions.pod:250 ../src/guestfs-actions.pod:399 ../src/guestfs-actions.pod:561 ../src/guestfs-actions.pod:588 ../src/guestfs-actions.pod:604 ../src/guestfs-actions.pod:621 ../src/guestfs-actions.pod:1166 ../src/guestfs-actions.pod:1494 ../src/guestfs-actions.pod:1683 ../src/guestfs-actions.pod:1770 ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:1851 ../src/guestfs-actions.pod:1870 ../src/guestfs-actions.pod:2108 ../src/guestfs-actions.pod:2349 ../src/guestfs-actions.pod:2368 ../src/guestfs-actions.pod:3843 ../src/guestfs-actions.pod:3957 ../src/guestfs-actions.pod:4329 ../src/guestfs-actions.pod:4353 ../src/guestfs-actions.pod:5518 ../src/guestfs-actions.pod:5890 ../src/guestfs-actions.pod:5901 ../src/guestfs-actions.pod:5912 msgid "On error this function returns -1." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:174 +#: ../src/guestfs-actions.pod:252 msgid "guestfs_aug_get" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:176 +#: ../src/guestfs-actions.pod:254 #, no-wrap msgid "" -" char *guestfs_aug_get (guestfs_h *g,\n" -"\t\tconst char *augpath);\n" +" char *\n" +" guestfs_aug_get (guestfs_h *g,\n" +" const char *augpath);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:151 +#: ../src/guestfs-actions.pod:258 ../fish/guestfish-actions.pod:184 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:182 ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:695 ../src/guestfs-actions.pod:786 ../src/guestfs-actions.pod:899 ../src/guestfs-actions.pod:928 ../src/guestfs-actions.pod:942 ../src/guestfs-actions.pod:958 ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:1487 ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1577 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1729 ../src/guestfs-actions.pod:1868 ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:2099 ../src/guestfs-actions.pod:2215 ../src/guestfs-actions.pod:2250 ../src/guestfs-actions.pod:2565 ../src/guestfs-actions.pod:2986 ../src/guestfs-actions.pod:3082 ../src/guestfs-actions.pod:3625 ../src/guestfs-actions.pod:3801 ../src/guestfs-actions.pod:3942 ../src/guestfs-actions.pod:4103 ../src/guestfs-actions.pod:4146 ../src/guestfs-actions.pod:4622 ../src/guestfs-actions.pod:4635 ../src/guestfs-actions.pod:4649 ../src/guestfs-actions.pod:4670 ../src/guestfs-actions.pod:5229 ../src/guestfs-actions.pod:5245 ../src/guestfs-actions.pod:5260 ../src/guestfs-actions.pod:5408 ../src/guestfs-actions.pod:5638 +#: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:713 ../src/guestfs-actions.pod:729 ../src/guestfs-actions.pod:787 ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:896 ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1047 ../src/guestfs-actions.pod:1062 ../src/guestfs-actions.pod:1079 ../src/guestfs-actions.pod:1196 ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1479 ../src/guestfs-actions.pod:1630 ../src/guestfs-actions.pod:1645 ../src/guestfs-actions.pod:1726 ../src/guestfs-actions.pod:1745 ../src/guestfs-actions.pod:1891 ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:2228 ../src/guestfs-actions.pod:2299 ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2456 ../src/guestfs-actions.pod:2477 ../src/guestfs-actions.pod:2813 ../src/guestfs-actions.pod:3128 ../src/guestfs-actions.pod:3279 ../src/guestfs-actions.pod:3380 ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4155 ../src/guestfs-actions.pod:4306 ../src/guestfs-actions.pod:4473 ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:5023 ../src/guestfs-actions.pod:5037 ../src/guestfs-actions.pod:5052 ../src/guestfs-actions.pod:5074 ../src/guestfs-actions.pod:5668 ../src/guestfs-actions.pod:5685 ../src/guestfs-actions.pod:5701 ../src/guestfs-actions.pod:5860 ../src/guestfs-actions.pod:6104 msgid "" "This function returns a string, or NULL on error. I." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:185 +#: ../src/guestfs-actions.pod:264 msgid "guestfs_aug_init" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:187 +#: ../src/guestfs-actions.pod:266 #, no-wrap msgid "" -" int guestfs_aug_init (guestfs_h *g,\n" -"\t\tconst char *root,\n" -"\t\tint flags);\n" +" int\n" +" guestfs_aug_init (guestfs_h *g,\n" +" const char *root,\n" +" int flags);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:191 ../fish/guestfish-actions.pod:158 +#: ../src/guestfs-actions.pod:271 ../fish/guestfish-actions.pod:191 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 " @@ -3852,170 +4358,173 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:195 +#: ../src/guestfs-actions.pod:275 msgid "You must call this before using any other C commands." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:198 ../fish/guestfish-actions.pod:165 +#: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:198 msgid "C is the filesystem root. C must not be NULL, use C instead." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:201 ../fish/guestfish-actions.pod:168 +#: ../src/guestfs-actions.pod:281 ../fish/guestfish-actions.pod:201 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:207 ../fish/guestfish-actions.pod:174 +#: ../src/guestfs-actions.pod:287 ../fish/guestfish-actions.pod:207 msgid "C = 1" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:209 ../fish/guestfish-actions.pod:176 +#: ../src/guestfs-actions.pod:289 ../fish/guestfish-actions.pod:209 msgid "Keep the original file with a C<.augsave> extension." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:211 ../fish/guestfish-actions.pod:178 +#: ../src/guestfs-actions.pod:291 ../fish/guestfish-actions.pod:211 msgid "C = 2" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:213 ../fish/guestfish-actions.pod:180 +#: ../src/guestfs-actions.pod:293 ../fish/guestfish-actions.pod:213 msgid "" "Save changes into a file with extension C<.augnew>, and do not overwrite " "original. Overrides C." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:216 ../fish/guestfish-actions.pod:183 +#: ../src/guestfs-actions.pod:296 ../fish/guestfish-actions.pod:216 msgid "C = 4" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:218 ../fish/guestfish-actions.pod:185 +#: ../src/guestfs-actions.pod:298 ../fish/guestfish-actions.pod:218 msgid "Typecheck lenses (can be expensive)." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:220 ../fish/guestfish-actions.pod:187 +#: ../src/guestfs-actions.pod:300 ../fish/guestfish-actions.pod:220 msgid "C = 8" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:222 ../fish/guestfish-actions.pod:189 +#: ../src/guestfs-actions.pod:302 ../fish/guestfish-actions.pod:222 msgid "Do not use standard load path for modules." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:224 ../fish/guestfish-actions.pod:191 +#: ../src/guestfs-actions.pod:304 ../fish/guestfish-actions.pod:224 msgid "C = 16" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:226 ../fish/guestfish-actions.pod:193 +#: ../src/guestfs-actions.pod:306 ../fish/guestfish-actions.pod:226 msgid "Make save a no-op, just record what would have been changed." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:228 ../fish/guestfish-actions.pod:195 +#: ../src/guestfs-actions.pod:308 ../fish/guestfish-actions.pod:228 msgid "C = 32" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:230 +#: ../src/guestfs-actions.pod:310 msgid "Do not load the tree in C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:234 +#: ../src/guestfs-actions.pod:314 msgid "To close the handle, you can call C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:236 ../fish/guestfish-actions.pod:203 +#: ../src/guestfs-actions.pod:316 ../fish/guestfish-actions.pod:236 msgid "To find out more about Augeas, see L." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:240 +#: ../src/guestfs-actions.pod:320 msgid "guestfs_aug_insert" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:242 +#: ../src/guestfs-actions.pod:322 #, no-wrap msgid "" -" int guestfs_aug_insert (guestfs_h *g,\n" -"\t\tconst char *augpath,\n" -"\t\tconst char *label,\n" -"\t\tint before);\n" +" int\n" +" guestfs_aug_insert (guestfs_h *g,\n" +" const char *augpath,\n" +" const char *label,\n" +" int before);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:247 ../fish/guestfish-actions.pod:209 +#: ../src/guestfs-actions.pod:328 ../fish/guestfish-actions.pod:242 msgid "" "Create a new sibling C