X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=po-docs%2Fja.po;h=dcf36c5aa276e471994f60b91a29422d707c921a;hp=d5b5312940c9a1ab6efc7ee5736130a8a9ad002e;hb=69f2f6290032e1079dfa1e83fab3559d5d2d690f;hpb=ece3b30e4957b2d1d02377a82afb132e8061804d diff --git a/po-docs/ja.po b/po-docs/ja.po index d5b5312..dcf36c5 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-11-03 21:09+0000\n" +"POT-Creation-Date: 2011-01-11 21:54+0000\n" "PO-Revision-Date: 2010-09-02 14:46+0100\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,45 +16,36 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -# type: =encoding -#: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 -#: ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 -#: ../inspector/virt-inspector.pl:31 ../tools/virt-edit.pl:30 -#: ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:30 -#: ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 -#: ../tools/virt-cat.pl:29 ../tools/virt-tar.pl:29 ../tools/virt-rescue.pl:29 -#: ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28 -msgid "utf8" -msgstr "" - # type: =head1 +#. type: =head1 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 -#: ../inspector/virt-inspector.pl:33 ../tools/virt-edit.pl:32 -#: ../tools/virt-win-reg.pl:35 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:32 +#: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 #: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 -#: ../tools/virt-cat.pl:31 ../tools/virt-tar.pl:31 ../tools/virt-rescue.pl:31 -#: ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 +#: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 +#: ../tools/virt-list-partitions.pl:30 msgid "NAME" msgstr "名前" # type: textblock +#. type: textblock #: ../src/guestfs.pod:5 msgid "guestfs - Library for accessing and modifying virtual machine images" msgstr "" # type: =head1 +#. type: =head1 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 -#: ../inspector/virt-inspector.pl:37 ../tools/virt-edit.pl:36 -#: ../tools/virt-win-reg.pl:39 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:36 +#: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 #: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 -#: ../tools/virt-cat.pl:35 ../tools/virt-tar.pl:35 ../tools/virt-rescue.pl:35 -#: ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 +#: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 +#: ../tools/virt-list-partitions.pl:34 msgid "SYNOPSIS" msgstr "" # type: verbatim +#. type: verbatim #: ../src/guestfs.pod:9 #, no-wrap msgid "" @@ -63,6 +54,7 @@ msgid "" msgstr "" # type: verbatim +#. type: verbatim #: ../src/guestfs.pod:11 #, no-wrap msgid "" @@ -72,13 +64,13 @@ msgid "" " guestfs_mount (g, \"/dev/sda1\", \"/\");\n" " guestfs_touch (g, \"/hello\");\n" " guestfs_umount (g, \"/\");\n" -" guestfs_sync (g);\n" " guestfs_close (g);\n" "\n" msgstr "" # type: verbatim -#: ../src/guestfs.pod:20 +#. type: verbatim +#: ../src/guestfs.pod:19 #, no-wrap msgid "" " cc prog.c -o prog -lguestfs\n" @@ -88,18 +80,19 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 +#. type: =head1 +#: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 -#: ../inspector/virt-inspector.pl:43 ../tools/virt-edit.pl:50 -#: ../tools/virt-win-reg.pl:63 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:42 +#: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 #: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 -#: ../tools/virt-cat.pl:41 ../tools/virt-tar.pl:72 ../tools/virt-rescue.pl:51 -#: ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40 +#: ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47 +#: ../tools/virt-list-partitions.pl:40 msgid "DESCRIPTION" msgstr "" # type: textblock -#: ../src/guestfs.pod:26 +#. type: textblock +#: ../src/guestfs.pod:25 msgid "" "Libguestfs is a library for accessing and modifying guest disk images. " "Amongst the things this is good for: making batch configuration changes to " @@ -110,7 +103,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:34 +#. type: textblock +#: ../src/guestfs.pod:33 msgid "" "Libguestfs uses Linux kernel and qemu code, and can access any type of guest " "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, " @@ -119,7 +113,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:39 +#. type: textblock +#: ../src/guestfs.pod:38 msgid "" "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, " "what filesystem is in each LV, etc.). It can also run commands in the " @@ -127,7 +122,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:44 +#. type: textblock +#: ../src/guestfs.pod:43 msgid "" "Libguestfs is a library that can be linked with C and C++ management " "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, " @@ -136,26 +132,38 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:49 +#. type: textblock +#: ../src/guestfs.pod:48 msgid "" "You don't need to be root to use libguestfs, although obviously you do need " "enough permissions to access the disk images." msgstr "" # type: textblock -#: ../src/guestfs.pod:52 +#. type: textblock +#: ../src/guestfs.pod:51 msgid "" "Libguestfs is a large API because it can do many things. For a gentle " "introduction, please read the L section next." msgstr "" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:54 +msgid "" +"There are also some example programs in the L manual " +"page." +msgstr "" + # type: =head1 -#: ../src/guestfs.pod:55 +#. type: =head1 +#: ../src/guestfs.pod:57 msgid "API OVERVIEW" msgstr "" # type: textblock -#: ../src/guestfs.pod:57 +#. type: textblock +#: ../src/guestfs.pod:59 msgid "" "This section provides a gentler overview of the libguestfs API. We also try " "to group API calls together, where that may not be obvious from reading " @@ -163,12 +171,14 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:62 +#. type: =head2 +#: ../src/guestfs.pod:64 msgid "HANDLES" msgstr "" # type: textblock -#: ../src/guestfs.pod:64 +#. type: textblock +#: ../src/guestfs.pod:66 msgid "" "Before you can use libguestfs calls, you have to create a handle. Then you " "must add at least one disk image to the handle, followed by launching the " @@ -178,12 +188,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:71 +#. type: textblock +#: ../src/guestfs.pod:73 msgid "The general structure of all libguestfs-using programs looks like this:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:74 +#. type: verbatim +#: ../src/guestfs.pod:76 #, no-wrap msgid "" " guestfs_h *g = guestfs_create ();\n" @@ -191,7 +203,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:76 +#. type: verbatim +#: ../src/guestfs.pod:78 #, no-wrap msgid "" " /* Call guestfs_add_drive additional times if there are\n" @@ -202,7 +215,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:81 +#. type: verbatim +#: ../src/guestfs.pod:83 #, no-wrap msgid "" " /* Most manipulation calls won't work until you've launched\n" @@ -214,7 +228,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:87 +#. type: verbatim +#: ../src/guestfs.pod:89 #, no-wrap msgid "" " /* Now you can examine what partitions, LVs etc are available.\n" @@ -225,7 +240,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:92 +#. type: verbatim +#: ../src/guestfs.pod:94 #, no-wrap msgid "" " /* To access a filesystem in the image, you must mount it.\n" @@ -235,31 +251,33 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:96 +#. type: verbatim +#: ../src/guestfs.pod:98 #, no-wrap msgid "" " /* Now you can perform filesystem actions on the guest\n" " * disk image.\n" " */\n" " guestfs_touch (g, \"/hello\");\n" -" \n" +"\n" msgstr "" # type: verbatim -#: ../src/guestfs.pod:101 +#. type: verbatim +#: ../src/guestfs.pod:103 #, no-wrap msgid "" -" /* You only need to call guestfs_sync if you have made\n" -" * changes to the guest image. (But if you've made changes\n" -" * then you *must* sync). See also: guestfs_umount and\n" -" * guestfs_umount_all calls.\n" +" /* This is only needed for libguestfs < 1.5.24. Since then\n" +" * it is done automatically when you close the handle. See\n" +" * discussion of autosync in this page.\n" " */\n" " guestfs_sync (g);\n" " \n" msgstr "" # type: verbatim -#: ../src/guestfs.pod:108 +#. type: verbatim +#: ../src/guestfs.pod:109 #, no-wrap msgid "" " /* Close the handle 'g'. */\n" @@ -268,23 +286,27 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:111 +#. type: textblock +#: ../src/guestfs.pod:112 msgid "" "The code above doesn't include any error checking. In real code you should " "check return values carefully for errors. In general all functions that " "return integers return C<-1> on error, and all functions that return " "pointers return C on error. See section L below for " "how to handle errors, and consult the documentation for each function call " -"below to see precisely how they return error indications." +"below to see precisely how they return error indications. See L for fully worked examples." msgstr "" # type: =head2 -#: ../src/guestfs.pod:119 +#. type: =head2 +#: ../src/guestfs.pod:121 msgid "DISK IMAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:121 +#. type: textblock +#: ../src/guestfs.pod:123 msgid "" "The image filename (C<\"guest.img\"> in the example above) could be a disk " "image from a virtual machine, a L copy of a physical hard disk, an " @@ -294,7 +316,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:127 +#. type: textblock +#: ../src/guestfs.pod:129 msgid "" "The call you should use in modern code for adding drives is L. To add a disk image, allowing writes, and " @@ -302,7 +325,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:131 +#. type: verbatim +#: ../src/guestfs.pod:133 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -312,12 +336,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:135 +#. type: textblock +#: ../src/guestfs.pod:137 msgid "You can add a disk read-only using:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:137 +#. type: verbatim +#: ../src/guestfs.pod:139 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -328,14 +354,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:142 +#. type: textblock +#: ../src/guestfs.pod:144 msgid "" "or by calling the older function L. In either case " "libguestfs won't modify the file." msgstr "" # type: textblock -#: ../src/guestfs.pod:145 +#. type: textblock +#: ../src/guestfs.pod:147 msgid "" "Be extremely cautious if the disk image is in use, eg. if it is being used " "by a virtual machine. Adding it read-write will almost certainly cause disk " @@ -343,7 +371,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:149 +#. type: textblock +#: ../src/guestfs.pod:151 msgid "" "You must add at least one disk image, and you may add multiple disk images. " "In the API, the disk images are usually referred to as C (for the " @@ -351,7 +380,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:154 +#. type: textblock +#: ../src/guestfs.pod:156 msgid "" "Once L has been called you cannot add any more images. You " "can call L to get a list of the device names, in the " @@ -359,63 +389,74 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:159 +#. type: =head2 +#: ../src/guestfs.pod:161 msgid "MOUNTING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:161 +#. type: textblock +#: ../src/guestfs.pod:163 msgid "" "Before you can read or write files, create directories and so on in a disk " "image that contains filesystems, you have to mount those filesystems using " -"L. If you already know that a disk image contains (for " -"example) one partition with a filesystem on that partition, then you can " -"mount it directly:" +"L or L. If you already know that " +"a disk image contains (for example) one partition with a filesystem on that " +"partition, then you can mount it directly:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:167 +#. type: verbatim +#: ../src/guestfs.pod:170 #, no-wrap msgid "" -" guestfs_mount (g, \"/dev/sda1\", \"/\");\n" +" guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:169 +#. type: textblock +#: ../src/guestfs.pod:172 msgid "" "where C means literally the first partition (C<1>) of the first " "disk image that we added (C). If the disk contains Linux LVM2 " -"logical volumes you could refer to those instead (eg. C)." +"logical volumes you could refer to those instead (eg. C). Note " +"that these are libguestfs virtual devices, and are nothing to do with host " +"devices." msgstr "" -# type: textblock -#: ../src/guestfs.pod:173 +#. type: textblock +#: ../src/guestfs.pod:178 msgid "" "If you are given a disk image and you don't know what it contains then you " "have to find out. Libguestfs can do that too: use L and L to list possible partitions and " "LVs, and either try mounting each to see what is mountable, or else examine " -"them with L or L. Libguestfs also has a " -"set of APIs for inspection of disk images (see L below). But " -"you might find it easier to look at higher level programs built on top of " -"libguestfs, in particular L." +"them with L or L. To list just " +"filesystems, use L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:183 +#. type: textblock +#: ../src/guestfs.pod:186 msgid "" -"To mount a disk image read-only, use L. There are " +"Libguestfs also has a set of APIs for inspection of unknown disk images (see " +"L below). But you might find it easier to look at higher level " +"programs built on top of libguestfs, in particular L." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:191 +msgid "" +"To mount a filesystem read-only, use L. There are " "several other variations of the C call." msgstr "" # type: =head2 -#: ../src/guestfs.pod:186 +#. type: =head2 +#: ../src/guestfs.pod:194 msgid "FILESYSTEM ACCESS AND MODIFICATION" msgstr "" # type: textblock -#: ../src/guestfs.pod:188 +#. type: textblock +#: ../src/guestfs.pod:196 msgid "" "The majority of the libguestfs API consists of fairly low-level calls for " "accessing and modifying the files, directories, symlinks etc on mounted " @@ -425,21 +466,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:194 +#. type: textblock +#: ../src/guestfs.pod:202 msgid "" "Specify filenames as full paths, starting with C<\"/\"> and including the " "mount point." msgstr "" # type: textblock -#: ../src/guestfs.pod:197 +#. type: textblock +#: ../src/guestfs.pod:205 msgid "" "For example, if you mounted a filesystem at C<\"/\"> and you want to read " "the file called C<\"etc/passwd\"> then you could do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:200 +#. type: verbatim +#: ../src/guestfs.pod:208 #, no-wrap msgid "" " char *data = guestfs_cat (g, \"/etc/passwd\");\n" @@ -447,7 +491,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:202 +#. type: textblock +#: ../src/guestfs.pod:210 msgid "" "This would return C as a newly allocated buffer containing the full " "content of that file (with some conditions: see also L below), " @@ -455,14 +500,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:206 +#. type: textblock +#: ../src/guestfs.pod:214 msgid "" "As another example, to create a top-level directory on that filesystem " "called C<\"var\"> you would do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:209 +#. type: verbatim +#: ../src/guestfs.pod:217 #, no-wrap msgid "" " guestfs_mkdir (g, \"/var\");\n" @@ -470,12 +517,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:211 +#. type: textblock +#: ../src/guestfs.pod:219 msgid "To create a symlink you could do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:213 +#. type: verbatim +#: ../src/guestfs.pod:221 #, no-wrap msgid "" " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n" @@ -484,14 +533,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:216 +#. type: textblock +#: ../src/guestfs.pod:224 msgid "" "Libguestfs will reject attempts to use relative paths and there is no " "concept of a current working directory." msgstr "" # type: textblock -#: ../src/guestfs.pod:219 +#. type: textblock +#: ../src/guestfs.pod:227 msgid "" "Libguestfs can return errors in many situations: for example if the " "filesystem isn't writable, or if a file or directory that you requested " @@ -501,33 +552,38 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:225 +#. type: textblock +#: ../src/guestfs.pod:233 msgid "" "File writes are affected by the per-handle umask, set by calling L and defaulting to 022. See L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:228 +#. type: =head2 +#: ../src/guestfs.pod:236 msgid "PARTITIONING" msgstr "" # type: textblock -#: ../src/guestfs.pod:230 +#. type: textblock +#: ../src/guestfs.pod:238 msgid "" "Libguestfs contains API calls to read, create and modify partition tables on " "disk images." msgstr "" # type: textblock -#: ../src/guestfs.pod:233 +#. type: textblock +#: ../src/guestfs.pod:241 msgid "" "In the common case where you want to create a single partition covering the " "whole disk, you should use the L call:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:237 +#. type: verbatim +#: ../src/guestfs.pod:245 #, no-wrap msgid "" " const char *parttype = \"mbr\";\n" @@ -538,18 +594,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:242 +#. type: textblock +#: ../src/guestfs.pod:250 msgid "" "Obviously this effectively wipes anything that was on that disk image before." msgstr "" # type: =head2 -#: ../src/guestfs.pod:245 +#. type: =head2 +#: ../src/guestfs.pod:253 msgid "LVM2" msgstr "" # type: textblock -#: ../src/guestfs.pod:247 +#. type: textblock +#: ../src/guestfs.pod:255 msgid "" "Libguestfs provides access to a large part of the LVM2 API, such as L and L. It won't make much sense unless " @@ -558,27 +617,30 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:252 +#. type: textblock +#: ../src/guestfs.pod:260 msgid "" "This author strongly recommends reading the LVM HOWTO, online at L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:255 +#. type: =head2 +#: ../src/guestfs.pod:263 msgid "DOWNLOADING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:257 +#. type: textblock +#: ../src/guestfs.pod:265 msgid "" "Use L to download small, text only files. This call is " "limited to files which are less than 2 MB and which cannot contain any ASCII " -"NUL (C<\\0>) characters. However it has a very simple to use API." +"NUL (C<\\0>) characters. However the API is very simple to use." msgstr "" # type: textblock -#: ../src/guestfs.pod:262 +#. type: textblock +#: ../src/guestfs.pod:269 msgid "" "L can be used to read files which contain arbitrary 8 " "bit data, since it returns a (pointer, size) pair. However it is still " @@ -586,31 +648,36 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:266 +#. type: textblock +#: ../src/guestfs.pod:273 msgid "" "L can be used to download any file, with no limits on " "content or size (even files larger than 4 GB)." msgstr "" # type: textblock -#: ../src/guestfs.pod:269 +#. type: textblock +#: ../src/guestfs.pod:276 msgid "" "To download multiple files, see L and L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:272 +#. type: =head2 +#: ../src/guestfs.pod:279 msgid "UPLOADING" msgstr "" # type: textblock -#: ../src/guestfs.pod:274 +#. type: textblock +#: ../src/guestfs.pod:281 msgid "" "It's often the case that you want to write a file or files to the disk image." msgstr "" # type: textblock -#: ../src/guestfs.pod:277 +#. type: textblock +#: ../src/guestfs.pod:284 msgid "" "To write a small file with fixed content, use L. To create " "a file of all zeroes, use L (sparse) or L. This call has no limits on " "file content or size (even files larger than 4 GB)." msgstr "" # type: textblock -#: ../src/guestfs.pod:286 +#. type: textblock +#: ../src/guestfs.pod:293 msgid "" "To upload multiple files, see L and L." msgstr "" # type: textblock -#: ../src/guestfs.pod:288 +#. type: textblock +#: ../src/guestfs.pod:295 msgid "" "However the fastest way to upload I is to " "turn them into a squashfs or CD ISO (see L and L to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:309 +#. type: textblock +#: ../src/guestfs.pod:316 msgid "" "Use L to copy a single file, or L to copy " "directories recursively." msgstr "" # type: =item -#: ../src/guestfs.pod:312 +#. type: =item +#: ../src/guestfs.pod:319 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:314 +#. type: textblock +#: ../src/guestfs.pod:321 msgid "" "Use L which efficiently uses L to copy between files and " "devices in the guest." msgstr "" # type: textblock -#: ../src/guestfs.pod:317 +#. type: textblock +#: ../src/guestfs.pod:324 msgid "Example: duplicate the contents of an LV:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:319 +#. type: verbatim +#: ../src/guestfs.pod:326 #, no-wrap msgid "" " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n" @@ -697,7 +775,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:321 +#. type: textblock +#: ../src/guestfs.pod:328 msgid "" "The destination (C) must be at least as large as the source " "(C). To copy less than the whole source device, use L to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:327 +#. type: textblock +#: ../src/guestfs.pod:334 msgid "Use L. See L above." msgstr "" # type: =item -#: ../src/guestfs.pod:329 +#. type: =item +#: ../src/guestfs.pod:336 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:331 +#. type: textblock +#: ../src/guestfs.pod:338 msgid "Use L. See L above." msgstr "" # type: =head2 -#: ../src/guestfs.pod:335 +#. type: =head2 +#: ../src/guestfs.pod:342 +msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:344 +msgid "" +"Calls like L, L, L, L etc appear to only take filenames as arguments, so it " +"appears you can only upload and download to files. However many Un*x-like " +"hosts let you use the special device files C, C, C and C to read and write from stdin, stdout, stderr, " +"and arbitrary file descriptor N." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:352 +msgid "For example, L writes its output to stdout by doing:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:355 +#, no-wrap +msgid "" +" guestfs_download (g, filename, \"/dev/stdout\");\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:357 +msgid "and you can write tar output to a pipe C by doing:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:359 +#, no-wrap +msgid "" +" char devfd[64];\n" +" snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n" +" guestfs_tar_out (g, \"/\", devfd);\n" +"\n" +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:363 msgid "LISTING FILES" msgstr "" # type: textblock -#: ../src/guestfs.pod:337 +#. type: textblock +#: ../src/guestfs.pod:365 msgid "" "L is just designed for humans to read (mainly when using the " "L-equivalent command C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:340 +#. type: textblock +#: ../src/guestfs.pod:368 msgid "" "L is a quick way to get a list of files in a directory from " "programs, as a flat list of strings." msgstr "" # type: textblock -#: ../src/guestfs.pod:343 +#. type: textblock +#: ../src/guestfs.pod:371 msgid "" "L is a programmatic way to get a list of files in a " "directory, plus additional information about each one. It is more " @@ -752,18 +887,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:347 +#. type: textblock +#: ../src/guestfs.pod:375 msgid "" "L and L can be used to recursively list files." msgstr "" # type: =head2 -#: ../src/guestfs.pod:350 +#. type: =head2 +#: ../src/guestfs.pod:378 msgid "RUNNING COMMANDS" msgstr "" # type: textblock -#: ../src/guestfs.pod:352 +#. type: textblock +#: ../src/guestfs.pod:380 msgid "" "Although libguestfs is primarily an API for manipulating files inside guest " "images, we also provide some limited facilities for running commands inside " @@ -771,98 +909,110 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:356 +#. type: textblock +#: ../src/guestfs.pod:384 msgid "There are many limitations to this:" msgstr "" # type: =item -#: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370 -#: ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383 -#: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:1224 -#: ../src/guestfs.pod:1229 ../src/guestfs.pod:1233 ../src/guestfs.pod:1449 -#: ../src/guestfs.pod:1454 ../src/guestfs.pod:1458 ../src/guestfs.pod:1560 -#: ../src/guestfs.pod:1564 ../src/guestfs.pod:1568 ../src/guestfs.pod:1573 -#: ../src/guestfs.pod:1581 ../src/guestfs.pod:1600 ../src/guestfs.pod:1608 -#: ../src/guestfs.pod:1838 ../src/guestfs.pod:1844 ../src/guestfs.pod:1849 -#: ../src/guestfs.pod:1855 ../src/guestfs.pod:1962 ../src/guestfs.pod:1966 -#: ../src/guestfs.pod:1970 ../src/guestfs.pod:1974 +#. type: =item +#: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 +#: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 +#: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1011 +#: ../src/guestfs.pod:1015 ../src/guestfs.pod:1019 ../src/guestfs.pod:1024 +#: ../src/guestfs.pod:1032 ../src/guestfs.pod:1051 ../src/guestfs.pod:1059 +#: ../src/guestfs.pod:1081 ../src/guestfs.pod:1085 ../src/guestfs.pod:1089 +#: ../src/guestfs.pod:1093 ../src/guestfs.pod:1097 ../src/guestfs.pod:1101 +#: ../src/guestfs.pod:1583 ../src/guestfs.pod:1588 ../src/guestfs.pod:1592 +#: ../src/guestfs.pod:1702 ../src/guestfs.pod:1707 ../src/guestfs.pod:1711 +#: ../src/guestfs.pod:2063 ../src/guestfs.pod:2069 ../src/guestfs.pod:2074 +#: ../src/guestfs.pod:2080 ../src/guestfs.pod:2544 ../src/guestfs.pod:2548 +#: ../src/guestfs.pod:2552 ../src/guestfs.pod:2556 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 -#: ../src/guestfs-actions.pod:461 ../src/guestfs-actions.pod:469 -#: ../src/guestfs-actions.pod:476 ../src/guestfs-actions.pod:483 -#: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1426 -#: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1434 -#: ../src/guestfs-actions.pod:1442 ../src/guestfs-actions.pod:1446 -#: ../src/guestfs-actions.pod:1450 ../src/guestfs-actions.pod:1460 -#: ../src/guestfs-actions.pod:1464 ../src/guestfs-actions.pod:1468 -#: ../src/guestfs-actions.pod:1596 ../src/guestfs-actions.pod:1600 -#: ../src/guestfs-actions.pod:1605 ../src/guestfs-actions.pod:1610 -#: ../src/guestfs-actions.pod:1665 ../src/guestfs-actions.pod:1669 -#: ../src/guestfs-actions.pod:1674 ../fish/guestfish.pod:364 -#: ../fish/guestfish.pod:368 ../fish/guestfish.pod:372 -#: ../fish/guestfish.pod:376 ../fish/guestfish-actions.pod:13 -#: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:339 -#: ../fish/guestfish-actions.pod:347 ../fish/guestfish-actions.pod:354 -#: ../fish/guestfish-actions.pod:361 ../fish/guestfish-actions.pod:1056 -#: ../fish/guestfish-actions.pod:1060 ../fish/guestfish-actions.pod:1064 -#: ../fish/guestfish-actions.pod:1068 ../fish/guestfish-actions.pod:1076 -#: ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084 -#: ../fish/guestfish-actions.pod:1094 ../fish/guestfish-actions.pod:1098 -#: ../fish/guestfish-actions.pod:1102 ../fish/guestfish-actions.pod:1192 -#: ../fish/guestfish-actions.pod:1196 ../fish/guestfish-actions.pod:1201 -#: ../fish/guestfish-actions.pod:1206 ../fish/guestfish-actions.pod:1248 -#: ../fish/guestfish-actions.pod:1252 ../fish/guestfish-actions.pod:1257 -#: ../inspector/virt-inspector.pl:584 ../inspector/virt-inspector.pl:588 -#: ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348 -#: ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363 +#: ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577 +#: ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591 +#: ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591 +#: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 +#: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 +#: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625 +#: ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633 +#: ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775 +#: ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785 +#: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 +#: ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:427 +#: ../fish/guestfish.pod:431 ../fish/guestfish.pod:435 +#: ../fish/guestfish.pod:439 ../fish/guestfish-actions.pod:13 +#: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:373 +#: ../fish/guestfish-actions.pod:381 ../fish/guestfish-actions.pod:388 +#: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:1065 +#: ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1073 +#: ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1085 +#: ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1093 +#: ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107 +#: ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1201 +#: ../fish/guestfish-actions.pod:1205 ../fish/guestfish-actions.pod:1210 +#: ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1257 +#: ../fish/guestfish-actions.pod:1261 ../fish/guestfish-actions.pod:1266 +#: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 +#: ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 +#: ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360 msgid "*" msgstr "" # type: textblock -#: ../src/guestfs.pod:362 +#. type: textblock +#: ../src/guestfs.pod:390 msgid "" "The kernel version that the command runs under will be different from what " "it expects." msgstr "" # type: textblock -#: ../src/guestfs.pod:367 +#. type: textblock +#: ../src/guestfs.pod:395 msgid "" "If the command needs to communicate with daemons, then most likely they " "won't be running." msgstr "" # type: textblock -#: ../src/guestfs.pod:372 +#. type: textblock +#: ../src/guestfs.pod:400 msgid "The command will be running in limited memory." msgstr "" # type: textblock -#: ../src/guestfs.pod:376 +#. type: textblock +#: ../src/guestfs.pod:404 msgid "" "The network may not be available unless you enable it (see L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:381 +#. type: textblock +#: ../src/guestfs.pod:409 msgid "Only supports Linux guests (not Windows, BSD, etc)." msgstr "" # type: textblock -#: ../src/guestfs.pod:385 +#. type: textblock +#: ../src/guestfs.pod:413 msgid "" "Architecture limitations (eg. won't work for a PPC guest on an X86 host)." msgstr "" # type: textblock -#: ../src/guestfs.pod:390 +#. type: textblock +#: ../src/guestfs.pod:418 msgid "" "For SELinux guests, you may need to enable SELinux and load policy first. " "See L in this manpage." msgstr "" # type: textblock -#: ../src/guestfs.pod:395 +#. type: textblock +#: ../src/guestfs.pod:423 msgid "" "I It is not safe to run commands from untrusted, possibly " "malicious guests. These commands may attempt to exploit your program by " @@ -874,35 +1024,41 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:404 +#. type: textblock +#: ../src/guestfs.pod:432 msgid "" "A secure alternative is to use libguestfs to install a \"firstboot\" script " "(a script which runs when the guest next boots normally), and to have this " "script run the commands you want in the normal context of the running guest, " -"network security and so on." +"network security and so on. For information about other security issues, " +"see L." msgstr "" # type: textblock -#: ../src/guestfs.pod:411 +#. type: textblock +#: ../src/guestfs.pod:440 msgid "" "The two main API calls to run commands are L and L (there are also variations)." msgstr "" # type: textblock -#: ../src/guestfs.pod:414 +#. type: textblock +#: ../src/guestfs.pod:443 msgid "" "The difference is that L runs commands using the shell, so any " "shell globs, redirections, etc will work." msgstr "" # type: =head2 -#: ../src/guestfs.pod:417 +#. type: =head2 +#: ../src/guestfs.pod:446 msgid "CONFIGURATION FILES" msgstr "" # type: textblock -#: ../src/guestfs.pod:419 +#. type: textblock +#: ../src/guestfs.pod:448 msgid "" "To read and write configuration files in Linux guest filesystems, we " "strongly recommend using Augeas. For example, Augeas understands how to " @@ -911,7 +1067,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:424 +#. type: textblock +#: ../src/guestfs.pod:453 msgid "" "The main Augeas calls are bound through the C APIs. We don't " "document Augeas itself here because there is excellent documentation on the " @@ -919,7 +1076,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:428 +#. type: textblock +#: ../src/guestfs.pod:457 msgid "" "If you don't want to use Augeas (you fool!) then try calling L to get the file as a list of lines which you can iterate " @@ -927,29 +1085,35 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:432 +#. type: =head2 +#: ../src/guestfs.pod:461 msgid "SELINUX" msgstr "" # type: textblock -#: ../src/guestfs.pod:434 +#. type: textblock +#: ../src/guestfs.pod:463 msgid "" "We support SELinux guests. To ensure that labeling happens correctly in " "SELinux guests, you need to enable SELinux and load the guest's policy:" msgstr "" # type: =item -#: ../src/guestfs.pod:440 ../src/guestfs.pod:953 +#. type: =item +#: ../src/guestfs.pod:469 ../src/guestfs.pod:1204 ../src/guestfs.pod:1335 +#: ../src/guestfs.pod:2108 msgid "1." msgstr "" # type: textblock -#: ../src/guestfs.pod:442 +#. type: textblock +#: ../src/guestfs.pod:471 msgid "Before launching, do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:444 +#. type: verbatim +#: ../src/guestfs.pod:473 #, no-wrap msgid "" " guestfs_set_selinux (g, 1);\n" @@ -957,19 +1121,23 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:446 ../src/guestfs.pod:957 +#. type: =item +#: ../src/guestfs.pod:475 ../src/guestfs.pod:1208 ../src/guestfs.pod:1339 +#: ../src/guestfs.pod:2133 msgid "2." msgstr "" # type: textblock -#: ../src/guestfs.pod:448 +#. type: textblock +#: ../src/guestfs.pod:477 msgid "" "After mounting the guest's filesystem(s), load the policy. This is best " "done by running the L command in the guest itself:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:452 +#. type: verbatim +#: ../src/guestfs.pod:481 #, no-wrap msgid "" " guestfs_sh (g, \"/usr/sbin/load_policy\");\n" @@ -977,26 +1145,30 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:454 +#. type: textblock +#: ../src/guestfs.pod:483 msgid "" "(Older versions of C require you to specify the name of the " "policy file)." msgstr "" # type: =item -#: ../src/guestfs.pod:457 ../src/guestfs.pod:963 +#. type: =item +#: ../src/guestfs.pod:486 ../src/guestfs.pod:1345 msgid "3." msgstr "" # type: textblock -#: ../src/guestfs.pod:459 +#. type: textblock +#: ../src/guestfs.pod:488 msgid "" "Optionally, set the security context for the API. The correct security " "context to use can only be known by inspecting the guest. As an example:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:463 +#. type: verbatim +#: ../src/guestfs.pod:492 #, no-wrap msgid "" " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n" @@ -1004,24 +1176,28 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:467 +#. type: textblock +#: ../src/guestfs.pod:496 msgid "This will work for running commands and editing existing files." msgstr "" # type: textblock -#: ../src/guestfs.pod:469 +#. type: textblock +#: ../src/guestfs.pod:498 msgid "" "When new files are created, you may need to label them explicitly, for " "example by running the external command C." msgstr "" # type: =head2 -#: ../src/guestfs.pod:473 +#. type: =head2 +#: ../src/guestfs.pod:502 msgid "UMASK" msgstr "" # type: textblock -#: ../src/guestfs.pod:475 +#. type: textblock +#: ../src/guestfs.pod:504 msgid "" "Certain calls are affected by the current file mode creation mask (the " "\"umask\"). In particular ones which create files or directories, such as " @@ -1031,14 +1207,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:481 +#. type: textblock +#: ../src/guestfs.pod:510 msgid "" "The default umask is C<022>, so files are created with modes such as C<0644> " "and directories with C<0755>." msgstr "" # type: textblock -#: ../src/guestfs.pod:484 +#. type: textblock +#: ../src/guestfs.pod:513 msgid "" "There are two ways to avoid being affected by umask. Either set umask to 0 " "(call C early after launching). Or call L." msgstr "" # type: =head1 -#: ../src/guestfs.pod:490 ../fish/guestfish.pod:630 +#. type: =head1 +#: ../src/guestfs.pod:519 ../fish/guestfish.pod:720 msgid "ENCRYPTED DISKS" msgstr "" # type: textblock -#: ../src/guestfs.pod:492 +#. type: textblock +#: ../src/guestfs.pod:521 msgid "" "Libguestfs allows you to access Linux guests which have been encrypted using " "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) " @@ -1065,21 +1246,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:498 +#. type: textblock +#: ../src/guestfs.pod:527 msgid "" "Use L to identify LUKS-encrypted block devices (it " "returns the string C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:501 +#. type: textblock +#: ../src/guestfs.pod:530 msgid "" "Then open these devices by calling L. Obviously you " "will require the passphrase!" msgstr "" # type: textblock -#: ../src/guestfs.pod:504 +#. type: textblock +#: ../src/guestfs.pod:533 msgid "" "Opening a LUKS device creates a new device mapper device called C (where C is the string you supply to L followed by L. The logical volume" @@ -1096,7 +1281,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:514 +#. type: textblock +#: ../src/guestfs.pod:543 msgid "" "Use the reverse process to close a LUKS device. Unmount any logical volumes " "on it, deactivate the volume groups by caling C in the usual way." msgstr "" # type: textblock -#: ../src/guestfs.pod:532 +#. type: textblock +#: ../src/guestfs.pod:561 msgid "" "Then call L. This function uses other libguestfs calls " "and certain heuristics, and returns a list of operating systems that were " @@ -1141,7 +1331,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:541 +#. type: textblock +#: ../src/guestfs.pod:570 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" @@ -1171,21 +1364,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:558 +#. type: textblock +#: ../src/guestfs.pod:587 msgid "" "The caller can then make calls to L to mount the " "filesystems as suggested." msgstr "" # type: textblock -#: ../src/guestfs.pod:561 +#. type: textblock +#: ../src/guestfs.pod:590 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:565 +#. type: textblock +#: ../src/guestfs.pod:594 msgid "" "Inspection currently only works for some common operating systems. " "Contributors are welcome to send patches for other operating systems that we " @@ -1193,7 +1389,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:569 +#. type: textblock +#: ../src/guestfs.pod:598 msgid "" "Encrypted disks must be opened before inspection. See L " "for more details. The L function just ignores any " @@ -1201,29 +1398,42 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:573 +#. type: textblock +#: ../src/guestfs.pod:602 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:580 +#. type: =head2 +#: ../src/guestfs.pod:611 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:582 +#. type: textblock +#: ../src/guestfs.pod:613 msgid "" "Libguestfs can mount NTFS partitions. It does this using the L driver." msgstr "" +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:616 +msgid "DRIVE LETTERS AND PATHS" +msgstr "" + # type: textblock -#: ../src/guestfs.pod:585 +#. type: textblock +#: ../src/guestfs.pod:618 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 " @@ -1233,7 +1443,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:591 +#. type: textblock +#: ../src/guestfs.pod:624 msgid "" "Drive letter mappings are outside the scope of libguestfs. You have to use " "libguestfs to read the appropriate Windows Registry and configuration files, " @@ -1242,21 +1453,30 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:596 +#. type: textblock +#: ../src/guestfs.pod:629 msgid "" "Replacing backslash characters with forward slash characters is also outside " "the scope of libguestfs, but something that you can easily do." msgstr "" # type: textblock -#: ../src/guestfs.pod:599 +#. type: textblock +#: ../src/guestfs.pod:632 msgid "" "Where we can help is in resolving the case insensitivity of paths. For " "this, call L." msgstr "" +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:635 +msgid "ACCESSING THE WINDOWS REGISTRY" +msgstr "" + # type: textblock -#: ../src/guestfs.pod:602 +#. type: textblock +#: ../src/guestfs.pod:637 msgid "" "Libguestfs also provides some help for decoding Windows Registry \"hive\" " "files, through the library C which is part of the libguestfs project " @@ -1266,36 +1486,106 @@ msgid "" "reg(1)> for more help on this issue." msgstr "" +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:645 +msgid "SYMLINKS ON NTFS-3G FILESYSTEMS" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:647 +msgid "" +"Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to " +"provide something which looks like a Linux symlink. The way it tries to do " +"the rewriting is described here:" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:651 +msgid "" +"L" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:653 +msgid "" +"The essential problem is that ntfs-3g simply does not have enough " +"information to do a correct job. NTFS links can contain drive letters and " +"references to external device GUIDs that ntfs-3g has no way of resolving. " +"It is almost certainly the case that libguestfs callers should ignore what " +"ntfs-3g does (ie. don't use L on NTFS volumes)." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:660 +msgid "" +"Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L to read the C extended " +"attribute, and read the raw reparse data from that (you can find the format " +"documented in various places around the web)." +msgstr "" + +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:665 +msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:667 +msgid "" +"There are other useful extended attributes that can be read from ntfs-3g " +"filesystems (using L). See:" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:670 +msgid "" +"L" +msgstr "" + # type: =head2 -#: ../src/guestfs.pod:610 +#. type: =head2 +#: ../src/guestfs.pod:672 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:612 +#. type: textblock +#: ../src/guestfs.pod:674 msgid "" "Although we don't want to discourage you from using the C API, we will " "mention here that the same API is also available in other languages." msgstr "" -# type: textblock -#: ../src/guestfs.pod:615 +#. type: textblock +#: ../src/guestfs.pod:677 msgid "" "The API is broadly identical in all supported languages. This means that " -"the C call C is C<$g-Emount($path)> in Perl, C in Python, and C in OCaml. In other " -"words, a straightforward, predictable isomorphism between each language." +"the C call C is C<$g-Eadd_drive_ro($file)> " +"in Perl, C in Python, and C in " +"OCaml. In other words, a straightforward, predictable isomorphism between " +"each language." msgstr "" # type: textblock -#: ../src/guestfs.pod:621 +#. type: textblock +#: ../src/guestfs.pod:683 msgid "" "Error messages are automatically transformed into exceptions if the language " "supports it." msgstr "" # type: textblock -#: ../src/guestfs.pod:624 +#. type: textblock +#: ../src/guestfs.pod:686 msgid "" "We don't try to \"object orientify\" parts of the API in OO languages, " "although contributors are welcome to write higher level APIs above what we " @@ -1303,36 +1593,42 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:630 +#. type: =item +#: ../src/guestfs.pod:692 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:632 +#. type: textblock +#: ../src/guestfs.pod:694 msgid "" "You can use the I header file from C++ programs. The C++ API is " "identical to the C API. C++ classes and exceptions are not used." msgstr "" # type: =item -#: ../src/guestfs.pod:636 +#. type: =item +#: ../src/guestfs.pod:698 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:638 +#. type: textblock +#: ../src/guestfs.pod:700 msgid "" "The C# bindings are highly experimental. Please read the warnings at the " "top of C." msgstr "" # type: =item -#: ../src/guestfs.pod:641 +#. type: =item +#: ../src/guestfs.pod:703 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:643 +#. type: textblock +#: ../src/guestfs.pod:705 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 " @@ -1340,103 +1636,103 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:647 +#. type: =item +#: ../src/guestfs.pod:709 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:649 +#. type: textblock +#: ../src/guestfs.pod:711 msgid "" "Full documentation is contained in the Javadoc which is distributed with " "libguestfs." msgstr "" # type: =item -#: ../src/guestfs.pod:652 +#. type: =item +#: ../src/guestfs.pod:714 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:654 -msgid "For documentation see the file C." +#. type: textblock +#: ../src/guestfs.pod:716 +msgid "See L." msgstr "" # type: =item -#: ../src/guestfs.pod:656 +#. type: =item +#: ../src/guestfs.pod:718 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:658 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:720 +msgid "See L." msgstr "" # type: =item -#: ../src/guestfs.pod:660 +#. type: =item +#: ../src/guestfs.pod:722 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:662 +#. type: textblock +#: ../src/guestfs.pod:724 msgid "" "For documentation see C supplied with libguestfs sources or in " "the php-libguestfs package for your distribution." msgstr "" # type: textblock -#: ../src/guestfs.pod:665 +#. type: textblock +#: ../src/guestfs.pod:727 msgid "The PHP binding only works correctly on 64 bit machines." msgstr "" # type: =item -#: ../src/guestfs.pod:667 +#. type: =item +#: ../src/guestfs.pod:729 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:669 -msgid "For documentation do:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:671 -#, no-wrap -msgid "" -" $ python\n" -" >>> import guestfs\n" -" >>> help (guestfs)\n" -"\n" +#. type: textblock +#: ../src/guestfs.pod:731 +msgid "See L." msgstr "" # type: =item -#: ../src/guestfs.pod:675 +#. type: =item +#: ../src/guestfs.pod:733 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:677 -msgid "" -"Use the Guestfs module. There is no Ruby-specific documentation, but you " -"can find examples written in Ruby in the libguestfs source." +#. type: textblock +#: ../src/guestfs.pod:735 +msgid "See L." msgstr "" # type: =item -#: ../src/guestfs.pod:680 +#. type: =item +#: ../src/guestfs.pod:737 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:682 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:739 +msgid "See L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:686 +#. type: =head2 +#: ../src/guestfs.pod:743 msgid "LIBGUESTFS GOTCHAS" msgstr "" # type: textblock -#: ../src/guestfs.pod:688 +#. type: textblock +#: ../src/guestfs.pod:745 msgid "" "L: \"A feature of a " "system [...] that works in the way it is documented but is counterintuitive " @@ -1444,7 +1740,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:692 +#. type: textblock +#: ../src/guestfs.pod:749 msgid "" "Since we developed libguestfs and the associated tools, there are several " "things we would have designed differently, but are now stuck with for " @@ -1453,12 +1750,14 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:700 +#. type: =item +#: ../src/guestfs.pod:757 msgid "Autosync / forgetting to sync." msgstr "" # type: textblock -#: ../src/guestfs.pod:702 +#. type: textblock +#: ../src/guestfs.pod:759 msgid "" "When modifying a filesystem from C or another language, you B unmount " "all filesystems and call L explicitly before you close the " @@ -1466,7 +1765,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:706 +#. type: verbatim +#: ../src/guestfs.pod:763 #, no-wrap msgid "" " guestfs_set_autosync (g, 1);\n" @@ -1474,14 +1774,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:708 +#. type: textblock +#: ../src/guestfs.pod:765 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:712 +#. type: textblock +#: ../src/guestfs.pod:769 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 " @@ -1489,7 +1791,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:716 +#. type: textblock +#: ../src/guestfs.pod:773 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 " @@ -1497,19 +1800,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:720 +#. type: textblock +#: ../src/guestfs.pod:777 msgid "" "Update: Autosync is enabled by default for all API users starting from " "libguestfs 1.5.24." msgstr "" # type: =item -#: ../src/guestfs.pod:723 +#. type: =item +#: ../src/guestfs.pod:780 msgid "Mount option C<-o sync> should not be the default." msgstr "" # type: textblock -#: ../src/guestfs.pod:725 +#. type: textblock +#: ../src/guestfs.pod:782 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 " @@ -1517,31 +1823,36 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:729 +#. type: textblock +#: ../src/guestfs.pod:786 msgid "" "The work around is to use L and set the mount " "options that you actually want to use." msgstr "" # type: =item -#: ../src/guestfs.pod:732 +#. type: =item +#: ../src/guestfs.pod:789 msgid "Read-only should be the default." msgstr "" # type: textblock -#: ../src/guestfs.pod:734 +#. type: textblock +#: ../src/guestfs.pod:791 msgid "" "In L, I<--ro> should be the default, and you should have to " "specify I<--rw> if you want to make changes to the image." msgstr "" # type: textblock -#: ../src/guestfs.pod:737 +#. type: textblock +#: ../src/guestfs.pod:794 msgid "This would reduce the potential to corrupt live VM images." msgstr "" # type: textblock -#: ../src/guestfs.pod:739 +#. type: textblock +#: ../src/guestfs.pod:796 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 " @@ -1564,12 +1877,14 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:752 +#. type: =item +#: ../src/guestfs.pod:809 msgid "guestfish megabyte modifiers don't work right on all commands" msgstr "" # type: textblock -#: ../src/guestfs.pod:754 +#. type: textblock +#: ../src/guestfs.pod:811 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 " @@ -1579,12 +1894,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:761 +#. type: textblock +#: ../src/guestfs.pod:818 msgid "The most common is L. The guestfish command:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:763 +#. type: verbatim +#: ../src/guestfs.pod:820 #, no-wrap msgid "" " lvcreate LV VG 100M\n" @@ -1592,7 +1909,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:765 +#. type: textblock +#: ../src/guestfs.pod:822 msgid "" "does not do what you might expect. Instead because L is " "already expecting megabytes, this tries to create a 100 I (100 " @@ -1601,19 +1919,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:770 +#. type: textblock +#: ../src/guestfs.pod:827 msgid "" "This could be fixed in the generator by specially marking parameters and " "return values which take bytes or other units." msgstr "" # type: =item -#: ../src/guestfs.pod:773 +#. type: =item +#: ../src/guestfs.pod:830 msgid "Ambiguity between devices and paths" msgstr "" # type: textblock -#: ../src/guestfs.pod:775 +#. type: textblock +#: ../src/guestfs.pod:832 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 " @@ -1621,7 +1942,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:780 +#. type: textblock +#: ../src/guestfs.pod:837 msgid "" "In the current API we usually resolve this ambiguity by having two separate " "calls, for example L and L. " @@ -1630,7 +1952,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:786 +#. type: textblock +#: ../src/guestfs.pod:843 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 " @@ -1640,7 +1963,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:792 +#. type: verbatim +#: ../src/guestfs.pod:849 #, no-wrap msgid "" " type path = Path of string | Device of int | Partition of int * int\n" @@ -1648,12 +1972,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:794 +#. type: textblock +#: ../src/guestfs.pod:851 msgid "which would allow you to pass arguments like:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:796 +#. type: verbatim +#: ../src/guestfs.pod:853 #, no-wrap msgid "" " Path \"/foo/bar\"\n" @@ -1664,19 +1990,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:801 +#. type: textblock +#: ../src/guestfs.pod:858 msgid "" "As you can see there are still problems to resolve even with this " "representation. Also consider how it might work in guestfish." msgstr "" # type: =head2 -#: ../src/guestfs.pod:806 +#. type: =head2 +#: ../src/guestfs.pod:863 msgid "PROTOCOL LIMITS" msgstr "" # type: textblock -#: ../src/guestfs.pod:808 +#. type: textblock +#: ../src/guestfs.pod:865 msgid "" "Internally libguestfs uses a message-based protocol to pass API calls and " "their responses to and from a small \"appliance\" (see L for " @@ -1687,7 +2016,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:816 +#. type: textblock +#: ../src/guestfs.pod:873 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 " @@ -1696,7 +2026,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:822 +#. type: textblock +#: ../src/guestfs.pod:879 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 " @@ -1704,26 +2035,30 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:826 +#. type: textblock +#: ../src/guestfs.pod:883 msgid "" "You might also consider mounting the disk image using our FUSE filesystem " "support (L)." msgstr "" # type: =head2 -#: ../src/guestfs.pod:829 +#. type: =head2 +#: ../src/guestfs.pod:886 msgid "KEYS AND PASSPHRASES" msgstr "" # type: textblock -#: ../src/guestfs.pod:831 +#. type: textblock +#: ../src/guestfs.pod:888 msgid "" "Certain libguestfs calls take a parameter that contains sensitive key " "material, passed in as a C string." msgstr "" # type: textblock -#: ../src/guestfs.pod:834 +#. type: textblock +#: ../src/guestfs.pod:891 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 " @@ -1732,7 +2067,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:839 +#. type: textblock +#: ../src/guestfs.pod:896 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, " @@ -1740,6773 +2076,9706 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:844 -msgid "CONNECTION MANAGEMENT" -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:846 -msgid "guestfs_h *" +#. type: =head2 +#: ../src/guestfs.pod:901 +msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" msgstr "" # type: textblock -#: ../src/guestfs.pod:848 +#. type: textblock +#: ../src/guestfs.pod:903 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." +"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:852 +#. type: textblock +#: ../src/guestfs.pod:906 msgid "" -"For information on using multiple handles and threads, see the section L below." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:855 -msgid "guestfs_create" +"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: verbatim -#: ../src/guestfs.pod:857 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:910 msgid "" -" guestfs_h *guestfs_create (void);\n" -"\n" +"See the graphical program guestfs-browser for one possible architecture for " +"multithreaded programs using libvirt and libguestfs." msgstr "" -# type: textblock -#: ../src/guestfs.pod:859 -msgid "Create a connection handle." +# type: =head1 +#. type: =head2 +#: ../src/guestfs.pod:913 +msgid "PATH" msgstr "" # type: textblock -#: ../src/guestfs.pod:861 +#. type: textblock +#: ../src/guestfs.pod:915 msgid "" -"You have to call L (or one of the equivalent calls) " -"on the handle at least once." +"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " +"internal path." msgstr "" # type: textblock -#: ../src/guestfs.pod:864 +#. type: textblock +#: ../src/guestfs.pod:918 msgid "" -"This function returns a non-NULL pointer to a handle on success or NULL on " -"error." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:867 -msgid "After configuring the handle, you have to call L." +"By default it looks for these in the directory C<$libdir/guestfs> (eg. C or C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:869 +#. type: textblock +#: ../src/guestfs.pod:921 msgid "" -"You may also want to configure error handling for the handle. See L section below." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:872 -msgid "guestfs_close" +"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: verbatim -#: ../src/guestfs.pod:874 -#, no-wrap -msgid "" -" void guestfs_close (guestfs_h *g);\n" -"\n" +# type: =head1 +#. type: =head2 +#: ../src/guestfs.pod:928 +msgid "QEMU WRAPPERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:876 -msgid "This closes the connection handle and frees up all resources used." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:878 -msgid "ERROR HANDLING" +#. type: textblock +#: ../src/guestfs.pod:930 +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:880 +#. type: textblock +#: ../src/guestfs.pod:934 msgid "" -"API functions can return errors. For example, almost all functions that " -"return C will return C<-1> to indicate an error." +"There is one important rule to remember: you I> as the " +"last command in the shell script (so that qemu replaces the shell and " +"becomes the direct child of the libguestfs-using program). If you don't do " +"this, then the qemu process won't be cleaned up correctly." msgstr "" # type: textblock -#: ../src/guestfs.pod:883 +#. type: textblock +#: ../src/guestfs.pod:939 msgid "" -"Additional information is available for errors: an error message string and " -"optionally an error number (errno) if the thing that failed was a system " -"call." +"Here is an example of a wrapper, where I have built my own copy of qemu from " +"source:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:887 +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:942 +#, no-wrap msgid "" -"You can get at the additional information about the last error on the handle " -"by calling L, L, and/or by setting " -"up an error handler with L." +" #!/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:892 +#. type: textblock +#: ../src/guestfs.pod:946 msgid "" -"When the handle is created, a default error handler is installed which " -"prints the error message string to C. For small short-running " -"command line programs it is sufficient to do:" +"Save this script as C (or wherever), C, and " +"then use it by setting the LIBGUESTFS_QEMU environment variable. For " +"example:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:896 +#. type: verbatim +#: ../src/guestfs.pod:950 #, no-wrap msgid "" -" if (guestfs_launch (g) == -1)\n" -" exit (EXIT_FAILURE);\n" +" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:899 +#. type: textblock +#: ../src/guestfs.pod:952 msgid "" -"since the default error handler will ensure that an error message has been " -"printed to C before the program exits." +"Note that libguestfs also calls qemu with the -help and -version options in " +"order to determine features." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:955 +msgid "ABI GUARANTEE" msgstr "" # type: textblock -#: ../src/guestfs.pod:902 +#. type: textblock +#: ../src/guestfs.pod:957 msgid "" -"For other programs the caller will almost certainly want to install an " -"alternate error handler or do error handling in-line like this:" +"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: verbatim -#: ../src/guestfs.pod:905 -#, no-wrap +# type: =head1 +#. type: =head2 +#: ../src/guestfs.pod:963 +msgid "BLOCK DEVICE NAMING" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:965 msgid "" -" g = guestfs_create ();\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: verbatim -#: ../src/guestfs.pod:907 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:977 msgid "" -" /* This disables the default behaviour of printing errors\n" -" on stderr. */\n" -" guestfs_set_error_handler (g, NULL, NULL);\n" -" \n" +"As discussed above, libguestfs uses a qemu appliance running an embedded " +"Linux kernel to access block devices. We can run a variety of appliances " +"based on a variety of Linux kernels." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:911 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:981 msgid "" -" if (guestfs_launch (g) == -1) {\n" -" /* Examine the error message and print it etc. */\n" -" char *msg = guestfs_last_error (g);\n" -" int errnum = guestfs_last_errno (g);\n" -" fprintf (stderr, \"%s\\n\", msg);\n" -" /* ... */\n" -" }\n" -"\n" +"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:919 +#. type: textblock +#: ../src/guestfs.pod:986 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." +"Therefore libguestfs defines C as the I. " +"Internally C names are translated, if necessary, to other names as " +"required. For example, under RHEL 5 which uses the C scheme, any " +"device parameter C is translated to C transparently." msgstr "" # type: textblock -#: ../src/guestfs.pod:923 +#. type: textblock +#: ../src/guestfs.pod:992 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)." +"Note that this I applies to parameters. The L, " +"L and similar calls return the true names of the " +"devices and partitions as known to the appliance." msgstr "" # type: =head2 -#: ../src/guestfs.pod:929 -msgid "guestfs_last_error" +#. type: =head3 +#: ../src/guestfs.pod:997 +msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:931 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:999 msgid "" -" const char *guestfs_last_error (guestfs_h *g);\n" -"\n" +"Usually this translation is transparent. However in some (very rare) cases " +"you may need to know the exact algorithm. Such cases include where you use " +"L to add a mixture of virtio and IDE devices to the qemu-" +"based appliance, so have a mixture of C and C devices." msgstr "" # type: textblock -#: ../src/guestfs.pod:933 +#. type: textblock +#: ../src/guestfs.pod:1005 msgid "" -"This returns the last error message that happened on C. If there has not " -"been an error since the handle was created, then this returns C." +"The 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:937 -msgid "" -"The lifetime of the returned string is until the next error occurs, or L is called." +#. type: textblock +#: ../src/guestfs.pod:1013 +msgid "Is the string a parameter which is a device or partition name?" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:940 -msgid "guestfs_last_errno" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1017 +msgid "Does the string begin with C?" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:942 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1021 msgid "" -" int guestfs_last_errno (guestfs_h *g);\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:944 -msgid "This returns the last error number (errno) that happened on C." +#. type: textblock +#: ../src/guestfs.pod:1026 +msgid "Replace initial C string with C." msgstr "" # type: textblock -#: ../src/guestfs.pod:946 -msgid "If successful, an errno integer not equal to zero is returned." +#. type: textblock +#: ../src/guestfs.pod:1028 +msgid "For example, change C to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:948 -msgid "" -"If no error, this returns 0. This call can return 0 in three situations:" +#. type: textblock +#: ../src/guestfs.pod:1030 +msgid "If that named device exists, use it. If not, continue." msgstr "" # type: textblock -#: ../src/guestfs.pod:955 -msgid "There has not been any error on the handle." +#. type: textblock +#: ../src/guestfs.pod:1034 +msgid "Replace initial C string with C." msgstr "" # type: textblock -#: ../src/guestfs.pod:959 -msgid "" -"There has been an error but the errno was meaningless. This corresponds to " -"the case where the error did not come from a failed system call, but for " -"some other reason." +#. type: textblock +#: ../src/guestfs.pod:1036 +msgid "If that named device exists, use it. If not, return an error." msgstr "" -# type: textblock -#: ../src/guestfs.pod:965 -msgid "" -"There was an error from a failed system call, but for some reason the errno " -"was not captured and returned. This usually indicates a bug in libguestfs." +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:1040 +msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING" msgstr "" # type: textblock -#: ../src/guestfs.pod:971 +#. type: textblock +#: ../src/guestfs.pod:1042 msgid "" -"Libguestfs tries to convert the errno from inside the applicance into a " -"corresponding errno for the caller (not entirely trivial: the appliance " -"might be running a completely different operating system from the library " -"and error numbers are not standardized across Un*xen). If this could not be " -"done, then the error is translated to C. In practice this should " -"only happen in very rare circumstances." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:979 -msgid "guestfs_set_error_handler" +"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: verbatim -#: ../src/guestfs.pod:981 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1046 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" +"Where possible for maximum future portability programs using libguestfs " +"should use these future-proof techniques:" msgstr "" # type: textblock -#: ../src/guestfs.pod:988 +#. type: textblock +#: ../src/guestfs.pod:1053 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." +"Use L or L to list actual " +"device names, and then use those names directly." msgstr "" # type: textblock -#: ../src/guestfs.pod:992 +#. type: textblock +#: ../src/guestfs.pod:1056 msgid "" -"C is not passed to the callback. To get that the callback must call " -"L." +"Since those device names exist by definition, they will never be translated." msgstr "" # type: textblock -#: ../src/guestfs.pod:995 +#. type: textblock +#: ../src/guestfs.pod:1061 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." +"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " +"filesystem labels." msgstr "" -# type: textblock -#: ../src/guestfs.pod:999 -msgid "The default handler prints messages on C." +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1066 +msgid "SECURITY" msgstr "" # type: textblock -#: ../src/guestfs.pod:1001 -msgid "If you set C to C then I handler is called." +#. type: textblock +#: ../src/guestfs.pod:1068 +msgid "" +"This section discusses security implications of using libguestfs, " +"particularly with untrusted or malicious guests or disk images." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1003 -msgid "guestfs_get_error_handler" +#. type: =head2 +#: ../src/guestfs.pod:1071 +msgid "GENERAL SECURITY CONSIDERATIONS" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1005 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1073 msgid "" -" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" -" void **opaque_rtn);\n" -"\n" +"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:1008 -msgid "Returns the current error handler callback." +#. type: textblock +#: ../src/guestfs.pod:1083 +msgid "the data (file etc) not being present" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1010 -msgid "guestfs_set_out_of_memory_handler" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1087 +msgid "being present but empty" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1012 -#, 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 +#. type: textblock +#: ../src/guestfs.pod:1091 +msgid "being much larger than normal" msgstr "" # type: textblock -#: ../src/guestfs.pod:1016 -msgid "" -"The callback C will be called if there is an out of memory situation. " -"I." +#. type: textblock +#: ../src/guestfs.pod:1095 +msgid "containing arbitrary 8 bit data" msgstr "" # type: textblock -#: ../src/guestfs.pod:1019 -msgid "The default is to call L." +#. type: textblock +#: ../src/guestfs.pod:1099 +msgid "being in an unexpected character encoding" msgstr "" # type: textblock -#: ../src/guestfs.pod:1021 -msgid "" -"You cannot set C to C. You can't ignore out of memory situations." +#. type: textblock +#: ../src/guestfs.pod:1103 +msgid "containing homoglyphs." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1024 -msgid "guestfs_get_out_of_memory_handler" +#. type: =head2 +#: ../src/guestfs.pod:1107 +msgid "SECURITY OF MOUNTING FILESYSTEMS" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1026 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1109 msgid "" -" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" -"\n" +"When you mount a filesystem under Linux, mistakes in the kernel filesystem " +"(VFS) module can sometimes be escalated into exploits by deliberately " +"creating a malicious, malformed filesystem. These exploits are very severe " +"for two reasons. Firstly there are very many filesystem drivers in the " +"kernel, and many of them are infrequently used and not much developer " +"attention has been paid to the code. Linux userspace helps potential " +"crackers by detecting the filesystem type and automatically choosing the " +"right VFS driver, even if that filesystem type is obscure or unexpected for " +"the administrator. Secondly, a kernel-level exploit is like a local root " +"exploit (worse in some ways), giving immediate and total access to the " +"system right down to the hardware level." msgstr "" # type: textblock -#: ../src/guestfs.pod:1028 -msgid "This returns the current out of memory handler." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1030 -msgid "PATH" +#. type: textblock +#: ../src/guestfs.pod:1122 +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:1032 +#. type: textblock +#: ../src/guestfs.pod:1133 msgid "" -"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " -"internal path." +"In any case callers can reduce the attack surface by forcing the filesystem " +"type when mounting (use L)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1035 -msgid "" -"By default it looks for these in the directory C<$libdir/guestfs> (eg. C or C)." +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1136 +msgid "PROTOCOL SECURITY" msgstr "" # type: textblock -#: ../src/guestfs.pod:1038 +#. type: textblock +#: ../src/guestfs.pod:1138 msgid "" -"Use L or set the environment variable L " -"to change the directories that libguestfs will search in. The value is a " -"colon-separated list of paths. The current directory is I searched " -"unless the path contains an empty element or C<.>. For example " -"C would search the current directory and " -"then C." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1045 -msgid "HIGH-LEVEL API ACTIONS" +"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:1047 -msgid "ABI GUARANTEE" +#. type: =head2 +#: ../src/guestfs.pod:1144 +msgid "INSPECTION SECURITY" msgstr "" # type: textblock -#: ../src/guestfs.pod:1049 +#. type: textblock +#: ../src/guestfs.pod:1146 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." +"Parts of the inspection API (see L) return untrusted strings " +"directly from the guest, and these could contain any 8 bit data. Callers " +"should be careful to escape these before printing them to a structured file " +"(for example, use HTML escaping if creating a web page)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1055 ../fish/guestfish.pod:860 -msgid "@ACTIONS@" +#. type: textblock +#: ../src/guestfs.pod:1152 +msgid "" +"Guest configuration may be altered in unusual ways by the administrator of " +"the virtual machine, and may not reflect reality (particularly for untrusted " +"or actively malicious guests). For example we parse the hostname from " +"configuration files like C that we find in the " +"guest, but the guest administrator can easily manipulate these files to " +"provide the wrong hostname." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1057 -msgid "STRUCTURES" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1160 +msgid "" +"The inspection API parses guest configuration using two external libraries: " +"Augeas (Linux configuration) and hivex (Windows Registry). Both are " +"designed to be robust in the face of malicious data, although denial of " +"service attacks are still possible, for example with oversized configuration " +"files." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1059 -msgid "@STRUCTS@" +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1166 +msgid "RUNNING UNTRUSTED GUEST COMMANDS" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1061 -msgid "AVAILABILITY" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1168 +msgid "" +"Be very cautious about running commands from the guest. By running a " +"command in the guest, you are giving CPU time to a binary that you do not " +"control, under the same user account as the library, albeit wrapped in qemu " +"virtualization. More information and alternatives can be found in the " +"section L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1063 -msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" +#. type: =head2 +#: ../src/guestfs.pod:1174 +msgid "CVE-2010-3851" msgstr "" # type: textblock -#: ../src/guestfs.pod:1065 -msgid "" -"Using L you can test availability of the following " -"groups of functions. This test queries the appliance to see if the " -"appliance you are currently using supports the functionality." +#. type: textblock +#: ../src/guestfs.pod:1176 +msgid "https://bugzilla.redhat.com/642934" msgstr "" # type: textblock -#: ../src/guestfs.pod:1070 -msgid "@AVAILABILITY@" +#. type: textblock +#: ../src/guestfs.pod:1178 +msgid "" +"This security bug concerns the automatic disk format detection that qemu " +"does on disk images." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1072 -msgid "GUESTFISH supported COMMAND" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1181 +msgid "" +"A raw disk image is just the raw bytes, there is no header. Other disk " +"images like qcow2 contain a special header. Qemu deals with this by looking " +"for one of the known headers, and if none is found then assuming the disk " +"image must be raw." msgstr "" # type: textblock -#: ../src/guestfs.pod:1074 +#. type: textblock +#: ../src/guestfs.pod:1186 msgid "" -"In L there is a handy interactive command C which " -"prints out the available groups and whether they are supported by this build " -"of libguestfs. Note however that you have to do C first." +"This 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: =head2 -#: ../src/guestfs.pod:1079 -msgid "SINGLE CALLS AT COMPILE TIME" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1191 +msgid "" +"This in itself would not be a problem, but qcow2 offers many features, one " +"of which is to allow a disk image to refer to another image (called the " +"\"backing disk\"). It does this by placing the path to the backing disk " +"into the qcow2 header. This path is not validated and could point to any " +"host file (eg. \"/etc/passwd\"). The backing disk is then exposed through " +"\"holes\" in the qcow2 disk image, which of course is completely under the " +"control of the attacker." msgstr "" # type: textblock -#: ../src/guestfs.pod:1081 +#. type: textblock +#: ../src/guestfs.pod:1199 msgid "" -"Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " -"function, such as:" +"In libguestfs this is rather hard to exploit except under two circumstances:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1084 -#, no-wrap -msgid "" -" #define LIBGUESTFS_HAVE_DD 1\n" -"\n" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1206 +msgid "You have enabled the network or have opened the disk in write mode." msgstr "" # type: textblock -#: ../src/guestfs.pod:1086 -msgid "if L is available." +#. type: textblock +#: ../src/guestfs.pod:1210 +msgid "" +"You are also running untrusted code from the guest (see L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1088 +#. type: textblock +#: ../src/guestfs.pod:1215 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:" +"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: verbatim -#: ../src/guestfs.pod:1093 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1220 msgid "" -" AC_CHECK_LIB([guestfs],[guestfs_create])\n" -" AC_CHECK_FUNCS([guestfs_dd])\n" -"\n" +"For disks added from libvirt using calls like L, the " +"format is fetched from libvirt and passed through." msgstr "" # type: textblock -#: ../src/guestfs.pod:1096 +#. type: textblock +#: ../src/guestfs.pod:1223 msgid "" -"which would result in C being either defined or not defined " -"in your program." +"For libguestfs tools, use the I<--format> command line parameter as " +"appropriate." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1099 -msgid "SINGLE CALLS AT RUN TIME" +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1226 +msgid "CONNECTION MANAGEMENT" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1101 -msgid "" -"Testing at compile time doesn't guarantee that a function really exists in " -"the library. The reason is that you might be dynamically linked against a " -"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." +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1228 +msgid "guestfs_h *" msgstr "" # type: textblock -#: ../src/guestfs.pod:1108 +#. type: textblock +#: ../src/guestfs.pod:1230 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):" +"C is the opaque type representing a connection handle. Create a " +"handle by calling L. Call L to free the " +"handle and release all resources used." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1112 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1234 msgid "" -" #include \n" -" #include \n" -" #include \n" -" #include \n" -" #include \n" -" \n" +"For information on using multiple handles and threads, see the section L below." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1118 -#, no-wrap -msgid "" -" main ()\n" -" {\n" -" #ifdef LIBGUESTFS_HAVE_DD\n" -" void *dl;\n" -" int has_function;\n" -" \n" +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1237 +msgid "guestfs_create" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1124 +#. type: verbatim +#: ../src/guestfs.pod:1239 #, no-wrap 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" +" guestfs_h *guestfs_create (void);\n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1133 -#, no-wrap -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" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1241 +msgid "Create a connection handle." msgstr "" # type: textblock -#: ../src/guestfs.pod:1146 +#. type: textblock +#: ../src/guestfs.pod:1243 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 have to call L (or one of the equivalent calls) " +"on the handle at least once." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1151 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1246 msgid "" -" Requires: libguestfs >= 1.0.80\n" -"\n" +"This function returns a non-NULL pointer to a handle on success or NULL on " +"error." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1153 -msgid "CALLS WITH OPTIONAL ARGUMENTS" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1249 +msgid "After configuring the handle, you have to call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1155 +#. type: textblock +#: ../src/guestfs.pod:1251 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:" +"You may also want to configure error handling for the handle. See L section below." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1254 +msgid "guestfs_close" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1160 +#. type: verbatim +#: ../src/guestfs.pod:1256 #, no-wrap msgid "" -" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" +" void guestfs_close (guestfs_h *g);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1162 -msgid "" -"Call this with a list of optional arguments, terminated by C<-1>. So to " -"call with no optional arguments specified:" +#. type: textblock +#: ../src/guestfs.pod:1258 +msgid "This closes the connection handle and frees up all resources used." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1165 -#, no-wrap +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1260 +msgid "ERROR HANDLING" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1262 msgid "" -" guestfs_add_drive_opts (g, filename, -1);\n" -"\n" +"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:1167 -msgid "With a single optional argument:" +#. type: textblock +#: ../src/guestfs.pod:1265 +msgid "" +"Additional information is available for errors: an error message string and " +"optionally an error number (errno) if the thing that failed was a system " +"call." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1169 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1269 msgid "" -" guestfs_add_drive_opts (g, filename,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" -" -1);\n" -"\n" +"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:1173 -msgid "With two:" +#. type: textblock +#: ../src/guestfs.pod:1274 +msgid "" +"When the handle is created, a default error handler is installed which " +"prints the error message string to C. For small short-running " +"command line programs it is sufficient to do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1175 +#. type: verbatim +#: ../src/guestfs.pod:1278 #, no-wrap msgid "" -" guestfs_add_drive_opts (g, filename,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" -" GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n" -" -1);\n" +" if (guestfs_launch (g) == -1)\n" +" exit (EXIT_FAILURE);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1180 +#. type: textblock +#: ../src/guestfs.pod:1281 msgid "" -"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " -"happen!" -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1183 -msgid "USING va_list FOR OPTIONAL ARGUMENTS" +"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:1185 +#. type: textblock +#: ../src/guestfs.pod:1284 msgid "" -"The second variant has the same name with the suffix C<_va>, which works the " -"same way but takes a C. See the C manual for details. For the " -"example function, this is declared:" +"For other programs the caller will almost certainly want to install an " +"alternate error handler or do error handling in-line like this:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1189 +#. type: verbatim +#: ../src/guestfs.pod:1287 #, no-wrap msgid "" -" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" -" va_list args);\n" -"\n" -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1192 -msgid "CONSTRUCTING OPTIONAL ARGUMENTS" +" g = guestfs_create ();\n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1194 +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1289 +#, no-wrap msgid "" -"The third variant is useful where you need to construct these calls. You " -"pass in a structure where you fill in the optional fields. The structure " -"has a bitmask as the first element which you must set to indicate which " -"fields you have filled in. For our example function the structure and call " -"are declared:" +" /* 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:1200 +#. type: verbatim +#: ../src/guestfs.pod:1293 #, no-wrap msgid "" -" struct guestfs_add_drive_opts_argv {\n" -" uint64_t bitmask;\n" -" int readonly;\n" -" const char *format;\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" -" int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n" -" const struct guestfs_add_drive_opts_argv *optargs);\n" +" }\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1209 -msgid "You could call it like this:" +#. type: textblock +#: ../src/guestfs.pod:1301 +msgid "" +"Out of memory errors are handled differently. The default action is to call " +"L. If this is undesirable, then you can set a handler using L." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1211 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1305 msgid "" -" struct guestfs_add_drive_opts_argv optargs = {\n" -" .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n" -" .readonly = 1,\n" -" .format = \"qcow2\"\n" -" };\n" -" \n" +"L returns C if the handle cannot be created, and " +"because there is no handle if this happens there is no way to get additional " +"error information. However L is supposed to be a " +"lightweight operation which can only fail because of insufficient memory (it " +"returns NULL in this case)." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1311 +msgid "guestfs_last_error" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1218 +#. type: verbatim +#: ../src/guestfs.pod:1313 #, no-wrap msgid "" -" guestfs_add_drive_opts_argv (g, filename, &optargs);\n" +" const char *guestfs_last_error (guestfs_h *g);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1220 ../src/guestfs-actions.pod:11 -#: ../src/guestfs-actions.pod:1661 ../fish/guestfish-actions.pod:9 -#: ../fish/guestfish-actions.pod:1244 -msgid "Notes:" +#. type: textblock +#: ../src/guestfs.pod:1315 +msgid "" +"This returns the last error message that happened on C. If there has not " +"been an error since the handle was created, then this returns C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1226 -msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." +#. type: textblock +#: ../src/guestfs.pod:1319 +msgid "" +"The lifetime of the returned string is until the next error occurs, or L is called." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1231 -msgid "You do not need to fill in all fields of the structure." +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1322 +msgid "guestfs_last_errno" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1235 +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1324 +#, no-wrap msgid "" -"There must be a one-to-one correspondence between fields of the structure " -"that are filled in, and bits set in the bitmask." +" int guestfs_last_errno (guestfs_h *g);\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1240 -msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1326 +msgid "This returns the last error number (errno) that happened on C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1242 -msgid "" -"In other languages, optional arguments are expressed in the way that is " -"natural for that language. We refer you to the language-specific " -"documentation for more details on that." +#. type: textblock +#: ../src/guestfs.pod:1328 +msgid "If successful, an errno integer not equal to zero is returned." msgstr "" # type: textblock -#: ../src/guestfs.pod:1246 -msgid "For guestfish, see L." +#. type: textblock +#: ../src/guestfs.pod:1330 +msgid "" +"If no error, this returns 0. This call can return 0 in three situations:" msgstr "" -# type: =end -#: ../src/guestfs.pod:1248 ../src/guestfs.pod:1253 -msgid "html" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1337 +msgid "There has not been any error on the handle." msgstr "" # type: textblock -#: ../src/guestfs.pod:1250 +#. type: textblock +#: ../src/guestfs.pod:1341 msgid "" -" " +"There has been an error but the errno was meaningless. This corresponds to " +"the case where the error did not come from a failed system call, but for " +"some other reason." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1255 -msgid "ARCHITECTURE" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1347 +msgid "" +"There was an error from a failed system call, but for some reason the errno " +"was not captured and returned. This usually indicates a bug in libguestfs." msgstr "" # type: textblock -#: ../src/guestfs.pod:1257 +#. type: textblock +#: ../src/guestfs.pod:1353 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." +"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 +#. type: =head2 +#: ../src/guestfs.pod:1361 +msgid "guestfs_set_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1261 +#. type: verbatim +#: ../src/guestfs.pod:1363 #, 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" +" 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:1281 +#. type: textblock +#: ../src/guestfs.pod:1370 msgid "" -"The library, linked to the main program, creates the child process and hence " -"the appliance in the L function." +"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:1284 +#. type: textblock +#: ../src/guestfs.pod:1374 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." +"C is not passed to the callback. To get that the callback must call " +"L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1293 +#. type: textblock +#: ../src/guestfs.pod:1377 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)." +"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: =head1 -#: ../src/guestfs.pod:1300 -msgid "STATE MACHINE" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1381 +msgid "The default handler prints messages on C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1302 -msgid "libguestfs uses a state machine to model the child process:" +#. type: textblock +#: ../src/guestfs.pod:1383 +msgid "If you set C to C then I handler is called." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1385 +msgid "guestfs_get_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1304 +#. type: verbatim +#: ../src/guestfs.pod:1387 #, 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" +" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" +" void **opaque_rtn);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1326 -msgid "" -"The normal transitions are (1) CONFIG (when the handle is created, but there " -"is no child process), (2) LAUNCHING (when the child process is booting up), " -"(3) alternating between READY and BUSY as commands are issued to, and " -"carried out by, the child process." +#. type: textblock +#: ../src/guestfs.pod:1390 +msgid "Returns the current error handler callback." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1331 +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1392 +msgid "guestfs_set_out_of_memory_handler" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1394 +#, no-wrap 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." +" 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:1335 +#. type: textblock +#: ../src/guestfs.pod:1398 msgid "" -"Configuration commands for qemu such as L can only be " -"issued when in the CONFIG state." +"The callback C will be called if there is an out of memory situation. " +"I." msgstr "" # type: textblock -#: ../src/guestfs.pod:1338 -msgid "" -"The API offers one call that goes from CONFIG through LAUNCHING to READY. " -"L blocks until the child process is READY to accept " -"commands (or until some failure or timeout). L internally " -"moves the state from CONFIG to LAUNCHING while it is running." +#. type: textblock +#: ../src/guestfs.pod:1401 +msgid "The default is to call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1344 +#. type: textblock +#: ../src/guestfs.pod:1403 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 cannot set C to C. You can't ignore out of memory situations." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1406 +msgid "guestfs_get_out_of_memory_handler" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1408 +#, no-wrap +msgid "" +" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1410 +msgid "This returns the current out of memory handler." +msgstr "" + +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1412 +msgid "API CALLS" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1414 ../fish/guestfish.pod:958 +msgid "@ACTIONS@" +msgstr "" + +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1416 +msgid "STRUCTURES" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1418 +msgid "@STRUCTS@" +msgstr "" + +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1420 +msgid "AVAILABILITY" +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1422 +msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1350 +#. type: textblock +#: ../src/guestfs.pod:1424 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." +"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 +#. type: textblock +#: ../src/guestfs.pod:1429 +msgid "@AVAILABILITY@" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1354 -msgid "SETTING CALLBACKS TO HANDLE EVENTS" +#. type: =head2 +#: ../src/guestfs.pod:1431 +msgid "GUESTFISH supported COMMAND" msgstr "" # type: textblock -#: ../src/guestfs.pod:1356 +#. type: textblock +#: ../src/guestfs.pod:1433 msgid "" -"The child process generates events in some situations. Current events " -"include: receiving a log message, the child process exits." +"In L there is a handy interactive command C which " +"prints out the available groups and whether they are supported by this build " +"of libguestfs. Note however that you have to do C first." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1438 +msgid "SINGLE CALLS AT COMPILE TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:1359 +#. type: textblock +#: ../src/guestfs.pod:1440 msgid "" -"Use the C functions to set a callback for different " -"types of events." +"Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " +"function, such as:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1443 +#, no-wrap +msgid "" +" #define LIBGUESTFS_HAVE_DD 1\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1362 +#. type: textblock +#: ../src/guestfs.pod:1445 +msgid "if L is available." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1447 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." +"Before version 1.5.8, if you needed to test whether a single libguestfs " +"function is available at compile time, we recommended using build tools such " +"as autoconf or cmake. For example in autotools you could use:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1452 +#, no-wrap +msgid "" +" AC_CHECK_LIB([guestfs],[guestfs_create])\n" +" AC_CHECK_FUNCS([guestfs_dd])\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1455 +msgid "" +"which would result in C being either defined or not defined " +"in your program." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1367 -msgid "guestfs_set_log_message_callback" +#. type: =head2 +#: ../src/guestfs.pod:1458 +msgid "SINGLE CALLS AT RUN TIME" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1460 +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." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1467 +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):" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1471 +#, no-wrap +msgid "" +" #include \n" +" #include \n" +" #include \n" +" #include \n" +" #include \n" +" \n" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1477 +#, no-wrap +msgid "" +" main ()\n" +" {\n" +" #ifdef LIBGUESTFS_HAVE_DD\n" +" void *dl;\n" +" int has_function;\n" +" \n" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1483 +#, no-wrap +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" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1492 +#, no-wrap +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" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1505 +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:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1510 +#, no-wrap +msgid "" +" Requires: libguestfs >= 1.0.80\n" +"\n" +msgstr "" + +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1512 +msgid "CALLS WITH OPTIONAL ARGUMENTS" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1514 +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 +#. type: verbatim +#: ../src/guestfs.pod:1519 +#, no-wrap +msgid "" +" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1521 +msgid "" +"Call this with a list of optional arguments, terminated by C<-1>. So to " +"call with no optional arguments specified:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1524 +#, no-wrap +msgid "" +" guestfs_add_drive_opts (g, filename, -1);\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1526 +msgid "With a single optional argument:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1528 +#, no-wrap +msgid "" +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" +" -1);\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1532 +msgid "With two:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1534 +#, no-wrap +msgid "" +" guestfs_add_drive_opts (g, filename,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" +" GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n" +" -1);\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1539 +msgid "" +"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " +"happen!" +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1542 +msgid "USING va_list FOR OPTIONAL ARGUMENTS" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1544 +msgid "" +"The second variant has the same name with the suffix C<_va>, which works the " +"same way but takes a C. See the C manual for details. For the " +"example function, this is declared:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1548 +#, no-wrap +msgid "" +" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" +" va_list args);\n" +"\n" +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1551 +msgid "CONSTRUCTING OPTIONAL ARGUMENTS" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1553 +msgid "" +"The third variant is useful where you need to construct these calls. You " +"pass in a structure where you fill in the optional fields. The structure " +"has a bitmask as the first element which you must set to indicate which " +"fields you have filled in. For our example function the structure and call " +"are declared:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1559 +#, no-wrap +msgid "" +" struct guestfs_add_drive_opts_argv {\n" +" uint64_t bitmask;\n" +" int readonly;\n" +" const char *format;\n" +" /* ... */\n" +" };\n" +" int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n" +" const struct guestfs_add_drive_opts_argv *optargs);\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1568 +msgid "You could call it like this:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1570 +#, no-wrap +msgid "" +" struct guestfs_add_drive_opts_argv optargs = {\n" +" .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n" +" .readonly = 1,\n" +" .format = \"qcow2\"\n" +" };\n" +" \n" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1577 +#, no-wrap +msgid "" +" guestfs_add_drive_opts_argv (g, filename, &optargs);\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1579 ../src/guestfs-actions.pod:11 +#: ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9 +#: ../fish/guestfish-actions.pod:1253 ../tools/virt-win-reg.pl:532 +msgid "Notes:" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1585 +msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1590 +msgid "You do not need to fill in all fields of the structure." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1594 +msgid "" +"There must be a one-to-one correspondence between fields of the structure " +"that are filled in, and bits set in the bitmask." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1599 +msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1601 +msgid "" +"In other languages, optional arguments are expressed in the way that is " +"natural for that language. We refer you to the language-specific " +"documentation for more details on that." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1605 +msgid "For guestfish, see L." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1607 +msgid "SETTING CALLBACKS TO HANDLE EVENTS" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1609 +msgid "" +"The child process generates events in some situations. Current events " +"include: receiving a log message, the child process exits." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1612 +msgid "" +"Use the C functions to set a callback for different " +"types of events." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1615 +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." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1620 +msgid "guestfs_set_log_message_callback" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1622 +#, 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 +#. type: textblock +#: ../src/guestfs.pod:1628 +msgid "" +"The callback function C will be called whenever qemu or the guest writes " +"anything to the console." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1631 +msgid "Use this function to capture kernel messages and similar." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1633 +msgid "" +"Normally there is no log message handler, and log messages are just " +"discarded." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1636 +msgid "guestfs_set_subprocess_quit_callback" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1638 +#, no-wrap +msgid "" +" typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n" +" void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n" +" guestfs_subprocess_quit_cb cb,\n" +" void *opaque);\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1643 +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)." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1648 +msgid "guestfs_set_launch_done_callback" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1650 +#, 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" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1655 +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)." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1659 +msgid "guestfs_set_close_callback" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1661 +#, no-wrap +msgid "" +" typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n" +" void guestfs_set_close_callback (guestfs_h *g,\n" +" guestfs_close_cb cb,\n" +" void *opaque);\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1666 +msgid "" +"The callback function C will be called while the handle is being closed " +"(synchronously from L)." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1669 +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)." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1677 +msgid "guestfs_set_progress_callback" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1679 +#, 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" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1686 +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 +#. type: textblock +#: ../src/guestfs.pod:1692 +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 +#. type: textblock +#: ../src/guestfs.pod:1698 +msgid "The only defined and stable parts of the API are:" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1704 +msgid "" +"The callback can display to the user some type of progress bar or indicator " +"which shows the ratio of C:C." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1709 +msgid "0 E= C E= C" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1713 +msgid "" +"If any progress notification is sent during a call, then a final progress " +"notification is always sent when C = C." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1716 +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." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1722 +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 +#. type: =head1 +#: ../src/guestfs.pod:1727 +msgid "PRIVATE DATA AREA" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1729 +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 +#. type: textblock +#: ../src/guestfs.pod:1733 +msgid "To attach a named piece of data, use the following call:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1735 +#, no-wrap +msgid "" +" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1737 +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." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1741 +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 +#. type: textblock +#: ../src/guestfs.pod:1746 +msgid "To retrieve the pointer, use:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1748 +#, no-wrap +msgid "" +" void *guestfs_get_private (guestfs_h *g, const char *key);\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1750 +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." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1754 +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)." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1762 +msgid "" +"The private data area is implemented using a hash table, and should be " +"reasonably efficient for moderate numbers of keys." +msgstr "" + +# type: =end +#. type: =end +#: ../src/guestfs.pod:1765 ../src/guestfs.pod:1770 +msgid "html" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1767 +msgid "" +" " +msgstr "" + +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1772 +msgid "ARCHITECTURE" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1774 +msgid "" +"Internally, libguestfs is implemented by running an appliance (a special " +"type of small virtual machine) using L. Qemu runs as a child " +"process of the main program." +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1778 +#, no-wrap +msgid "" +" ___________________\n" +" / \\\n" +" | main program |\n" +" | |\n" +" | | child process / appliance\n" +" | | __________________________\n" +" | | / qemu \\\n" +" +-------------------+ RPC | +-----------------+ |\n" +" | libguestfs <--------------------> guestfsd | |\n" +" | | | +-----------------+ |\n" +" \\___________________/ | | Linux kernel | |\n" +" | +--^--------------+ |\n" +" \\_________|________________/\n" +" |\n" +" _______v______\n" +" / \\\n" +" | Device or |\n" +" | disk image |\n" +" \\______________/\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1798 +msgid "" +"The library, linked to the main program, creates the child process and hence " +"the appliance in the L function." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1801 +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." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1810 +msgid "" +"A common misunderstanding is that the appliance \"is\" the virtual machine. " +"Although the disk image you are attached to might also be used by some " +"virtual machine, libguestfs doesn't know or care about this. (But you will " +"care if both libguestfs's qemu process and your virtual machine are trying " +"to update the disk image at the same time, since these usually results in " +"massive disk corruption)." +msgstr "" + +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1817 +msgid "STATE MACHINE" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1819 +msgid "libguestfs uses a state machine to model the child process:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1821 +#, no-wrap +msgid "" +" |\n" +" guestfs_create\n" +" |\n" +" |\n" +" ____V_____\n" +" / \\\n" +" | CONFIG |\n" +" \\__________/\n" +" ^ ^ ^ \\\n" +" / | \\ \\ guestfs_launch\n" +" / | _\\__V______\n" +" / | / \\\n" +" / | | LAUNCHING |\n" +" / | \\___________/\n" +" / | /\n" +" / | guestfs_launch\n" +" / | /\n" +" ______ / __|____V\n" +" / \\ ------> / \\\n" +" | BUSY | | READY |\n" +" \\______/ <------ \\________/\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1843 +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." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1848 +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 +#. type: textblock +#: ../src/guestfs.pod:1852 +msgid "" +"Configuration commands for qemu such as L can only be " +"issued when in the CONFIG state." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1855 +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 +#. type: textblock +#: ../src/guestfs.pod:1861 +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 +#. type: textblock +#: ../src/guestfs.pod:1867 +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." +msgstr "" + +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:1871 +msgid "INTERNALS" +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs.pod:1873 +msgid "COMMUNICATION PROTOCOL" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1875 +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 +#. type: textblock +#: ../src/guestfs.pod:1878 +msgid "" +"The protocol used to talk between the library and the daemon running inside " +"the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC " +"1014, RFC 1832, RFC 4506)." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1882 +msgid "" +"The detailed format of structures is in C (note: " +"this file is automatically generated)." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1885 +msgid "" +"There are two broad cases, ordinary functions that don't have any C " +"and C parameters, which are handled with very simple request/reply " +"messages. Then there are functions that have any C or C " +"parameters, which use the same request and reply messages, but they may also " +"be followed by files sent using a chunked encoding." +msgstr "" + +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:1892 +msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1894 +msgid "For ordinary functions, the request message is:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1896 +#, 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" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1901 +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 +#. type: textblock +#: ../src/guestfs.pod:1907 +msgid "" +"Note also that many functions don't take any arguments, in which case the " +"C_args> is completely omitted." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1910 +msgid "" +"The header contains the procedure number (C) which is how the " +"receiver knows what type of args structure to expect, or none at all." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1914 +msgid "" +"For functions that take optional arguments, the optional arguments are " +"encoded in the C_args> structure in the same way as ordinary " +"arguments. A bitmask in the header indicates which optional arguments are " +"meaningful. The bitmask is also checked to see if it contains bits set " +"which the daemon does not know about (eg. if more optional arguments were " +"added in a later version of the library), and this causes the call to be " +"rejected." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1922 +msgid "The reply message for ordinary functions is:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1924 +#, no-wrap +msgid "" +" total length (header + ret,\n" +" but not including the length word itself)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs__ret (encoded as XDR)\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1929 +msgid "" +"As above the C_ret> structure may be completely omitted for " +"functions that return no formal return values." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1932 +msgid "" +"As above the total length of the reply is limited to C." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1935 +msgid "" +"In the case of an error, a flag is set in the header, and the reply message " +"is slightly changed:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1938 +#, no-wrap +msgid "" +" total length (header + error,\n" +" but not including the length word itself)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs_message_error (encoded as XDR)\n" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1943 +msgid "" +"The C structure contains the error message as a " +"string." +msgstr "" + +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:1946 +msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1948 +msgid "" +"A C parameter indicates that we transfer a file I the guest. " +"The normal request message is sent (see above). However this is followed by " +"a sequence of file chunks." +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1952 +#, 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" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1960 +msgid "The \"sequence of chunks\" is:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:1962 +#, 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" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1970 +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." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1974 +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: textblock +#. type: textblock +#: ../src/guestfs.pod:1979 +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." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1985 +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." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:1994 +msgid "" +"This protocol allows the transfer of arbitrary sized files (no 32 bit " +"limit), and also files where the size is not known in advance (eg. from " +"pipes or sockets). However the chunks are rather small " +"(C), so that neither the library nor the daemon need " +"to keep much in memory." +msgstr "" + +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:2000 +msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2002 +msgid "" +"The protocol for FileOut parameters is exactly the same as for FileIn " +"parameters, but with the roles of daemon and library reversed." +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:2005 +#, 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" +msgstr "" + +# type: =head3 +#. type: =head3 +#: ../src/guestfs.pod:2013 +msgid "INITIAL MESSAGE" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2015 +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 +#. type: =head3 +#: ../src/guestfs.pod:2019 +msgid "PROGRESS NOTIFICATION MESSAGES" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2021 +msgid "" +"The daemon may send progress notification messages at any time. These are " +"distinguished by the normal length word being replaced by " +"C, followed by a fixed size progress message." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2025 +msgid "" +"The library turns them into progress callbacks (see " +"C) if there is a callback registered, or " +"discards them if not." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2029 +msgid "" +"The daemon self-limits the frequency of progress messages it sends (see " +"C). Not all calls generate progress " +"messages." +msgstr "" + +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:2033 +msgid "LIBGUESTFS VERSION NUMBERS" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2035 +msgid "" +"Since April 2010, libguestfs has started to make separate development and " +"stable releases, along with corresponding branches in our git repository. " +"These separate releases can be identified by version number:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:2040 +#, 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" +"\n" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2051 +msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2053 +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." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2059 +msgid "Our criteria for backporting changes are:" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2065 +msgid "" +"Documentation changes which don't affect any code are backported unless the " +"documentation refers to a future feature which is not in stable." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2071 +msgid "" +"Bug fixes which are not controversial, fix obvious problems, and have been " +"well tested are backported." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2076 +msgid "" +"Simple rearrangements of code which shouldn't affect how it works get " +"backported. This is so that the code in the two branches doesn't get too " +"far out of step, allowing us to backport future fixes more easily." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2082 +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." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2088 +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." +msgstr "" + +#. type: =head1 +#: ../src/guestfs.pod:2096 +msgid "EXTENDING LIBGUESTFS" +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:2098 +msgid "ADDING A NEW API ACTION" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2100 +msgid "" +"Large amounts of boilerplate code in libguestfs (RPC, bindings, " +"documentation) are generated, and this makes it easy to extend the " +"libguestfs API." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2104 +msgid "To add a new API action there are two changes:" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2110 +msgid "" +"You need to add a description of the call (name, parameters, return type, " +"tests, documentation) to C." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2113 +msgid "" +"There are two sorts of API action, depending on whether the call goes " +"through to the daemon in the appliance, or is serviced entirely by the " +"library (see L above). L is an example of the " +"former, since the sync is done in the appliance. L is " +"an example of the latter, since a trace flag is maintained in the handle and " +"all tracing is done on the library side." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2121 +msgid "" +"Most new actions are of the first type, and get added to the " +"C list. Each function has a unique procedure number used " +"in the RPC protocol which is assigned to that action when we publish " +"libguestfs and cannot be reused. Take the latest procedure number and " +"increment it." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2127 +msgid "" +"For library-only actions of the second type, add to the " +"C list. Since these functions are serviced by the " +"library and do not travel over the RPC mechanism to the daemon, these " +"functions do not need a procedure number, and so the procedure number is set " +"to C<-1>." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2135 +msgid "Implement the action (in C):" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2137 +msgid "" +"For daemon actions, implement the function CnameE> in the " +"C directory." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2140 +msgid "" +"For library actions, implement the function CnameE> " +"(note: double underscore) in the C directory." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2143 +msgid "In either case, use another function as an example of what to do." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2147 +msgid "After making these changes, use C to compile." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2149 +msgid "" +"Note that you don't need to implement the RPC, language bindings, manual " +"pages or anything else. It's all automatically generated from the OCaml " +"description." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:2153 +msgid "ADDING TESTS FOR AN API ACTION" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2155 +msgid "" +"You can supply zero or as many tests as you want per API call. The tests " +"can either be added as part of the API description (C), or in some rarer cases you may want to drop a script " +"into C. Note that adding a script to C is " +"slower, so if possible use the first method." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2161 +msgid "" +"The following describes the test environment used when you add an API test " +"in C." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2164 +msgid "The test environment has 4 block devices:" +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2168 +msgid "C 500MB" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2170 +msgid "General block device for testing." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2172 +msgid "C 50MB" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2174 +msgid "" +"C is an ext2 filesystem used for testing filesystem write " +"operations." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2177 +msgid "C 10MB" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2179 +msgid "Used in a few tests where two block devices are needed." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2181 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2183 +msgid "ISO with fixed content (see C)." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2187 +msgid "" +"To be able to run the tests in a reasonable amount of time, the libguestfs " +"appliance and block devices are reused between tests. So don't try testing " +"L :-x" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2191 +msgid "" +"Each test starts with an initial scenario, selected using one of the " +"C expressions, described in C. These " +"initialize the disks mentioned above in a particular way as documented in " +"C. You should not assume anything about the previous " +"contents of other disks that are not initialized." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2197 +msgid "" +"You can add a prerequisite clause to any individual test. This is a run-" +"time check, which, if it fails, causes the test to be skipped. Useful if " +"testing a command which might not work on all variations of libguestfs " +"builds. A test that has prerequisite of C means to run " +"unconditionally." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2203 +msgid "" +"In addition, packagers can skip individual tests by setting environment " +"variables before running C." +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:2206 +#, no-wrap +msgid "" +" SKIP_TEST__=1\n" +"\n" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2208 +msgid "eg: C skips test #3 of L." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2210 +msgid "or:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:2212 +#, no-wrap +msgid "" +" SKIP_TEST_=1\n" +"\n" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2214 +msgid "eg: C skips all L tests." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2216 +msgid "Packagers can run only certain tests by setting for example:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:2218 +#, no-wrap +msgid "" +" TEST_ONLY=\"vfs_type zerofree\"\n" +"\n" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2220 +msgid "" +"See C for more details of how these environment variables " +"work." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:2223 +msgid "DEBUGGING NEW API ACTIONS" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2225 +msgid "Test new actions work before submitting them." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2227 +msgid "You can use guestfish to try out new commands." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2229 +msgid "" +"Debugging the daemon is a problem because it runs inside a minimal " +"environment. However you can fprintf messages in the daemon to stderr, and " +"they will show up if you use C." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:2233 +msgid "FORMATTING CODE AND OTHER CONVENTIONS" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2235 +msgid "" +"Our C source code generally adheres to some basic code-formatting " +"conventions. The existing code base is not totally consistent on this " +"front, but we do prefer that contributed code be formatted similarly. In " +"short, use spaces-not-TABs for indentation, use 2 spaces for each " +"indentation level, and other than that, follow the K&R style." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2241 +msgid "" +"If you use Emacs, add the following to one of one of your start-up files (e." +"g., ~/.emacs), to help ensure that you get indentation right:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:2244 +#, no-wrap +msgid "" +" ;;; In libguestfs, indent with spaces everywhere (not TABs).\n" +" ;;; Exceptions: Makefile and ChangeLog modes.\n" +" (add-hook 'find-file-hook\n" +" '(lambda () (if (and buffer-file-name\n" +" (string-match \"/libguestfs\\\\>\"\n" +" (buffer-file-name))\n" +" (not (string-equal mode-name \"Change Log\"))\n" +" (not (string-equal mode-name \"Makefile\")))\n" +" (setq indent-tabs-mode nil))))\n" +" \n" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:2254 +#, no-wrap +msgid "" +" ;;; When editing C sources in libguestfs, use this style.\n" +" (defun libguestfs-c-mode ()\n" +" \"C mode with adjusted defaults for use with libguestfs.\"\n" +" (interactive)\n" +" (c-set-style \"K&R\")\n" +" (setq c-indent-level 2)\n" +" (setq c-basic-offset 2))\n" +" (add-hook 'c-mode-hook\n" +" '(lambda () (if (string-match \"/libguestfs\\\\>\"\n" +" (buffer-file-name))\n" +" (libguestfs-c-mode))))\n" +"\n" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2266 +msgid "Enable warnings when compiling (and fix any problems this finds):" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:2269 +#, no-wrap +msgid "" +" ./configure --enable-gcc-warnings\n" +"\n" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2271 +msgid "Useful targets are:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:2273 +#, no-wrap +msgid "" +" make syntax-check # checks the syntax of the C code\n" +" make check # runs the test suite\n" +"\n" +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:2276 +msgid "DAEMON CUSTOM PRINTF FORMATTERS" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2278 +msgid "" +"In the daemon code we have created custom printf formatters C<%Q> and C<%R>, " +"which are used to do shell quoting." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2283 +msgid "%Q" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2285 +msgid "" +"Simple shell quoted string. Any spaces or other shell characters are " +"escaped for you." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2288 +msgid "%R" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2290 +msgid "" +"Same as C<%Q> except the string is treated as a path which is prefixed by " +"the sysroot." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2295 ../fish/guestfish.pod:240 ../fish/guestfish.pod:594 +msgid "For example:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:2297 +#, no-wrap +msgid "" +" asprintf (&cmd, \"cat %R\", path);\n" +"\n" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2299 +msgid "would produce C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2301 +msgid "" +"I Do I use these when you are passing parameters to the C functions. These parameters do NOT need to be quoted because " +"they are not passed via the shell (instead, straight to exec). You probably " +"want to use the C function however." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:2307 +msgid "SUBMITTING YOUR NEW API ACTIONS" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2309 +msgid "" +"Submit patches to the mailing list: L and CC to L." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:2313 +msgid "INTERNATIONALIZATION (I18N) SUPPORT" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2315 +msgid "We support i18n (gettext anyhow) in the library." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2317 +msgid "" +"However many messages come from the daemon, and we don't translate those at " +"the moment. One reason is that the appliance generally has all locale files " +"removed from it, because they take up a lot of space. So we'd have to readd " +"some of those, as well as copying our PO files into the appliance." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2323 +msgid "" +"Debugging messages are never translated, since they are intended for the " +"programmers." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:2326 +msgid "SOURCE CODE SUBDIRECTORIES" +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2330 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2332 +msgid "The libguestfs appliance, build scripts and so on." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2334 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2336 +msgid "Automated tests of the C API." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2338 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2340 +msgid "" +"The L, L and L commands and " +"documentation." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2343 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2345 +msgid "Outside contributions, experimental parts." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2347 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2349 +msgid "" +"The daemon that runs inside the libguestfs appliance and carries out actions." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2352 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2354 +msgid "L command and documentation." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2356 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2358 +msgid "C API example code." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2360 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2362 +msgid "" +"L, the command-line shell, and various shell scripts built on " +"top such as L, L, L, " +"L." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2366 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2368 +msgid "" +"L, FUSE (userspace filesystem) built on top of libguestfs." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2370 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2372 +msgid "" +"The crucially important generator, used to automatically generate large " +"amounts of boilerplate C code for things like RPC and bindings." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2375 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2377 +msgid "Files used by the test suite." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2379 +msgid "Some \"phony\" guest images which we test against." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2381 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2383 +msgid "L, the virtual machine image inspector." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2385 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2387 +msgid "Logo used on the website. The fish is called Arthur by the way." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2389 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2391 +msgid "M4 macros used by autoconf." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2393 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2395 +msgid "Translations of simple gettext strings." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2397 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2399 +msgid "" +"The build infrastructure and PO files for translations of manpages and POD " +"files. Eventually this will be combined with the C directory, but that " +"is rather complicated." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2403 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2405 +msgid "Regression tests." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2407 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2409 +msgid "L command and documentation." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2411 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2413 +msgid "Source code to the C library." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2415 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2417 +msgid "Command line tools written in Perl (L and many others)." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2419 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2421 +msgid "" +"Test tool for end users to test if their qemu/kernel combination will work " +"with libguestfs." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2424 +msgid "C" +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2426 +msgid "C" +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2428 +msgid "C" +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2430 +msgid "C" +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2432 +msgid "C" +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2434 +msgid "C" +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2436 +msgid "C" +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2438 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2440 +msgid "Language bindings." +msgstr "" + +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:2444 ../fish/guestfish.pod:965 +#: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 +msgid "ENVIRONMENT VARIABLES" +msgstr "" + +# type: =item +#. type: =item +#: ../src/guestfs.pod:2448 ../fish/guestfish.pod:991 +msgid "LIBGUESTFS_APPEND" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2450 ../fish/guestfish.pod:993 +msgid "Pass additional options to the guest kernel." +msgstr "" + +# type: =item +#. type: =item +#: ../src/guestfs.pod:2452 ../fish/guestfish.pod:995 +msgid "LIBGUESTFS_DEBUG" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2454 +msgid "" +"Set C to enable verbose messages. This has the same " +"effect as calling C." +msgstr "" + +# type: =item +#. type: =item +#: ../src/guestfs.pod:2457 ../fish/guestfish.pod:1000 +msgid "LIBGUESTFS_MEMSIZE" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2459 ../fish/guestfish.pod:1002 +msgid "" +"Set the memory allocated to the qemu process, in megabytes. For example:" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs.pod:2462 ../fish/guestfish.pod:1005 +#, no-wrap +msgid "" +" LIBGUESTFS_MEMSIZE=700\n" +"\n" +msgstr "" + +# type: =item +#. type: =item +#: ../src/guestfs.pod:2464 ../fish/guestfish.pod:1007 +msgid "LIBGUESTFS_PATH" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2466 +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 +#. type: =item +#: ../src/guestfs.pod:2469 ../fish/guestfish.pod:1012 +msgid "LIBGUESTFS_QEMU" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2471 ../fish/guestfish.pod:1014 +msgid "" +"Set the default qemu binary that libguestfs uses. If not set, then the qemu " +"which was found at compile time by the configure script is used." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2475 +msgid "See also L above." +msgstr "" + +# type: =item +#. type: =item +#: ../src/guestfs.pod:2477 ../fish/guestfish.pod:1018 +msgid "LIBGUESTFS_TRACE" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2479 +msgid "" +"Set C to enable command traces. This has the same " +"effect as calling C." +msgstr "" + +# type: =item +#. type: =item +#: ../src/guestfs.pod:2482 ../fish/guestfish.pod:1027 +msgid "TMPDIR" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2484 ../fish/guestfish.pod:1029 +msgid "Location of temporary directory, defaults to C." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2486 ../fish/guestfish.pod:1031 +msgid "" +"If libguestfs was compiled to use the supermin appliance then the real " +"appliance is cached in this directory, shared between all handles belonging " +"to the same EUID. You can use C<$TMPDIR> to configure another directory to " +"use in case C is not large enough." +msgstr "" + +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:2494 ../fish/guestfish.pod:1089 +#: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 +#: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:572 +#: ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189 +#: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:534 +#: ../tools/virt-list-partitions.pl:257 +msgid "SEE ALSO" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2496 +msgid "" +"L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2523 +msgid "" +"Tools with a similar purpose: L, L, L, L, L." +msgstr "" + +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:2530 ../tools/virt-win-reg.pl:587 +#: ../tools/virt-make-fs.pl:548 +msgid "BUGS" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2532 +msgid "To get a list of bugs against libguestfs use this link:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1369 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2534 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" +"L" +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2536 +msgid "To report a new bug against libguestfs use this link:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1375 +#. type: textblock +#: ../src/guestfs.pod:2538 msgid "" -"The callback function C will be called whenever qemu or the guest writes " -"anything to the console." +"L" msgstr "" # type: textblock -#: ../src/guestfs.pod:1378 -msgid "Use this function to capture kernel messages and similar." +#. type: textblock +#: ../src/guestfs.pod:2540 +msgid "When reporting a bug, please check:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1380 -msgid "" -"Normally there is no log message handler, and log messages are just " -"discarded." +#. type: textblock +#: ../src/guestfs.pod:2546 +msgid "That the bug hasn't been reported already." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1383 -msgid "guestfs_set_subprocess_quit_callback" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2550 +msgid "That you are testing a recent version." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1385 -#, no-wrap -msgid "" -" typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n" -" void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n" -" guestfs_subprocess_quit_cb cb,\n" -" void *opaque);\n" -"\n" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2554 +msgid "Describe the bug accurately, and give a way to reproduce it." msgstr "" # type: textblock -#: ../src/guestfs.pod:1390 +#. type: textblock +#: ../src/guestfs.pod:2558 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)." +"Run libguestfs-test-tool and paste the B output into the " +"bug report." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1395 -msgid "guestfs_set_launch_done_callback" +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:2563 ../fish/guestfish.pod:1112 +#: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244 +msgid "AUTHORS" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1397 -#, 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" -"\n" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2565 ../fish/guestfish.pod:1114 +#: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246 +msgid "Richard W.M. Jones (C)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1402 -msgid "" -"The callback function C will be called when the child process becomes " -"ready first time after it has been launched. (This corresponds to a " -"transition from LAUNCHING to the READY state)." +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:2567 ../fish/guestfish.pod:1116 +#: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 +#: ../tools/virt-edit.pl:368 ../tools/virt-win-reg.pl:602 +#: ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206 +#: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:563 +#: ../tools/virt-list-partitions.pl:273 +msgid "COPYRIGHT" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1406 -msgid "guestfs_set_close_callback" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2569 ../fish/guestfish.pod:1118 +#: ../fuse/guestmount.pod:250 +msgid "Copyright (C) 2009-2010 Red Hat Inc. L" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1408 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2572 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" +"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." msgstr "" # type: textblock -#: ../src/guestfs.pod:1413 +#. type: textblock +#: ../src/guestfs.pod:2577 msgid "" -"The callback function C will be called while the handle is being closed " -"(synchronously from L)." +"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." msgstr "" # type: textblock -#: ../src/guestfs.pod:1416 +#. type: textblock +#: ../src/guestfs.pod:2582 msgid "" -"Note that libguestfs installs an L handler to try to clean up " -"handles that are open when the program exits. This means that this callback " -"might be called indirectly from L, which can cause unexpected " -"problems in higher-level languages (eg. if your HLL interpreter has already " -"been cleaned up by the time this is called, and if your callback then jumps " -"into some HLL function)." +"You should have received a copy of the GNU Lesser General Public License " +"along with this library; if not, write to the Free Software Foundation, " +"Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1424 -msgid "guestfs_set_progress_callback" +#. type: =head2 +#: ../src/guestfs-actions.pod:1 +msgid "guestfs_add_cdrom" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1426 +#. type: verbatim +#: ../src/guestfs-actions.pod:3 #, 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" +" int\n" +" guestfs_add_cdrom (guestfs_h *g,\n" +" const char *filename);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1433 -msgid "" -"Some long-running operations can generate progress messages. If this " -"callback is registered, then it will be called each time a progress message " -"is generated (usually two seconds after the operation started, and three " -"times per second thereafter until it completes, although the frequency may " -"change in future versions)." +#. type: textblock +#: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5 +msgid "This function adds a virtual CD-ROM disk image to the guest." msgstr "" # type: textblock -#: ../src/guestfs.pod:1439 -msgid "" -"The callback receives two numbers: C and C. The units of " -"C are not defined, although for some operations C may relate " -"in some way to the amount of data to be transferred (eg. in bytes or " -"megabytes), and C may be the portion which has been transferred." +#. type: textblock +#: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7 +msgid "This is equivalent to the qemu parameter C<-cdrom filename>." msgstr "" # type: textblock -#: ../src/guestfs.pod:1445 -msgid "The only defined and stable parts of the API are:" +#. type: textblock +#: ../src/guestfs-actions.pod:17 +msgid "" +"This call checks for the existence of C. This stops you from " +"specifying other types of drive which are supported by qemu such as C " +"and C URLs. To specify those, use the general C call " +"instead." msgstr "" # type: textblock -#: ../src/guestfs.pod:1451 +#. type: textblock +#: ../src/guestfs-actions.pod:24 msgid "" -"The callback can display to the user some type of progress bar or indicator " -"which shows the ratio of C:C." +"If you just want to add an ISO file (often you use this as an efficient way " +"to transfer large files into the guest), then you should probably use " +"C instead." msgstr "" # type: textblock -#: ../src/guestfs.pod:1456 -msgid "0 E= C E= C" +#. type: textblock +#: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126 +#: ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224 +#: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259 +#: ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293 +#: ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428 +#: ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487 +#: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533 +#: ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633 +#: ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662 +#: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779 +#: ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 +#: ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988 +#: ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090 +#: ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127 +#: ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161 +#: ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262 +#: ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324 +#: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464 +#: ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704 +#: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2243 +#: ../src/guestfs-actions.pod:2387 ../src/guestfs-actions.pod:2448 +#: ../src/guestfs-actions.pod:2483 ../src/guestfs-actions.pod:3226 +#: ../src/guestfs-actions.pod:3241 ../src/guestfs-actions.pod:3261 +#: ../src/guestfs-actions.pod:3416 ../src/guestfs-actions.pod:3430 +#: ../src/guestfs-actions.pod:3443 ../src/guestfs-actions.pod:3457 +#: ../src/guestfs-actions.pod:3472 ../src/guestfs-actions.pod:3508 +#: ../src/guestfs-actions.pod:3580 ../src/guestfs-actions.pod:3600 +#: ../src/guestfs-actions.pod:3617 ../src/guestfs-actions.pod:3640 +#: ../src/guestfs-actions.pod:3663 ../src/guestfs-actions.pod:3695 +#: ../src/guestfs-actions.pod:3714 ../src/guestfs-actions.pod:3733 +#: ../src/guestfs-actions.pod:3768 ../src/guestfs-actions.pod:3780 +#: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3832 +#: ../src/guestfs-actions.pod:3845 ../src/guestfs-actions.pod:3860 +#: ../src/guestfs-actions.pod:3877 ../src/guestfs-actions.pod:3970 +#: ../src/guestfs-actions.pod:3990 ../src/guestfs-actions.pod:4003 +#: ../src/guestfs-actions.pod:4054 ../src/guestfs-actions.pod:4072 +#: ../src/guestfs-actions.pod:4090 ../src/guestfs-actions.pod:4106 +#: ../src/guestfs-actions.pod:4120 ../src/guestfs-actions.pod:4134 +#: ../src/guestfs-actions.pod:4151 ../src/guestfs-actions.pod:4166 +#: ../src/guestfs-actions.pod:4186 ../src/guestfs-actions.pod:4230 +#: ../src/guestfs-actions.pod:4303 ../src/guestfs-actions.pod:4334 +#: ../src/guestfs-actions.pod:4353 ../src/guestfs-actions.pod:4372 +#: ../src/guestfs-actions.pod:4384 ../src/guestfs-actions.pod:4401 +#: ../src/guestfs-actions.pod:4414 ../src/guestfs-actions.pod:4429 +#: ../src/guestfs-actions.pod:4444 ../src/guestfs-actions.pod:4479 +#: ../src/guestfs-actions.pod:4494 ../src/guestfs-actions.pod:4514 +#: ../src/guestfs-actions.pod:4528 ../src/guestfs-actions.pod:4545 +#: ../src/guestfs-actions.pod:4594 ../src/guestfs-actions.pod:4631 +#: ../src/guestfs-actions.pod:4645 ../src/guestfs-actions.pod:4673 +#: ../src/guestfs-actions.pod:4690 ../src/guestfs-actions.pod:4708 +#: ../src/guestfs-actions.pod:4842 ../src/guestfs-actions.pod:4899 +#: ../src/guestfs-actions.pod:4921 ../src/guestfs-actions.pod:4939 +#: ../src/guestfs-actions.pod:4971 ../src/guestfs-actions.pod:5037 +#: ../src/guestfs-actions.pod:5054 ../src/guestfs-actions.pod:5067 +#: ../src/guestfs-actions.pod:5081 ../src/guestfs-actions.pod:5370 +#: ../src/guestfs-actions.pod:5389 ../src/guestfs-actions.pod:5403 +#: ../src/guestfs-actions.pod:5415 ../src/guestfs-actions.pod:5429 +#: ../src/guestfs-actions.pod:5441 ../src/guestfs-actions.pod:5455 +#: ../src/guestfs-actions.pod:5471 ../src/guestfs-actions.pod:5492 +#: ../src/guestfs-actions.pod:5511 ../src/guestfs-actions.pod:5530 +#: ../src/guestfs-actions.pod:5548 ../src/guestfs-actions.pod:5571 +#: ../src/guestfs-actions.pod:5589 ../src/guestfs-actions.pod:5608 +#: ../src/guestfs-actions.pod:5629 ../src/guestfs-actions.pod:5648 +#: ../src/guestfs-actions.pod:5665 ../src/guestfs-actions.pod:5693 +#: ../src/guestfs-actions.pod:5717 ../src/guestfs-actions.pod:5736 +#: ../src/guestfs-actions.pod:5760 ../src/guestfs-actions.pod:5775 +#: ../src/guestfs-actions.pod:5790 ../src/guestfs-actions.pod:5809 +#: ../src/guestfs-actions.pod:5846 ../src/guestfs-actions.pod:5869 +#: ../src/guestfs-actions.pod:5895 ../src/guestfs-actions.pod:6003 +#: ../src/guestfs-actions.pod:6124 ../src/guestfs-actions.pod:6136 +#: ../src/guestfs-actions.pod:6149 ../src/guestfs-actions.pod:6162 +#: ../src/guestfs-actions.pod:6184 ../src/guestfs-actions.pod:6197 +#: ../src/guestfs-actions.pod:6210 ../src/guestfs-actions.pod:6223 +#: ../src/guestfs-actions.pod:6238 ../src/guestfs-actions.pod:6297 +#: ../src/guestfs-actions.pod:6314 ../src/guestfs-actions.pod:6330 +#: ../src/guestfs-actions.pod:6346 ../src/guestfs-actions.pod:6363 +#: ../src/guestfs-actions.pod:6376 ../src/guestfs-actions.pod:6396 +#: ../src/guestfs-actions.pod:6432 ../src/guestfs-actions.pod:6446 +#: ../src/guestfs-actions.pod:6487 ../src/guestfs-actions.pod:6500 +#: ../src/guestfs-actions.pod:6518 ../src/guestfs-actions.pod:6552 +#: ../src/guestfs-actions.pod:6588 ../src/guestfs-actions.pod:6707 +#: ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6739 +#: ../src/guestfs-actions.pod:6794 ../src/guestfs-actions.pod:6807 +#: ../src/guestfs-actions.pod:6852 ../src/guestfs-actions.pod:6885 +#: ../src/guestfs-actions.pod:6939 ../src/guestfs-actions.pod:6965 +#: ../src/guestfs-actions.pod:7031 ../src/guestfs-actions.pod:7050 +#: ../src/guestfs-actions.pod:7079 +msgid "This function returns 0 on success or -1 on error." msgstr "" # type: textblock -#: ../src/guestfs.pod:1460 +#. type: textblock +#: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240 +#: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28 +#: ../fish/guestfish-actions.pod:151 ../fish/guestfish-actions.pod:165 msgid "" -"If any progress notification is sent during a call, then a final progress " -"notification is always sent when C = C." +"This function is deprecated. In new code, use the C call " +"instead." msgstr "" # type: textblock -#: ../src/guestfs.pod:1463 +#. type: textblock +#: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243 +#: ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435 +#: ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942 +#: ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:6973 +#: ../src/guestfs-actions.pod:7142 ../fish/guestfish-actions.pod:31 +#: ../fish/guestfish-actions.pod:154 ../fish/guestfish-actions.pod:168 +#: ../fish/guestfish-actions.pod:949 ../fish/guestfish-actions.pod:1306 +#: ../fish/guestfish-actions.pod:1320 ../fish/guestfish-actions.pod:2820 +#: ../fish/guestfish-actions.pod:4622 ../fish/guestfish-actions.pod:4719 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." +"Deprecated functions will not be removed from the API, but the fact that " +"they are deprecated indicates that there are problems with correct use of " +"these functions." msgstr "" # type: textblock -#: ../src/guestfs.pod:1469 -msgid "" -"The callback also receives the procedure number and serial number of the " -"call. These are only useful for debugging protocol issues, and the callback " -"can normally ignore them. The callback may want to print these numbers in " -"error messages or debugging messages." +#. type: textblock +#: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128 +#: ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893 +#: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094 +#: ../src/guestfs-actions.pod:3228 ../src/guestfs-actions.pod:3243 +#: ../src/guestfs-actions.pod:4481 ../src/guestfs-actions.pod:5550 +#: ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5777 +#: ../src/guestfs-actions.pod:6240 ../src/guestfs-actions.pod:6365 +#: ../src/guestfs-actions.pod:6887 +msgid "(Added in 0.3)" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1474 -msgid "PRIVATE DATA AREA" +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:41 +msgid "guestfs_add_domain" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1476 +# type: verbatim +#. type: verbatim +#: ../src/guestfs-actions.pod:43 +#, no-wrap 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." +" int\n" +" guestfs_add_domain (guestfs_h *g,\n" +" const char *dom,\n" +" ...);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1480 -msgid "To attach a named piece of data, use the following call:" +#. type: textblock +#: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137 +#: ../src/guestfs-actions.pod:4205 +msgid "" +"You may supply a list of optional arguments to this call. Use zero or more " +"of the following pairs of parameters, and terminate the list with C<-1> on " +"its own. See L." msgstr "" # type: verbatim -#: ../src/guestfs.pod:1482 +#. type: verbatim +#: ../src/guestfs-actions.pod:53 #, no-wrap msgid "" -" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" +" GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n" +" GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n" +" GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1484 +#. type: textblock +#: ../src/guestfs-actions.pod:57 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." +"This function adds the disk(s) attached to the named libvirt domain C. " +"It works by connecting to libvirt, requesting the domain and domain XML from " +"libvirt, parsing it for disks, and calling C on each " +"one." msgstr "" # type: textblock -#: ../src/guestfs.pod:1488 +#. type: textblock +#: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46 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." +"The number of disks added is returned. This operation is atomic: if an " +"error is returned, then no disks are added." msgstr "" # type: textblock -#: ../src/guestfs.pod:1493 -msgid "To retrieve the pointer, use:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:1495 -#, no-wrap +#. type: textblock +#: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49 msgid "" -" void *guestfs_get_private (guestfs_h *g, const char *key);\n" -"\n" +"This function does some minimal checks to make sure the libvirt domain is " +"not running (unless C is true). In a future version we will try " +"to acquire the libvirt lock on each disk." msgstr "" # type: textblock -#: ../src/guestfs.pod:1497 +#. type: textblock +#: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53 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." +"Disks must be accessible locally. This often means that adding disks from a " +"remote libvirt connection (see L) will fail " +"unless those disks are accessible via the same device path locally too." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1501 +#. type: textblock +#: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:58 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)." +"The optional C parameter sets the libvirt URI (see L). If this is not set then we connect to the default " +"libvirt URI (or one set through an environment variable, see the libvirt " +"documentation for full details)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1509 +#. type: textblock +#: ../src/guestfs-actions.pod:80 msgid "" -"The private data area is implemented using a hash table, and should be " -"reasonably efficient for moderate numbers of keys." +"The other optional parameters are passed directly through to " +"C." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1512 -msgid "BLOCK DEVICE NAMING" +# type: textblock +#. type: textblock +#: ../src/guestfs-actions.pod:83 ../src/guestfs-actions.pod:336 +#: ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679 +#: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728 +#: ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307 +#: ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864 +#: ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003 +#: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081 +#: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2662 +#: ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:4617 +#: ../src/guestfs-actions.pod:4745 ../src/guestfs-actions.pod:5151 +#: ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:6473 +#: ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6911 +#: ../src/guestfs-actions.pod:6924 +msgid "On error this function returns -1." msgstr "" # type: textblock -#: ../src/guestfs.pod:1514 -msgid "" -"In the kernel there is now quite a profusion of schemata for naming block " -"devices (in this context, by I I mean a physical or virtual " -"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." +#. type: textblock +#: ../src/guestfs-actions.pod:85 +msgid "(Added in 1.7.4)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1526 +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:87 +msgid "guestfs_add_domain_va" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs-actions.pod:89 +#, no-wrap msgid "" -"As discussed above, libguestfs uses a qemu appliance running an embedded " -"Linux kernel to access block devices. We can run a variety of appliances " -"based on a variety of Linux kernels." +" int\n" +" guestfs_add_domain_va (guestfs_h *g,\n" +" const char *dom,\n" +" va_list args);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1530 -msgid "" -"This causes a problem for libguestfs because many API calls use device or " -"partition names. Working scripts and the recipe (example) scripts that we " -"make available over the internet could fail if the naming scheme changes." +#. type: textblock +#: ../src/guestfs-actions.pod:94 +msgid "This is the \"va_list variant\" of L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1535 +#. type: textblock +#: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107 +#: ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211 +#: ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4256 +msgid "See L." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:98 +msgid "guestfs_add_domain_argv" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs-actions.pod:100 +#, no-wrap msgid "" -"Therefore libguestfs defines C as the I. " -"Internally C names are translated, if necessary, to other names as " -"required. For example, under RHEL 5 which uses the C scheme, any " -"device parameter C is translated to C transparently." +" int\n" +" guestfs_add_domain_argv (guestfs_h *g,\n" +" const char *dom,\n" +" const struct guestfs_add_domain_argv *optargs);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1541 -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." +#. type: textblock +#: ../src/guestfs-actions.pod:105 +msgid "This is the \"argv variant\" of L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1546 -msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" +#. type: =head2 +#: ../src/guestfs-actions.pod:109 +msgid "guestfs_add_drive" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1548 +# type: verbatim +#. type: verbatim +#: ../src/guestfs-actions.pod:111 +#, no-wrap 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." +" int\n" +" guestfs_add_drive (guestfs_h *g,\n" +" const char *filename);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1554 +#. type: textblock +#: ../src/guestfs-actions.pod:115 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." +"This function is the equivalent of calling C with no " +"optional parameters, so the disk is added writable, with the format being " +"detected automatically." msgstr "" # type: textblock -#: ../src/guestfs.pod:1562 -msgid "Is the string a parameter which is a device or partition name?" +#. type: textblock +#: ../src/guestfs-actions.pod:119 +msgid "" +"Automatic detection of the format opens you up to a potential security hole " +"when dealing with untrusted raw-format images. See CVE-2010-3851 and " +"RHBZ#642934. Specifying the format closes this security hole. Therefore " +"you should think about replacing calls to this function with calls to " +"C, and specifying the format." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1566 -msgid "Does the string begin with C?" +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:130 +msgid "guestfs_add_drive_opts" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1570 +# type: verbatim +#. type: verbatim +#: ../src/guestfs-actions.pod:132 +#, no-wrap msgid "" -"Does the named device exist? If so, we use that device. However if I " -"then we continue with this algorithm." +" int\n" +" guestfs_add_drive_opts (guestfs_h *g,\n" +" const char *filename,\n" +" ...);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1575 -msgid "Replace initial C string with C." +# type: verbatim +#. type: verbatim +#: ../src/guestfs-actions.pod:142 +#, no-wrap +msgid "" +" GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n" +" GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1577 -msgid "For example, change C to C." +#. type: textblock +#: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:90 +msgid "" +"This function adds a virtual machine disk image C to libguestfs. " +"The first time you call this function, the disk appears as C, the " +"second time as C, and so on." msgstr "" # type: textblock -#: ../src/guestfs.pod:1579 -msgid "If that named device exists, use it. If not, continue." +#. type: textblock +#: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:95 +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)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1583 -msgid "Replace initial C string with C." +#. type: textblock +#: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:101 +msgid "This call checks that C exists." msgstr "" # type: textblock -#: ../src/guestfs.pod:1585 -msgid "If that named device exists, use it. If not, return an error." +#. type: textblock +#: ../src/guestfs-actions.pod:159 ../src/guestfs-actions.pod:4215 +#: ../fish/guestfish-actions.pod:103 ../fish/guestfish-actions.pod:2831 +msgid "The optional arguments are:" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1589 -msgid "PORTABILITY CONCERNS" +# type: =item +#. type: =item +#: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:107 +msgid "C" msgstr "" # type: textblock -#: ../src/guestfs.pod:1591 +#. type: textblock +#: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109 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." +"If true then the image is treated as read-only. Writes are still allowed, " +"but they are stored in a temporary snapshot overlay which is discarded at " +"the end. The disk that you add is not modified." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1595 -msgid "" -"Where possible for maximum future portability programs using libguestfs " -"should use these future-proof techniques:" +# type: =item +#. type: =item +#: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:113 +msgid "C" msgstr "" # type: textblock -#: ../src/guestfs.pod:1602 +#. type: textblock +#: ../src/guestfs-actions.pod:171 msgid "" -"Use L or L to list actual " -"device names, and then use those names directly." +"This forces the image format. If you omit this (or use C " +"or C) then the format is automatically detected. " +"Possible formats include C and C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1605 +#. type: textblock +#: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:119 msgid "" -"Since those device names exist by definition, they will never be translated." +"Automatic detection of the format opens you up to a potential security hole " +"when dealing with untrusted raw-format images. See CVE-2010-3851 and " +"RHBZ#642934. Specifying the format closes this security hole." +msgstr "" + +# type: =item +#. type: =item +#: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:124 +msgid "C" msgstr "" # type: textblock -#: ../src/guestfs.pod:1610 +#. type: textblock +#: ../src/guestfs-actions.pod:182 msgid "" -"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " -"filesystem labels." +"This rarely-used option lets you emulate the behaviour of the deprecated " +"C call (q.v.)" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1615 -msgid "INTERNALS" +# type: textblock +#. type: textblock +#: ../src/guestfs-actions.pod:189 +msgid "(Added in 1.5.23)" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1617 -msgid "COMMUNICATION PROTOCOL" +#. type: =head2 +#: ../src/guestfs-actions.pod:191 +msgid "guestfs_add_drive_opts_va" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1619 +# type: verbatim +#. type: verbatim +#: ../src/guestfs-actions.pod:193 +#, 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." +" int\n" +" guestfs_add_drive_opts_va (guestfs_h *g,\n" +" const char *filename,\n" +" va_list args);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1622 -msgid "" -"The protocol used to talk between the library and the daemon running inside " -"the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC " -"1014, RFC 1832, RFC 4506)." +#. type: textblock +#: ../src/guestfs-actions.pod:198 +msgid "This is the \"va_list variant\" of L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1626 -msgid "" -"The detailed format of structures is in C (note: " -"this file is automatically generated)." +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:202 +msgid "guestfs_add_drive_opts_argv" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1629 +# type: verbatim +#. type: verbatim +#: ../src/guestfs-actions.pod:204 +#, 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." +" int\n" +" guestfs_add_drive_opts_argv (guestfs_h *g,\n" +" const char *filename,\n" +" const struct guestfs_add_drive_opts_argv *optargs);\n" +"\n" msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1636 -msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" +# type: textblock +#. type: textblock +#: ../src/guestfs-actions.pod:209 +msgid "This is the \"argv variant\" of L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1638 -msgid "For ordinary functions, the request message is:" +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:213 +msgid "guestfs_add_drive_ro" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1640 +#. type: verbatim +#: ../src/guestfs-actions.pod:215 #, 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\n" +" guestfs_add_drive_ro (guestfs_h *g,\n" +" const char *filename);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1645 -msgid "" -"The total length field allows the daemon to allocate a fixed size buffer " -"into which it slurps the rest of the message. As a result, the total length " -"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.pod:1651 +#. type: textblock +#: ../src/guestfs-actions.pod:219 msgid "" -"Note also that many functions don't take any arguments, in which case the " -"C_args> is completely omitted." +"This function is the equivalent of calling C with " +"the optional parameter C set to 1, so the " +"disk is added read-only, with the format being detected automatically." msgstr "" # type: textblock -#: ../src/guestfs.pod:1654 -msgid "" -"The header contains the procedure number (C) which is how the " -"receiver knows what type of args structure to expect, or none at all." +#. type: textblock +#: ../src/guestfs-actions.pod:226 +msgid "(Added in 1.0.38)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1658 -msgid "The reply message for ordinary functions is:" +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:228 +msgid "guestfs_add_drive_ro_with_if" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1660 +#. type: verbatim +#: ../src/guestfs-actions.pod:230 #, 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" +" int\n" +" guestfs_add_drive_ro_with_if (guestfs_h *g,\n" +" const char *filename,\n" +" const char *iface);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1665 +#. type: textblock +#: ../src/guestfs-actions.pod:235 msgid "" -"As above the C_ret> structure may be completely omitted for " -"functions that return no formal return values." +"This is the same as C but it allows you to specify the " +"QEMU interface emulation to use at run time." msgstr "" # type: textblock -#: ../src/guestfs.pod:1668 +#. type: textblock +#: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268 +#: ../src/guestfs-actions.pod:2333 +msgid "(Added in 1.0.84)" +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:249 +msgid "guestfs_add_drive_with_if" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs-actions.pod:251 +#, no-wrap msgid "" -"As above the total length of the reply is limited to C." +" int\n" +" guestfs_add_drive_with_if (guestfs_h *g,\n" +" const char *filename,\n" +" const char *iface);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1671 +#. type: textblock +#: ../src/guestfs-actions.pod:256 msgid "" -"In the case of an error, a flag is set in the header, and the reply message " -"is slightly changed:" +"This is the same as C but it allows you to specify the " +"QEMU interface emulation to use at run time." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:270 +msgid "guestfs_aug_clear" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1674 +#. type: verbatim +#: ../src/guestfs-actions.pod:272 #, 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\n" +" guestfs_aug_clear (guestfs_h *g,\n" +" const char *augpath);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1679 +#. type: textblock +#: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:176 msgid "" -"The C structure contains the error message as a " -"string." +"Set the value associated with C to C. This is the same as the " +"L C command." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1682 -msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" +# type: textblock +#. type: textblock +#: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083 +msgid "(Added in 1.3.4)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1684 -msgid "" -"A C parameter indicates that we transfer a file I the guest. " -"The normal request message is sent (see above). However this is followed by " -"a sequence of file chunks." +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:283 +msgid "guestfs_aug_close" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1688 +#. type: verbatim +#: ../src/guestfs-actions.pod:285 #, 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" +" int\n" +" guestfs_aug_close (guestfs_h *g);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1696 -msgid "The \"sequence of chunks\" is:" +#. type: textblock +#: ../src/guestfs-actions.pod:288 +msgid "" +"Close the current Augeas handle and free up any resources used by it. After " +"calling this, you have to call C again before you can use " +"any other Augeas functions." +msgstr "" + +# type: textblock +#. type: textblock +#: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320 +#: ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352 +#: ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430 +#: ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475 +#: ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503 +#: ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535 +#: ../src/guestfs-actions.pod:5228 +msgid "(Added in 0.7)" +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:297 +msgid "guestfs_aug_defnode" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1698 +#. type: verbatim +#: ../src/guestfs-actions.pod:299 #, 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" +" struct guestfs_int_bool *\n" +" guestfs_aug_defnode (guestfs_h *g,\n" +" const char *name,\n" +" const char *expr,\n" +" const char *val);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1706 +#. type: textblock +#: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:192 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." +"Defines a variable C whose value is the result of evaluating C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1710 +#. type: textblock +#: ../src/guestfs-actions.pod:308 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)." +"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." msgstr "" # type: textblock -#: ../src/guestfs.pod:1715 +#. type: textblock +#: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:199 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." +"On success this returns a pair containing the number of nodes in the " +"nodeset, and a boolean flag if a node was created." msgstr "" # type: textblock -#: ../src/guestfs.pod:1721 +#. type: textblock +#: ../src/guestfs-actions.pod:316 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." +"This function returns a C, or NULL if there was " +"an error. I after use>." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1730 +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:322 +msgid "guestfs_aug_defvar" +msgstr "" + +# type: verbatim +#. type: verbatim +#: ../src/guestfs-actions.pod:324 +#, no-wrap 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." +" int\n" +" guestfs_aug_defvar (guestfs_h *g,\n" +" const char *name,\n" +" const char *expr);\n" +"\n" msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1736 -msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" +# type: textblock +#. type: textblock +#: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:207 +msgid "" +"Defines an Augeas variable C whose value is the result of evaluating " +"C. If C is NULL, then C is undefined." msgstr "" # type: textblock -#: ../src/guestfs.pod:1738 +#. type: textblock +#: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:211 msgid "" -"The protocol for FileOut parameters is exactly the same as for FileIn " -"parameters, but with the roles of daemon and library reversed." +"On success this returns the number of nodes in C, or C<0> if C " +"evaluates to something which is not a nodeset." +msgstr "" + +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:340 +msgid "guestfs_aug_get" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1741 +#. type: verbatim +#: ../src/guestfs-actions.pod:342 #, 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" +" char *\n" +" guestfs_aug_get (guestfs_h *g,\n" +" const char *augpath);\n" "\n" msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1749 -msgid "INITIAL MESSAGE" +# type: textblock +#. type: textblock +#: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:218 +msgid "" +"Look up the value associated with C. If C matches exactly one " +"node, the C is returned." msgstr "" # type: textblock -#: ../src/guestfs.pod:1751 +#. type: textblock +#: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849 +#: ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927 +#: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046 +#: ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193 +#: ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341 +#: ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644 +#: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824 +#: ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936 +#: ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2298 +#: ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2586 +#: ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2748 +#: ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2803 +#: ../src/guestfs-actions.pod:2865 ../src/guestfs-actions.pod:2888 +#: ../src/guestfs-actions.pod:3402 ../src/guestfs-actions.pod:3752 +#: ../src/guestfs-actions.pod:3922 ../src/guestfs-actions.pod:4032 +#: ../src/guestfs-actions.pod:4763 ../src/guestfs-actions.pod:4956 +#: ../src/guestfs-actions.pod:5126 ../src/guestfs-actions.pod:5304 +#: ../src/guestfs-actions.pod:5353 ../src/guestfs-actions.pod:5916 +#: ../src/guestfs-actions.pod:5932 ../src/guestfs-actions.pod:5949 +#: ../src/guestfs-actions.pod:5973 ../src/guestfs-actions.pod:6647 +#: ../src/guestfs-actions.pod:6666 ../src/guestfs-actions.pod:6684 +#: ../src/guestfs-actions.pod:6864 ../src/guestfs-actions.pod:7136 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." +"This function returns a string, or NULL on error. I." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1755 -msgid "PROGRESS NOTIFICATION MESSAGES" +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:354 +msgid "guestfs_aug_init" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1757 +# type: verbatim +#. type: verbatim +#: ../src/guestfs-actions.pod:356 +#, no-wrap 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." +" int\n" +" guestfs_aug_init (guestfs_h *g,\n" +" const char *root,\n" +" int flags);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1761 +#. type: textblock +#: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:225 msgid "" -"The library turns them into progress callbacks (see " -"C) if there is a callback registered, or " -"discards them if not." +"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." msgstr "" # type: textblock -#: ../src/guestfs.pod:1765 -msgid "" -"The daemon self-limits the frequency of progress messages it sends (see " -"C). Not all calls generate progress " -"messages." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1769 -msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" +#. type: textblock +#: ../src/guestfs-actions.pod:365 +msgid "You must call this before using any other C commands." msgstr "" # type: textblock -#: ../src/guestfs.pod:1771 +#. type: textblock +#: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:232 msgid "" -"All high-level libguestfs actions are synchronous. If you want to use " -"libguestfs asynchronously then you must create a thread." +"C is the filesystem root. C must not be NULL, use C instead." msgstr "" # type: textblock -#: ../src/guestfs.pod:1774 +#. type: textblock +#: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:235 msgid "" -"Only use the handle from a single thread. Either use the handle exclusively " -"from one thread, or provide your own mutex so that two threads cannot issue " -"calls on the same handle at the same time." +"The flags are the same as the flags defined in Eaugeas.hE, the " +"logical I of the following integers:" +msgstr "" + +# type: =item +#. type: =item +#: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:241 +msgid "C = 1" msgstr "" # type: textblock -#: ../src/guestfs.pod:1778 -msgid "" -"See the graphical program guestfs-browser for one possible architecture for " -"multithreaded programs using libvirt and libguestfs." +#. type: textblock +#: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243 +msgid "Keep the original file with a C<.augsave> extension." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1781 -msgid "QEMU WRAPPERS" +# type: =item +#. type: =item +#: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245 +msgid "C = 2" msgstr "" # type: textblock -#: ../src/guestfs.pod:1783 +#. type: textblock +#: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247 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." +"Save changes into a file with extension C<.augnew>, and do not overwrite " +"original. Overrides C." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1787 -msgid "" -"There is one important rule to remember: you I> as the " -"last command in the shell script (so that qemu replaces the shell and " -"becomes the direct child of the libguestfs-using program). If you don't do " -"this, then the qemu process won't be cleaned up correctly." +# type: =item +#. type: =item +#: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:250 +msgid "C = 4" msgstr "" # type: textblock -#: ../src/guestfs.pod:1792 -msgid "" -"Here is an example of a wrapper, where I have built my own copy of qemu from " -"source:" +#. type: textblock +#: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252 +msgid "Typecheck lenses (can be expensive)." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1795 -#, no-wrap -msgid "" -" #!/bin/sh -\n" -" qemudir=/home/rjones/d/qemu\n" -" exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n" -"\n" +# type: =item +#. type: =item +#: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254 +msgid "C = 8" msgstr "" # type: textblock -#: ../src/guestfs.pod:1799 -msgid "" -"Save this script as C (or wherever), C, and " -"then use it by setting the LIBGUESTFS_QEMU environment variable. For " -"example:" +#. type: textblock +#: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256 +msgid "Do not use standard load path for modules." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1803 -#, no-wrap -msgid "" -" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" -"\n" +# type: =item +#. type: =item +#: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258 +msgid "C = 16" msgstr "" # type: textblock -#: ../src/guestfs.pod:1805 -msgid "" -"Note that libguestfs also calls qemu with the -help and -version options in " -"order to determine features." +#. type: textblock +#: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260 +msgid "Make save a no-op, just record what would have been changed." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1808 -msgid "LIBGUESTFS VERSION NUMBERS" +# type: =item +#. type: =item +#: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262 +msgid "C = 32" msgstr "" # type: textblock -#: ../src/guestfs.pod:1810 -msgid "" -"Since April 2010, libguestfs has started to make separate development and " -"stable releases, along with corresponding branches in our git repository. " -"These separate releases can be identified by version number:" +#. type: textblock +#: ../src/guestfs-actions.pod:400 +msgid "Do not load the tree in C." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1815 -#, 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" -"\n" +# type: textblock +#. type: textblock +#: ../src/guestfs-actions.pod:404 +msgid "To close the handle, you can call C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1826 -msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." +#. type: textblock +#: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:270 +msgid "To find out more about Augeas, see L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1828 -msgid "" -"As time passes we cherry pick fixes from the development branch and backport " -"those into the stable branch, the effect being that the stable branch should " -"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." +# type: =head2 +#. type: =head2 +#: ../src/guestfs-actions.pod:412 +msgid "guestfs_aug_insert" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1834 -msgid "Our criteria for backporting changes are:" +# type: verbatim +#. type: verbatim +#: ../src/guestfs-actions.pod:414 +#, no-wrap +msgid "" +" int\n" +" guestfs_aug_insert (guestfs_h *g,\n" +" const char *augpath,\n" +" const char *label,\n" +" int before);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1840 +#. type: textblock +#: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:276 msgid "" -"Documentation changes which don't affect any code are backported unless the " -"documentation refers to a future feature which is not in stable." +"Create a new sibling C