X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=po-docs%2Flibguestfs-docs.pot;h=105529eb4fa97a15cce37bfced80a7e141829cb8;hp=aec69aaf4959fe5470b74e2861a3f72ebdbe63a5;hb=a2591230c12efad4a6ad843d9b8991e44fecabb2;hpb=c51ade2e85b1e0b4d6f8537cc2bfe671023cd8b1 diff --git a/po-docs/libguestfs-docs.pot b/po-docs/libguestfs-docs.pot index aec69aa..105529e 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.9\n" +"Project-Id-Version: libguestfs 1.7.0\n" "Report-Msgid-Bugs-To: libguestfs@redhat.com\n" -"POT-Creation-Date: 2010-09-08 11:40+0200\n" +"POT-Creation-Date: 2010-11-02 16:23+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-cat.pl:30 ../tools/virt-df.pl:32 ../tools/virt-edit.pl:31 ../tools/virt-list-filesystems.pl:28 ../tools/virt-list-partitions.pl:28 ../tools/virt-ls.pl:31 ../tools/virt-make-fs.pl:33 ../tools/virt-rescue.pl:29 ../tools/virt-resize.pl:38 ../tools/virt-tar.pl:30 ../tools/virt-win-reg.pl:34 +#: ../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-cat.pl:32 ../tools/virt-df.pl:34 ../tools/virt-edit.pl:33 ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30 ../tools/virt-ls.pl:33 ../tools/virt-make-fs.pl:35 ../tools/virt-rescue.pl:31 ../tools/virt-resize.pl:40 ../tools/virt-tar.pl:32 ../tools/virt-win-reg.pl:36 +#: ../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-cat.pl:36 ../tools/virt-df.pl:38 ../tools/virt-edit.pl:37 ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34 ../tools/virt-ls.pl:37 ../tools/virt-make-fs.pl:39 ../tools/virt-rescue.pl:35 ../tools/virt-resize.pl:44 ../tools/virt-tar.pl:36 ../tools/virt-win-reg.pl:40 +#: ../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:115 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:16 ../inspector/virt-inspector.pl:48 ../tools/virt-cat.pl:42 ../tools/virt-df.pl:46 ../tools/virt-edit.pl:51 ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40 ../tools/virt-ls.pl:43 ../tools/virt-make-fs.pl:47 ../tools/virt-rescue.pl:51 ../tools/virt-resize.pl:50 ../tools/virt-tar.pl:73 ../tools/virt-win-reg.pl:64 +#: ../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,99 +728,120 @@ 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 a primarily an API for manipulating files inside " -"guest images, we also provide some limited facilities for running commands " -"inside guests." +"Although libguestfs is primarily an API for manipulating files inside guest " +"images, we also provide some limited facilities for running commands inside " +"guests." msgstr "" # type: textblock -#: ../src/guestfs.pod: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:1226 ../src/guestfs.pod:1231 ../src/guestfs.pod:1235 ../src/guestfs.pod:1337 ../src/guestfs.pod:1341 ../src/guestfs.pod:1345 ../src/guestfs.pod:1350 ../src/guestfs.pod:1358 ../src/guestfs.pod:1377 ../src/guestfs.pod:1385 ../src/guestfs.pod:1599 ../src/guestfs.pod:1605 ../src/guestfs.pod:1610 ../src/guestfs.pod:1616 ../src/guestfs.pod:1723 ../src/guestfs.pod:1727 ../src/guestfs.pod:1731 ../src/guestfs.pod:1735 ../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:1257 ../src/guestfs-actions.pod:1261 ../src/guestfs-actions.pod:1265 ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:1281 ../src/guestfs-actions.pod:1285 ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1299 ../src/guestfs-actions.pod:1303 ../src/guestfs-actions.pod:1426 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1440 ../src/guestfs-actions.pod:1492 ../src/guestfs-actions.pod:1496 ../src/guestfs-actions.pod:1501 ../fish/guestfish.pod:309 ../fish/guestfish.pod:313 ../fish/guestfish.pod:317 ../fish/guestfish.pod:321 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:300 ../fish/guestfish-actions.pod:308 ../fish/guestfish-actions.pod:315 ../fish/guestfish-actions.pod:322 ../fish/guestfish-actions.pod:998 ../fish/guestfish-actions.pod:1002 ../fish/guestfish-actions.pod:1006 ../fish/guestfish-actions.pod:1010 ../fish/guestfish-actions.pod:1018 ../fish/guestfish-actions.pod:1022 ../fish/guestfish-actions.pod:1026 ../fish/guestfish-actions.pod:1036 ../fish/guestfish-actions.pod:1040 ../fish/guestfish-actions.pod:1044 ../fish/guestfish-actions.pod:1134 ../fish/guestfish-actions.pod:1138 ../fish/guestfish-actions.pod:1143 ../fish/guestfish-actions.pod:1148 ../fish/guestfish-actions.pod:1190 ../fish/guestfish-actions.pod:1194 ../fish/guestfish-actions.pod:1199 ../tools/virt-resize.pl:324 ../tools/virt-resize.pl:329 ../tools/virt-resize.pl:339 +#: ../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:1159 ../src/guestfs.pod:1164 ../src/guestfs.pod:1168 ../src/guestfs.pod:1384 ../src/guestfs.pod:1389 ../src/guestfs.pod:1393 ../src/guestfs.pod:1495 ../src/guestfs.pod:1499 ../src/guestfs.pod:1503 ../src/guestfs.pod:1508 ../src/guestfs.pod:1516 ../src/guestfs.pod:1535 ../src/guestfs.pod:1543 ../src/guestfs.pod:1773 ../src/guestfs.pod:1779 ../src/guestfs.pod:1784 ../src/guestfs.pod:1790 ../src/guestfs.pod:1897 ../src/guestfs.pod:1901 ../src/guestfs.pod:1905 ../src/guestfs.pod:1909 ../src/guestfs-actions.pod:14 ../src/guestfs-actions.pod:21 ../src/guestfs-actions.pod:438 ../src/guestfs-actions.pod:446 ../src/guestfs-actions.pod:453 ../src/guestfs-actions.pod:460 ../src/guestfs-actions.pod:1351 ../src/guestfs-actions.pod:1355 ../src/guestfs-actions.pod:1359 ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1371 ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1389 ../src/guestfs-actions.pod:1393 ../src/guestfs-actions.pod:1397 ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1524 ../src/guestfs-actions.pod:1529 ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1586 ../src/guestfs-actions.pod:1590 ../src/guestfs-actions.pod:1595 ../fish/guestfish.pod:364 ../fish/guestfish.pod:368 ../fish/guestfish.pod:372 ../fish/guestfish.pod:376 ../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 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 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 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:559 +#: ../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,19 +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 +#: ../src/guestfs.pod:773 msgid "Library should return errno with error messages." msgstr "" # type: textblock -#: ../src/guestfs.pod:741 +#: ../src/guestfs.pod:775 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 " @@ -1501,19 +1563,82 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:747 +#: ../src/guestfs.pod:781 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:784 +msgid "Ambiguity between devices and paths" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:786 +msgid "" +"There is a subtle ambiguity in the API between a device name " +"(eg. C) and a similar pathname. A file might just happen to be " +"called C in the directory C (consider some non-Unix VM image)." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:791 +msgid "" +"In the current API we usually resolve this ambiguity by having two separate " +"calls, for example L and L. " +"Some API calls are ambiguous and (incorrectly) resolve the problem by " +"detecting if the path supplied begins with C." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:797 +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 " +"use a notation like grub (C), although nobody really likes this " +"aspect of grub. Another way would be to use a structured type, equivalent " +"to this OCaml type:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:803 +#, no-wrap +msgid "" +" type path = Path of string | Device of int | Partition of int * int\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:805 +msgid "which would allow you to pass arguments like:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:807 +#, no-wrap +msgid "" +" Path \"/foo/bar\"\n" +" Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n" +" Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n" +" Path \"/dev/sdb2\" (* not a device *)\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:812 +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:752 +#: ../src/guestfs.pod:817 msgid "PROTOCOL LIMITS" msgstr "" # type: textblock -#: ../src/guestfs.pod:754 +#: ../src/guestfs.pod:819 msgid "" "Internally libguestfs uses a message-based protocol to pass API calls and " "their responses to and from a small \"appliance\" (see L for " @@ -1524,7 +1649,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:762 +#: ../src/guestfs.pod:827 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 " @@ -1533,7 +1658,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:768 +#: ../src/guestfs.pod:833 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 " @@ -1541,26 +1666,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:772 +#: ../src/guestfs.pod:837 msgid "" "You might also consider mounting the disk image using our FUSE filesystem " "support (L)." msgstr "" # type: =head2 -#: ../src/guestfs.pod:775 +#: ../src/guestfs.pod:840 msgid "KEYS AND PASSPHRASES" msgstr "" # type: textblock -#: ../src/guestfs.pod:777 +#: ../src/guestfs.pod:842 msgid "" "Certain libguestfs calls take a parameter that contains sensitive key " "material, passed in as a C string." msgstr "" # type: textblock -#: ../src/guestfs.pod:780 +#: ../src/guestfs.pod:845 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 " @@ -1569,7 +1694,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:785 +#: ../src/guestfs.pod:850 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, " @@ -1577,17 +1702,17 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:790 +#: ../src/guestfs.pod:855 msgid "CONNECTION MANAGEMENT" msgstr "" # type: =head2 -#: ../src/guestfs.pod:792 +#: ../src/guestfs.pod:857 msgid "guestfs_h *" msgstr "" # type: textblock -#: ../src/guestfs.pod:794 +#: ../src/guestfs.pod:859 msgid "" "C is the opaque type representing a connection handle. Create a " "handle by calling L. Call L to free the " @@ -1595,19 +1720,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:798 +#: ../src/guestfs.pod:863 msgid "" "For information on using multiple handles and threads, see the section " "L below." msgstr "" # type: =head2 -#: ../src/guestfs.pod:801 +#: ../src/guestfs.pod:866 msgid "guestfs_create" msgstr "" # type: verbatim -#: ../src/guestfs.pod:803 +#: ../src/guestfs.pod:868 #, no-wrap msgid "" " guestfs_h *guestfs_create (void);\n" @@ -1615,41 +1740,43 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:805 +#: ../src/guestfs.pod:870 msgid "Create a connection handle." msgstr "" # type: textblock -#: ../src/guestfs.pod:807 -msgid "You have to call L on the handle at least once." +#: ../src/guestfs.pod:872 +msgid "" +"You have to call L (or one of the equivalent calls) " +"on the handle at least once." msgstr "" # type: textblock -#: ../src/guestfs.pod:809 +#: ../src/guestfs.pod:875 msgid "" "This function returns a non-NULL pointer to a handle on success or NULL on " "error." msgstr "" # type: textblock -#: ../src/guestfs.pod:812 +#: ../src/guestfs.pod:878 msgid "After configuring the handle, you have to call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:814 +#: ../src/guestfs.pod:880 msgid "" "You may also want to configure error handling for the handle. See L section below." msgstr "" # type: =head2 -#: ../src/guestfs.pod:817 +#: ../src/guestfs.pod:883 msgid "guestfs_close" msgstr "" # type: verbatim -#: ../src/guestfs.pod:819 +#: ../src/guestfs.pod:885 #, no-wrap msgid "" " void guestfs_close (guestfs_h *g);\n" @@ -1657,17 +1784,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:821 +#: ../src/guestfs.pod:887 msgid "This closes the connection handle and frees up all resources used." msgstr "" # type: =head1 -#: ../src/guestfs.pod:823 +#: ../src/guestfs.pod:889 msgid "ERROR HANDLING" msgstr "" # type: textblock -#: ../src/guestfs.pod:825 +#: ../src/guestfs.pod:891 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 " @@ -1676,12 +1803,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:830 +#: ../src/guestfs.pod:896 msgid "The default error handler prints the information string to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:832 +#: ../src/guestfs.pod:898 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 " @@ -1689,12 +1816,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:836 +#: ../src/guestfs.pod:902 msgid "guestfs_last_error" msgstr "" # type: verbatim -#: ../src/guestfs.pod:838 +#: ../src/guestfs.pod:904 #, no-wrap msgid "" " const char *guestfs_last_error (guestfs_h *g);\n" @@ -1702,21 +1829,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:840 +#: ../src/guestfs.pod:906 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:844 +#: ../src/guestfs.pod:910 msgid "" "The lifetime of the returned string is until the next error occurs, or " "L is called." msgstr "" # type: textblock -#: ../src/guestfs.pod:847 +#: ../src/guestfs.pod:913 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 " @@ -1724,12 +1851,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:851 +#: ../src/guestfs.pod:917 msgid "guestfs_set_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:853 +#: ../src/guestfs.pod:919 #, no-wrap msgid "" " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" @@ -1742,7 +1869,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:860 +#: ../src/guestfs.pod:926 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 " @@ -1750,7 +1877,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:864 +#: ../src/guestfs.pod:930 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 " @@ -1758,22 +1885,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:868 +#: ../src/guestfs.pod:934 msgid "The default handler prints messages on C." msgstr "" # type: textblock -#: ../src/guestfs.pod:870 +#: ../src/guestfs.pod:936 msgid "If you set C to C then I handler is called." msgstr "" # type: =head2 -#: ../src/guestfs.pod:872 +#: ../src/guestfs.pod:938 msgid "guestfs_get_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:874 +#: ../src/guestfs.pod:940 #, no-wrap msgid "" " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" @@ -1782,17 +1909,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:877 +#: ../src/guestfs.pod:943 msgid "Returns the current error handler callback." msgstr "" # type: =head2 -#: ../src/guestfs.pod:879 +#: ../src/guestfs.pod:945 msgid "guestfs_set_out_of_memory_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:881 +#: ../src/guestfs.pod:947 #, no-wrap msgid "" " typedef void (*guestfs_abort_cb) (void);\n" @@ -1802,29 +1929,29 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:885 +#: ../src/guestfs.pod:951 msgid "" "The callback C will be called if there is an out of memory situation. " "I." msgstr "" # type: textblock -#: ../src/guestfs.pod:888 +#: ../src/guestfs.pod:954 msgid "The default is to call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:890 +#: ../src/guestfs.pod:956 msgid "You cannot set C to C. You can't ignore out of memory situations." msgstr "" # type: =head2 -#: ../src/guestfs.pod:893 +#: ../src/guestfs.pod:959 msgid "guestfs_get_out_of_memory_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:895 +#: ../src/guestfs.pod:961 #, no-wrap msgid "" " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" @@ -1832,31 +1959,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:897 +#: ../src/guestfs.pod:963 msgid "This returns the current out of memory handler." msgstr "" # type: =head1 -#: ../src/guestfs.pod:899 +#: ../src/guestfs.pod:965 msgid "PATH" msgstr "" # type: textblock -#: ../src/guestfs.pod:901 +#: ../src/guestfs.pod:967 msgid "" "Libguestfs needs a kernel and initrd.img, which it finds by looking along an " "internal path." msgstr "" # type: textblock -#: ../src/guestfs.pod:904 +#: ../src/guestfs.pod:970 msgid "" "By default it looks for these in the directory C<$libdir/guestfs> " "(eg. C or C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:907 +#: ../src/guestfs.pod:973 msgid "" "Use L or set the environment variable L " "to change the directories that libguestfs will search in. The value is a " @@ -1867,17 +1994,17 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:914 +#: ../src/guestfs.pod:980 msgid "HIGH-LEVEL API ACTIONS" msgstr "" # type: =head2 -#: ../src/guestfs.pod:916 +#: ../src/guestfs.pod:982 msgid "ABI GUARANTEE" msgstr "" # type: textblock -#: ../src/guestfs.pod:918 +#: ../src/guestfs.pod:984 msgid "" "We guarantee the libguestfs ABI (binary interface), for public, high-level " "actions as outlined in this section. Although we will deprecate some " @@ -1887,32 +2014,32 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:924 ../fish/guestfish.pod:898 +#: ../src/guestfs.pod:990 ../fish/guestfish.pod:860 msgid "@ACTIONS@" msgstr "" # type: =head1 -#: ../src/guestfs.pod:926 +#: ../src/guestfs.pod:992 msgid "STRUCTURES" msgstr "" # type: textblock -#: ../src/guestfs.pod:928 +#: ../src/guestfs.pod:994 msgid "@STRUCTS@" msgstr "" # type: =head1 -#: ../src/guestfs.pod:930 +#: ../src/guestfs.pod:996 msgid "AVAILABILITY" msgstr "" # type: =head2 -#: ../src/guestfs.pod:932 +#: ../src/guestfs.pod:998 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" msgstr "" # type: textblock -#: ../src/guestfs.pod:934 +#: ../src/guestfs.pod:1000 msgid "" "Using L you can test availability of the following " "groups of functions. This test queries the appliance to see if the " @@ -1920,17 +2047,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:939 +#: ../src/guestfs.pod:1005 msgid "@AVAILABILITY@" msgstr "" # type: =head2 -#: ../src/guestfs.pod:941 +#: ../src/guestfs.pod:1007 msgid "GUESTFISH supported COMMAND" msgstr "" # type: textblock -#: ../src/guestfs.pod:943 +#: ../src/guestfs.pod:1009 msgid "" "In L there is a handy interactive command C which " "prints out the available groups and whether they are supported by this build " @@ -1938,19 +2065,19 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:948 +#: ../src/guestfs.pod:1014 msgid "SINGLE CALLS AT COMPILE TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:950 +#: ../src/guestfs.pod:1016 msgid "" "Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " "function, such as:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:953 +#: ../src/guestfs.pod:1019 #, no-wrap msgid "" " #define LIBGUESTFS_HAVE_DD 1\n" @@ -1958,12 +2085,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:955 +#: ../src/guestfs.pod:1021 msgid "if L is available." msgstr "" # type: textblock -#: ../src/guestfs.pod:957 +#: ../src/guestfs.pod:1023 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 " @@ -1971,7 +2098,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:962 +#: ../src/guestfs.pod:1028 #, no-wrap msgid "" " AC_CHECK_LIB([guestfs],[guestfs_create])\n" @@ -1980,19 +2107,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:965 +#: ../src/guestfs.pod:1031 msgid "" "which would result in C being either defined or not defined " "in your program." msgstr "" # type: =head2 -#: ../src/guestfs.pod:968 +#: ../src/guestfs.pod:1034 msgid "SINGLE CALLS AT RUN TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:970 +#: ../src/guestfs.pod:1036 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 " @@ -2002,7 +2129,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:977 +#: ../src/guestfs.pod:1043 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 " @@ -2010,7 +2137,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:981 +#: ../src/guestfs.pod:1047 #, no-wrap msgid "" " #include \n" @@ -2022,7 +2149,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:987 +#: ../src/guestfs.pod:1053 #, no-wrap msgid "" " main ()\n" @@ -2034,7 +2161,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:993 +#: ../src/guestfs.pod:1059 #, no-wrap msgid "" " /* Test if the function guestfs_dd is really available. */\n" @@ -2049,7 +2176,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1002 +#: ../src/guestfs.pod:1068 #, no-wrap msgid "" " if (!has_function)\n" @@ -2068,7 +2195,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1015 +#: ../src/guestfs.pod:1081 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 " @@ -2076,75 +2203,267 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1020 +#: ../src/guestfs.pod:1086 #, no-wrap msgid "" " Requires: libguestfs >= 1.0.80\n" "\n" msgstr "" -# type: =end -#: ../src/guestfs.pod:1022 ../src/guestfs.pod:1027 -msgid "html" +# type: =head1 +#: ../src/guestfs.pod:1088 +msgid "CALLS WITH OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1024 +#: ../src/guestfs.pod:1090 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: =head1 -#: ../src/guestfs.pod:1029 -msgid "ARCHITECTURE" +# type: verbatim +#: ../src/guestfs.pod:1095 +#, no-wrap +msgid "" +" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1031 +#: ../src/guestfs.pod:1097 msgid "" -"Internally, libguestfs is implemented by running an appliance (a special " -"type of small virtual machine) using L. Qemu runs as a child " -"process of the main program." +"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:1035 +#: ../src/guestfs.pod:1100 #, no-wrap msgid "" -" ___________________\n" -" / \\\n" -" | main program |\n" -" | |\n" -" | | child process / appliance\n" -" | | __________________________\n" -" | | / qemu \\\n" -" +-------------------+ RPC | +-----------------+ |\n" -" | libguestfs <--------------------> guestfsd | |\n" -" | | | +-----------------+ |\n" -" \\___________________/ | | Linux kernel | |\n" -" | +--^--------------+ |\n" -" \\_________|________________/\n" -" |\n" -" _______v______\n" -" / \\\n" -" | Device or |\n" -" | disk image |\n" -" \\______________/\n" +" guestfs_add_drive_opts (g, filename, -1);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1055 +#: ../src/guestfs.pod:1102 +msgid "With a single optional argument:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1104 +#, no-wrap msgid "" -"The library, linked to the main program, creates the child process and hence " -"the appliance in the L function." +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" +" -1);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1058 +#: ../src/guestfs.pod:1108 +msgid "With two:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1110 +#, no-wrap msgid "" -"Inside the appliance is a Linux kernel and a complete stack of userspace " +" 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:1115 +msgid "" +"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " +"happen!" +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1118 +msgid "USING va_list FOR OPTIONAL ARGUMENTS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1120 +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:1124 +#, 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:1127 +msgid "CONSTRUCTING OPTIONAL ARGUMENTS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1129 +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:1135 +#, 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:1144 +msgid "You could call it like this:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1146 +#, 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:1153 +#, no-wrap +msgid "" +" guestfs_add_drive_opts_argv (g, filename, &optargs);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1155 ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1244 +msgid "Notes:" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1161 +msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1166 +msgid "You do not need to fill in all fields of the structure." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1170 +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:1175 +msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1177 +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:1181 +msgid "For guestfish, see L." +msgstr "" + +# type: =end +#: ../src/guestfs.pod:1183 ../src/guestfs.pod:1188 +msgid "html" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1185 +msgid "" +" " +msgstr "" + +# type: =head1 +#: ../src/guestfs.pod:1190 +msgid "ARCHITECTURE" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1192 +msgid "" +"Internally, libguestfs is implemented by running an appliance (a special " +"type of small virtual machine) using L. Qemu runs as a child " +"process of the main program." +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1196 +#, no-wrap +msgid "" +" ___________________\n" +" / \\\n" +" | main program |\n" +" | |\n" +" | | child process / appliance\n" +" | | __________________________\n" +" | | / qemu \\\n" +" +-------------------+ RPC | +-----------------+ |\n" +" | libguestfs <--------------------> guestfsd | |\n" +" | | | +-----------------+ |\n" +" \\___________________/ | | Linux kernel | |\n" +" | +--^--------------+ |\n" +" \\_________|________________/\n" +" |\n" +" _______v______\n" +" / \\\n" +" | Device or |\n" +" | disk image |\n" +" \\______________/\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1216 +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:1219 +msgid "" +"Inside the appliance is a Linux kernel and a complete stack of userspace " "tools (such as LVM and ext2 programs) and a small controlling daemon called " "L. The library talks to L using remote procedure " "calls (RPC). There is a mostly one-to-one correspondence between libguestfs " @@ -2154,7 +2473,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1067 +#: ../src/guestfs.pod:1228 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 " @@ -2165,17 +2484,17 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1074 +#: ../src/guestfs.pod:1235 msgid "STATE MACHINE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1076 +#: ../src/guestfs.pod:1237 msgid "libguestfs uses a state machine to model the child process:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1078 +#: ../src/guestfs.pod:1239 #, no-wrap msgid "" " |\n" @@ -2203,7 +2522,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1100 +#: ../src/guestfs.pod:1261 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), " @@ -2212,7 +2531,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1105 +#: ../src/guestfs.pod:1266 msgid "" "The guest may be killed by L, or may die " "asynchronously at any time (eg. due to some internal error), and that causes " @@ -2220,62 +2539,60 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1109 +#: ../src/guestfs.pod:1270 msgid "" "Configuration commands for qemu such as L can only be " "issued when in the CONFIG state." msgstr "" # type: textblock -#: ../src/guestfs.pod:1112 +#: ../src/guestfs.pod:1273 msgid "" -"The high-level API offers two calls that go from CONFIG through LAUNCHING to " -"READY. L blocks until the child process is READY to accept " +"The API offers one call that goes from CONFIG through LAUNCHING to READY. " +"L blocks until the child process is READY to accept " "commands (or until some failure or timeout). L internally " "moves the state from CONFIG to LAUNCHING while it is running." msgstr "" # type: textblock -#: ../src/guestfs.pod:1118 +#: ../src/guestfs.pod:1279 msgid "" -"High-level API actions such as L can only be issued when in " -"the READY state. These high-level API calls block waiting for the command " -"to be carried out (ie. the state to transition to BUSY and then back to " -"READY). But using the low-level event API, you get non-blocking versions. " -"(But you can still only carry out one operation per handle at a time - that " -"is a limitation of the communications protocol we use)." +"API actions such as L can only be issued when in the READY " +"state. These API calls block waiting for the command to be carried out " +"(ie. the state to transition to BUSY and then back to READY). There are no " +"non-blocking versions, and no way to issue more than one command per handle " +"at the same time." msgstr "" # type: textblock -#: ../src/guestfs.pod:1126 +#: ../src/guestfs.pod:1285 msgid "" "Finally, the child process sends asynchronous messages back to the main " -"program, such as kernel log messages. Mostly these are ignored by the " -"high-level API, but using the low-level event API you can register to " +"program, such as kernel log messages. You can register a callback to " "receive these messages." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1131 +#: ../src/guestfs.pod:1289 msgid "SETTING CALLBACKS TO HANDLE EVENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1133 +#: ../src/guestfs.pod:1291 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:1136 +#: ../src/guestfs.pod:1294 msgid "" "Use the C functions to set a callback for different " "types of events." msgstr "" # type: textblock -#: ../src/guestfs.pod:1139 +#: ../src/guestfs.pod:1297 msgid "" "Only I can be registered for each handle. " "Calling C again overwrites the previous callback of " @@ -2284,12 +2601,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1144 +#: ../src/guestfs.pod:1302 msgid "guestfs_set_log_message_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1146 +#: ../src/guestfs.pod:1304 #, no-wrap msgid "" " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n" @@ -2301,31 +2618,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1152 +#: ../src/guestfs.pod:1310 msgid "" "The callback function C will be called whenever qemu or the guest writes " "anything to the console." msgstr "" # type: textblock -#: ../src/guestfs.pod:1155 +#: ../src/guestfs.pod:1313 msgid "Use this function to capture kernel messages and similar." msgstr "" # type: textblock -#: ../src/guestfs.pod:1157 +#: ../src/guestfs.pod:1315 msgid "" "Normally there is no log message handler, and log messages are just " "discarded." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1160 +#: ../src/guestfs.pod:1318 msgid "guestfs_set_subprocess_quit_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1162 +#: ../src/guestfs.pod:1320 #, no-wrap msgid "" " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n" @@ -2336,7 +2653,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1167 +#: ../src/guestfs.pod:1325 msgid "" "The callback function C will be called when the child process quits, " "either asynchronously or if killed by L. (This " @@ -2344,12 +2661,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1172 +#: ../src/guestfs.pod:1330 msgid "guestfs_set_launch_done_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1174 +#: ../src/guestfs.pod:1332 #, no-wrap msgid "" " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n" @@ -2360,7 +2677,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1179 +#: ../src/guestfs.pod:1337 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 " @@ -2368,12 +2685,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1183 +#: ../src/guestfs.pod:1341 msgid "guestfs_set_close_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1185 +#: ../src/guestfs.pod:1343 #, no-wrap msgid "" " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n" @@ -2384,14 +2701,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1190 +#: ../src/guestfs.pod:1348 msgid "" "The callback function C will be called while the handle is being closed " "(synchronously from L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1193 +#: ../src/guestfs.pod:1351 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 " @@ -2402,12 +2719,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1201 +#: ../src/guestfs.pod:1359 msgid "guestfs_set_progress_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1203 +#: ../src/guestfs.pod:1361 #, no-wrap msgid "" " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n" @@ -2420,7 +2737,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1210 +#: ../src/guestfs.pod:1368 msgid "" "Some long-running operations can generate progress messages. If this " "callback is registered, then it will be called each time a progress message " @@ -2430,7 +2747,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1216 +#: ../src/guestfs.pod:1374 msgid "" "The callback receives two numbers: C and C. The units of " "C are not defined, although for some operations C may relate " @@ -2439,31 +2756,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1222 +#: ../src/guestfs.pod:1380 msgid "The only defined and stable parts of the API are:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1228 +#: ../src/guestfs.pod:1386 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:1233 +#: ../src/guestfs.pod:1391 msgid "0 E= C E= C" msgstr "" # type: textblock -#: ../src/guestfs.pod:1237 +#: ../src/guestfs.pod:1395 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:1240 +#: ../src/guestfs.pod:1398 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 " @@ -2471,7 +2788,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1246 +#: ../src/guestfs.pod:1404 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 " @@ -2480,12 +2797,12 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1251 +#: ../src/guestfs.pod:1409 msgid "PRIVATE DATA AREA" msgstr "" # type: textblock -#: ../src/guestfs.pod:1253 +#: ../src/guestfs.pod:1411 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 " @@ -2493,12 +2810,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1257 +#: ../src/guestfs.pod:1415 msgid "To attach a named piece of data, use the following call:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1259 +#: ../src/guestfs.pod:1417 #, no-wrap msgid "" " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" @@ -2506,7 +2823,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1261 +#: ../src/guestfs.pod:1419 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 " @@ -2514,7 +2831,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1265 +#: ../src/guestfs.pod:1423 msgid "" "You can use any C you want, but names beginning with an underscore " "character are reserved for internal libguestfs purposes (for implementing " @@ -2523,12 +2840,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1270 +#: ../src/guestfs.pod:1428 msgid "To retrieve the pointer, use:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1272 +#: ../src/guestfs.pod:1430 #, no-wrap msgid "" " void *guestfs_get_private (guestfs_h *g, const char *key);\n" @@ -2536,7 +2853,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1274 +#: ../src/guestfs.pod:1432 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 " @@ -2544,7 +2861,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1278 +#: ../src/guestfs.pod:1436 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 " @@ -2556,19 +2873,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1286 +#: ../src/guestfs.pod:1444 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:1289 +#: ../src/guestfs.pod:1447 msgid "BLOCK DEVICE NAMING" msgstr "" # type: textblock -#: ../src/guestfs.pod:1291 +#: ../src/guestfs.pod:1449 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 " @@ -2583,7 +2900,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1303 +#: ../src/guestfs.pod:1461 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 " @@ -2591,7 +2908,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1307 +#: ../src/guestfs.pod:1465 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 " @@ -2599,7 +2916,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1312 +#: ../src/guestfs.pod:1470 msgid "" "Therefore libguestfs defines C as the I. " "Internally C names are translated, if necessary, to other names as " @@ -2608,7 +2925,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1318 +#: ../src/guestfs.pod:1476 msgid "" "Note that this I applies to parameters. The L, " "L and similar calls return the true names of the " @@ -2616,12 +2933,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1323 +#: ../src/guestfs.pod:1481 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" msgstr "" # type: textblock -#: ../src/guestfs.pod:1325 +#: ../src/guestfs.pod:1483 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 " @@ -2631,7 +2948,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1331 +#: ../src/guestfs.pod:1489 msgid "" "The algorithm is applied only to I which are known to be either " "device or partition names. Return values from functions such as " @@ -2639,54 +2956,54 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1339 +#: ../src/guestfs.pod:1497 msgid "Is the string a parameter which is a device or partition name?" msgstr "" # type: textblock -#: ../src/guestfs.pod:1343 +#: ../src/guestfs.pod:1501 msgid "Does the string begin with C?" msgstr "" # type: textblock -#: ../src/guestfs.pod:1347 +#: ../src/guestfs.pod:1505 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:1352 +#: ../src/guestfs.pod:1510 msgid "Replace initial C string with C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1354 +#: ../src/guestfs.pod:1512 msgid "For example, change C to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1356 +#: ../src/guestfs.pod:1514 msgid "If that named device exists, use it. If not, continue." msgstr "" # type: textblock -#: ../src/guestfs.pod:1360 +#: ../src/guestfs.pod:1518 msgid "Replace initial C string with C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1362 +#: ../src/guestfs.pod:1520 msgid "If that named device exists, use it. If not, return an error." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1366 +#: ../src/guestfs.pod:1524 msgid "PORTABILITY CONCERNS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1368 +#: ../src/guestfs.pod:1526 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 " @@ -2694,50 +3011,50 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1372 +#: ../src/guestfs.pod:1530 msgid "" "Where possible for maximum future portability programs using libguestfs " "should use these future-proof techniques:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1379 +#: ../src/guestfs.pod:1537 msgid "" "Use L or L to list actual " "device names, and then use those names directly." msgstr "" # type: textblock -#: ../src/guestfs.pod:1382 +#: ../src/guestfs.pod:1540 msgid "Since those device names exist by definition, they will never be translated." msgstr "" # type: textblock -#: ../src/guestfs.pod:1387 +#: ../src/guestfs.pod:1545 msgid "" "Use higher level ways to identify filesystems, such as LVM names, UUIDs and " "filesystem labels." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1392 +#: ../src/guestfs.pod:1550 msgid "INTERNALS" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1394 +#: ../src/guestfs.pod:1552 msgid "COMMUNICATION PROTOCOL" msgstr "" # type: textblock -#: ../src/guestfs.pod:1396 +#: ../src/guestfs.pod:1554 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:1399 +#: ../src/guestfs.pod:1557 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 " @@ -2745,14 +3062,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1403 +#: ../src/guestfs.pod:1561 msgid "" "The detailed format of structures is in C (note: " "this file is automatically generated)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1406 +#: ../src/guestfs.pod:1564 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 " @@ -2762,17 +3079,17 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1413 +#: ../src/guestfs.pod:1571 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" msgstr "" # type: textblock -#: ../src/guestfs.pod:1415 +#: ../src/guestfs.pod:1573 msgid "For ordinary functions, the request message is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1417 +#: ../src/guestfs.pod:1575 #, no-wrap msgid "" " total length (header + arguments,\n" @@ -2783,7 +3100,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1422 +#: ../src/guestfs.pod:1580 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 " @@ -2792,26 +3109,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1428 +#: ../src/guestfs.pod:1586 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:1431 +#: ../src/guestfs.pod:1589 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:1435 +#: ../src/guestfs.pod:1593 msgid "The reply message for ordinary functions is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1437 +#: ../src/guestfs.pod:1595 #, no-wrap msgid "" " total length (header + ret,\n" @@ -2822,26 +3139,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1442 +#: ../src/guestfs.pod:1600 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:1445 +#: ../src/guestfs.pod:1603 msgid "As above the total length of the reply is limited to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1448 +#: ../src/guestfs.pod:1606 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:1451 +#: ../src/guestfs.pod:1609 #, no-wrap msgid "" " total length (header + error,\n" @@ -2852,19 +3169,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1456 +#: ../src/guestfs.pod:1614 msgid "" "The C structure contains the error message as a " "string." msgstr "" # type: =head3 -#: ../src/guestfs.pod:1459 +#: ../src/guestfs.pod:1617 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1461 +#: ../src/guestfs.pod:1619 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 " @@ -2872,7 +3189,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1465 +#: ../src/guestfs.pod:1623 #, no-wrap msgid "" " total length (header + arguments,\n" @@ -2886,12 +3203,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1473 +#: ../src/guestfs.pod:1631 msgid "The \"sequence of chunks\" is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1475 +#: ../src/guestfs.pod:1633 #, no-wrap msgid "" " length of chunk (not including length word itself)\n" @@ -2905,7 +3222,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1483 +#: ../src/guestfs.pod:1641 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 " @@ -2913,7 +3230,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1487 +#: ../src/guestfs.pod:1645 msgid "" "At time of writing there are no functions that have more than one FileIn " "parameter. However this is (theoretically) supported, by sending the " @@ -2922,7 +3239,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1492 +#: ../src/guestfs.pod:1650 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 " @@ -2931,7 +3248,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1498 +#: ../src/guestfs.pod:1656 msgid "" "The daemon may also cancel. It does this by writing a special word " "C to the socket. The library listens for this during " @@ -2943,7 +3260,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1507 +#: ../src/guestfs.pod:1665 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 " @@ -2953,19 +3270,19 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1513 +#: ../src/guestfs.pod:1671 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1515 +#: ../src/guestfs.pod:1673 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:1518 +#: ../src/guestfs.pod:1676 #, no-wrap msgid "" " total length (header + ret,\n" @@ -2979,46 +3296,81 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1526 +#: ../src/guestfs.pod:1684 msgid "INITIAL MESSAGE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1528 +#: ../src/guestfs.pod:1686 +msgid "" +"When the daemon launches it sends an initial word (C) " +"which indicates that the guest and daemon is alive. This is what " +"L waits for." +msgstr "" + +# type: =head3 +#: ../src/guestfs.pod:1690 +msgid "PROGRESS NOTIFICATION MESSAGES" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1692 +msgid "" +"The daemon may send progress notification messages at any time. These are " +"distinguished by the normal length word being replaced by " +"C, followed by a fixed size progress message." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1696 +msgid "" +"The library turns them into progress callbacks (see " +"C) if there is a callback registered, or " +"discards them if not." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1700 msgid "" -"Because the underlying channel (QEmu -net channel) doesn't have any sort of " -"connection control, when the daemon launches it sends an initial word " -"(C) which indicates that the guest and daemon is " -"alive. This is what L waits for." +"The daemon self-limits the frequency of progress messages it sends (see " +"C). Not all calls generate progress " +"messages." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1533 +#: ../src/guestfs.pod:1704 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1535 +#: ../src/guestfs.pod:1706 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:1538 +#: ../src/guestfs.pod:1709 msgid "" "Only use the handle from a single thread. Either use the handle exclusively " "from one thread, or provide your own mutex so that two threads cannot issue " "calls on the same handle at the same time." msgstr "" +# type: textblock +#: ../src/guestfs.pod:1713 +msgid "" +"See the graphical program guestfs-browser for one possible architecture for " +"multithreaded programs using libvirt and libguestfs." +msgstr "" + # type: =head1 -#: ../src/guestfs.pod:1542 +#: ../src/guestfs.pod:1716 msgid "QEMU WRAPPERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1544 +#: ../src/guestfs.pod:1718 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 " @@ -3026,7 +3378,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1548 +#: ../src/guestfs.pod:1722 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 " @@ -3035,14 +3387,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1553 +#: ../src/guestfs.pod:1727 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:1556 +#: ../src/guestfs.pod:1730 #, no-wrap msgid "" " #!/bin/sh -\n" @@ -3053,7 +3405,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1560 +#: ../src/guestfs.pod:1734 msgid "" "Save this script as C (or wherever), C, and " "then use it by setting the LIBGUESTFS_QEMU environment variable. For " @@ -3061,7 +3413,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1564 +#: ../src/guestfs.pod:1738 #, no-wrap msgid "" " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" @@ -3069,19 +3421,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1566 +#: ../src/guestfs.pod:1740 msgid "" "Note that libguestfs also calls qemu with the -help and -version options in " "order to determine features." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1569 +#: ../src/guestfs.pod:1743 msgid "LIBGUESTFS VERSION NUMBERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1571 +#: ../src/guestfs.pod:1745 msgid "" "Since April 2010, libguestfs has started to make separate development and " "stable releases, along with corresponding branches in our git repository. " @@ -3089,7 +3441,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1576 +#: ../src/guestfs.pod:1750 #, no-wrap msgid "" " even numbers for stable: 1.2.x, 1.4.x, ...\n" @@ -3106,12 +3458,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1587 +#: ../src/guestfs.pod:1761 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." msgstr "" # type: textblock -#: ../src/guestfs.pod:1589 +#: ../src/guestfs.pod:1763 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 " @@ -3121,26 +3473,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1595 +#: ../src/guestfs.pod:1769 msgid "Our criteria for backporting changes are:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1601 +#: ../src/guestfs.pod:1775 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:1607 +#: ../src/guestfs.pod:1781 msgid "" "Bug fixes which are not controversial, fix obvious problems, and have been " "well tested are backported." msgstr "" # type: textblock -#: ../src/guestfs.pod:1612 +#: ../src/guestfs.pod:1786 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 " @@ -3148,7 +3500,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1618 +#: ../src/guestfs.pod:1792 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 " @@ -3156,7 +3508,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1624 +#: ../src/guestfs.pod:1798 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 " @@ -3167,44 +3519,44 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1632 ../fish/guestfish.pod:905 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:312 ../tools/virt-rescue.pl:226 +#: ../src/guestfs.pod:1806 ../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:1636 ../fish/guestfish.pod:925 +#: ../src/guestfs.pod:1810 ../fish/guestfish.pod:893 msgid "LIBGUESTFS_APPEND" msgstr "" # type: textblock -#: ../src/guestfs.pod:1638 ../fish/guestfish.pod:927 +#: ../src/guestfs.pod:1812 ../fish/guestfish.pod:895 msgid "Pass additional options to the guest kernel." msgstr "" # type: =item -#: ../src/guestfs.pod:1640 ../fish/guestfish.pod:929 +#: ../src/guestfs.pod:1814 ../fish/guestfish.pod:897 msgid "LIBGUESTFS_DEBUG" msgstr "" # type: textblock -#: ../src/guestfs.pod:1642 +#: ../src/guestfs.pod:1816 msgid "" "Set C to enable verbose messages. This has the same " "effect as calling C." msgstr "" # type: =item -#: ../src/guestfs.pod:1645 ../fish/guestfish.pod:934 +#: ../src/guestfs.pod:1819 ../fish/guestfish.pod:902 msgid "LIBGUESTFS_MEMSIZE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1647 ../fish/guestfish.pod:936 +#: ../src/guestfs.pod:1821 ../fish/guestfish.pod:904 msgid "Set the memory allocated to the qemu process, in megabytes. For example:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1650 ../fish/guestfish.pod:939 +#: ../src/guestfs.pod:1824 ../fish/guestfish.pod:907 #, no-wrap msgid "" " LIBGUESTFS_MEMSIZE=700\n" @@ -3212,72 +3564,72 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:1652 ../fish/guestfish.pod:941 +#: ../src/guestfs.pod:1826 ../fish/guestfish.pod:909 msgid "LIBGUESTFS_PATH" msgstr "" # type: textblock -#: ../src/guestfs.pod:1654 +#: ../src/guestfs.pod:1828 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:1657 ../fish/guestfish.pod:946 +#: ../src/guestfs.pod:1831 ../fish/guestfish.pod:914 msgid "LIBGUESTFS_QEMU" msgstr "" # type: textblock -#: ../src/guestfs.pod:1659 ../fish/guestfish.pod:948 +#: ../src/guestfs.pod:1833 ../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:1663 +#: ../src/guestfs.pod:1837 msgid "See also L above." msgstr "" # type: =item -#: ../src/guestfs.pod:1665 ../fish/guestfish.pod:952 +#: ../src/guestfs.pod:1839 ../fish/guestfish.pod:920 msgid "LIBGUESTFS_TRACE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1667 +#: ../src/guestfs.pod:1841 msgid "" "Set C to enable command traces. This has the same " "effect as calling C." msgstr "" # type: =item -#: ../src/guestfs.pod:1670 ../fish/guestfish.pod:961 +#: ../src/guestfs.pod:1844 ../fish/guestfish.pod:929 msgid "TMPDIR" msgstr "" # type: textblock -#: ../src/guestfs.pod:1672 ../fish/guestfish.pod:963 +#: ../src/guestfs.pod:1846 ../fish/guestfish.pod:931 msgid "Location of temporary directory, defaults to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1674 ../fish/guestfish.pod:965 +#: ../src/guestfs.pod:1848 ../fish/guestfish.pod:933 msgid "" -"If libguestfs was compiled to use the supermin appliance then each handle " -"will require rather a large amount of space in this directory for short " -"periods of time (~ 80 MB). You can use C<$TMPDIR> to configure another " -"directory to use in case C is not large enough." +"If libguestfs was compiled to use the supermin appliance then the real " +"appliance is cached in this directory, shared between all handles belonging " +"to the same EUID. You can use C<$TMPDIR> to configure another directory to " +"use in case C is not large enough." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1682 ../fish/guestfish.pod:1023 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:178 ../inspector/virt-inspector.pl:846 ../tools/virt-cat.pl:163 ../tools/virt-df.pl:482 ../tools/virt-edit.pl:325 ../tools/virt-list-filesystems.pl:191 ../tools/virt-list-partitions.pl:229 ../tools/virt-ls.pl:210 ../tools/virt-make-fs.pl:527 ../tools/virt-rescue.pl:231 ../tools/virt-resize.pl:1390 ../tools/virt-tar.pl:257 ../tools/virt-win-reg.pl:461 +#: ../src/guestfs.pod:1856 ../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:1684 +#: ../src/guestfs.pod:1858 msgid "" "L, L, L, L, " "L, L, L, " @@ -3287,86 +3639,86 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1702 +#: ../src/guestfs.pod:1876 msgid "" "Tools with a similar purpose: L, L, L, " "L, L." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1709 ../tools/virt-make-fs.pl:541 ../tools/virt-win-reg.pl:476 +#: ../src/guestfs.pod:1883 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548 msgid "BUGS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1711 +#: ../src/guestfs.pod:1885 msgid "To get a list of bugs against libguestfs use this link:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1713 +#: ../src/guestfs.pod:1887 msgid "L" msgstr "" # type: textblock -#: ../src/guestfs.pod:1715 +#: ../src/guestfs.pod:1889 msgid "To report a new bug against libguestfs use this link:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1717 +#: ../src/guestfs.pod:1891 msgid "L" msgstr "" # type: textblock -#: ../src/guestfs.pod:1719 +#: ../src/guestfs.pod:1893 msgid "When reporting a bug, please check:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1725 +#: ../src/guestfs.pod:1899 msgid "That the bug hasn't been reported already." msgstr "" # type: textblock -#: ../src/guestfs.pod:1729 +#: ../src/guestfs.pod:1903 msgid "That you are testing a recent version." msgstr "" # type: textblock -#: ../src/guestfs.pod:1733 +#: ../src/guestfs.pod:1907 msgid "Describe the bug accurately, and give a way to reproduce it." msgstr "" # type: textblock -#: ../src/guestfs.pod:1737 +#: ../src/guestfs.pod:1911 msgid "" "Run libguestfs-test-tool and paste the B output into the " "bug report." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1742 ../fish/guestfish.pod:1039 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:189 ../inspector/virt-inspector.pl:855 +#: ../src/guestfs.pod:1916 ../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:1744 ../fish/guestfish.pod:1041 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:191 +#: ../src/guestfs.pod:1918 ../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:1746 ../fish/guestfish.pod:1043 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:193 ../inspector/virt-inspector.pl:861 ../tools/virt-cat.pl:177 ../tools/virt-df.pl:495 ../tools/virt-edit.pl:341 ../tools/virt-list-filesystems.pl:207 ../tools/virt-list-partitions.pl:244 ../tools/virt-ls.pl:225 ../tools/virt-make-fs.pl:556 ../tools/virt-rescue.pl:245 ../tools/virt-resize.pl:1411 ../tools/virt-tar.pl:272 ../tools/virt-win-reg.pl:491 +#: ../src/guestfs.pod:1920 ../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:1748 ../fish/guestfish.pod:1045 +#: ../src/guestfs.pod:1922 ../fish/guestfish.pod:1014 ../fuse/guestmount.pod:231 msgid "Copyright (C) 2009-2010 Red Hat Inc. L" msgstr "" # type: textblock -#: ../src/guestfs.pod:1751 +#: ../src/guestfs.pod:1925 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 " @@ -3375,7 +3727,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1756 +#: ../src/guestfs.pod:1930 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 " @@ -3384,7 +3736,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1761 +#: ../src/guestfs.pod:1935 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, " @@ -3416,11 +3768,6 @@ msgid "This is equivalent to the qemu parameter C<-cdrom filename>." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1186 -msgid "Notes:" -msgstr "" - -# type: textblock #: ../src/guestfs-actions.pod:16 msgid "" "This call checks for the existence of C. This stops you from " @@ -3438,17 +3785,32 @@ 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:996 ../src/guestfs-actions.pod:1027 ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:1146 ../src/guestfs-actions.pod:1346 ../src/guestfs-actions.pod:1365 ../src/guestfs-actions.pod:1446 ../src/guestfs-actions.pod:1794 ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:1972 ../src/guestfs-actions.pod:2002 ../src/guestfs-actions.pod:2349 ../src/guestfs-actions.pod:2361 ../src/guestfs-actions.pod:2378 ../src/guestfs-actions.pod:2443 ../src/guestfs-actions.pod:2454 ../src/guestfs-actions.pod:2464 ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2487 ../src/guestfs-actions.pod:2517 ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2598 ../src/guestfs-actions.pod:2612 ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2652 ../src/guestfs-actions.pod:2681 ../src/guestfs-actions.pod:2697 ../src/guestfs-actions.pod:2713 ../src/guestfs-actions.pod:2725 ../src/guestfs-actions.pod:2734 ../src/guestfs-actions.pod:2767 ../src/guestfs-actions.pod:2780 ../src/guestfs-actions.pod:2790 ../src/guestfs-actions.pod:2802 ../src/guestfs-actions.pod:2816 ../src/guestfs-actions.pod:2896 ../src/guestfs-actions.pod:2913 ../src/guestfs-actions.pod:2923 ../src/guestfs-actions.pod:2968 ../src/guestfs-actions.pod:2983 ../src/guestfs-actions.pod:2998 ../src/guestfs-actions.pod:3011 ../src/guestfs-actions.pod:3022 ../src/guestfs-actions.pod:3033 ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3059 ../src/guestfs-actions.pod:3076 ../src/guestfs-actions.pod:3107 ../src/guestfs-actions.pod:3135 ../src/guestfs-actions.pod:3151 ../src/guestfs-actions.pod:3167 ../src/guestfs-actions.pod:3176 ../src/guestfs-actions.pod:3190 ../src/guestfs-actions.pod:3200 ../src/guestfs-actions.pod:3212 ../src/guestfs-actions.pod:3224 ../src/guestfs-actions.pod:3256 ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3285 ../src/guestfs-actions.pod:3296 ../src/guestfs-actions.pod:3310 ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3392 ../src/guestfs-actions.pod:3417 ../src/guestfs-actions.pod:3431 ../src/guestfs-actions.pod:3446 ../src/guestfs-actions.pod:3568 ../src/guestfs-actions.pod:3620 ../src/guestfs-actions.pod:3639 ../src/guestfs-actions.pod:3654 ../src/guestfs-actions.pod:3665 ../src/guestfs-actions.pod:3699 ../src/guestfs-actions.pod:3713 ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:3734 ../src/guestfs-actions.pod:3966 ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:3993 ../src/guestfs-actions.pod:4002 ../src/guestfs-actions.pod:4013 ../src/guestfs-actions.pod:4022 ../src/guestfs-actions.pod:4033 ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4064 ../src/guestfs-actions.pod:4080 ../src/guestfs-actions.pod:4096 ../src/guestfs-actions.pod:4111 ../src/guestfs-actions.pod:4131 ../src/guestfs-actions.pod:4146 ../src/guestfs-actions.pod:4162 ../src/guestfs-actions.pod:4180 ../src/guestfs-actions.pod:4196 ../src/guestfs-actions.pod:4210 ../src/guestfs-actions.pod:4235 ../src/guestfs-actions.pod:4256 ../src/guestfs-actions.pod:4272 ../src/guestfs-actions.pod:4293 ../src/guestfs-actions.pod:4305 ../src/guestfs-actions.pod:4317 ../src/guestfs-actions.pod:4333 ../src/guestfs-actions.pod:4367 ../src/guestfs-actions.pod:4387 ../src/guestfs-actions.pod:4410 ../src/guestfs-actions.pod:4500 ../src/guestfs-actions.pod:4606 ../src/guestfs-actions.pod:4615 ../src/guestfs-actions.pod:4625 ../src/guestfs-actions.pod:4635 ../src/guestfs-actions.pod:4654 ../src/guestfs-actions.pod:4664 ../src/guestfs-actions.pod:4674 ../src/guestfs-actions.pod:4684 ../src/guestfs-actions.pod:4696 ../src/guestfs-actions.pod:4746 ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:4773 ../src/guestfs-actions.pod:4786 ../src/guestfs-actions.pod:4800 ../src/guestfs-actions.pod:4810 ../src/guestfs-actions.pod:4827 ../src/guestfs-actions.pod:4857 ../src/guestfs-actions.pod:4868 ../src/guestfs-actions.pod:4903 ../src/guestfs-actions.pod:4913 ../src/guestfs-actions.pod:4928 ../src/guestfs-actions.pod:4956 ../src/guestfs-actions.pod:5060 ../src/guestfs-actions.pod:5075 ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5132 ../src/guestfs-actions.pod:5142 ../src/guestfs-actions.pod:5179 ../src/guestfs-actions.pod:5206 ../src/guestfs-actions.pod:5248 ../src/guestfs-actions.pod:5271 ../src/guestfs-actions.pod:5328 ../src/guestfs-actions.pod:5344 ../src/guestfs-actions.pod:5370 +#: ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:54 ../src/guestfs-actions.pod:112 ../src/guestfs-actions.pod:144 ../src/guestfs-actions.pod:155 ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:190 ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:304 ../src/guestfs-actions.pod:321 ../src/guestfs-actions.pod:332 ../src/guestfs-actions.pod:368 ../src/guestfs-actions.pod:390 ../src/guestfs-actions.pod:405 ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:496 ../src/guestfs-actions.pod:507 ../src/guestfs-actions.pod:519 ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:615 ../src/guestfs-actions.pod:626 ../src/guestfs-actions.pod:637 ../src/guestfs-actions.pod:783 ../src/guestfs-actions.pod:800 ../src/guestfs-actions.pod:815 ../src/guestfs-actions.pod:890 ../src/guestfs-actions.pod:905 ../src/guestfs-actions.pod:921 ../src/guestfs-actions.pod:932 ../src/guestfs-actions.pod:949 ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1040 ../src/guestfs-actions.pod:1068 ../src/guestfs-actions.pod:1090 ../src/guestfs-actions.pod:1121 ../src/guestfs-actions.pod:1209 ../src/guestfs-actions.pod:1240 ../src/guestfs-actions.pod:1440 ../src/guestfs-actions.pod:1459 ../src/guestfs-actions.pod:1540 ../src/guestfs-actions.pod:1888 ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2096 ../src/guestfs-actions.pod:2545 ../src/guestfs-actions.pod:2557 ../src/guestfs-actions.pod:2574 ../src/guestfs-actions.pod:2682 ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2703 ../src/guestfs-actions.pod:2714 ../src/guestfs-actions.pod:2726 ../src/guestfs-actions.pod:2756 ../src/guestfs-actions.pod:2820 ../src/guestfs-actions.pod:2837 ../src/guestfs-actions.pod:2851 ../src/guestfs-actions.pod:2871 ../src/guestfs-actions.pod:2891 ../src/guestfs-actions.pod:2920 ../src/guestfs-actions.pod:2936 ../src/guestfs-actions.pod:2952 ../src/guestfs-actions.pod:2981 ../src/guestfs-actions.pod:2990 ../src/guestfs-actions.pod:3023 ../src/guestfs-actions.pod:3036 ../src/guestfs-actions.pod:3046 ../src/guestfs-actions.pod:3058 ../src/guestfs-actions.pod:3072 ../src/guestfs-actions.pod:3152 ../src/guestfs-actions.pod:3169 ../src/guestfs-actions.pod:3179 ../src/guestfs-actions.pod:3224 ../src/guestfs-actions.pod:3239 ../src/guestfs-actions.pod:3254 ../src/guestfs-actions.pod:3267 ../src/guestfs-actions.pod:3278 ../src/guestfs-actions.pod:3289 ../src/guestfs-actions.pod:3303 ../src/guestfs-actions.pod:3315 ../src/guestfs-actions.pod:3332 ../src/guestfs-actions.pod:3378 ../src/guestfs-actions.pod:3406 ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:3438 ../src/guestfs-actions.pod:3447 ../src/guestfs-actions.pod:3461 ../src/guestfs-actions.pod:3471 ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3495 ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:3539 ../src/guestfs-actions.pod:3556 ../src/guestfs-actions.pod:3567 ../src/guestfs-actions.pod:3581 ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3652 ../src/guestfs-actions.pod:3663 ../src/guestfs-actions.pod:3688 ../src/guestfs-actions.pod:3702 ../src/guestfs-actions.pod:3717 ../src/guestfs-actions.pod:3839 ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:3910 ../src/guestfs-actions.pod:3925 ../src/guestfs-actions.pod:3951 ../src/guestfs-actions.pod:4008 ../src/guestfs-actions.pod:4022 ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4043 ../src/guestfs-actions.pod:4298 ../src/guestfs-actions.pod:4314 ../src/guestfs-actions.pod:4325 ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4345 ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:4365 ../src/guestfs-actions.pod:4378 ../src/guestfs-actions.pod:4396 ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4428 ../src/guestfs-actions.pod:4443 ../src/guestfs-actions.pod:4463 ../src/guestfs-actions.pod:4478 ../src/guestfs-actions.pod:4494 ../src/guestfs-actions.pod:4512 ../src/guestfs-actions.pod:4528 ../src/guestfs-actions.pod:4542 ../src/guestfs-actions.pod:4567 ../src/guestfs-actions.pod:4588 ../src/guestfs-actions.pod:4604 ../src/guestfs-actions.pod:4625 ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4649 ../src/guestfs-actions.pod:4665 ../src/guestfs-actions.pod:4699 ../src/guestfs-actions.pod:4719 ../src/guestfs-actions.pod:4742 ../src/guestfs-actions.pod:4832 ../src/guestfs-actions.pod:4938 ../src/guestfs-actions.pod:4947 ../src/guestfs-actions.pod:4957 ../src/guestfs-actions.pod:4967 ../src/guestfs-actions.pod:4986 ../src/guestfs-actions.pod:4996 ../src/guestfs-actions.pod:5006 ../src/guestfs-actions.pod:5016 ../src/guestfs-actions.pod:5028 ../src/guestfs-actions.pod:5078 ../src/guestfs-actions.pod:5092 ../src/guestfs-actions.pod:5105 ../src/guestfs-actions.pod:5118 ../src/guestfs-actions.pod:5132 ../src/guestfs-actions.pod:5142 ../src/guestfs-actions.pod:5159 ../src/guestfs-actions.pod:5189 ../src/guestfs-actions.pod:5200 ../src/guestfs-actions.pod:5235 ../src/guestfs-actions.pod:5245 ../src/guestfs-actions.pod:5260 ../src/guestfs-actions.pod:5286 ../src/guestfs-actions.pod:5314 ../src/guestfs-actions.pod:5418 ../src/guestfs-actions.pod:5433 ../src/guestfs-actions.pod:5444 ../src/guestfs-actions.pod:5490 ../src/guestfs-actions.pod:5500 ../src/guestfs-actions.pod:5537 ../src/guestfs-actions.pod:5564 ../src/guestfs-actions.pod:5606 ../src/guestfs-actions.pod:5629 ../src/guestfs-actions.pod:5686 ../src/guestfs-actions.pod:5702 ../src/guestfs-actions.pod:5728 msgid "This function returns 0 on success or -1 on error." msgstr "" +# type: textblock +#: ../src/guestfs-actions.pod:31 ../src/guestfs-actions.pod:157 ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:117 ../fish/guestfish-actions.pod:131 +msgid "" +"This function is deprecated. In new code, use the C call " +"instead." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:34 ../src/guestfs-actions.pod:160 ../src/guestfs-actions.pod:178 ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1667 ../src/guestfs-actions.pod:5637 ../src/guestfs-actions.pod:5782 ../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:38 msgid "guestfs_add_drive" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:33 +#: ../src/guestfs-actions.pod:40 #, no-wrap msgid "" " int guestfs_add_drive (guestfs_h *g,\n" @@ -3457,97 +3819,203 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:36 ../fish/guestfish-actions.pod:32 -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." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:41 ../fish/guestfish-actions.pod:37 +#: ../src/guestfs-actions.pod:43 msgid "" -"You don't necessarily need to be root when using libguestfs. However you " -"obviously do need sufficient permissions to access the filename for whatever " -"operations you want to perform (ie. read access if you just want to read the " -"image or write access if you want to modify the image)." +"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:47 ../fish/guestfish-actions.pod:43 +#: ../src/guestfs-actions.pod:47 msgid "" -"This is equivalent to the qemu parameter C<-drive " -"file=filename,cache=off,if=...>." +"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: textblock -#: ../src/guestfs-actions.pod:50 ../fish/guestfish-actions.pod:46 -msgid "" -"C is omitted in cases where it is not supported by the underlying " -"filesystem." +# type: =head2 +#: ../src/guestfs-actions.pod:56 +msgid "guestfs_add_drive_opts" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:53 ../src/guestfs-actions.pod:82 +# type: verbatim +#: ../src/guestfs-actions.pod:58 +#, no-wrap 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." +" int guestfs_add_drive_opts (guestfs_h *g,\n" +"\t\tconst char *filename,\n" +"\t\t...);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:58 ../src/guestfs-actions.pod:87 +#: ../src/guestfs-actions.pod:62 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." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:65 -msgid "guestfs_add_drive_ro" +"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:67 #, no-wrap msgid "" -" int guestfs_add_drive_ro (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:70 ../fish/guestfish-actions.pod:63 -msgid "This adds a drive in snapshot mode, making it effectively read-only." +#: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:56 +msgid "" +"This function adds a virtual machine disk image C to libguestfs. " +"The first time you call this function, the disk appears as C, the " +"second time as C, and so on." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:73 ../fish/guestfish-actions.pod:66 +#: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:61 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." +"You don't necessarily need to be root when using libguestfs. However you " +"obviously do need sufficient permissions to access the filename for whatever " +"operations you want to perform (ie. read access if you just want to read the " +"image or write access if you want to modify the image)." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:79 ../fish/guestfish-actions.pod:72 -msgid "" -"This is equivalent to the qemu parameter C<-drive " -"file=filename,snapshot=on,if=...>." +#: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:67 +msgid "This call checks that C exists." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:84 ../fish/guestfish-actions.pod:69 +msgid "The optional arguments are:" +msgstr "" + +# type: =item +#: ../src/guestfs-actions.pod:88 ../fish/guestfish-actions.pod:73 +msgid "C" +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:90 ../fish/guestfish-actions.pod:75 +msgid "" +"If true then the image is treated as read-only. Writes are still allowed, " +"but they are stored in a temporary snapshot overlay which is discarded at " +"the end. The disk that you add is not modified." +msgstr "" + +# type: =item +#: ../src/guestfs-actions.pod:94 ../fish/guestfish-actions.pod:79 +msgid "C" +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:96 +msgid "" +"This forces the image format. If you omit this (or use C " +"or C) then the format is automatically detected. " +"Possible formats include C and C." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:100 ../fish/guestfish-actions.pod:85 +msgid "" +"Automatic detection of the format opens you up to a potential security hole " +"when dealing with untrusted raw-format images. See CVE-2010-3851 and " +"RHBZ#642934. Specifying the format closes this security hole." +msgstr "" + +# type: =item +#: ../src/guestfs-actions.pod:105 ../fish/guestfish-actions.pod:90 +msgid "C" +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:107 +msgid "" +"This rarely-used option lets you emulate the behaviour of the deprecated " +"C call (q.v.)" +msgstr "" + +# type: =head2 +#: ../src/guestfs-actions.pod:114 +msgid "guestfs_add_drive_opts_va" +msgstr "" + +# type: verbatim +#: ../src/guestfs-actions.pod:116 +#, no-wrap +msgid "" +" int guestfs_add_drive_opts_va (guestfs_h *g,\n" +"\t\tconst char *filename,\n" +"\t\tva_list args);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:120 +msgid "This is the \"va_list variant\" of L." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:122 ../src/guestfs-actions.pod:132 +msgid "See L." +msgstr "" + +# type: =head2 +#: ../src/guestfs-actions.pod:124 +msgid "guestfs_add_drive_opts_argv" +msgstr "" + +# type: verbatim +#: ../src/guestfs-actions.pod:126 +#, no-wrap +msgid "" +" int guestfs_add_drive_opts_argv (guestfs_h *g,\n" +"\t\tconst char *filename,\n" +"\t\tconst struct guestfs_add_drive_opts_argv *optargs);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:130 +msgid "This is the \"argv variant\" of L." +msgstr "" + +# type: =head2 +#: ../src/guestfs-actions.pod:134 +msgid "guestfs_add_drive_ro" +msgstr "" + +# type: verbatim +#: ../src/guestfs-actions.pod:136 +#, no-wrap +msgid "" +" int guestfs_add_drive_ro (guestfs_h *g,\n" +"\t\tconst char *filename);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:139 +msgid "" +"This function is the equivalent of calling C with " +"the optional parameter C set to 1, so the " +"disk is added read-only, with the format being detected automatically." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:94 +#: ../src/guestfs-actions.pod:146 msgid "guestfs_add_drive_ro_with_if" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:96 +#: ../src/guestfs-actions.pod:148 #, no-wrap msgid "" " int guestfs_add_drive_ro_with_if (guestfs_h *g,\n" @@ -3557,19 +4025,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:100 +#: ../src/guestfs-actions.pod:152 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:164 msgid "guestfs_add_drive_with_if" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:107 +#: ../src/guestfs-actions.pod:166 #, no-wrap msgid "" " int guestfs_add_drive_with_if (guestfs_h *g,\n" @@ -3579,19 +4047,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:111 +#: ../src/guestfs-actions.pod:170 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:182 msgid "guestfs_aug_clear" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:118 +#: ../src/guestfs-actions.pod:184 #, no-wrap msgid "" " int guestfs_aug_clear (guestfs_h *g,\n" @@ -3600,19 +4068,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:121 ../fish/guestfish-actions.pod:103 +#: ../src/guestfs-actions.pod:187 ../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:192 msgid "guestfs_aug_close" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:128 +#: ../src/guestfs-actions.pod:194 #, no-wrap msgid "" " int guestfs_aug_close (guestfs_h *g);\n" @@ -3620,7 +4088,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:130 +#: ../src/guestfs-actions.pod:196 msgid "" "Close the current Augeas handle and free up any resources used by it. After " "calling this, you have to call C again before you can use " @@ -3628,12 +4096,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:137 +#: ../src/guestfs-actions.pod:203 msgid "guestfs_aug_defnode" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:139 +#: ../src/guestfs-actions.pod:205 #, no-wrap msgid "" " struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *g,\n" @@ -3644,12 +4112,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:144 ../fish/guestfish-actions.pod:119 +#: ../src/guestfs-actions.pod:210 ../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:213 msgid "" "If C evaluates to an empty nodeset, a node is created, equivalent to " "calling C C, C. C will be the nodeset " @@ -3657,26 +4125,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:126 +#: ../src/guestfs-actions.pod:217 ../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:221 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:225 msgid "guestfs_aug_defvar" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:161 +#: ../src/guestfs-actions.pod:227 #, no-wrap msgid "" " int guestfs_aug_defvar (guestfs_h *g,\n" @@ -3686,31 +4154,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:134 +#: ../src/guestfs-actions.pod:231 ../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:138 +#: ../src/guestfs-actions.pod:235 ../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:1013 ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:1510 ../src/guestfs-actions.pod:1591 ../src/guestfs-actions.pod:1622 ../src/guestfs-actions.pod:1665 ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:2119 ../src/guestfs-actions.pod:2137 ../src/guestfs-actions.pod:3370 ../src/guestfs-actions.pod:3477 ../src/guestfs-actions.pod:3793 ../src/guestfs-actions.pod:4892 ../src/guestfs-actions.pod:5216 ../src/guestfs-actions.pod:5226 ../src/guestfs-actions.pod:5236 +#: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:379 ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:558 ../src/guestfs-actions.pod:573 ../src/guestfs-actions.pod:589 ../src/guestfs-actions.pod:1107 ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1685 ../src/guestfs-actions.pod:1716 ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:1776 ../src/guestfs-actions.pod:2001 ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:2251 ../src/guestfs-actions.pod:3641 ../src/guestfs-actions.pod:3748 ../src/guestfs-actions.pod:4102 ../src/guestfs-actions.pod:4125 ../src/guestfs-actions.pod:5224 ../src/guestfs-actions.pod:5574 ../src/guestfs-actions.pod:5584 ../src/guestfs-actions.pod:5594 msgid "On error this function returns -1." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:174 +#: ../src/guestfs-actions.pod:240 msgid "guestfs_aug_get" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:176 +#: ../src/guestfs-actions.pod:242 #, no-wrap msgid "" " char *guestfs_aug_get (guestfs_h *g,\n" @@ -3719,26 +4187,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:145 +#: ../src/guestfs-actions.pod:245 ../fish/guestfish-actions.pod:184 msgid "" "Look up the value associated with C. If C matches exactly one " "node, the C is returned." 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:1041 ../src/guestfs-actions.pod:1205 ../src/guestfs-actions.pod:1314 ../src/guestfs-actions.pod:1459 ../src/guestfs-actions.pod:1473 ../src/guestfs-actions.pod:1549 ../src/guestfs-actions.pod:1567 ../src/guestfs-actions.pod:1701 ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2021 ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:2187 ../src/guestfs-actions.pod:2222 ../src/guestfs-actions.pod:2432 ../src/guestfs-actions.pod:2853 ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:3492 ../src/guestfs-actions.pod:3771 ../src/guestfs-actions.pod:3909 ../src/guestfs-actions.pod:3952 ../src/guestfs-actions.pod:4428 ../src/guestfs-actions.pod:4441 ../src/guestfs-actions.pod:4455 ../src/guestfs-actions.pod:4476 ../src/guestfs-actions.pod:5009 ../src/guestfs-actions.pod:5025 ../src/guestfs-actions.pod:5040 ../src/guestfs-actions.pod:5188 ../src/guestfs-actions.pod:5418 +#: ../src/guestfs-actions.pod:248 ../src/guestfs-actions.pod:676 ../src/guestfs-actions.pod:691 ../src/guestfs-actions.pod:748 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:965 ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:1135 ../src/guestfs-actions.pod:1299 ../src/guestfs-actions.pod:1408 ../src/guestfs-actions.pod:1553 ../src/guestfs-actions.pod:1567 ../src/guestfs-actions.pod:1643 ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1795 ../src/guestfs-actions.pod:1934 ../src/guestfs-actions.pod:2115 ../src/guestfs-actions.pod:2185 ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:2336 ../src/guestfs-actions.pod:2356 ../src/guestfs-actions.pod:2671 ../src/guestfs-actions.pod:2968 ../src/guestfs-actions.pod:3109 ../src/guestfs-actions.pod:3205 ../src/guestfs-actions.pod:3763 ../src/guestfs-actions.pod:3939 ../src/guestfs-actions.pod:4080 ../src/guestfs-actions.pod:4241 ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:4773 ../src/guestfs-actions.pod:4787 ../src/guestfs-actions.pod:4808 ../src/guestfs-actions.pod:5367 ../src/guestfs-actions.pod:5383 ../src/guestfs-actions.pod:5398 ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:5776 msgid "" "This function returns a string, or NULL on error. I." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:185 +#: ../src/guestfs-actions.pod:251 msgid "guestfs_aug_init" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:187 +#: ../src/guestfs-actions.pod:253 #, no-wrap msgid "" " int guestfs_aug_init (guestfs_h *g,\n" @@ -3748,7 +4216,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:191 ../fish/guestfish-actions.pod:152 +#: ../src/guestfs-actions.pod:257 ../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 " @@ -3756,101 +4224,101 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:195 +#: ../src/guestfs-actions.pod:261 msgid "You must call this before using any other C commands." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:198 ../fish/guestfish-actions.pod:159 +#: ../src/guestfs-actions.pod:264 ../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:162 +#: ../src/guestfs-actions.pod:267 ../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:168 +#: ../src/guestfs-actions.pod:273 ../fish/guestfish-actions.pod:207 msgid "C = 1" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:209 ../fish/guestfish-actions.pod:170 +#: ../src/guestfs-actions.pod:275 ../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:172 +#: ../src/guestfs-actions.pod:277 ../fish/guestfish-actions.pod:211 msgid "C = 2" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:213 ../fish/guestfish-actions.pod:174 +#: ../src/guestfs-actions.pod:279 ../fish/guestfish-actions.pod:213 msgid "" "Save changes into a file with extension C<.augnew>, and do not overwrite " "original. Overrides C." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:216 ../fish/guestfish-actions.pod:177 +#: ../src/guestfs-actions.pod:282 ../fish/guestfish-actions.pod:216 msgid "C = 4" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:218 ../fish/guestfish-actions.pod:179 +#: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:218 msgid "Typecheck lenses (can be expensive)." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:220 ../fish/guestfish-actions.pod:181 +#: ../src/guestfs-actions.pod:286 ../fish/guestfish-actions.pod:220 msgid "C = 8" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:222 ../fish/guestfish-actions.pod:183 +#: ../src/guestfs-actions.pod:288 ../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:185 +#: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:224 msgid "C = 16" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:226 ../fish/guestfish-actions.pod:187 +#: ../src/guestfs-actions.pod:292 ../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:189 +#: ../src/guestfs-actions.pod:294 ../fish/guestfish-actions.pod:228 msgid "C = 32" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:230 +#: ../src/guestfs-actions.pod:296 msgid "Do not load the tree in C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:234 +#: ../src/guestfs-actions.pod:300 msgid "To close the handle, you can call C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:236 ../fish/guestfish-actions.pod:197 +#: ../src/guestfs-actions.pod:302 ../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:306 msgid "guestfs_aug_insert" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:242 +#: ../src/guestfs-actions.pod:308 #, no-wrap msgid "" " int guestfs_aug_insert (guestfs_h *g,\n" @@ -3861,26 +4329,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:247 ../fish/guestfish-actions.pod:203 +#: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:242 msgid "" "Create a new sibling C