X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=po-docs%2Fja.po;h=bebaba4525da37fec752cfddb7f30a2821e32a89;hp=90c914baa9c9f4ec9ae2e0d1e953ca7a1eb9e845;hb=9f2135c4e4062087b9bd525406802da2a25c7365;hpb=0003ea2c3dbaa7e22f4f616539136821d80694b8 diff --git a/po-docs/ja.po b/po-docs/ja.po index 90c914b..bebaba4 100644 --- a/po-docs/ja.po +++ b/po-docs/ja.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: libguestfs@redhat.com\n" -"POT-Creation-Date: 2010-09-18 09:23+0200\n" +"POT-Creation-Date: 2010-12-01 17:35+0000\n" "PO-Revision-Date: 2010-09-02 14:46+0100\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -19,24 +19,20 @@ msgstr "" # 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 +#: ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 +#: ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 +#: ../tools/virt-tar.pl:29 ../tools/virt-make-fs.pl:33 +#: ../tools/virt-list-partitions.pl:28 msgid "utf8" msgstr "" # type: =head1 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 -#: ../inspector/virt-inspector.pl: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 +#: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 +#: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 +#: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 +#: ../tools/virt-list-partitions.pl:30 msgid "NAME" msgstr "名前" @@ -48,12 +44,10 @@ 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 +#: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 +#: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 +#: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 +#: ../tools/virt-list-partitions.pl:34 msgid "SYNOPSIS" msgstr "" @@ -91,14 +85,12 @@ 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 +#: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 +#: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 +#: ../tools/virt-tar.pl:72 ../tools/virt-make-fs.pl:47 +#: ../tools/virt-list-partitions.pl:40 msgid "DESCRIPTION" msgstr "" @@ -153,13 +145,20 @@ msgid "" "introduction, please read the L section next." msgstr "" -# type: =head1 +# type: textblock #: ../src/guestfs.pod:55 +msgid "" +"There are also some example programs in the L manual " +"page." +msgstr "" + +# type: =head1 +#: ../src/guestfs.pod:58 msgid "API OVERVIEW" msgstr "" # type: textblock -#: ../src/guestfs.pod:57 +#: ../src/guestfs.pod:60 msgid "" "This section provides a gentler overview of the libguestfs API. We also try " "to group API calls together, where that may not be obvious from reading " @@ -167,12 +166,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:62 +#: ../src/guestfs.pod:65 msgid "HANDLES" msgstr "" # type: textblock -#: ../src/guestfs.pod:64 +#: ../src/guestfs.pod:67 msgid "" "Before you can use libguestfs calls, you have to create a handle. Then you " "must add at least one disk image to the handle, followed by launching the " @@ -182,12 +181,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:71 +#: ../src/guestfs.pod:74 msgid "The general structure of all libguestfs-using programs looks like this:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:74 +#: ../src/guestfs.pod:77 #, no-wrap msgid "" " guestfs_h *g = guestfs_create ();\n" @@ -195,7 +194,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:76 +#: ../src/guestfs.pod:79 #, no-wrap msgid "" " /* Call guestfs_add_drive additional times if there are\n" @@ -206,7 +205,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:81 +#: ../src/guestfs.pod:84 #, no-wrap msgid "" " /* Most manipulation calls won't work until you've launched\n" @@ -218,7 +217,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:87 +#: ../src/guestfs.pod:90 #, no-wrap msgid "" " /* Now you can examine what partitions, LVs etc are available.\n" @@ -229,7 +228,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:92 +#: ../src/guestfs.pod:95 #, no-wrap msgid "" " /* To access a filesystem in the image, you must mount it.\n" @@ -239,7 +238,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:96 +#: ../src/guestfs.pod:99 #, no-wrap msgid "" " /* Now you can perform filesystem actions on the guest\n" @@ -250,7 +249,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:101 +#: ../src/guestfs.pod:104 #, no-wrap msgid "" " /* You only need to call guestfs_sync if you have made\n" @@ -263,7 +262,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:108 +#: ../src/guestfs.pod:111 #, no-wrap msgid "" " /* Close the handle 'g'. */\n" @@ -272,7 +271,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:111 +#: ../src/guestfs.pod:114 msgid "" "The code above doesn't include any error checking. In real code you should " "check return values carefully for errors. In general all functions that " @@ -283,12 +282,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:119 +#: ../src/guestfs.pod:122 msgid "DISK IMAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:121 +#: ../src/guestfs.pod:124 msgid "" "The image filename (C<\"guest.img\"> in the example above) could be a disk " "image from a virtual machine, a L copy of a physical hard disk, an " @@ -298,14 +297,48 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:127 +#: ../src/guestfs.pod:130 +msgid "" +"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:134 +#, 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:138 +msgid "You can add a disk read-only using:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:140 +#, 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:145 msgid "" -"You can add a disk read-only using L, in which case " +"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:148 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 " @@ -313,7 +346,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:134 +#: ../src/guestfs.pod:152 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 " @@ -321,7 +354,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:139 +#: ../src/guestfs.pod:157 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 " @@ -329,12 +362,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:144 +#: ../src/guestfs.pod:162 msgid "MOUNTING" msgstr "" # type: textblock -#: ../src/guestfs.pod:146 +#: ../src/guestfs.pod:164 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 " @@ -344,7 +377,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:152 +#: ../src/guestfs.pod:170 #, no-wrap msgid "" " guestfs_mount (g, \"/dev/sda1\", \"/\");\n" @@ -352,7 +385,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:154 +#: ../src/guestfs.pod:172 msgid "" "where C means literally the first partition (C<1>) of the first " "disk image that we added (C). If the disk contains Linux LVM2 " @@ -360,7 +393,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:158 +#: ../src/guestfs.pod:176 msgid "" "If you are given a disk image and you don't know what it contains then you " "have to find out. Libguestfs can do that too: use L. There are " "several other variations of the C call." msgstr "" # type: =head2 -#: ../src/guestfs.pod:171 +#: ../src/guestfs.pod:189 msgid "FILESYSTEM ACCESS AND MODIFICATION" msgstr "" # type: textblock -#: ../src/guestfs.pod:173 +#: ../src/guestfs.pod:191 msgid "" "The majority of the libguestfs API consists of fairly low-level calls for " "accessing and modifying the files, directories, symlinks etc on mounted " @@ -395,21 +428,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:179 +#: ../src/guestfs.pod:197 msgid "" "Specify filenames as full paths, starting with C<\"/\"> and including the " "mount point." msgstr "" # type: textblock -#: ../src/guestfs.pod:182 +#: ../src/guestfs.pod:200 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:203 #, no-wrap msgid "" " char *data = guestfs_cat (g, \"/etc/passwd\");\n" @@ -417,7 +450,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:187 +#: ../src/guestfs.pod:205 msgid "" "This would return C as a newly allocated buffer containing the full " "content of that file (with some conditions: see also L below), " @@ -425,14 +458,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:191 +#: ../src/guestfs.pod:209 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:212 #, no-wrap msgid "" " guestfs_mkdir (g, \"/var\");\n" @@ -440,12 +473,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:196 +#: ../src/guestfs.pod:214 msgid "To create a symlink you could do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:198 +#: ../src/guestfs.pod:216 #, no-wrap msgid "" " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n" @@ -454,14 +487,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:201 +#: ../src/guestfs.pod:219 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:222 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 " @@ -471,33 +504,33 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:210 +#: ../src/guestfs.pod:228 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:231 msgid "PARTITIONING" msgstr "" # type: textblock -#: ../src/guestfs.pod:215 +#: ../src/guestfs.pod:233 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:236 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:240 #, no-wrap msgid "" " const char *parttype = \"mbr\";\n" @@ -508,18 +541,18 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:227 +#: ../src/guestfs.pod:245 msgid "" "Obviously this effectively wipes anything that was on that disk image before." msgstr "" # type: =head2 -#: ../src/guestfs.pod:230 +#: ../src/guestfs.pod:248 msgid "LVM2" msgstr "" # type: textblock -#: ../src/guestfs.pod:232 +#: ../src/guestfs.pod:250 msgid "" "Libguestfs provides access to a large part of the LVM2 API, such as L and L. It won't make much sense unless " @@ -528,19 +561,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:237 +#: ../src/guestfs.pod:255 msgid "" "This author strongly recommends reading the LVM HOWTO, online at L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:240 +#: ../src/guestfs.pod:258 msgid "DOWNLOADING" msgstr "" # type: textblock -#: ../src/guestfs.pod:242 +#: ../src/guestfs.pod:260 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 " @@ -548,7 +581,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:247 +#: ../src/guestfs.pod:265 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 " @@ -556,31 +589,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:251 +#: ../src/guestfs.pod:269 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:272 msgid "" "To download multiple files, see L and L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:257 +#: ../src/guestfs.pod:275 msgid "UPLOADING" msgstr "" # type: textblock -#: ../src/guestfs.pod:259 +#: ../src/guestfs.pod:277 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:280 msgid "" "To write a small file with fixed content, use L. To create " "a file of all zeroes, use L (sparse) or L. This call has no limits on " "file content or size (even files larger than 4 GB)." msgstr "" # type: textblock -#: ../src/guestfs.pod:271 +#: ../src/guestfs.pod:289 msgid "" "To upload multiple files, see L and L." msgstr "" # type: textblock -#: ../src/guestfs.pod:273 +#: ../src/guestfs.pod:291 msgid "" "However the fastest way to upload I is to " "turn them into a squashfs or CD ISO (see L and L to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:294 +#: ../src/guestfs.pod:312 msgid "" "Use L to copy a single file, or L to copy " "directories recursively." msgstr "" # type: =item -#: ../src/guestfs.pod:297 +#: ../src/guestfs.pod:315 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:299 +#: ../src/guestfs.pod:317 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:320 msgid "Example: duplicate the contents of an LV:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:304 +#: ../src/guestfs.pod:322 #, no-wrap msgid "" " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n" @@ -667,7 +700,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:306 +#: ../src/guestfs.pod:324 msgid "" "The destination (C) must be at least as large as the source " "(C). To copy less than the whole source device, use L to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:312 +#: ../src/guestfs.pod:330 msgid "Use L. See L above." msgstr "" # type: =item -#: ../src/guestfs.pod:314 +#: ../src/guestfs.pod:332 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:316 +#: ../src/guestfs.pod:334 msgid "Use L. See L above." msgstr "" # type: =head2 -#: ../src/guestfs.pod:320 +#: ../src/guestfs.pod:338 msgid "LISTING FILES" msgstr "" # type: textblock -#: ../src/guestfs.pod:322 +#: ../src/guestfs.pod:340 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:343 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:346 msgid "" "L is a programmatic way to get a list of files in a " "directory, plus additional information about each one. It is more " @@ -722,18 +755,18 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:332 +#: ../src/guestfs.pod:350 msgid "" "L and L can be used to recursively list files." msgstr "" # type: =head2 -#: ../src/guestfs.pod:335 +#: ../src/guestfs.pod:353 msgid "RUNNING COMMANDS" msgstr "" # type: textblock -#: ../src/guestfs.pod:337 +#: ../src/guestfs.pod:355 msgid "" "Although libguestfs is primarily an API for manipulating files inside guest " "images, we also provide some limited facilities for running commands inside " @@ -741,114 +774,140 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:341 +#: ../src/guestfs.pod:359 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:1223 ../src/guestfs.pod:1228 -#: ../src/guestfs.pod:1232 ../src/guestfs.pod:1334 ../src/guestfs.pod:1338 -#: ../src/guestfs.pod:1342 ../src/guestfs.pod:1347 ../src/guestfs.pod:1355 -#: ../src/guestfs.pod:1374 ../src/guestfs.pod:1382 ../src/guestfs.pod:1612 -#: ../src/guestfs.pod:1618 ../src/guestfs.pod:1623 ../src/guestfs.pod:1629 -#: ../src/guestfs.pod:1736 ../src/guestfs.pod:1740 ../src/guestfs.pod:1744 -#: ../src/guestfs.pod:1748 ../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:363 ../src/guestfs.pod:368 ../src/guestfs.pod:373 +#: ../src/guestfs.pod:377 ../src/guestfs.pod:382 ../src/guestfs.pod:386 +#: ../src/guestfs.pod:391 ../src/guestfs.pod:396 ../src/guestfs.pod:955 +#: ../src/guestfs.pod:959 ../src/guestfs.pod:963 ../src/guestfs.pod:968 +#: ../src/guestfs.pod:976 ../src/guestfs.pod:995 ../src/guestfs.pod:1003 +#: ../src/guestfs.pod:1025 ../src/guestfs.pod:1029 ../src/guestfs.pod:1033 +#: ../src/guestfs.pod:1037 ../src/guestfs.pod:1041 ../src/guestfs.pod:1045 +#: ../src/guestfs.pod:1527 ../src/guestfs.pod:1532 ../src/guestfs.pod:1536 +#: ../src/guestfs.pod:1646 ../src/guestfs.pod:1651 ../src/guestfs.pod:1655 +#: ../src/guestfs.pod:2007 ../src/guestfs.pod:2013 ../src/guestfs.pod:2018 +#: ../src/guestfs.pod:2024 ../src/guestfs.pod:2136 ../src/guestfs.pod:2140 +#: ../src/guestfs.pod:2144 ../src/guestfs.pod:2148 +#: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 +#: ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:579 +#: ../src/guestfs-actions.pod:586 ../src/guestfs-actions.pod:593 +#: ../src/guestfs-actions.pod:1589 ../src/guestfs-actions.pod:1593 +#: ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:1601 +#: ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1613 +#: ../src/guestfs-actions.pod:1617 ../src/guestfs-actions.pod:1627 +#: ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1635 +#: ../src/guestfs-actions.pod:1773 ../src/guestfs-actions.pod:1777 +#: ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1787 +#: ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1852 +#: ../src/guestfs-actions.pod:1857 ../fish/guestfish.pod:377 +#: ../fish/guestfish.pod:381 ../fish/guestfish.pod:385 +#: ../fish/guestfish.pod:389 ../fish/guestfish-actions.pod:13 +#: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:375 +#: ../fish/guestfish-actions.pod:383 ../fish/guestfish-actions.pod:390 +#: ../fish/guestfish-actions.pod:397 ../fish/guestfish-actions.pod:1067 +#: ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075 +#: ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087 +#: ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095 +#: ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109 +#: ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203 +#: ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212 +#: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259 +#: ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268 +#: ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 +#: ../tools/virt-resize.pl:360 msgid "*" msgstr "" # type: textblock -#: ../src/guestfs.pod:347 +#: ../src/guestfs.pod:365 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:370 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:375 msgid "The command will be running in limited memory." msgstr "" # type: textblock -#: ../src/guestfs.pod:361 +#: ../src/guestfs.pod:379 msgid "" "The network may not be available unless you enable it (see L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:366 +#: ../src/guestfs.pod:384 msgid "Only supports Linux guests (not Windows, BSD, etc)." msgstr "" # type: textblock -#: ../src/guestfs.pod:370 +#: ../src/guestfs.pod:388 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:393 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:398 +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:407 +msgid "" +"A secure alternative is to use libguestfs to install a \"firstboot\" script " +"(a script which runs when the guest next boots normally), and to have this " +"script run the commands you want in the normal context of the running guest, " +"network security and so on. For information about other security issues, " +"see L." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:415 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:418 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:421 msgid "CONFIGURATION FILES" msgstr "" # type: textblock -#: ../src/guestfs.pod:388 +#: ../src/guestfs.pod:423 msgid "" "To read and write configuration files in Linux guest filesystems, we " "strongly recommend using Augeas. For example, Augeas understands how to " @@ -857,7 +916,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:393 +#: ../src/guestfs.pod:428 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 " @@ -865,7 +924,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:397 +#: ../src/guestfs.pod:432 msgid "" "If you don't want to use Augeas (you fool!) then try calling L to get the file as a list of lines which you can iterate " @@ -873,29 +932,29 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:401 +#: ../src/guestfs.pod:436 msgid "SELINUX" msgstr "" # type: textblock -#: ../src/guestfs.pod:403 +#: ../src/guestfs.pod:438 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:444 ../src/guestfs.pod:1148 ../src/guestfs.pod:1279 msgid "1." msgstr "" # type: textblock -#: ../src/guestfs.pod:411 +#: ../src/guestfs.pod:446 msgid "Before launching, do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:413 +#: ../src/guestfs.pod:448 #, no-wrap msgid "" " guestfs_set_selinux (g, 1);\n" @@ -903,19 +962,19 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:415 +#: ../src/guestfs.pod:450 ../src/guestfs.pod:1152 ../src/guestfs.pod:1283 msgid "2." msgstr "" # type: textblock -#: ../src/guestfs.pod:417 +#: ../src/guestfs.pod:452 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:456 #, no-wrap msgid "" " guestfs_sh (g, \"/usr/sbin/load_policy\");\n" @@ -923,26 +982,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:423 +#: ../src/guestfs.pod:458 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:461 ../src/guestfs.pod:1289 msgid "3." msgstr "" # type: textblock -#: ../src/guestfs.pod:428 +#: ../src/guestfs.pod:463 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:467 #, no-wrap msgid "" " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n" @@ -950,24 +1009,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:436 +#: ../src/guestfs.pod:471 msgid "This will work for running commands and editing existing files." msgstr "" # type: textblock -#: ../src/guestfs.pod:438 +#: ../src/guestfs.pod:473 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:477 msgid "UMASK" msgstr "" # type: textblock -#: ../src/guestfs.pod:444 +#: ../src/guestfs.pod:479 msgid "" "Certain calls are affected by the current file mode creation mask (the " "\"umask\"). In particular ones which create files or directories, such as " @@ -977,14 +1036,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:450 +#: ../src/guestfs.pod:485 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:488 msgid "" "There are two ways to avoid being affected by umask. Either set umask to 0 " "(call C early after launching). Or call L." msgstr "" # type: =head1 -#: ../src/guestfs.pod:459 ../fish/guestfish.pod:559 +#: ../src/guestfs.pod:494 ../fish/guestfish.pod:670 msgid "ENCRYPTED DISKS" msgstr "" # type: textblock -#: ../src/guestfs.pod:461 +#: ../src/guestfs.pod:496 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) " @@ -1011,21 +1070,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:467 +#: ../src/guestfs.pod:502 msgid "" "Use L to identify LUKS-encrypted block devices (it " "returns the string C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:470 +#: ../src/guestfs.pod:505 msgid "" "Then open these devices by calling L. Obviously you " "will require the passphrase!" msgstr "" # type: textblock -#: ../src/guestfs.pod:473 +#: ../src/guestfs.pod:508 msgid "" "Opening a LUKS device creates a new device mapper device called C (where C is the string you supply to L followed by L. The logical volume" @@ -1042,7 +1101,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:483 +#: ../src/guestfs.pod:518 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:536 msgid "" "Then call L. This function uses other libguestfs calls " "and certain heuristics, and returns a list of operating systems that were " @@ -1087,7 +1146,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:510 +#: ../src/guestfs.pod:545 msgid "" "For each root, you can then call various C functions " "to get additional details about that operating system. For example, call L /dev/sda1\n" @@ -1117,21 +1176,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:527 +#: ../src/guestfs.pod:562 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:565 msgid "" "Be careful to mount filesystems in the right order (eg. C before C). Sorting the keys of the hash by length, shortest first, should work." msgstr "" # type: textblock -#: ../src/guestfs.pod:534 +#: ../src/guestfs.pod:569 msgid "" "Inspection currently only works for some common operating systems. " "Contributors are welcome to send patches for other operating systems that we " @@ -1139,7 +1198,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:538 +#: ../src/guestfs.pod:573 msgid "" "Encrypted disks must be opened before inspection. See L " "for more details. The L function just ignores any " @@ -1147,29 +1206,32 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:542 +#: ../src/guestfs.pod:577 msgid "" "A note on the implementation: The call L performs " "inspection and caches the results in the guest handle. Subsequent calls to " "C return this cached information, but I re-" "read the disks. If you change the content of the guest disks, you can redo " -"inspection by calling L again." +"inspection by calling L again. (L works a little differently from the other " +"calls and does read the disks. See documentation for that function for " +"details)." msgstr "" # type: =head2 -#: ../src/guestfs.pod:549 +#: ../src/guestfs.pod:586 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:551 +#: ../src/guestfs.pod:588 msgid "" "Libguestfs can mount NTFS partitions. It does this using the L driver." msgstr "" # type: textblock -#: ../src/guestfs.pod:554 +#: ../src/guestfs.pod:591 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 " @@ -1179,7 +1241,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:560 +#: ../src/guestfs.pod:597 msgid "" "Drive letter mappings are outside the scope of libguestfs. You have to use " "libguestfs to read the appropriate Windows Registry and configuration files, " @@ -1188,21 +1250,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:565 +#: ../src/guestfs.pod:602 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:605 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:608 msgid "" "Libguestfs also provides some help for decoding Windows Registry \"hive\" " "files, through the library C which is part of the libguestfs project " @@ -1213,19 +1275,19 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:579 +#: ../src/guestfs.pod:616 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:581 +#: ../src/guestfs.pod:618 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:621 msgid "" "The API is broadly identical in all supported languages. This means that " "the C call C is C<$g-Emount($path)> in Perl, C" msgstr "" # type: textblock -#: ../src/guestfs.pod:601 +#: ../src/guestfs.pod:638 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:642 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:607 +#: ../src/guestfs.pod:644 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:647 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:612 +#: ../src/guestfs.pod:649 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 " @@ -1286,103 +1348,91 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:616 +#: ../src/guestfs.pod:653 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:618 +#: ../src/guestfs.pod:655 msgid "" "Full documentation is contained in the Javadoc which is distributed with " "libguestfs." msgstr "" # type: =item -#: ../src/guestfs.pod:621 +#: ../src/guestfs.pod:658 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:623 -msgid "For documentation see the file C." +#: ../src/guestfs.pod:660 +msgid "For documentation see L." msgstr "" # type: =item -#: ../src/guestfs.pod:625 +#: ../src/guestfs.pod:662 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:627 +#: ../src/guestfs.pod:664 msgid "For documentation see L." msgstr "" # type: =item -#: ../src/guestfs.pod:629 +#: ../src/guestfs.pod:666 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:631 +#: ../src/guestfs.pod:668 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:671 msgid "The PHP binding only works correctly on 64 bit machines." msgstr "" # type: =item -#: ../src/guestfs.pod:636 +#: ../src/guestfs.pod:673 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:638 -msgid "For documentation do:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:640 -#, no-wrap -msgid "" -" $ python\n" -" >>> import guestfs\n" -" >>> help (guestfs)\n" -"\n" +#: ../src/guestfs.pod:675 +msgid "For documentation see L." msgstr "" # type: =item -#: ../src/guestfs.pod:644 +#: ../src/guestfs.pod:677 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:646 -msgid "" -"Use the Guestfs module. There is no Ruby-specific documentation, but you " -"can find examples written in Ruby in the libguestfs source." +#: ../src/guestfs.pod:679 +msgid "For documentation see L." msgstr "" # type: =item -#: ../src/guestfs.pod:649 +#: ../src/guestfs.pod:681 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:651 +#: ../src/guestfs.pod:683 msgid "For documentation see L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:655 +#: ../src/guestfs.pod:687 msgid "LIBGUESTFS GOTCHAS" msgstr "" # type: textblock -#: ../src/guestfs.pod:657 +#: ../src/guestfs.pod:689 msgid "" "L: \"A feature of a " "system [...] that works in the way it is documented but is counterintuitive " @@ -1390,7 +1440,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:661 +#: ../src/guestfs.pod:693 msgid "" "Since we developed libguestfs and the associated tools, there are several " "things we would have designed differently, but are now stuck with for " @@ -1399,12 +1449,12 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:669 +#: ../src/guestfs.pod:701 msgid "Autosync / forgetting to sync." msgstr "" # type: textblock -#: ../src/guestfs.pod:671 +#: ../src/guestfs.pod:703 msgid "" "When modifying a filesystem from C or another language, you B unmount " "all filesystems and call L explicitly before you close the " @@ -1412,7 +1462,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:675 +#: ../src/guestfs.pod:707 #, no-wrap msgid "" " guestfs_set_autosync (g, 1);\n" @@ -1420,14 +1470,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:677 +#: ../src/guestfs.pod:709 msgid "" "to have the unmount/sync done automatically for you when the handle 'g' is " "closed. (This feature is called \"autosync\", L q.v.)" msgstr "" # type: textblock -#: ../src/guestfs.pod:681 +#: ../src/guestfs.pod:713 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 " @@ -1435,20 +1485,27 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:685 +#: ../src/guestfs.pod:717 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:721 +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:724 msgid "Mount option C<-o sync> should not be the default." msgstr "" # type: textblock -#: ../src/guestfs.pod:691 +#: ../src/guestfs.pod:726 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 " @@ -1456,31 +1513,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:695 +#: ../src/guestfs.pod:730 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:733 msgid "Read-only should be the default." msgstr "" # type: textblock -#: ../src/guestfs.pod:700 +#: ../src/guestfs.pod:735 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:738 msgid "This would reduce the potential to corrupt live VM images." msgstr "" # type: textblock -#: ../src/guestfs.pod:705 +#: ../src/guestfs.pod:740 msgid "" "Note that many filesystems change the disk when you just mount and unmount, " "even if you didn't perform any writes. You need to use L doesn't do what people expect (open C for " "examination). It tries to run a guestfish command C which doesn't " @@ -1503,12 +1560,12 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:718 +#: ../src/guestfs.pod:753 msgid "guestfish megabyte modifiers don't work right on all commands" msgstr "" # type: textblock -#: ../src/guestfs.pod:720 +#: ../src/guestfs.pod:755 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 " @@ -1518,12 +1575,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:727 +#: ../src/guestfs.pod:762 msgid "The most common is L. The guestfish command:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:729 +#: ../src/guestfs.pod:764 #, no-wrap msgid "" " lvcreate LV VG 100M\n" @@ -1531,7 +1588,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:731 +#: ../src/guestfs.pod:766 msgid "" "does not do what you might expect. Instead because L is " "already expecting megabytes, this tries to create a 100 I (100 " @@ -1540,40 +1597,82 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:736 +#: ../src/guestfs.pod:771 msgid "" "This could be fixed in the generator by specially marking parameters and " "return values which take bytes or other units." msgstr "" # type: =item -#: ../src/guestfs.pod:739 -msgid "Library should return errno with error messages." +#: ../src/guestfs.pod:774 +msgid "Ambiguity between devices and paths" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:776 +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:781 +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:787 +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:793 +#, no-wrap +msgid "" +" type path = Path of string | Device of int | Partition of int * int\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:741 +#: ../src/guestfs.pod:795 +msgid "which would allow you to pass arguments like:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:797 +#, no-wrap msgid "" -"It would be a nice-to-have to be able to get the original value of 'errno' " -"from inside the appliance along error paths (where set). Currently " -"L goes through hoops to try to reverse the error message " -"string into an errno, see the function error() in fuse/guestmount.c." +" 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:747 +#: ../src/guestfs.pod:802 msgid "" -"In libguestfs 1.5.4, the protocol was changed so that the Linux errno is " -"sent back from the daemon." +"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:807 msgid "PROTOCOL LIMITS" msgstr "" # type: textblock -#: ../src/guestfs.pod:754 +#: ../src/guestfs.pod:809 msgid "" "Internally libguestfs uses a message-based protocol to pass API calls and " "their responses to and from a small \"appliance\" (see L for " @@ -1584,7 +1683,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:762 +#: ../src/guestfs.pod:817 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 " @@ -1593,7 +1692,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:768 +#: ../src/guestfs.pod:823 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 " @@ -1601,26 +1700,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:772 +#: ../src/guestfs.pod:827 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:830 msgid "KEYS AND PASSPHRASES" msgstr "" # type: textblock -#: ../src/guestfs.pod:777 +#: ../src/guestfs.pod:832 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:835 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 " @@ -1629,7 +1728,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:785 +#: ../src/guestfs.pod:840 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, " @@ -1637,23332 +1736,25156 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:790 -msgid "CONNECTION MANAGEMENT" +#: ../src/guestfs.pod:845 +msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:792 -msgid "guestfs_h *" +# type: textblock +#: ../src/guestfs.pod:847 +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:794 +#: ../src/guestfs.pod:850 msgid "" -"C is the opaque type representing a connection handle. Create a " -"handle by calling L. Call L to free the " -"handle and release all resources used." +"Only use the handle from a single thread. Either use the handle exclusively " +"from one thread, or provide your own mutex so that two threads cannot issue " +"calls on the same handle at the same time." msgstr "" # type: textblock -#: ../src/guestfs.pod:798 +#: ../src/guestfs.pod:854 msgid "" -"For information on using multiple handles and threads, see the section L below." +"See the graphical program guestfs-browser for one possible architecture for " +"multithreaded programs using libvirt and libguestfs." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:801 -msgid "guestfs_create" +# type: =head1 +#: ../src/guestfs.pod:857 +msgid "PATH" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:803 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:859 msgid "" -" guestfs_h *guestfs_create (void);\n" -"\n" +"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " +"internal path." msgstr "" # type: textblock -#: ../src/guestfs.pod:805 -msgid "Create a connection handle." +#: ../src/guestfs.pod:862 +msgid "" +"By default it looks for these in the directory C<$libdir/guestfs> (eg. C or C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:807 -msgid "You have to call L on the handle at least once." +#: ../src/guestfs.pod:865 +msgid "" +"Use L or set the environment variable L " +"to change the directories that libguestfs will search in. The value is a " +"colon-separated list of paths. The current directory is I searched " +"unless the path contains an empty element or C<.>. For example " +"C would search the current directory and " +"then C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:809 -msgid "" -"This function returns a non-NULL pointer to a handle on success or NULL on " -"error." +# type: =head1 +#: ../src/guestfs.pod:872 +msgid "QEMU WRAPPERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:812 -msgid "After configuring the handle, you have to call L." +#: ../src/guestfs.pod:874 +msgid "" +"If you want to compile your own qemu, run qemu from a non-standard location, " +"or pass extra arguments to qemu, then you can write a shell-script wrapper " +"around qemu." msgstr "" # type: textblock -#: ../src/guestfs.pod:814 +#: ../src/guestfs.pod:878 msgid "" -"You may also want to configure error handling for the handle. See L section below." +"There is one important rule to remember: you I> as the " +"last command in the shell script (so that qemu replaces the shell and " +"becomes the direct child of the libguestfs-using program). If you don't do " +"this, then the qemu process won't be cleaned up correctly." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:817 -msgid "guestfs_close" +# type: textblock +#: ../src/guestfs.pod:883 +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:819 +#: ../src/guestfs.pod:886 #, no-wrap msgid "" -" void guestfs_close (guestfs_h *g);\n" +" #!/bin/sh -\n" +" qemudir=/home/rjones/d/qemu\n" +" exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:821 -msgid "This closes the connection handle and frees up all resources used." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:823 -msgid "ERROR HANDLING" +#: ../src/guestfs.pod:890 +msgid "" +"Save this script as C (or wherever), C, and " +"then use it by setting the LIBGUESTFS_QEMU environment variable. For " +"example:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:825 +# type: verbatim +#: ../src/guestfs.pod:894 +#, no-wrap msgid "" -"The convention in all functions that return C is that they return C<-1> " -"to indicate an error. You can get additional information on errors by " -"calling L and/or by setting up an error handler with L." +" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:830 -msgid "The default error handler prints the information string to C." +#: ../src/guestfs.pod:896 +msgid "" +"Note that libguestfs also calls qemu with the -help and -version options in " +"order to determine features." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:899 +msgid "ABI GUARANTEE" msgstr "" # type: textblock -#: ../src/guestfs.pod:832 +#: ../src/guestfs.pod:901 msgid "" -"Out of memory errors are handled differently. The default action is to call " -"L. If this is undesirable, then you can set a handler using L." +"We guarantee the libguestfs ABI (binary interface), for public, high-level " +"actions as outlined in this section. Although we will deprecate some " +"actions, for example if they get replaced by newer calls, we will keep the " +"old actions forever. This allows you the developer to program in confidence " +"against the libguestfs API." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:836 -msgid "guestfs_last_error" +# type: =head1 +#: ../src/guestfs.pod:907 +msgid "BLOCK DEVICE NAMING" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:838 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:909 msgid "" -" const char *guestfs_last_error (guestfs_h *g);\n" -"\n" +"In the kernel there is now quite a profusion of schemata for naming block " +"devices (in this context, by I I mean a physical or virtual " +"hard drive). The original Linux IDE driver used names starting with C. SCSI devices have historically used a different naming scheme, C. When the Linux kernel I driver became a popular replacement " +"for the old IDE driver (particularly for SATA devices) those devices also " +"used the C scheme. Additionally we now have virtual machines with " +"paravirtualized drivers. This has created several different naming systems, " +"such as C for virtio disks and C for Xen PV disks." msgstr "" # type: textblock -#: ../src/guestfs.pod:840 +#: ../src/guestfs.pod:921 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." +"As discussed above, libguestfs uses a qemu appliance running an embedded " +"Linux kernel to access block devices. We can run a variety of appliances " +"based on a variety of Linux kernels." msgstr "" # type: textblock -#: ../src/guestfs.pod:844 +#: ../src/guestfs.pod:925 msgid "" -"The lifetime of the returned string is until the next error occurs, or L is called." +"This causes a problem for libguestfs because many API calls use device or " +"partition names. Working scripts and the recipe (example) scripts that we " +"make available over the internet could fail if the naming scheme changes." msgstr "" # type: textblock -#: ../src/guestfs.pod:847 +#: ../src/guestfs.pod:930 msgid "" -"The error string is not localized (ie. is always in English), because this " -"makes searching for error messages in search engines give the largest number " -"of results." +"Therefore libguestfs defines C as the I. " +"Internally C names are translated, if necessary, to other names as " +"required. For example, under RHEL 5 which uses the C scheme, any " +"device parameter C is translated to C transparently." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:851 -msgid "guestfs_set_error_handler" +# type: textblock +#: ../src/guestfs.pod:936 +msgid "" +"Note that this I applies to parameters. The L, " +"L and similar calls return the true names of the " +"devices and partitions as known to the appliance." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:853 -#, no-wrap -msgid "" -" typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" -" void *opaque,\n" -" const char *msg);\n" -" void guestfs_set_error_handler (guestfs_h *g,\n" -" guestfs_error_handler_cb cb,\n" -" void *opaque);\n" -"\n" +# type: =head2 +#: ../src/guestfs.pod:941 +msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" msgstr "" # type: textblock -#: ../src/guestfs.pod:860 +#: ../src/guestfs.pod:943 msgid "" -"The callback C will be called if there is an error. The parameters " -"passed to the callback are an opaque data pointer and the error message " -"string." +"Usually this translation is transparent. However in some (very rare) cases " +"you may need to know the exact algorithm. Such cases include where you use " +"L to add a mixture of virtio and IDE devices to the qemu-" +"based appliance, so have a mixture of C and C devices." msgstr "" # type: textblock -#: ../src/guestfs.pod:864 +#: ../src/guestfs.pod:949 msgid "" -"Note that the message string C is freed as soon as the callback " -"function returns, so if you want to stash it somewhere you must make your " -"own copy." +"The algorithm is applied only to I which are known to be either " +"device or partition names. Return values from functions such as L are never changed." msgstr "" # type: textblock -#: ../src/guestfs.pod:868 -msgid "The default handler prints messages on C." +#: ../src/guestfs.pod:957 +msgid "Is the string a parameter which is a device or partition name?" msgstr "" # type: textblock -#: ../src/guestfs.pod:870 -msgid "If you set C to C then I handler is called." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:872 -msgid "guestfs_get_error_handler" +#: ../src/guestfs.pod:961 +msgid "Does the string begin with C?" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:874 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:965 msgid "" -" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" -" void **opaque_rtn);\n" -"\n" +"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:877 -msgid "Returns the current error handler callback." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:879 -msgid "guestfs_set_out_of_memory_handler" +#: ../src/guestfs.pod:970 +msgid "Replace initial C string with C." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:881 -#, no-wrap -msgid "" -" typedef void (*guestfs_abort_cb) (void);\n" -" int guestfs_set_out_of_memory_handler (guestfs_h *g,\n" -" guestfs_abort_cb);\n" -"\n" +# type: textblock +#: ../src/guestfs.pod:972 +msgid "For example, change C to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:885 -msgid "" -"The callback C will be called if there is an out of memory situation. " -"I." +#: ../src/guestfs.pod:974 +msgid "If that named device exists, use it. If not, continue." msgstr "" # type: textblock -#: ../src/guestfs.pod:888 -msgid "The default is to call L." +#: ../src/guestfs.pod:978 +msgid "Replace initial C string with C." msgstr "" # type: textblock -#: ../src/guestfs.pod:890 -msgid "" -"You cannot set C to C. You can't ignore out of memory situations." +#: ../src/guestfs.pod:980 +msgid "If that named device exists, use it. If not, return an error." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:893 -msgid "guestfs_get_out_of_memory_handler" +# type: =head3 +#: ../src/guestfs.pod:984 +msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:895 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:986 msgid "" -" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" -"\n" +"Although the standard naming scheme and automatic translation is useful for " +"simple programs and guestfish scripts, for larger programs it is best not to " +"rely on this mechanism." msgstr "" # type: textblock -#: ../src/guestfs.pod:897 -msgid "This returns the current out of memory handler." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:899 -msgid "PATH" +#: ../src/guestfs.pod:990 +msgid "" +"Where possible for maximum future portability programs using libguestfs " +"should use these future-proof techniques:" msgstr "" # type: textblock -#: ../src/guestfs.pod:901 +#: ../src/guestfs.pod:997 msgid "" -"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " -"internal path." +"Use L or L to list actual " +"device names, and then use those names directly." msgstr "" # type: textblock -#: ../src/guestfs.pod:904 +#: ../src/guestfs.pod:1000 msgid "" -"By default it looks for these in the directory C<$libdir/guestfs> (eg. C or C)." +"Since those device names exist by definition, they will never be translated." msgstr "" # type: textblock -#: ../src/guestfs.pod:907 +#: ../src/guestfs.pod:1005 msgid "" -"Use L or set the environment variable L " -"to change the directories that libguestfs will search in. The value is a " -"colon-separated list of paths. The current directory is I searched " -"unless the path contains an empty element or C<.>. For example " -"C would search the current directory and " -"then C." +"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " +"filesystem labels." msgstr "" # type: =head1 -#: ../src/guestfs.pod:914 -msgid "HIGH-LEVEL API ACTIONS" +#: ../src/guestfs.pod:1010 +msgid "SECURITY" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1012 +msgid "" +"This section discusses security implications of using libguestfs, " +"particularly with untrusted or malicious guests or disk images." msgstr "" # type: =head2 -#: ../src/guestfs.pod:916 -msgid "ABI GUARANTEE" +#: ../src/guestfs.pod:1015 +msgid "GENERAL SECURITY CONSIDERATIONS" msgstr "" # type: textblock -#: ../src/guestfs.pod:918 +#: ../src/guestfs.pod:1017 msgid "" -"We guarantee the libguestfs ABI (binary interface), for public, high-level " -"actions as outlined in this section. Although we will deprecate some " -"actions, for example if they get replaced by newer calls, we will keep the " -"old actions forever. This allows you the developer to program in confidence " -"against the libguestfs API." +"Be careful with any files or data that you download from a guest (by " +"\"download\" we mean not just the L command but any " +"command that reads files, filenames, directories or anything else from a " +"disk image). An attacker could manipulate the data to fool your program " +"into doing the wrong thing. Consider cases such as:" msgstr "" # type: textblock -#: ../src/guestfs.pod:924 ../fish/guestfish.pod:789 -msgid "@ACTIONS@" -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:926 -msgid "STRUCTURES" +#: ../src/guestfs.pod:1027 +msgid "the data (file etc) not being present" msgstr "" # type: textblock -#: ../src/guestfs.pod:928 -msgid "@STRUCTS@" +#: ../src/guestfs.pod:1031 +msgid "being present but empty" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:930 -msgid "AVAILABILITY" +# type: textblock +#: ../src/guestfs.pod:1035 +msgid "being much larger than normal" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:932 -msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" +# type: textblock +#: ../src/guestfs.pod:1039 +msgid "containing arbitrary 8 bit data" msgstr "" # type: textblock -#: ../src/guestfs.pod:934 -msgid "" -"Using L you can test availability of the following " -"groups of functions. This test queries the appliance to see if the " -"appliance you are currently using supports the functionality." +#: ../src/guestfs.pod:1043 +msgid "being in an unexpected character encoding" msgstr "" # type: textblock -#: ../src/guestfs.pod:939 -msgid "@AVAILABILITY@" +#: ../src/guestfs.pod:1047 +msgid "containing homoglyphs." msgstr "" # type: =head2 -#: ../src/guestfs.pod:941 -msgid "GUESTFISH supported COMMAND" +#: ../src/guestfs.pod:1051 +msgid "SECURITY OF MOUNTING FILESYSTEMS" msgstr "" # type: textblock -#: ../src/guestfs.pod:943 +#: ../src/guestfs.pod:1053 msgid "" -"In L there is a handy interactive command C which " -"prints out the available groups and whether they are supported by this build " -"of libguestfs. Note however that you have to do C first." +"When you mount a filesystem under Linux, mistakes in the kernel filesystem " +"(VFS) module can sometimes be escalated into exploits by deliberately " +"creating a malicious, malformed filesystem. These exploits are very severe " +"for two reasons. Firstly there are very many filesystem drivers in the " +"kernel, and many of them are infrequently used and not much developer " +"attention has been paid to the code. Linux userspace helps potential " +"crackers by detecting the filesystem type and automatically choosing the " +"right VFS driver, even if that filesystem type is obscure or unexpected for " +"the administrator. Secondly, a kernel-level exploit is like a local root " +"exploit (worse in some ways), giving immediate and total access to the " +"system right down to the hardware level." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:948 -msgid "SINGLE CALLS AT COMPILE TIME" +# type: textblock +#: ../src/guestfs.pod:1066 +msgid "" +"That explains why you should never mount a filesystem from an untrusted " +"guest on your host kernel. How about libguestfs? We run a Linux kernel " +"inside a qemu virtual machine, usually running as a non-root user. The " +"attacker would need to write a filesystem which first exploited the kernel, " +"and then exploited either qemu virtualization (eg. a faulty qemu driver) or " +"the libguestfs protocol, and finally to be as serious as the host kernel " +"exploit it would need to escalate its privileges to root. This multi-step " +"escalation, performed by a static piece of data, is thought to be extremely " +"hard to do, although we never say 'never' about security issues." msgstr "" # type: textblock -#: ../src/guestfs.pod:950 +#: ../src/guestfs.pod:1077 msgid "" -"Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " -"function, such as:" +"In any case callers can reduce the attack surface by forcing the filesystem " +"type when mounting (use L)." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:953 -#, no-wrap -msgid "" -" #define LIBGUESTFS_HAVE_DD 1\n" -"\n" +# type: =head2 +#: ../src/guestfs.pod:1080 +msgid "PROTOCOL SECURITY" msgstr "" # type: textblock -#: ../src/guestfs.pod:955 -msgid "if L is available." +#: ../src/guestfs.pod:1082 +msgid "" +"The protocol is designed to be secure, being based on RFC 4506 (XDR) with a " +"defined upper message size. However a program that uses libguestfs must " +"also take care - for example you can write a program that downloads a binary " +"from a disk image and executes it locally, and no amount of protocol " +"security will save you from the consequences." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1088 +msgid "INSPECTION SECURITY" msgstr "" # type: textblock -#: ../src/guestfs.pod:957 +#: ../src/guestfs.pod:1090 msgid "" -"Before version 1.5.8, if you needed to test whether a single libguestfs " -"function is available at compile time, we recommended using build tools such " -"as autoconf or cmake. For example in autotools you could use:" +"Parts of the inspection API (see L) return untrusted strings " +"directly from the guest, and these could contain any 8 bit data. Callers " +"should be careful to escape these before printing them to a structured file " +"(for example, use HTML escaping if creating a web page)." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:962 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:1096 msgid "" -" AC_CHECK_LIB([guestfs],[guestfs_create])\n" -" AC_CHECK_FUNCS([guestfs_dd])\n" -"\n" +"Guest configuration may be altered in unusual ways by the administrator of " +"the virtual machine, and may not reflect reality (particularly for untrusted " +"or actively malicious guests). For example we parse the hostname from " +"configuration files like C that we find in the " +"guest, but the guest administrator can easily manipulate these files to " +"provide the wrong hostname." msgstr "" # type: textblock -#: ../src/guestfs.pod:965 +#: ../src/guestfs.pod:1104 msgid "" -"which would result in C being either defined or not defined " -"in your program." +"The inspection API parses guest configuration using two external libraries: " +"Augeas (Linux configuration) and hivex (Windows Registry). Both are " +"designed to be robust in the face of malicious data, although denial of " +"service attacks are still possible, for example with oversized configuration " +"files." msgstr "" # type: =head2 -#: ../src/guestfs.pod:968 -msgid "SINGLE CALLS AT RUN TIME" +#: ../src/guestfs.pod:1110 +msgid "RUNNING UNTRUSTED GUEST COMMANDS" msgstr "" # type: textblock -#: ../src/guestfs.pod:970 +#: ../src/guestfs.pod:1112 msgid "" -"Testing at compile time doesn't guarantee that a function really exists in " -"the library. The reason is that you might be dynamically linked against a " -"previous I (dynamic library) which doesn't have the call. " -"This situation unfortunately results in a segmentation fault, which is a " -"shortcoming of the C dynamic linking system itself." +"Be very cautious about running commands from the guest. By running a " +"command in the guest, you are giving CPU time to a binary that you do not " +"control, under the same user account as the library, albeit wrapped in qemu " +"virtualization. More information and alternatives can be found in the " +"section L." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1118 +msgid "CVE-2010-3851" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1120 +msgid "https://bugzilla.redhat.com/642934" msgstr "" # type: textblock -#: ../src/guestfs.pod:977 +#: ../src/guestfs.pod:1122 msgid "" -"You can use L to test if a function is available at run time, as " -"in this example program (note that you still need the compile time check as " -"well):" +"This security bug concerns the automatic disk format detection that qemu " +"does on disk images." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:981 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:1125 msgid "" -" #include \n" -" #include \n" -" #include \n" -" #include \n" -" #include \n" -" \n" +"A raw disk image is just the raw bytes, there is no header. Other disk " +"images like qcow2 contain a special header. Qemu deals with this by looking " +"for one of the known headers, and if none is found then assuming the disk " +"image must be raw." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:987 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:1130 msgid "" -" main ()\n" -" {\n" -" #ifdef LIBGUESTFS_HAVE_DD\n" -" void *dl;\n" -" int has_function;\n" -" \n" +"This allows a guest which has been given a raw disk image to write some " +"other header. At next boot (or when the disk image is accessed by " +"libguestfs) qemu would do autodetection and think the disk image format was, " +"say, qcow2 based on the header written by the guest." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:993 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:1135 msgid "" -" /* Test if the function guestfs_dd is really available. */\n" -" dl = dlopen (NULL, RTLD_LAZY);\n" -" if (!dl) {\n" -" fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n" -" exit (EXIT_FAILURE);\n" -" }\n" -" has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n" -" dlclose (dl);\n" -" \n" +"This in itself would not be a problem, but qcow2 offers many features, one " +"of which is to allow a disk image to refer to another image (called the " +"\"backing disk\"). It does this by placing the path to the backing disk " +"into the qcow2 header. This path is not validated and could point to any " +"host file (eg. \"/etc/passwd\"). The backing disk is then exposed through " +"\"holes\" in the qcow2 disk image, which of course is completely under the " +"control of the attacker." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1002 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:1143 msgid "" -" if (!has_function)\n" -" printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n" -" else {\n" -" printf (\"this libguestfs.so has guestfs_dd function\\n\");\n" -" /* Now it's safe to call\n" -" guestfs_dd (g, \"foo\", \"bar\");\n" -" */\n" -" }\n" -" #else\n" -" printf (\"guestfs_dd function was not found at compile time\\n\");\n" -" #endif\n" -" }\n" -"\n" +"In libguestfs this is rather hard to exploit except under two circumstances:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1015 +#: ../src/guestfs.pod:1150 +msgid "You have enabled the network or have opened the disk in write mode." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1154 msgid "" -"You may think the above is an awful lot of hassle, and it is. There are " -"other ways outside of the C linking system to ensure that this kind of " -"incompatibility never arises, such as using package versioning:" +"You are also running untrusted code from the guest (see L)." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1020 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:1159 msgid "" -" Requires: libguestfs >= 1.0.80\n" -"\n" +"The way to avoid this is to specify the expected disk format when adding " +"disks (the optional C option to L). You " +"should always do this if the disk is raw format, and it's a good idea for " +"other cases too." msgstr "" -# type: =end -#: ../src/guestfs.pod:1022 ../src/guestfs.pod:1027 -msgid "html" +# type: textblock +#: ../src/guestfs.pod:1164 +msgid "" +"For disks added from libvirt using calls like L, the " +"format is fetched from libvirt and passed through." msgstr "" # type: textblock -#: ../src/guestfs.pod:1024 +#: ../src/guestfs.pod:1167 msgid "" -" " +"For libguestfs tools, use the I<--format> command line parameter as " +"appropriate." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1029 -msgid "ARCHITECTURE" +#: ../src/guestfs.pod:1170 +msgid "CONNECTION MANAGEMENT" +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1172 +msgid "guestfs_h *" msgstr "" # type: textblock -#: ../src/guestfs.pod:1031 +#: ../src/guestfs.pod:1174 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." +"C is the opaque type representing a connection handle. Create a " +"handle by calling L. Call L to free the " +"handle and release all resources used." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1178 +msgid "" +"For information on using multiple handles and threads, see the section L below." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1181 +msgid "guestfs_create" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1035 +#: ../src/guestfs.pod:1183 #, 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_h *guestfs_create (void);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1055 -msgid "" -"The library, linked to the main program, creates the child process and hence " -"the appliance in the L function." +#: ../src/guestfs.pod:1185 +msgid "Create a connection handle." msgstr "" # type: textblock -#: ../src/guestfs.pod:1058 +#: ../src/guestfs.pod:1187 msgid "" -"Inside the appliance is a Linux kernel and a complete stack of userspace " -"tools (such as LVM and ext2 programs) and a small controlling daemon called " -"L. The library talks to L using remote procedure " -"calls (RPC). There is a mostly one-to-one correspondence between libguestfs " -"API calls and RPC calls to the daemon. Lastly the disk image(s) are " -"attached to the qemu process which translates device access by the " -"appliance's Linux kernel into accesses to the image." +"You have to call L (or one of the equivalent calls) " +"on the handle at least once." msgstr "" # type: textblock -#: ../src/guestfs.pod:1067 +#: ../src/guestfs.pod:1190 msgid "" -"A common misunderstanding is that the appliance \"is\" the virtual machine. " -"Although the disk image you are attached to might also be used by some " -"virtual machine, libguestfs doesn't know or care about this. (But you will " -"care if both libguestfs's qemu process and your virtual machine are trying " -"to update the disk image at the same time, since these usually results in " -"massive disk corruption)." +"This function returns a non-NULL pointer to a handle on success or NULL on " +"error." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1074 -msgid "STATE MACHINE" +# type: textblock +#: ../src/guestfs.pod:1193 +msgid "After configuring the handle, you have to call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1076 -msgid "libguestfs uses a state machine to model the child process:" +#: ../src/guestfs.pod:1195 +msgid "" +"You may also want to configure error handling for the handle. See L section below." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1198 +msgid "guestfs_close" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1078 +#: ../src/guestfs.pod:1200 #, no-wrap msgid "" -" |\n" -" guestfs_create\n" -" |\n" -" |\n" -" ____V_____\n" -" / \\\n" -" | CONFIG |\n" -" \\__________/\n" -" ^ ^ ^ \\\n" -" / | \\ \\ guestfs_launch\n" -" / | _\\__V______\n" -" / | / \\\n" -" / | | LAUNCHING |\n" -" / | \\___________/\n" -" / | /\n" -" / | guestfs_launch\n" -" / | /\n" -" ______ / __|____V\n" -" / \\ ------> / \\\n" -" | BUSY | | READY |\n" -" \\______/ <------ \\________/\n" +" void guestfs_close (guestfs_h *g);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1100 -msgid "" -"The normal transitions are (1) CONFIG (when the handle is created, but there " -"is no child process), (2) LAUNCHING (when the child process is booting up), " -"(3) alternating between READY and BUSY as commands are issued to, and " -"carried out by, the child process." +#: ../src/guestfs.pod:1202 +msgid "This closes the connection handle and frees up all resources used." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1105 -msgid "" -"The guest may be killed by L, or may die " -"asynchronously at any time (eg. due to some internal error), and that causes " -"the state to transition back to CONFIG." +# type: =head1 +#: ../src/guestfs.pod:1204 +msgid "ERROR HANDLING" msgstr "" # type: textblock -#: ../src/guestfs.pod:1109 +#: ../src/guestfs.pod:1206 msgid "" -"Configuration commands for qemu such as L can only be " -"issued when in the CONFIG state." +"API functions can return errors. For example, almost all functions that " +"return C will return C<-1> to indicate an error." msgstr "" # type: textblock -#: ../src/guestfs.pod:1112 +#: ../src/guestfs.pod:1209 msgid "" -"The API offers one call that goes from CONFIG through LAUNCHING to READY. " -"L blocks until the child process is READY to accept " -"commands (or until some failure or timeout). L internally " -"moves the state from CONFIG to LAUNCHING while it is running." +"Additional information is available for errors: an error message string and " +"optionally an error number (errno) if the thing that failed was a system " +"call." msgstr "" # type: textblock -#: ../src/guestfs.pod:1118 +#: ../src/guestfs.pod:1213 msgid "" -"API actions such as L can only be issued when in the READY " -"state. These API calls block waiting for the command to be carried out (ie. " -"the state to transition to BUSY and then back to READY). There are no non-" -"blocking versions, and no way to issue more than one command per handle at " -"the same time." +"You can get at the additional information about the last error on the handle " +"by calling L, L, and/or by setting " +"up an error handler with L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1124 +#: ../src/guestfs.pod:1218 msgid "" -"Finally, the child process sends asynchronous messages back to the main " -"program, such as kernel log messages. You can register a callback to " -"receive these messages." +"When the handle is created, a default error handler is installed which " +"prints the error message string to C. For small short-running " +"command line programs it is sufficient to do:" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1128 -msgid "SETTING CALLBACKS TO HANDLE EVENTS" +# type: verbatim +#: ../src/guestfs.pod:1222 +#, no-wrap +msgid "" +" if (guestfs_launch (g) == -1)\n" +" exit (EXIT_FAILURE);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1130 +#: ../src/guestfs.pod:1225 msgid "" -"The child process generates events in some situations. Current events " -"include: receiving a log message, the child process exits." +"since the default error handler will ensure that an error message has been " +"printed to C before the program exits." msgstr "" # type: textblock -#: ../src/guestfs.pod:1133 +#: ../src/guestfs.pod:1228 msgid "" -"Use the C functions to set a callback for different " -"types of events." +"For other programs the caller will almost certainly want to install an " +"alternate error handler or do error handling in-line like this:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1136 +# type: verbatim +#: ../src/guestfs.pod:1231 +#, no-wrap msgid "" -"Only I can be registered for each handle. " -"Calling C again overwrites the previous callback of " -"that type. Cancel all callbacks of this type by calling this function with " -"C set to C." +" g = guestfs_create ();\n" +" \n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1141 -msgid "guestfs_set_log_message_callback" +# type: verbatim +#: ../src/guestfs.pod:1233 +#, no-wrap +msgid "" +" /* This disables the default behaviour of printing errors\n" +" on stderr. */\n" +" guestfs_set_error_handler (g, NULL, NULL);\n" +" \n" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1143 +#: ../src/guestfs.pod:1237 #, no-wrap msgid "" -" typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n" -" char *buf, int len);\n" -" void guestfs_set_log_message_callback (guestfs_h *g,\n" -" guestfs_log_message_cb cb,\n" -" void *opaque);\n" +" if (guestfs_launch (g) == -1) {\n" +" /* Examine the error message and print it etc. */\n" +" char *msg = guestfs_last_error (g);\n" +" int errnum = guestfs_last_errno (g);\n" +" fprintf (stderr, \"%s\\n\", msg);\n" +" /* ... */\n" +" }\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1149 +#: ../src/guestfs.pod:1245 msgid "" -"The callback function C will be called whenever qemu or the guest writes " -"anything to the console." +"Out of memory errors are handled differently. The default action is to call " +"L. If this is undesirable, then you can set a handler using L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1152 -msgid "Use this function to capture kernel messages and similar." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1154 -msgid "" -"Normally there is no log message handler, and log messages are just " -"discarded." +#: ../src/guestfs.pod:1249 +msgid "" +"L returns C if the handle cannot be created, and " +"because there is no handle if this happens there is no way to get additional " +"error information. However L is supposed to be a " +"lightweight operation which can only fail because of insufficient memory (it " +"returns NULL in this case)." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1157 -msgid "guestfs_set_subprocess_quit_callback" +#: ../src/guestfs.pod:1255 +msgid "guestfs_last_error" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1159 +#: ../src/guestfs.pod:1257 #, no-wrap msgid "" -" typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n" -" void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n" -" guestfs_subprocess_quit_cb cb,\n" -" void *opaque);\n" +" const char *guestfs_last_error (guestfs_h *g);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1164 +#: ../src/guestfs.pod:1259 msgid "" -"The callback function C will be called when the child process quits, " -"either asynchronously or if killed by L. (This " -"corresponds to a transition from any state to the CONFIG state)." +"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:1263 +msgid "" +"The lifetime of the returned string is until the next error occurs, or L is called." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1169 -msgid "guestfs_set_launch_done_callback" +#: ../src/guestfs.pod:1266 +msgid "guestfs_last_errno" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1171 +#: ../src/guestfs.pod:1268 #, no-wrap msgid "" -" typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n" -" void guestfs_set_launch_done_callback (guestfs_h *g,\n" -" guestfs_launch_done_cb cb,\n" -" void *opaque);\n" +" int guestfs_last_errno (guestfs_h *g);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1176 +#: ../src/guestfs.pod:1270 +msgid "This returns the last error number (errno) that happened on C." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1272 +msgid "If successful, an errno integer not equal to zero is returned." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1274 msgid "" -"The callback function C will be called when the child process becomes " -"ready first time after it has been launched. (This corresponds to a " -"transition from LAUNCHING to the READY state)." +"If no error, this returns 0. This call can return 0 in three situations:" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1180 -msgid "guestfs_set_close_callback" +# type: textblock +#: ../src/guestfs.pod:1281 +msgid "There has not been any error on the handle." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1182 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:1285 msgid "" -" typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n" -" void guestfs_set_close_callback (guestfs_h *g,\n" -" guestfs_close_cb cb,\n" -" void *opaque);\n" -"\n" +"There has been an error but the errno was meaningless. This corresponds to " +"the case where the error did not come from a failed system call, but for " +"some other reason." msgstr "" # type: textblock -#: ../src/guestfs.pod:1187 +#: ../src/guestfs.pod:1291 msgid "" -"The callback function C will be called while the handle is being closed " -"(synchronously from L)." +"There was an error from a failed system call, but for some reason the errno " +"was not captured and returned. This usually indicates a bug in libguestfs." msgstr "" # type: textblock -#: ../src/guestfs.pod:1190 +#: ../src/guestfs.pod:1297 msgid "" -"Note that libguestfs installs an L handler to try to clean up " -"handles that are open when the program exits. This means that this callback " -"might be called indirectly from L, which can cause unexpected " -"problems in higher-level languages (eg. if your HLL interpreter has already " -"been cleaned up by the time this is called, and if your callback then jumps " -"into some HLL function)." +"Libguestfs tries to convert the errno from inside the applicance into a " +"corresponding errno for the caller (not entirely trivial: the appliance " +"might be running a completely different operating system from the library " +"and error numbers are not standardized across Un*xen). If this could not be " +"done, then the error is translated to C. In practice this should " +"only happen in very rare circumstances." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1198 -msgid "guestfs_set_progress_callback" +#: ../src/guestfs.pod:1305 +msgid "guestfs_set_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1200 +#: ../src/guestfs.pod:1307 #, no-wrap msgid "" -" typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n" -" int proc_nr, int serial,\n" -" uint64_t position, uint64_t total);\n" -" void guestfs_set_progress_callback (guestfs_h *g,\n" -" guestfs_progress_cb cb,\n" -" void *opaque);\n" +" typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" +" void *opaque,\n" +" const char *msg);\n" +" void guestfs_set_error_handler (guestfs_h *g,\n" +" guestfs_error_handler_cb cb,\n" +" void *opaque);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1207 +#: ../src/guestfs.pod:1314 msgid "" -"Some long-running operations can generate progress messages. If this " -"callback is registered, then it will be called each time a progress message " -"is generated (usually two seconds after the operation started, and three " -"times per second thereafter until it completes, although the frequency may " -"change in future versions)." +"The callback C will be called if there is an error. The parameters " +"passed to the callback are an opaque data pointer and the error message " +"string." msgstr "" # type: textblock -#: ../src/guestfs.pod:1213 +#: ../src/guestfs.pod:1318 msgid "" -"The callback receives two numbers: C and C. The units of " -"C are not defined, although for some operations C may relate " -"in some way to the amount of data to be transferred (eg. in bytes or " -"megabytes), and C may be the portion which has been transferred." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1219 -msgid "The only defined and stable parts of the API are:" +"C is not passed to the callback. To get that the callback must call " +"L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1225 +#: ../src/guestfs.pod:1321 msgid "" -"The callback can display to the user some type of progress bar or indicator " -"which shows the ratio of C:C." +"Note that the message string C is freed as soon as the callback " +"function returns, so if you want to stash it somewhere you must make your " +"own copy." msgstr "" # type: textblock -#: ../src/guestfs.pod:1230 -msgid "0 E= C E= C" +#: ../src/guestfs.pod:1325 +msgid "The default handler prints messages on C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1234 -msgid "" -"If any progress notification is sent during a call, then a final progress " -"notification is always sent when C = C." +#: ../src/guestfs.pod:1327 +msgid "If you set C to C then I handler is called." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1237 -msgid "" -"This is to simplify caller code, so callers can easily set the progress " -"indicator to \"100%\" at the end of the operation, without requiring special " -"code to detect this case." +# type: =head2 +#: ../src/guestfs.pod:1329 +msgid "guestfs_get_error_handler" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1243 +# type: verbatim +#: ../src/guestfs.pod:1331 +#, no-wrap msgid "" -"The callback also receives the procedure number and serial number of the " -"call. These are only useful for debugging protocol issues, and the callback " -"can normally ignore them. The callback may want to print these numbers in " -"error messages or debugging messages." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1248 -msgid "PRIVATE DATA AREA" +" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" +" void **opaque_rtn);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1250 -msgid "" -"You can attach named pieces of private data to the libguestfs handle, and " -"fetch them by name for the lifetime of the handle. This is called the " -"private data area and is only available from the C API." +#: ../src/guestfs.pod:1334 +msgid "Returns the current error handler callback." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1254 -msgid "To attach a named piece of data, use the following call:" +# type: =head2 +#: ../src/guestfs.pod:1336 +msgid "guestfs_set_out_of_memory_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1256 +#: ../src/guestfs.pod:1338 #, no-wrap msgid "" -" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" +" typedef void (*guestfs_abort_cb) (void);\n" +" int guestfs_set_out_of_memory_handler (guestfs_h *g,\n" +" guestfs_abort_cb);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1258 +#: ../src/guestfs.pod:1342 msgid "" -"C is the name to associate with this data, and C is an arbitrary " -"pointer (which can be C). Any previous item with the same name is " -"overwritten." +"The callback C will be called if there is an out of memory situation. " +"I." msgstr "" # type: textblock -#: ../src/guestfs.pod:1262 -msgid "" -"You can use any C you want, but names beginning with an underscore " -"character are reserved for internal libguestfs purposes (for implementing " -"language bindings). It is recommended to prefix the name with some unique " -"string to avoid collisions with other users." +#: ../src/guestfs.pod:1345 +msgid "The default is to call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1267 -msgid "To retrieve the pointer, use:" +#: ../src/guestfs.pod:1347 +msgid "" +"You cannot set C to C. You can't ignore out of memory situations." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1350 +msgid "guestfs_get_out_of_memory_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1269 +#: ../src/guestfs.pod:1352 #, no-wrap msgid "" -" void *guestfs_get_private (guestfs_h *g, const char *key);\n" +" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1271 -msgid "" -"This function returns C if either no data is found associated with " -"C, or if the user previously set the C's C pointer to " -"C." +#: ../src/guestfs.pod:1354 +msgid "This returns the current out of memory handler." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1275 -msgid "" -"Libguestfs does not try to look at or interpret the C pointer in any " -"way. As far as libguestfs is concerned, it need not be a valid pointer at " -"all. In particular, libguestfs does I try to free the data when the " -"handle is closed. If the data must be freed, then the caller must either " -"free it before calling L or must set up a close callback to " -"do it (see L, and note that only one callback " -"can be registered for a handle)." +# type: =head1 +#: ../src/guestfs.pod:1356 +msgid "API CALLS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1283 -msgid "" -"The private data area is implemented using a hash table, and should be " -"reasonably efficient for moderate numbers of keys." +#: ../src/guestfs.pod:1358 ../fish/guestfish.pod:908 +msgid "@ACTIONS@" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1286 -msgid "BLOCK DEVICE NAMING" +#: ../src/guestfs.pod:1360 +msgid "STRUCTURES" msgstr "" # type: textblock -#: ../src/guestfs.pod:1288 -msgid "" -"In the kernel there is now quite a profusion of schemata for naming block " -"devices (in this context, by I I mean a physical or virtual " -"hard drive). The original Linux IDE driver used names starting with C. SCSI devices have historically used a different naming scheme, C. When the Linux kernel I driver became a popular replacement " -"for the old IDE driver (particularly for SATA devices) those devices also " -"used the C scheme. Additionally we now have virtual machines with " -"paravirtualized drivers. This has created several different naming systems, " -"such as C for virtio disks and C for Xen PV disks." +#: ../src/guestfs.pod:1362 +msgid "@STRUCTS@" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1300 -msgid "" -"As discussed above, libguestfs uses a qemu appliance running an embedded " -"Linux kernel to access block devices. We can run a variety of appliances " -"based on a variety of Linux kernels." +# type: =head1 +#: ../src/guestfs.pod:1364 +msgid "AVAILABILITY" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1304 -msgid "" -"This causes a problem for libguestfs because many API calls use device or " -"partition names. Working scripts and the recipe (example) scripts that we " -"make available over the internet could fail if the naming scheme changes." +# type: =head2 +#: ../src/guestfs.pod:1366 +msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1309 +#: ../src/guestfs.pod:1368 msgid "" -"Therefore libguestfs defines C as the I. " -"Internally C names are translated, if necessary, to other names as " -"required. For example, under RHEL 5 which uses the C scheme, any " -"device parameter C is translated to C transparently." +"Using L you can test availability of the following " +"groups of functions. This test queries the appliance to see if the " +"appliance you are currently using supports the functionality." msgstr "" # type: textblock -#: ../src/guestfs.pod:1315 -msgid "" -"Note that this I applies to parameters. The L, " -"L and similar calls return the true names of the " -"devices and partitions as known to the appliance." +#: ../src/guestfs.pod:1373 +msgid "@AVAILABILITY@" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1320 -msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" +#: ../src/guestfs.pod:1375 +msgid "GUESTFISH supported COMMAND" msgstr "" # type: textblock -#: ../src/guestfs.pod:1322 +#: ../src/guestfs.pod:1377 msgid "" -"Usually this translation is transparent. However in some (very rare) cases " -"you may need to know the exact algorithm. Such cases include where you use " -"L to add a mixture of virtio and IDE devices to the qemu-" -"based appliance, so have a mixture of C and C devices." +"In L there is a handy interactive command C which " +"prints out the available groups and whether they are supported by this build " +"of libguestfs. Note however that you have to do C first." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1328 -msgid "" -"The algorithm is applied only to I which are known to be either " -"device or partition names. Return values from functions such as L are never changed." +# type: =head2 +#: ../src/guestfs.pod:1382 +msgid "SINGLE CALLS AT COMPILE TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:1336 -msgid "Is the string a parameter which is a device or partition name?" +#: ../src/guestfs.pod:1384 +msgid "" +"Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " +"function, such as:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1340 -msgid "Does the string begin with C?" +# type: verbatim +#: ../src/guestfs.pod:1387 +#, no-wrap +msgid "" +" #define LIBGUESTFS_HAVE_DD 1\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1344 -msgid "" -"Does the named device exist? If so, we use that device. However if I " -"then we continue with this algorithm." +#: ../src/guestfs.pod:1389 +msgid "if L is available." msgstr "" # type: textblock -#: ../src/guestfs.pod:1349 -msgid "Replace initial C string with C." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1351 -msgid "For example, change C to C." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1353 -msgid "If that named device exists, use it. If not, continue." +#: ../src/guestfs.pod:1391 +msgid "" +"Before version 1.5.8, if you needed to test whether a single libguestfs " +"function is available at compile time, we recommended using build tools such " +"as autoconf or cmake. For example in autotools you could use:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1357 -msgid "Replace initial C string with C." +# type: verbatim +#: ../src/guestfs.pod:1396 +#, no-wrap +msgid "" +" AC_CHECK_LIB([guestfs],[guestfs_create])\n" +" AC_CHECK_FUNCS([guestfs_dd])\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1359 -msgid "If that named device exists, use it. If not, return an error." +#: ../src/guestfs.pod:1399 +msgid "" +"which would result in C being either defined or not defined " +"in your program." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1363 -msgid "PORTABILITY CONCERNS" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1365 -msgid "" -"Although the standard naming scheme and automatic translation is useful for " -"simple programs and guestfish scripts, for larger programs it is best not to " -"rely on this mechanism." +#: ../src/guestfs.pod:1402 +msgid "SINGLE CALLS AT RUN TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:1369 +#: ../src/guestfs.pod:1404 msgid "" -"Where possible for maximum future portability programs using libguestfs " -"should use these future-proof techniques:" +"Testing at compile time doesn't guarantee that a function really exists in " +"the library. The reason is that you might be dynamically linked against a " +"previous I (dynamic library) which doesn't have the call. " +"This situation unfortunately results in a segmentation fault, which is a " +"shortcoming of the C dynamic linking system itself." msgstr "" # type: textblock -#: ../src/guestfs.pod:1376 +#: ../src/guestfs.pod:1411 msgid "" -"Use L or L to list actual " -"device names, and then use those names directly." +"You can use L to test if a function is available at run time, as " +"in this example program (note that you still need the compile time check as " +"well):" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1379 +# type: verbatim +#: ../src/guestfs.pod:1415 +#, no-wrap msgid "" -"Since those device names exist by definition, they will never be translated." +" #include \n" +" #include \n" +" #include \n" +" #include \n" +" #include \n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1384 +# type: verbatim +#: ../src/guestfs.pod:1421 +#, no-wrap msgid "" -"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " -"filesystem labels." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1389 -msgid "INTERNALS" -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1391 -msgid "COMMUNICATION PROTOCOL" +" main ()\n" +" {\n" +" #ifdef LIBGUESTFS_HAVE_DD\n" +" void *dl;\n" +" int has_function;\n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1393 +# type: verbatim +#: ../src/guestfs.pod:1427 +#, no-wrap msgid "" -"Don't rely on using this protocol directly. This section documents how it " -"currently works, but it may change at any time." +" /* Test if the function guestfs_dd is really available. */\n" +" dl = dlopen (NULL, RTLD_LAZY);\n" +" if (!dl) {\n" +" fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n" +" exit (EXIT_FAILURE);\n" +" }\n" +" has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n" +" dlclose (dl);\n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1396 +# type: verbatim +#: ../src/guestfs.pod:1436 +#, no-wrap msgid "" -"The protocol used to talk between the library and the daemon running inside " -"the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC " -"1014, RFC 1832, RFC 4506)." +" if (!has_function)\n" +" printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n" +" else {\n" +" printf (\"this libguestfs.so has guestfs_dd function\\n\");\n" +" /* Now it's safe to call\n" +" guestfs_dd (g, \"foo\", \"bar\");\n" +" */\n" +" }\n" +" #else\n" +" printf (\"guestfs_dd function was not found at compile time\\n\");\n" +" #endif\n" +" }\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1400 +#: ../src/guestfs.pod:1449 msgid "" -"The detailed format of structures is in C (note: " -"this file is automatically generated)." +"You may think the above is an awful lot of hassle, and it is. There are " +"other ways outside of the C linking system to ensure that this kind of " +"incompatibility never arises, such as using package versioning:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1403 +# type: verbatim +#: ../src/guestfs.pod:1454 +#, no-wrap msgid "" -"There are two broad cases, ordinary functions that don't have any C " -"and C parameters, which are handled with very simple request/reply " -"messages. Then there are functions that have any C or C " -"parameters, which use the same request and reply messages, but they may also " -"be followed by files sent using a chunked encoding." +" Requires: libguestfs >= 1.0.80\n" +"\n" msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1410 -msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" +# type: =head1 +#: ../src/guestfs.pod:1456 +msgid "CALLS WITH OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1412 -msgid "For ordinary functions, the request message is:" +#: ../src/guestfs.pod:1458 +msgid "" +"A recent feature of the API is the introduction of calls which take optional " +"arguments. In C these are declared 3 ways. The main way is as a call which " +"takes variable arguments (ie. C<...>), as in this example:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1414 +#: ../src/guestfs.pod:1463 #, no-wrap msgid "" -" total length (header + arguments,\n" -" but not including the length word itself)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs__args (encoded as XDR)\n" +" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1419 +#: ../src/guestfs.pod:1465 msgid "" -"The total length field allows the daemon to allocate a fixed size buffer " -"into which it slurps the rest of the message. As a result, the total length " -"is limited to C bytes (currently 4MB), which means the " -"effective size of any request is limited to somewhere under this size." +"Call this with a list of optional arguments, terminated by C<-1>. So to " +"call with no optional arguments specified:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1425 +# type: verbatim +#: ../src/guestfs.pod:1468 +#, no-wrap msgid "" -"Note also that many functions don't take any arguments, in which case the " -"C_args> is completely omitted." +" guestfs_add_drive_opts (g, filename, -1);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1428 +#: ../src/guestfs.pod:1470 +msgid "With a single optional argument:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1472 +#, no-wrap 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." +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" +" -1);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1432 -msgid "The reply message for ordinary functions is:" +#: ../src/guestfs.pod:1476 +msgid "With two:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1434 +#: ../src/guestfs.pod:1478 #, no-wrap msgid "" -" total length (header + ret,\n" -" but not including the length word itself)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs__ret (encoded as XDR)\n" +" 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:1439 +#: ../src/guestfs.pod:1483 msgid "" -"As above the C_ret> structure may be completely omitted for " -"functions that return no formal return values." +"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " +"happen!" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1442 -msgid "" -"As above the total length of the reply is limited to C." +# type: =head2 +#: ../src/guestfs.pod:1486 +msgid "USING va_list FOR OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1445 +#: ../src/guestfs.pod:1488 msgid "" -"In the case of an error, a flag is set in the header, and the reply message " -"is slightly changed:" +"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:1448 +#: ../src/guestfs.pod:1492 #, no-wrap msgid "" -" total length (header + error,\n" -" but not including the length word itself)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs_message_error (encoded as XDR)\n" +" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" +" va_list args);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1453 -msgid "" -"The C structure contains the error message as a " -"string." -msgstr "" - -# type: =head3 -#: ../src/guestfs.pod:1456 -msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" +# type: =head2 +#: ../src/guestfs.pod:1495 +msgid "CONSTRUCTING OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1458 +#: ../src/guestfs.pod:1497 msgid "" -"A C parameter indicates that we transfer a file I the guest. " -"The normal request message is sent (see above). However this is followed by " -"a sequence of file chunks." +"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:1462 +#: ../src/guestfs.pod:1503 #, no-wrap msgid "" -" total length (header + arguments,\n" -" but not including the length word itself,\n" -" and not including the chunks)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs__args (encoded as XDR)\n" -" sequence of chunks for FileIn param #0\n" -" sequence of chunks for FileIn param #1 etc.\n" +" 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:1470 -msgid "The \"sequence of chunks\" is:" +#: ../src/guestfs.pod:1512 +msgid "You could call it like this:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1472 +#: ../src/guestfs.pod:1514 #, no-wrap msgid "" -" length of chunk (not including length word itself)\n" -" struct guestfs_chunk (encoded as XDR)\n" -" length of chunk\n" -" struct guestfs_chunk (encoded as XDR)\n" -" ...\n" -" length of chunk\n" -" struct guestfs_chunk (with data.data_len == 0)\n" -"\n" +" 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: textblock -#: ../src/guestfs.pod:1480 +# type: verbatim +#: ../src/guestfs.pod:1521 +#, no-wrap msgid "" -"The final chunk has the C field set to zero. Additionally a flag " -"is set in the final chunk to indicate either successful completion or early " -"cancellation." +" guestfs_add_drive_opts_argv (g, filename, &optargs);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1484 -msgid "" -"At time of writing there are no functions that have more than one FileIn " -"parameter. However this is (theoretically) supported, by sending the " -"sequence of chunks for each FileIn parameter one after another (from left to " -"right)." +#: ../src/guestfs.pod:1523 ../src/guestfs-actions.pod:11 +#: ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:9 +#: ../fish/guestfish-actions.pod:1255 +msgid "Notes:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1489 -msgid "" -"Both the library (sender) I the daemon (receiver) may cancel the " -"transfer. The library does this by sending a chunk with a special flag set " -"to indicate cancellation. When the daemon sees this, it cancels the whole " -"RPC, does I send any reply, and goes back to reading the next request." +#: ../src/guestfs.pod:1529 +msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." msgstr "" # type: textblock -#: ../src/guestfs.pod:1495 -msgid "" -"The daemon may also cancel. It does this by writing a special word " -"C to the socket. The library listens for this during " -"the transfer, and if it gets it, it will cancel the transfer (it sends a " -"cancel chunk). The special word is chosen so that even if cancellation " -"happens right at the end of the transfer (after the library has finished " -"writing and has started listening for the reply), the \"spurious\" cancel " -"flag will not be confused with the reply message." +#: ../src/guestfs.pod:1534 +msgid "You do not need to fill in all fields of the structure." msgstr "" # type: textblock -#: ../src/guestfs.pod:1504 +#: ../src/guestfs.pod:1538 msgid "" -"This protocol allows the transfer of arbitrary sized files (no 32 bit " -"limit), and also files where the size is not known in advance (eg. from " -"pipes or sockets). However the chunks are rather small " -"(C), so that neither the library nor the daemon need " -"to keep much in memory." +"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: =head3 -#: ../src/guestfs.pod:1510 -msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" +# type: =head2 +#: ../src/guestfs.pod:1543 +msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:1512 +#: ../src/guestfs.pod:1545 msgid "" -"The protocol for FileOut parameters is exactly the same as for FileIn " -"parameters, but with the roles of daemon and library reversed." +"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: verbatim -#: ../src/guestfs.pod:1515 -#, no-wrap -msgid "" -" total length (header + ret,\n" -" but not including the length word itself,\n" -" and not including the chunks)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs__ret (encoded as XDR)\n" -" sequence of chunks for FileOut param #0\n" -" sequence of chunks for FileOut param #1 etc.\n" -"\n" +# type: textblock +#: ../src/guestfs.pod:1549 +msgid "For guestfish, see L." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1523 -msgid "INITIAL MESSAGE" +# type: =head2 +#: ../src/guestfs.pod:1551 +msgid "SETTING CALLBACKS TO HANDLE EVENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1525 +#: ../src/guestfs.pod:1553 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:1529 -msgid "PROGRESS NOTIFICATION MESSAGES" +"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:1531 +#: ../src/guestfs.pod:1556 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." +"Use the C functions to set a callback for different " +"types of events." msgstr "" # type: textblock -#: ../src/guestfs.pod:1535 +#: ../src/guestfs.pod:1559 msgid "" -"The library turns them into progress callbacks (see " -"C) if there is a callback registered, or " -"discards them if not." +"Only I can be registered for each handle. " +"Calling C again overwrites the previous callback of " +"that type. Cancel all callbacks of this type by calling this function with " +"C set to C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1539 -msgid "" -"The daemon self-limits the frequency of progress messages it sends (see " -"C). Not all calls generate progress " -"messages." +# type: =head2 +#: ../src/guestfs.pod:1564 +msgid "guestfs_set_log_message_callback" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1543 -msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" +# type: verbatim +#: ../src/guestfs.pod:1566 +#, no-wrap +msgid "" +" typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n" +" char *buf, int len);\n" +" void guestfs_set_log_message_callback (guestfs_h *g,\n" +" guestfs_log_message_cb cb,\n" +" void *opaque);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1545 +#: ../src/guestfs.pod:1572 msgid "" -"All high-level libguestfs actions are synchronous. If you want to use " -"libguestfs asynchronously then you must create a thread." +"The callback function C will be called whenever qemu or the guest writes " +"anything to the console." msgstr "" # type: textblock -#: ../src/guestfs.pod:1548 -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." +#: ../src/guestfs.pod:1575 +msgid "Use this function to capture kernel messages and similar." msgstr "" # type: textblock -#: ../src/guestfs.pod:1552 +#: ../src/guestfs.pod:1577 msgid "" -"See the graphical program guestfs-browser for one possible architecture for " -"multithreaded programs using libvirt and libguestfs." +"Normally there is no log message handler, and log messages are just " +"discarded." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1555 -msgid "QEMU WRAPPERS" +# type: =head2 +#: ../src/guestfs.pod:1580 +msgid "guestfs_set_subprocess_quit_callback" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1557 +# type: verbatim +#: ../src/guestfs.pod:1582 +#, no-wrap msgid "" -"If you want to compile your own qemu, run qemu from a non-standard location, " -"or pass extra arguments to qemu, then you can write a shell-script wrapper " -"around qemu." +" typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n" +" void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n" +" guestfs_subprocess_quit_cb cb,\n" +" void *opaque);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1561 +#: ../src/guestfs.pod:1587 msgid "" -"There is one important rule to remember: you I> as the " -"last command in the shell script (so that qemu replaces the shell and " -"becomes the direct child of the libguestfs-using program). If you don't do " -"this, then the qemu process won't be cleaned up correctly." +"The callback function C will be called when the child process quits, " +"either asynchronously or if killed by L. (This " +"corresponds to a transition from any state to the CONFIG state)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1566 -msgid "" -"Here is an example of a wrapper, where I have built my own copy of qemu from " -"source:" +# type: =head2 +#: ../src/guestfs.pod:1592 +msgid "guestfs_set_launch_done_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1569 +#: ../src/guestfs.pod:1594 #, no-wrap msgid "" -" #!/bin/sh -\n" -" qemudir=/home/rjones/d/qemu\n" -" exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n" +" typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n" +" void guestfs_set_launch_done_callback (guestfs_h *g,\n" +" guestfs_launch_done_cb cb,\n" +" void *opaque);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1573 +#: ../src/guestfs.pod:1599 msgid "" -"Save this script as C (or wherever), C, and " -"then use it by setting the LIBGUESTFS_QEMU environment variable. For " -"example:" +"The callback function C will be called when the child process becomes " +"ready first time after it has been launched. (This corresponds to a " +"transition from LAUNCHING to the READY state)." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1603 +msgid "guestfs_set_close_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1577 +#: ../src/guestfs.pod:1605 #, no-wrap msgid "" -" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" +" typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n" +" void guestfs_set_close_callback (guestfs_h *g,\n" +" guestfs_close_cb cb,\n" +" void *opaque);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1579 +#: ../src/guestfs.pod:1610 msgid "" -"Note that libguestfs also calls qemu with the -help and -version options in " -"order to determine features." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1582 -msgid "LIBGUESTFS VERSION NUMBERS" +"The callback function C will be called while the handle is being closed " +"(synchronously from L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1584 +#: ../src/guestfs.pod:1613 msgid "" -"Since April 2010, libguestfs has started to make separate development and " -"stable releases, along with corresponding branches in our git repository. " -"These separate releases can be identified by version number:" +"Note that libguestfs installs an L handler to try to clean up " +"handles that are open when the program exits. This means that this callback " +"might be called indirectly from L, which can cause unexpected " +"problems in higher-level languages (eg. if your HLL interpreter has already " +"been cleaned up by the time this is called, and if your callback then jumps " +"into some HLL function)." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1621 +msgid "guestfs_set_progress_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1589 +#: ../src/guestfs.pod:1623 #, no-wrap msgid "" -" even numbers for stable: 1.2.x, 1.4.x, ...\n" -" .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n" -" |\n" -" v\n" -" 1 . 3 . 5\n" -" ^ ^\n" -" | |\n" -" | `-------- sub-version\n" -" |\n" -" `------ always '1' because we don't change the ABI\n" +" typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n" +" int proc_nr, int serial,\n" +" uint64_t position, uint64_t total);\n" +" void guestfs_set_progress_callback (guestfs_h *g,\n" +" guestfs_progress_cb cb,\n" +" void *opaque);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1600 -msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." +#: ../src/guestfs.pod:1630 +msgid "" +"Some long-running operations can generate progress messages. If this " +"callback is registered, then it will be called each time a progress message " +"is generated (usually two seconds after the operation started, and three " +"times per second thereafter until it completes, although the frequency may " +"change in future versions)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1602 +#: ../src/guestfs.pod:1636 msgid "" -"As time passes we cherry pick fixes from the development branch and backport " -"those into the stable branch, the effect being that the stable branch should " -"get more stable and less buggy over time. So the stable releases are ideal " -"for people who don't need new features but would just like the software to " -"work." +"The callback receives two numbers: C and C. The units of " +"C are not defined, although for some operations C may relate " +"in some way to the amount of data to be transferred (eg. in bytes or " +"megabytes), and C may be the portion which has been transferred." msgstr "" # type: textblock -#: ../src/guestfs.pod:1608 -msgid "Our criteria for backporting changes are:" +#: ../src/guestfs.pod:1642 +msgid "The only defined and stable parts of the API are:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1614 +#: ../src/guestfs.pod:1648 msgid "" -"Documentation changes which don't affect any code are backported unless the " -"documentation refers to a future feature which is not in stable." +"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:1620 -msgid "" -"Bug fixes which are not controversial, fix obvious problems, and have been " -"well tested are backported." +#: ../src/guestfs.pod:1653 +msgid "0 E= C E= C" msgstr "" # type: textblock -#: ../src/guestfs.pod:1625 +#: ../src/guestfs.pod:1657 msgid "" -"Simple rearrangements of code which shouldn't affect how it works get " -"backported. This is so that the code in the two branches doesn't get too " -"far out of step, allowing us to backport future fixes more easily." +"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:1631 +#: ../src/guestfs.pod:1660 msgid "" -"We I backport new features, new APIs, new tools etc, except in one " -"exceptional case: the new feature is required in order to implement an " -"important bug fix." +"This is to simplify caller code, so callers can easily set the progress " +"indicator to \"100%\" at the end of the operation, without requiring special " +"code to detect this case." msgstr "" # type: textblock -#: ../src/guestfs.pod:1637 +#: ../src/guestfs.pod:1666 msgid "" -"A new stable branch starts when we think the new features in development are " -"substantial and compelling enough over the current stable branch to warrant " -"it. When that happens we create new stable and development versions 1.N.0 " -"and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so " -"stable at this point, but by backporting fixes from development, that branch " -"will stabilize over time." +"The callback also receives the procedure number and serial number of the " +"call. These are only useful for debugging protocol issues, and the callback " +"can normally ignore them. The callback may want to print these numbers in " +"error messages or debugging messages." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1645 ../fish/guestfish.pod:796 -#: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:312 -#: ../tools/virt-rescue.pl:226 -msgid "ENVIRONMENT VARIABLES" +#: ../src/guestfs.pod:1671 +msgid "PRIVATE DATA AREA" msgstr "" -# type: =item -#: ../src/guestfs.pod:1649 ../fish/guestfish.pod:816 -msgid "LIBGUESTFS_APPEND" +# type: textblock +#: ../src/guestfs.pod:1673 +msgid "" +"You can attach named pieces of private data to the libguestfs handle, and " +"fetch them by name for the lifetime of the handle. This is called the " +"private data area and is only available from the C API." msgstr "" # type: textblock -#: ../src/guestfs.pod:1651 ../fish/guestfish.pod:818 -msgid "Pass additional options to the guest kernel." +#: ../src/guestfs.pod:1677 +msgid "To attach a named piece of data, use the following call:" msgstr "" -# type: =item -#: ../src/guestfs.pod:1653 ../fish/guestfish.pod:820 -msgid "LIBGUESTFS_DEBUG" +# type: verbatim +#: ../src/guestfs.pod:1679 +#, no-wrap +msgid "" +" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1655 +#: ../src/guestfs.pod:1681 msgid "" -"Set C to enable verbose messages. This has the same " -"effect as calling C." +"C is the name to associate with this data, and C is an arbitrary " +"pointer (which can be C). Any previous item with the same name is " +"overwritten." msgstr "" -# type: =item -#: ../src/guestfs.pod:1658 ../fish/guestfish.pod:825 -msgid "LIBGUESTFS_MEMSIZE" +# type: textblock +#: ../src/guestfs.pod:1685 +msgid "" +"You can use any C you want, but names beginning with an underscore " +"character are reserved for internal libguestfs purposes (for implementing " +"language bindings). It is recommended to prefix the name with some unique " +"string to avoid collisions with other users." msgstr "" # type: textblock -#: ../src/guestfs.pod:1660 ../fish/guestfish.pod:827 -msgid "" -"Set the memory allocated to the qemu process, in megabytes. For example:" +#: ../src/guestfs.pod:1690 +msgid "To retrieve the pointer, use:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1663 ../fish/guestfish.pod:830 +#: ../src/guestfs.pod:1692 #, no-wrap msgid "" -" LIBGUESTFS_MEMSIZE=700\n" +" void *guestfs_get_private (guestfs_h *g, const char *key);\n" "\n" msgstr "" -# type: =item -#: ../src/guestfs.pod:1665 ../fish/guestfish.pod:832 -msgid "LIBGUESTFS_PATH" -msgstr "" - # type: textblock -#: ../src/guestfs.pod:1667 +#: ../src/guestfs.pod:1694 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:1670 ../fish/guestfish.pod:837 -msgid "LIBGUESTFS_QEMU" +"This function returns C if either no data is found associated with " +"C, or if the user previously set the C's C pointer to " +"C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1672 ../fish/guestfish.pod:839 +#: ../src/guestfs.pod:1698 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." +"Libguestfs does not try to look at or interpret the C pointer in any " +"way. As far as libguestfs is concerned, it need not be a valid pointer at " +"all. In particular, libguestfs does I try to free the data when the " +"handle is closed. If the data must be freed, then the caller must either " +"free it before calling L or must set up a close callback to " +"do it (see L, and note that only one callback " +"can be registered for a handle)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1676 -msgid "See also L above." +#: ../src/guestfs.pod:1706 +msgid "" +"The private data area is implemented using a hash table, and should be " +"reasonably efficient for moderate numbers of keys." msgstr "" -# type: =item -#: ../src/guestfs.pod:1678 ../fish/guestfish.pod:843 -msgid "LIBGUESTFS_TRACE" +# type: =end +#: ../src/guestfs.pod:1709 ../src/guestfs.pod:1714 +msgid "html" msgstr "" # type: textblock -#: ../src/guestfs.pod:1680 +#: ../src/guestfs.pod:1711 msgid "" -"Set C to enable command traces. This has the same " -"effect as calling C." +" " msgstr "" -# type: =item -#: ../src/guestfs.pod:1683 ../fish/guestfish.pod:852 -msgid "TMPDIR" +# type: =head1 +#: ../src/guestfs.pod:1716 +msgid "ARCHITECTURE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1685 ../fish/guestfish.pod:854 -msgid "Location of temporary directory, defaults to C." +#: ../src/guestfs.pod:1718 +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: textblock -#: ../src/guestfs.pod:1687 ../fish/guestfish.pod:856 +# type: verbatim +#: ../src/guestfs.pod:1722 +#, no-wrap 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." +" ___________________\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: =head1 -#: ../src/guestfs.pod:1695 ../fish/guestfish.pod:914 -#: ../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 -msgid "SEE ALSO" +# type: textblock +#: ../src/guestfs.pod:1742 +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:1697 +#: ../src/guestfs.pod:1745 msgid "" -"L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, " -"L." +"Inside the appliance is a Linux kernel and a complete stack of userspace " +"tools (such as LVM and ext2 programs) and a small controlling daemon called " +"L. The library talks to L using remote procedure " +"calls (RPC). There is a mostly one-to-one correspondence between libguestfs " +"API calls and RPC calls to the daemon. Lastly the disk image(s) are " +"attached to the qemu process which translates device access by the " +"appliance's Linux kernel into accesses to the image." msgstr "" # type: textblock -#: ../src/guestfs.pod:1715 +#: ../src/guestfs.pod:1754 msgid "" -"Tools with a similar purpose: L, L, L, L, L." +"A common misunderstanding is that the appliance \"is\" the virtual machine. " +"Although the disk image you are attached to might also be used by some " +"virtual machine, libguestfs doesn't know or care about this. (But you will " +"care if both libguestfs's qemu process and your virtual machine are trying " +"to update the disk image at the same time, since these usually results in " +"massive disk corruption)." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1722 ../tools/virt-make-fs.pl:541 -#: ../tools/virt-win-reg.pl:476 -msgid "BUGS" +#: ../src/guestfs.pod:1761 +msgid "STATE MACHINE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1724 -msgid "To get a list of bugs against libguestfs use this link:" +#: ../src/guestfs.pod:1763 +msgid "libguestfs uses a state machine to model the child process:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1726 +# type: verbatim +#: ../src/guestfs.pod:1765 +#, no-wrap msgid "" -"L" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1728 -msgid "To report a new bug against libguestfs use this link:" +" |\n" +" guestfs_create\n" +" |\n" +" |\n" +" ____V_____\n" +" / \\\n" +" | CONFIG |\n" +" \\__________/\n" +" ^ ^ ^ \\\n" +" / | \\ \\ guestfs_launch\n" +" / | _\\__V______\n" +" / | / \\\n" +" / | | LAUNCHING |\n" +" / | \\___________/\n" +" / | /\n" +" / | guestfs_launch\n" +" / | /\n" +" ______ / __|____V\n" +" / \\ ------> / \\\n" +" | BUSY | | READY |\n" +" \\______/ <------ \\________/\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1730 +#: ../src/guestfs.pod:1787 msgid "" -"L" +"The normal transitions are (1) CONFIG (when the handle is created, but there " +"is no child process), (2) LAUNCHING (when the child process is booting up), " +"(3) alternating between READY and BUSY as commands are issued to, and " +"carried out by, the child process." msgstr "" # type: textblock -#: ../src/guestfs.pod:1732 -msgid "When reporting a bug, please check:" +#: ../src/guestfs.pod:1792 +msgid "" +"The guest may be killed by L, or may die " +"asynchronously at any time (eg. due to some internal error), and that causes " +"the state to transition back to CONFIG." msgstr "" # type: textblock -#: ../src/guestfs.pod:1738 -msgid "That the bug hasn't been reported already." +#: ../src/guestfs.pod:1796 +msgid "" +"Configuration commands for qemu such as L can only be " +"issued when in the CONFIG state." msgstr "" # type: textblock -#: ../src/guestfs.pod:1742 -msgid "That you are testing a recent version." +#: ../src/guestfs.pod:1799 +msgid "" +"The API offers one call that goes from CONFIG through LAUNCHING to READY. " +"L blocks until the child process is READY to accept " +"commands (or until some failure or timeout). L internally " +"moves the state from CONFIG to LAUNCHING while it is running." msgstr "" # type: textblock -#: ../src/guestfs.pod:1746 -msgid "Describe the bug accurately, and give a way to reproduce it." +#: ../src/guestfs.pod:1805 +msgid "" +"API actions such as L can only be issued when in the READY " +"state. These API calls block waiting for the command to be carried out (ie. " +"the state to transition to BUSY and then back to READY). There are no non-" +"blocking versions, and no way to issue more than one command per handle at " +"the same time." msgstr "" # type: textblock -#: ../src/guestfs.pod:1750 +#: ../src/guestfs.pod:1811 msgid "" -"Run libguestfs-test-tool and paste the B output into the " -"bug report." +"Finally, the child process sends asynchronous messages back to the main " +"program, such as kernel log messages. You can register a callback to " +"receive these messages." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1755 ../fish/guestfish.pod:930 -#: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:189 -#: ../inspector/virt-inspector.pl:855 -msgid "AUTHORS" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1757 ../fish/guestfish.pod:932 -#: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:191 -msgid "Richard W.M. Jones (C)" +#: ../src/guestfs.pod:1815 +msgid "INTERNALS" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1759 ../fish/guestfish.pod:934 -#: ../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 -msgid "COPYRIGHT" +# type: =head2 +#: ../src/guestfs.pod:1817 +msgid "COMMUNICATION PROTOCOL" msgstr "" # type: textblock -#: ../src/guestfs.pod:1761 ../fish/guestfish.pod:936 -msgid "Copyright (C) 2009-2010 Red Hat Inc. L" +#: ../src/guestfs.pod:1819 +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:1764 +#: ../src/guestfs.pod:1822 msgid "" -"This library is free software; you can redistribute it and/or modify it " -"under the terms of the GNU Lesser General Public License as published by the " -"Free Software Foundation; either version 2 of the License, or (at your " -"option) any later version." +"The protocol used to talk between the library and the daemon running inside " +"the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC " +"1014, RFC 1832, RFC 4506)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1769 +#: ../src/guestfs.pod:1826 msgid "" -"This library is distributed in the hope that it will be useful, but WITHOUT " -"ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or " -"FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License " -"for more details." +"The detailed format of structures is in C (note: " +"this file is automatically generated)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1774 +#: ../src/guestfs.pod:1829 msgid "" -"You should have received a copy of the GNU Lesser General Public License " -"along with this library; if not, write to the Free Software Foundation, " -"Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA" +"There are two broad cases, ordinary functions that don't have any C " +"and C parameters, which are handled with very simple request/reply " +"messages. Then there are functions that have any C or C " +"parameters, which use the same request and reply messages, but they may also " +"be followed by files sent using a chunked encoding." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1 -msgid "guestfs_add_cdrom" +# type: =head3 +#: ../src/guestfs.pod:1836 +msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1838 +msgid "For ordinary functions, the request message is:" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:3 +#: ../src/guestfs.pod:1840 #, no-wrap msgid "" -" int guestfs_add_cdrom (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" total length (header + arguments,\n" +" but not including the length word itself)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs__args (encoded as XDR)\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:6 ../fish/guestfish-actions.pod:5 -msgid "This function adds a virtual CD-ROM disk image to the guest." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:8 ../fish/guestfish-actions.pod:7 -msgid "This is equivalent to the qemu parameter C<-cdrom filename>." +#: ../src/guestfs.pod:1845 +msgid "" +"The total length field allows the daemon to allocate a fixed size buffer " +"into which it slurps the rest of the message. As a result, the total length " +"is limited to C bytes (currently 4MB), which means the " +"effective size of any request is limited to somewhere under this size." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:1488 -#: ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1186 -msgid "Notes:" +#: ../src/guestfs.pod:1851 +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-actions.pod:16 +#: ../src/guestfs.pod:1854 msgid "" -"This call checks for the existence of C. This stops you from " -"specifying other types of drive which are supported by qemu such as C " -"and C URLs. To specify those, use the general C call " -"instead." +"The header contains the procedure number (C) which is how the " +"receiver knows what type of args structure to expect, or none at all." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:23 +#: ../src/guestfs.pod:1858 msgid "" -"If you just want to add an ISO file (often you use this as an efficient way " -"to transfer large files into the guest), then you should probably use " -"C instead." +"For functions that take optional arguments, the optional arguments are " +"encoded in the C_args> structure in the same way as ordinary " +"arguments. A bitmask in the header indicates which optional arguments are " +"meaningful. The bitmask is also checked to see if it contains bits set " +"which the daemon does not know about (eg. if more optional arguments were " +"added in a later version of the library), and this causes the call to be " +"rejected." msgstr "" # type: textblock -#: ../src/guestfs-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:2411 ../src/guestfs-actions.pod:2423 -#: ../src/guestfs-actions.pod:2440 ../src/guestfs-actions.pod:2548 -#: ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2569 -#: ../src/guestfs-actions.pod:2580 ../src/guestfs-actions.pod:2592 -#: ../src/guestfs-actions.pod:2622 ../src/guestfs-actions.pod:2686 -#: ../src/guestfs-actions.pod:2703 ../src/guestfs-actions.pod:2717 -#: ../src/guestfs-actions.pod:2737 ../src/guestfs-actions.pod:2757 -#: ../src/guestfs-actions.pod:2786 ../src/guestfs-actions.pod:2802 -#: ../src/guestfs-actions.pod:2818 ../src/guestfs-actions.pod:2830 -#: ../src/guestfs-actions.pod:2839 ../src/guestfs-actions.pod:2872 -#: ../src/guestfs-actions.pod:2885 ../src/guestfs-actions.pod:2895 -#: ../src/guestfs-actions.pod:2907 ../src/guestfs-actions.pod:2921 -#: ../src/guestfs-actions.pod:3001 ../src/guestfs-actions.pod:3018 -#: ../src/guestfs-actions.pod:3028 ../src/guestfs-actions.pod:3073 -#: ../src/guestfs-actions.pod:3088 ../src/guestfs-actions.pod:3103 -#: ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3127 -#: ../src/guestfs-actions.pod:3138 ../src/guestfs-actions.pod:3152 -#: ../src/guestfs-actions.pod:3164 ../src/guestfs-actions.pod:3181 -#: ../src/guestfs-actions.pod:3212 ../src/guestfs-actions.pod:3240 -#: ../src/guestfs-actions.pod:3256 ../src/guestfs-actions.pod:3272 -#: ../src/guestfs-actions.pod:3281 ../src/guestfs-actions.pod:3295 -#: ../src/guestfs-actions.pod:3305 ../src/guestfs-actions.pod:3317 -#: ../src/guestfs-actions.pod:3329 ../src/guestfs-actions.pod:3361 -#: ../src/guestfs-actions.pod:3373 ../src/guestfs-actions.pod:3390 -#: ../src/guestfs-actions.pod:3401 ../src/guestfs-actions.pod:3415 -#: ../src/guestfs-actions.pod:3455 ../src/guestfs-actions.pod:3486 -#: ../src/guestfs-actions.pod:3497 ../src/guestfs-actions.pod:3522 -#: ../src/guestfs-actions.pod:3536 ../src/guestfs-actions.pod:3551 -#: ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3725 -#: ../src/guestfs-actions.pod:3744 ../src/guestfs-actions.pod:3759 -#: ../src/guestfs-actions.pod:3785 ../src/guestfs-actions.pod:3819 -#: ../src/guestfs-actions.pod:3833 ../src/guestfs-actions.pod:3843 -#: ../src/guestfs-actions.pod:3854 ../src/guestfs-actions.pod:4086 -#: ../src/guestfs-actions.pod:4102 ../src/guestfs-actions.pod:4113 -#: ../src/guestfs-actions.pod:4122 ../src/guestfs-actions.pod:4133 -#: ../src/guestfs-actions.pod:4142 ../src/guestfs-actions.pod:4153 -#: ../src/guestfs-actions.pod:4166 ../src/guestfs-actions.pod:4184 -#: ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4216 -#: ../src/guestfs-actions.pod:4231 ../src/guestfs-actions.pod:4251 -#: ../src/guestfs-actions.pod:4266 ../src/guestfs-actions.pod:4282 -#: ../src/guestfs-actions.pod:4300 ../src/guestfs-actions.pod:4316 -#: ../src/guestfs-actions.pod:4330 ../src/guestfs-actions.pod:4355 -#: ../src/guestfs-actions.pod:4376 ../src/guestfs-actions.pod:4392 -#: ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4425 -#: ../src/guestfs-actions.pod:4437 ../src/guestfs-actions.pod:4453 -#: ../src/guestfs-actions.pod:4487 ../src/guestfs-actions.pod:4507 -#: ../src/guestfs-actions.pod:4530 ../src/guestfs-actions.pod:4620 -#: ../src/guestfs-actions.pod:4726 ../src/guestfs-actions.pod:4735 -#: ../src/guestfs-actions.pod:4745 ../src/guestfs-actions.pod:4755 -#: ../src/guestfs-actions.pod:4774 ../src/guestfs-actions.pod:4784 -#: ../src/guestfs-actions.pod:4794 ../src/guestfs-actions.pod:4804 -#: ../src/guestfs-actions.pod:4816 ../src/guestfs-actions.pod:4866 -#: ../src/guestfs-actions.pod:4880 ../src/guestfs-actions.pod:4893 -#: ../src/guestfs-actions.pod:4906 ../src/guestfs-actions.pod:4920 -#: ../src/guestfs-actions.pod:4930 ../src/guestfs-actions.pod:4947 -#: ../src/guestfs-actions.pod:4977 ../src/guestfs-actions.pod:4988 -#: ../src/guestfs-actions.pod:5023 ../src/guestfs-actions.pod:5033 -#: ../src/guestfs-actions.pod:5048 ../src/guestfs-actions.pod:5076 -#: ../src/guestfs-actions.pod:5180 ../src/guestfs-actions.pod:5195 -#: ../src/guestfs-actions.pod:5206 ../src/guestfs-actions.pod:5252 -#: ../src/guestfs-actions.pod:5262 ../src/guestfs-actions.pod:5299 -#: ../src/guestfs-actions.pod:5326 ../src/guestfs-actions.pod:5368 -#: ../src/guestfs-actions.pod:5391 ../src/guestfs-actions.pod:5448 -#: ../src/guestfs-actions.pod:5464 ../src/guestfs-actions.pod:5490 -msgid "This function returns 0 on success or -1 on error." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:31 -msgid "guestfs_add_drive" +#: ../src/guestfs.pod:1866 +msgid "The reply message for ordinary functions is:" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:33 +#: ../src/guestfs.pod:1868 #, no-wrap msgid "" -" int guestfs_add_drive (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" total length (header + ret,\n" +" but not including the length word itself)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs__ret (encoded as XDR)\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:36 ../fish/guestfish-actions.pod:32 +#: ../src/guestfs.pod:1873 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." +"As above the C_ret> structure may be completely omitted for " +"functions that return no formal return values." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:41 ../fish/guestfish-actions.pod:37 +#: ../src/guestfs.pod:1876 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)." +"As above the total length of the reply is limited to C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:47 ../fish/guestfish-actions.pod:43 +#: ../src/guestfs.pod:1879 msgid "" -"This is equivalent to the qemu parameter C<-drive file=filename,cache=off," -"if=...>." +"In the case of an error, a flag is set in the header, and the reply message " +"is slightly changed:" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:50 ../fish/guestfish-actions.pod:46 +# type: verbatim +#: ../src/guestfs.pod:1882 +#, no-wrap msgid "" -"C is omitted in cases where it is not supported by the underlying " -"filesystem." +" total length (header + error,\n" +" but not including the length word itself)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs_message_error (encoded as XDR)\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:53 ../src/guestfs-actions.pod:82 +#: ../src/guestfs.pod:1887 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." +"The C structure contains the error message as a " +"string." +msgstr "" + +# type: =head3 +#: ../src/guestfs.pod:1890 +msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:58 ../src/guestfs-actions.pod:87 +#: ../src/guestfs.pod:1892 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" +"A C parameter indicates that we transfer a file I the guest. " +"The normal request message is sent (see above). However this is followed by " +"a sequence of file chunks." msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:67 +#: ../src/guestfs.pod:1896 #, no-wrap msgid "" -" int guestfs_add_drive_ro (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" total length (header + arguments,\n" +" but not including the length word itself,\n" +" and not including the chunks)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs__args (encoded as XDR)\n" +" sequence of chunks for FileIn param #0\n" +" sequence of chunks for FileIn param #1 etc.\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:63 -msgid "This adds a drive in snapshot mode, making it effectively read-only." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:73 ../fish/guestfish-actions.pod:66 -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." -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=...>." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:94 -msgid "guestfs_add_drive_ro_with_if" +#: ../src/guestfs.pod:1904 +msgid "The \"sequence of chunks\" is:" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:96 +#: ../src/guestfs.pod:1906 #, no-wrap msgid "" -" int guestfs_add_drive_ro_with_if (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst char *iface);\n" +" length of chunk (not including length word itself)\n" +" struct guestfs_chunk (encoded as XDR)\n" +" length of chunk\n" +" struct guestfs_chunk (encoded as XDR)\n" +" ...\n" +" length of chunk\n" +" struct guestfs_chunk (with data.data_len == 0)\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:100 +#: ../src/guestfs.pod:1914 msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." +"The final chunk has the C field set to zero. Additionally a flag " +"is set in the final chunk to indicate either successful completion or early " +"cancellation." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:105 -msgid "guestfs_add_drive_with_if" +# type: textblock +#: ../src/guestfs.pod:1918 +msgid "" +"At time of writing there are no functions that have more than one FileIn " +"parameter. However this is (theoretically) supported, by sending the " +"sequence of chunks for each FileIn parameter one after another (from left to " +"right)." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:107 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:1923 msgid "" -" int guestfs_add_drive_with_if (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst char *iface);\n" -"\n" +"Both the library (sender) I the daemon (receiver) may cancel the " +"transfer. The library does this by sending a chunk with a special flag set " +"to indicate cancellation. When the daemon sees this, it cancels the whole " +"RPC, does I send any reply, and goes back to reading the next request." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:111 +#: ../src/guestfs.pod:1929 msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." +"The daemon may also cancel. It does this by writing a special word " +"C to the socket. The library listens for this during " +"the transfer, and if it gets it, it will cancel the transfer (it sends a " +"cancel chunk). The special word is chosen so that even if cancellation " +"happens right at the end of the transfer (after the library has finished " +"writing and has started listening for the reply), the \"spurious\" cancel " +"flag will not be confused with the reply message." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:116 -msgid "guestfs_aug_clear" +# type: textblock +#: ../src/guestfs.pod:1938 +msgid "" +"This protocol allows the transfer of arbitrary sized files (no 32 bit " +"limit), and also files where the size is not known in advance (eg. from " +"pipes or sockets). However the chunks are rather small " +"(C), so that neither the library nor the daemon need " +"to keep much in memory." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:118 -#, no-wrap -msgid "" -" int guestfs_aug_clear (guestfs_h *g,\n" -"\t\tconst char *augpath);\n" -"\n" +# type: =head3 +#: ../src/guestfs.pod:1944 +msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:121 ../fish/guestfish-actions.pod:103 +#: ../src/guestfs.pod:1946 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 -msgid "guestfs_aug_close" +"The protocol for FileOut parameters is exactly the same as for FileIn " +"parameters, but with the roles of daemon and library reversed." msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:128 +#: ../src/guestfs.pod:1949 #, no-wrap msgid "" -" int guestfs_aug_close (guestfs_h *g);\n" +" total length (header + ret,\n" +" but not including the length word itself,\n" +" and not including the chunks)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs__ret (encoded as XDR)\n" +" sequence of chunks for FileOut param #0\n" +" sequence of chunks for FileOut param #1 etc.\n" "\n" msgstr "" +# type: =head3 +#: ../src/guestfs.pod:1957 +msgid "INITIAL MESSAGE" +msgstr "" + # type: textblock -#: ../src/guestfs-actions.pod:130 +#: ../src/guestfs.pod:1959 msgid "" -"Close the current Augeas handle and free up any resources used by it. After " -"calling this, you have to call C again before you can use " -"any other Augeas functions." +"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: =head2 -#: ../src/guestfs-actions.pod:137 -msgid "guestfs_aug_defnode" +# type: =head3 +#: ../src/guestfs.pod:1963 +msgid "PROGRESS NOTIFICATION MESSAGES" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:139 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:1965 msgid "" -" struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *g,\n" -"\t\tconst char *name,\n" -"\t\tconst char *expr,\n" -"\t\tconst char *val);\n" -"\n" +"The daemon may send progress notification messages at any time. These are " +"distinguished by the normal length word being replaced by " +"C, followed by a fixed size progress message." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:144 ../fish/guestfish-actions.pod:119 +#: ../src/guestfs.pod:1969 msgid "" -"Defines a variable C whose value is the result of evaluating C." +"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-actions.pod:147 +#: ../src/guestfs.pod:1973 msgid "" -"If C evaluates to an empty nodeset, a node is created, equivalent to " -"calling C C, C. C will be the nodeset " -"containing that single node." +"The daemon self-limits the frequency of progress messages it sends (see " +"C). Not all calls generate progress " +"messages." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:126 -msgid "" -"On success this returns a pair containing the number of nodes in the " -"nodeset, and a boolean flag if a node was created." +# type: =head1 +#: ../src/guestfs.pod:1977 +msgid "LIBGUESTFS VERSION NUMBERS" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:155 +#: ../src/guestfs.pod:1979 msgid "" -"This function returns a C, or NULL if there was " -"an error. I after use>." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:159 -msgid "guestfs_aug_defvar" +"Since April 2010, libguestfs has started to make separate development and " +"stable releases, along with corresponding branches in our git repository. " +"These separate releases can be identified by version number:" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:161 +#: ../src/guestfs.pod:1984 #, no-wrap msgid "" -" int guestfs_aug_defvar (guestfs_h *g,\n" -"\t\tconst char *name,\n" -"\t\tconst char *expr);\n" +" even numbers for stable: 1.2.x, 1.4.x, ...\n" +" .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n" +" |\n" +" v\n" +" 1 . 3 . 5\n" +" ^ ^\n" +" | |\n" +" | `-------- sub-version\n" +" |\n" +" `------ always '1' because we don't change the ABI\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:134 -msgid "" -"Defines an Augeas variable C whose value is the result of evaluating " -"C. If C is NULL, then C is undefined." +#: ../src/guestfs.pod:1995 +msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:138 +#: ../src/guestfs.pod:1997 msgid "" -"On success this returns the number of nodes in C, or C<0> if C " -"evaluates to something which is not a nodeset." +"As time passes we cherry pick fixes from the development branch and backport " +"those into the stable branch, the effect being that the stable branch should " +"get more stable and less buggy over time. So the stable releases are ideal " +"for people who don't need new features but would just like the software to " +"work." msgstr "" # type: 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:3475 ../src/guestfs-actions.pod:3582 -#: ../src/guestfs-actions.pod:3913 ../src/guestfs-actions.pod:5012 -#: ../src/guestfs-actions.pod:5336 ../src/guestfs-actions.pod:5346 -#: ../src/guestfs-actions.pod:5356 -msgid "On error this function returns -1." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:174 -msgid "guestfs_aug_get" +#: ../src/guestfs.pod:2003 +msgid "Our criteria for backporting changes are:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:176 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:2009 msgid "" -" char *guestfs_aug_get (guestfs_h *g,\n" -"\t\tconst char *augpath);\n" -"\n" +"Documentation changes which don't affect any code are backported unless the " +"documentation refers to a future feature which is not in stable." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:145 +#: ../src/guestfs.pod:2015 msgid "" -"Look up the value associated with C. If C matches exactly one " -"node, the C is returned." +"Bug fixes which are not controversial, fix obvious problems, and have been " +"well tested are backported." 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:2537 -#: ../src/guestfs-actions.pod:2958 ../src/guestfs-actions.pod:3054 -#: ../src/guestfs-actions.pod:3597 ../src/guestfs-actions.pod:3773 -#: ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:4029 -#: ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:4548 -#: ../src/guestfs-actions.pod:4561 ../src/guestfs-actions.pod:4575 -#: ../src/guestfs-actions.pod:4596 ../src/guestfs-actions.pod:5129 -#: ../src/guestfs-actions.pod:5145 ../src/guestfs-actions.pod:5160 -#: ../src/guestfs-actions.pod:5308 ../src/guestfs-actions.pod:5538 +#: ../src/guestfs.pod:2020 msgid "" -"This function returns a string, or NULL on error. I." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:185 -msgid "guestfs_aug_init" +"Simple rearrangements of code which shouldn't affect how it works get " +"backported. This is so that the code in the two branches doesn't get too " +"far out of step, allowing us to backport future fixes more easily." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:187 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:2026 msgid "" -" int guestfs_aug_init (guestfs_h *g,\n" -"\t\tconst char *root,\n" -"\t\tint flags);\n" -"\n" +"We I backport new features, new APIs, new tools etc, except in one " +"exceptional case: the new feature is required in order to implement an " +"important bug fix." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:191 ../fish/guestfish-actions.pod:152 +#: ../src/guestfs.pod:2032 msgid "" -"Create a new Augeas handle for editing configuration files. If there was " -"any previous Augeas handle associated with this guestfs session, then it is " -"closed." +"A new stable branch starts when we think the new features in development are " +"substantial and compelling enough over the current stable branch to warrant " +"it. When that happens we create new stable and development versions 1.N.0 " +"and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so " +"stable at this point, but by backporting fixes from development, that branch " +"will stabilize over time." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:195 -msgid "You must call this before using any other C commands." +# type: =head1 +#: ../src/guestfs.pod:2040 ../fish/guestfish.pod:915 +#: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 +msgid "ENVIRONMENT VARIABLES" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:198 ../fish/guestfish-actions.pod:159 -msgid "" -"C is the filesystem root. C must not be NULL, use C instead." +# type: =item +#: ../src/guestfs.pod:2044 ../fish/guestfish.pod:941 +msgid "LIBGUESTFS_APPEND" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:201 ../fish/guestfish-actions.pod:162 -msgid "" -"The flags are the same as the flags defined in Eaugeas.hE, the " -"logical I of the following integers:" +#: ../src/guestfs.pod:2046 ../fish/guestfish.pod:943 +msgid "Pass additional options to the guest kernel." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:207 ../fish/guestfish-actions.pod:168 -msgid "C = 1" +#: ../src/guestfs.pod:2048 ../fish/guestfish.pod:945 +msgid "LIBGUESTFS_DEBUG" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:209 ../fish/guestfish-actions.pod:170 -msgid "Keep the original file with a C<.augsave> extension." +#: ../src/guestfs.pod:2050 +msgid "" +"Set C to enable verbose messages. This has the same " +"effect as calling C." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:211 ../fish/guestfish-actions.pod:172 -msgid "C = 2" +#: ../src/guestfs.pod:2053 ../fish/guestfish.pod:950 +msgid "LIBGUESTFS_MEMSIZE" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:213 ../fish/guestfish-actions.pod:174 +#: ../src/guestfs.pod:2055 ../fish/guestfish.pod:952 msgid "" -"Save changes into a file with extension C<.augnew>, and do not overwrite " -"original. Overrides C." +"Set the memory allocated to the qemu process, in megabytes. For example:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:2058 ../fish/guestfish.pod:955 +#, no-wrap +msgid "" +" LIBGUESTFS_MEMSIZE=700\n" +"\n" msgstr "" # type: =item -#: ../src/guestfs-actions.pod:216 ../fish/guestfish-actions.pod:177 -msgid "C = 4" +#: ../src/guestfs.pod:2060 ../fish/guestfish.pod:957 +msgid "LIBGUESTFS_PATH" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:218 ../fish/guestfish-actions.pod:179 -msgid "Typecheck lenses (can be expensive)." +#: ../src/guestfs.pod:2062 +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-actions.pod:220 ../fish/guestfish-actions.pod:181 -msgid "C = 8" +#: ../src/guestfs.pod:2065 ../fish/guestfish.pod:962 +msgid "LIBGUESTFS_QEMU" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:222 ../fish/guestfish-actions.pod:183 -msgid "Do not use standard load path for modules." +#: ../src/guestfs.pod:2067 ../fish/guestfish.pod:964 +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:2071 +msgid "See also L above." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:224 ../fish/guestfish-actions.pod:185 -msgid "C = 16" +#: ../src/guestfs.pod:2073 ../fish/guestfish.pod:968 +msgid "LIBGUESTFS_TRACE" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:226 ../fish/guestfish-actions.pod:187 -msgid "Make save a no-op, just record what would have been changed." +#: ../src/guestfs.pod:2075 +msgid "" +"Set C to enable command traces. This has the same " +"effect as calling C." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:228 ../fish/guestfish-actions.pod:189 -msgid "C = 32" +#: ../src/guestfs.pod:2078 ../fish/guestfish.pod:977 +msgid "TMPDIR" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:230 -msgid "Do not load the tree in C." +#: ../src/guestfs.pod:2080 ../fish/guestfish.pod:979 +msgid "Location of temporary directory, defaults to C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:234 -msgid "To close the handle, you can call C." +#: ../src/guestfs.pod:2082 ../fish/guestfish.pod:981 +msgid "" +"If libguestfs was compiled to use the supermin appliance then the real " +"appliance is cached in this directory, shared between all handles belonging " +"to the same EUID. You can use C<$TMPDIR> to configure another directory to " +"use in case C is not large enough." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:236 ../fish/guestfish-actions.pod:197 -msgid "To find out more about Augeas, see L." +# type: =head1 +#: ../src/guestfs.pod:2090 ../fish/guestfish.pod:1039 +#: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 +#: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484 +#: ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189 +#: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 +#: ../tools/virt-list-partitions.pl:257 +msgid "SEE ALSO" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:240 -msgid "guestfs_aug_insert" +# type: textblock +#: ../src/guestfs.pod:2092 +msgid "" +"L, L, L, L, L, L, L, L, " +"L, L, L, L, L, L, L, L, L, L, L, " +"L, L, L." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:242 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:2115 msgid "" -" int guestfs_aug_insert (guestfs_h *g,\n" -"\t\tconst char *augpath,\n" -"\t\tconst char *label,\n" -"\t\tint before);\n" -"\n" +"Tools with a similar purpose: L, L, L, L, L." +msgstr "" + +# type: =head1 +#: ../src/guestfs.pod:2122 ../tools/virt-win-reg.pl:499 +#: ../tools/virt-make-fs.pl:548 +msgid "BUGS" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:247 ../fish/guestfish-actions.pod:203 -msgid "" -"Create a new sibling C