X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=po-docs%2Flibguestfs-docs.pot;h=d2a45891eb9585d0a4cb6b6425b45f3ed9c529fa;hp=355989d214d5da29194625fc36afd24463d2a048;hb=21c118a20e625dccd7cbd454f67a9f9c360c53f1;hpb=290e8864fff8a390d6bbbe20fe9781a03edb4c6a diff --git a/po-docs/libguestfs-docs.pot b/po-docs/libguestfs-docs.pot index 355989d..d2a4589 100644 --- a/po-docs/libguestfs-docs.pot +++ b/po-docs/libguestfs-docs.pot @@ -6,9 +6,9 @@ #, fuzzy msgid "" msgstr "" -"Project-Id-Version: libguestfs 1.9.9\n" +"Project-Id-Version: libguestfs 1.11.12\n" "Report-Msgid-Bugs-To: libguestfs@redhat.com\n" -"POT-Creation-Date: 2011-03-04 10:09+0000\n" +"POT-Creation-Date: 2011-06-28 19:35+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -18,7 +18,7 @@ msgstr "" "Content-Transfer-Encoding: 8bit\n" #. type: =head1 -#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 +#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-win-reg.pl:35 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 msgid "NAME" msgstr "" @@ -28,7 +28,7 @@ msgid "guestfs - Library for accessing and modifying virtual machine images" msgstr "" #. type: =head1 -#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 +#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-win-reg.pl:39 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 msgid "SYNOPSIS" msgstr "" @@ -65,7 +65,7 @@ msgid "" msgstr "" #. type: =head1 -#: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40 +#: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-win-reg.pl:63 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40 msgid "DESCRIPTION" msgstr "" @@ -220,7 +220,7 @@ msgid "" " * disk image.\n" " */\n" " guestfs_touch (g, \"/hello\");\n" -"\n" +" \n" msgstr "" #. type: verbatim @@ -741,7 +741,7 @@ msgstr "" #. type: textblock #: ../src/guestfs.pod:357 -msgid "and you can write tar output to a pipe C by doing:" +msgid "and you can write tar output to a file descriptor C by doing:" msgstr "" #. type: verbatim @@ -807,7 +807,7 @@ msgid "There are many limitations to this:" msgstr "" #. 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:1088 ../src/guestfs.pod:1092 ../src/guestfs.pod:1096 ../src/guestfs.pod:1101 ../src/guestfs.pod:1109 ../src/guestfs.pod:1128 ../src/guestfs.pod:1136 ../src/guestfs.pod:1158 ../src/guestfs.pod:1162 ../src/guestfs.pod:1166 ../src/guestfs.pod:1170 ../src/guestfs.pod:1174 ../src/guestfs.pod:1178 ../src/guestfs.pod:1660 ../src/guestfs.pod:1665 ../src/guestfs.pod:1669 ../src/guestfs.pod:1779 ../src/guestfs.pod:1784 ../src/guestfs.pod:1788 ../src/guestfs.pod:2140 ../src/guestfs.pod:2146 ../src/guestfs.pod:2151 ../src/guestfs.pod:2157 ../src/guestfs.pod:2622 ../src/guestfs.pod:2626 ../src/guestfs.pod:2630 ../src/guestfs.pod:2634 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592 ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1603 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1619 ../src/guestfs-actions.pod:1623 ../src/guestfs-actions.pod:1633 ../src/guestfs-actions.pod:1637 ../src/guestfs-actions.pod:1641 ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1783 ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:1854 ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:1863 ../fish/guestfish.pod:432 ../fish/guestfish.pod:436 ../fish/guestfish.pod:440 ../fish/guestfish.pod:444 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402 ../fish/guestfish-actions.pod:1072 ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1092 ../fish/guestfish-actions.pod:1096 ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1110 ../fish/guestfish-actions.pod:1114 ../fish/guestfish-actions.pod:1118 ../fish/guestfish-actions.pod:1208 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1268 ../fish/guestfish-actions.pod:1273 ../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 +#: ../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:1064 ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077 ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112 ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142 ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154 ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652 ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763 ../src/guestfs.pod:1773 ../src/guestfs.pod:2008 ../src/guestfs.pod:2013 ../src/guestfs.pod:2019 ../src/guestfs.pod:2027 ../src/guestfs.pod:2381 ../src/guestfs.pod:2387 ../src/guestfs.pod:2392 ../src/guestfs.pod:2398 ../src/guestfs.pod:2967 ../src/guestfs.pod:2971 ../src/guestfs.pod:2975 ../src/guestfs.pod:2979 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598 ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1603 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1623 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1641 ../src/guestfs-actions.pod:1645 ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1787 ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:1796 ../src/guestfs-actions.pod:1801 ../src/guestfs-actions.pod:1862 ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1871 ../src/guestfs-actions.pod:2783 ../src/guestfs-actions.pod:2789 ../src/guestfs-actions.pod:2797 ../src/guestfs-actions.pod:2804 ../src/guestfs-actions.pod:2811 ../fish/guestfish.pod:445 ../fish/guestfish.pod:449 ../fish/guestfish.pod:453 ../fish/guestfish.pod:457 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385 ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1074 ../fish/guestfish-actions.pod:1078 ../fish/guestfish-actions.pod:1082 ../fish/guestfish-actions.pod:1086 ../fish/guestfish-actions.pod:1094 ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102 ../fish/guestfish-actions.pod:1112 ../fish/guestfish-actions.pod:1116 ../fish/guestfish-actions.pod:1120 ../fish/guestfish-actions.pod:1210 ../fish/guestfish-actions.pod:1214 ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1224 ../fish/guestfish-actions.pod:1266 ../fish/guestfish-actions.pod:1270 ../fish/guestfish-actions.pod:1275 ../fish/guestfish-actions.pod:1902 ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:1916 ../fish/guestfish-actions.pod:1923 ../fish/guestfish-actions.pod:1930 ../tools/virt-win-reg.pl:195 ../tools/virt-win-reg.pl:200 ../tools/virt-win-reg.pl:206 ../tools/virt-win-reg.pl:708 ../tools/virt-win-reg.pl:714 ../tools/virt-win-reg.pl:720 msgid "*" msgstr "" @@ -933,7 +933,7 @@ msgid "" msgstr "" #. type: =item -#: ../src/guestfs.pod:469 ../src/guestfs.pod:1281 ../src/guestfs.pod:1412 ../src/guestfs.pod:2185 +#: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395 ../src/guestfs.pod:2426 msgid "1." msgstr "" @@ -951,7 +951,7 @@ msgid "" msgstr "" #. type: =item -#: ../src/guestfs.pod:475 ../src/guestfs.pod:1285 ../src/guestfs.pod:1416 ../src/guestfs.pod:2210 +#: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399 ../src/guestfs.pod:2451 msgid "2." msgstr "" @@ -978,7 +978,7 @@ msgid "" msgstr "" #. type: =item -#: ../src/guestfs.pod:486 ../src/guestfs.pod:1422 +#: ../src/guestfs.pod:486 ../src/guestfs.pod:1405 msgid "3." msgstr "" @@ -1045,7 +1045,7 @@ msgid "For more information about umask, see L." msgstr "" #. type: =head1 -#: ../src/guestfs.pod:519 ../fish/guestfish.pod:751 +#: ../src/guestfs.pod:519 ../fish/guestfish.pod:767 msgid "ENCRYPTED DISKS" msgstr "" @@ -1275,33 +1275,32 @@ msgstr "" #. type: textblock #: ../src/guestfs.pod:644 msgid "" -"Drive letter mappings are outside the scope of libguestfs. You have to use " -"libguestfs to read the appropriate Windows Registry and configuration files, " -"to determine yourself how drives are mapped (see also L and " -"L)." +"Drive letter mappings can be found using inspection (see L and " +"L)" msgstr "" #. type: textblock -#: ../src/guestfs.pod:649 +#: ../src/guestfs.pod:647 msgid "" -"Replacing backslash characters with forward slash characters is also outside " -"the scope of libguestfs, but something that you can easily do." +"Dealing with separator characters (backslash vs forward slash) is outside " +"the scope of libguestfs, but usually a simple character replacement will " +"work." msgstr "" #. type: textblock -#: ../src/guestfs.pod:652 +#: ../src/guestfs.pod:651 msgid "" -"Where we can help is in resolving the case insensitivity of paths. For " -"this, call L." +"To resolve the case insensitivity of paths, call " +"L." msgstr "" #. type: =head3 -#: ../src/guestfs.pod:655 +#: ../src/guestfs.pod:654 msgid "ACCESSING THE WINDOWS REGISTRY" msgstr "" #. type: textblock -#: ../src/guestfs.pod:657 +#: ../src/guestfs.pod:656 msgid "" "Libguestfs also provides some help for decoding Windows Registry \"hive\" " "files, through the library C which is part of the libguestfs project " @@ -1312,12 +1311,12 @@ msgid "" msgstr "" #. type: =head3 -#: ../src/guestfs.pod:665 +#: ../src/guestfs.pod:664 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:667 +#: ../src/guestfs.pod:666 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 " @@ -1325,12 +1324,12 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:671 +#: ../src/guestfs.pod:670 msgid "L" msgstr "" #. type: textblock -#: ../src/guestfs.pod:673 +#: ../src/guestfs.pod:672 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 " @@ -1340,7 +1339,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:680 +#: ../src/guestfs.pod:679 msgid "" "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use " "L to read the C extended " @@ -1349,36 +1348,36 @@ msgid "" msgstr "" #. type: =head3 -#: ../src/guestfs.pod:685 +#: ../src/guestfs.pod:684 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:687 +#: ../src/guestfs.pod:686 msgid "" "There are other useful extended attributes that can be read from ntfs-3g " "filesystems (using L). See:" msgstr "" #. type: textblock -#: ../src/guestfs.pod:690 +#: ../src/guestfs.pod:689 msgid "L" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:692 +#: ../src/guestfs.pod:691 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES" msgstr "" #. type: textblock -#: ../src/guestfs.pod:694 +#: ../src/guestfs.pod:693 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:697 +#: ../src/guestfs.pod:696 msgid "" "The API is broadly identical in all supported languages. This means that " "the C call C is C<$g-Eadd_drive_ro($file)> " @@ -1388,14 +1387,14 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:703 +#: ../src/guestfs.pod:702 msgid "" "Error messages are automatically transformed into exceptions if the language " "supports it." msgstr "" #. type: textblock -#: ../src/guestfs.pod:706 +#: ../src/guestfs.pod:705 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 " @@ -1403,36 +1402,36 @@ msgid "" msgstr "" #. type: =item -#: ../src/guestfs.pod:712 +#: ../src/guestfs.pod:711 msgid "B" msgstr "" #. type: textblock -#: ../src/guestfs.pod:714 +#: ../src/guestfs.pod:713 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:718 +#: ../src/guestfs.pod:717 msgid "B" msgstr "" #. type: textblock -#: ../src/guestfs.pod:720 +#: ../src/guestfs.pod:719 msgid "" "The C# bindings are highly experimental. Please read the warnings at the " "top of C." msgstr "" #. type: =item -#: ../src/guestfs.pod:723 +#: ../src/guestfs.pod:722 msgid "B" msgstr "" #. type: textblock -#: ../src/guestfs.pod:725 +#: ../src/guestfs.pod:724 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 " @@ -1440,91 +1439,91 @@ msgid "" msgstr "" #. type: =item -#: ../src/guestfs.pod:729 +#: ../src/guestfs.pod:728 msgid "B" msgstr "" #. type: textblock -#: ../src/guestfs.pod:731 +#: ../src/guestfs.pod:730 msgid "" "Full documentation is contained in the Javadoc which is distributed with " "libguestfs." msgstr "" #. type: =item -#: ../src/guestfs.pod:734 +#: ../src/guestfs.pod:733 msgid "B" msgstr "" #. type: textblock -#: ../src/guestfs.pod:736 +#: ../src/guestfs.pod:735 msgid "See L." msgstr "" #. type: =item -#: ../src/guestfs.pod:738 +#: ../src/guestfs.pod:737 msgid "B" msgstr "" #. type: textblock -#: ../src/guestfs.pod:740 +#: ../src/guestfs.pod:739 msgid "See L and L." msgstr "" #. type: =item -#: ../src/guestfs.pod:742 +#: ../src/guestfs.pod:741 msgid "B" msgstr "" #. type: textblock -#: ../src/guestfs.pod:744 +#: ../src/guestfs.pod:743 msgid "" "For documentation see C supplied with libguestfs sources or in " "the php-libguestfs package for your distribution." msgstr "" #. type: textblock -#: ../src/guestfs.pod:747 +#: ../src/guestfs.pod:746 msgid "The PHP binding only works correctly on 64 bit machines." msgstr "" #. type: =item -#: ../src/guestfs.pod:749 +#: ../src/guestfs.pod:748 msgid "B" msgstr "" #. type: textblock -#: ../src/guestfs.pod:751 +#: ../src/guestfs.pod:750 msgid "See L." msgstr "" #. type: =item -#: ../src/guestfs.pod:753 +#: ../src/guestfs.pod:752 msgid "B" msgstr "" #. type: textblock -#: ../src/guestfs.pod:755 +#: ../src/guestfs.pod:754 msgid "See L." msgstr "" #. type: =item -#: ../src/guestfs.pod:757 +#: ../src/guestfs.pod:756 msgid "B" msgstr "" #. type: textblock -#: ../src/guestfs.pod:759 +#: ../src/guestfs.pod:758 msgid "See L." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:763 +#: ../src/guestfs.pod:762 msgid "LIBGUESTFS GOTCHAS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:765 +#: ../src/guestfs.pod:764 msgid "" "L: \"A feature of a " "system [...] that works in the way it is documented but is counterintuitive " @@ -1532,7 +1531,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:769 +#: ../src/guestfs.pod:768 msgid "" "Since we developed libguestfs and the associated tools, there are several " "things we would have designed differently, but are now stuck with for " @@ -1541,12 +1540,19 @@ msgid "" msgstr "" #. type: =item -#: ../src/guestfs.pod:777 +#: ../src/guestfs.pod:776 msgid "Autosync / forgetting to sync." msgstr "" #. type: textblock -#: ../src/guestfs.pod:779 +#: ../src/guestfs.pod:778 +msgid "" +"I Autosync is enabled by default for all API users starting from " +"libguestfs 1.5.24. This section only applies to older versions." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:781 msgid "" "When modifying a filesystem from C or another language, you B unmount " "all filesystems and call L explicitly before you close the " @@ -1554,7 +1560,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:783 +#: ../src/guestfs.pod:785 #, no-wrap msgid "" " guestfs_set_autosync (g, 1);\n" @@ -1562,7 +1568,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:785 +#: ../src/guestfs.pod:787 msgid "" "to have the unmount/sync done automatically for you when the handle 'g' is " "closed. (This feature is called \"autosync\", L " @@ -1570,7 +1576,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:789 +#: ../src/guestfs.pod:791 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 " @@ -1578,27 +1584,20 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:793 +#: ../src/guestfs.pod:795 msgid "" "Note that in L autosync is the default. So quick and dirty " "guestfish scripts that forget to sync will work just fine, which can make " "this very puzzling if you are trying to debug a problem." msgstr "" -#. type: textblock -#: ../src/guestfs.pod:797 -msgid "" -"Update: Autosync is enabled by default for all API users starting from " -"libguestfs 1.5.24." -msgstr "" - #. type: =item -#: ../src/guestfs.pod:800 +#: ../src/guestfs.pod:799 msgid "Mount option C<-o sync> should not be the default." msgstr "" #. type: textblock -#: ../src/guestfs.pod:802 +#: ../src/guestfs.pod:801 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 " @@ -1606,31 +1605,31 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:806 +#: ../src/guestfs.pod:805 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:809 +#: ../src/guestfs.pod:808 msgid "Read-only should be the default." msgstr "" #. type: textblock -#: ../src/guestfs.pod:811 +#: ../src/guestfs.pod:810 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:814 +#: ../src/guestfs.pod:813 msgid "This would reduce the potential to corrupt live VM images." msgstr "" #. type: textblock -#: ../src/guestfs.pod:816 +#: ../src/guestfs.pod:815 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 " @@ -1638,12 +1637,12 @@ msgid "" msgstr "" #. type: =item -#: ../src/guestfs.pod:820 +#: ../src/guestfs.pod:819 msgid "guestfish command line is hard to use." msgstr "" #. type: textblock -#: ../src/guestfs.pod:822 +#: ../src/guestfs.pod:821 msgid "" "C doesn't do what people expect (open C for " "examination). It tries to run a guestfish command C which doesn't " @@ -1653,12 +1652,12 @@ msgid "" msgstr "" #. type: =item -#: ../src/guestfs.pod:829 +#: ../src/guestfs.pod:828 msgid "guestfish megabyte modifiers don't work right on all commands" msgstr "" #. type: textblock -#: ../src/guestfs.pod:831 +#: ../src/guestfs.pod:830 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 " @@ -1668,12 +1667,12 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:838 +#: ../src/guestfs.pod:837 msgid "The most common is L. The guestfish command:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:840 +#: ../src/guestfs.pod:839 #, no-wrap msgid "" " lvcreate LV VG 100M\n" @@ -1681,7 +1680,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:842 +#: ../src/guestfs.pod:841 msgid "" "does not do what you might expect. Instead because L is " "already expecting megabytes, this tries to create a 100 I (100 " @@ -1690,19 +1689,19 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:847 +#: ../src/guestfs.pod:846 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:850 +#: ../src/guestfs.pod:849 msgid "Ambiguity between devices and paths" msgstr "" #. type: textblock -#: ../src/guestfs.pod:852 +#: ../src/guestfs.pod:851 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 " @@ -1710,7 +1709,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:857 +#: ../src/guestfs.pod:856 msgid "" "In the current API we usually resolve this ambiguity by having two separate " "calls, for example L and L. " @@ -1719,7 +1718,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:863 +#: ../src/guestfs.pod:862 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 " @@ -1729,7 +1728,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:869 +#: ../src/guestfs.pod:868 #, no-wrap msgid "" " type path = Path of string | Device of int | Partition of int * int\n" @@ -1737,12 +1736,12 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:871 +#: ../src/guestfs.pod:870 msgid "which would allow you to pass arguments like:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:873 +#: ../src/guestfs.pod:872 #, no-wrap msgid "" " Path \"/foo/bar\"\n" @@ -1753,66 +1752,26 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:878 +#: ../src/guestfs.pod:877 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:883 -msgid "PROTOCOL LIMITS" -msgstr "" - -#. type: textblock -#: ../src/guestfs.pod:885 -msgid "" -"Internally libguestfs uses a message-based protocol to pass API calls and " -"their responses to and from a small \"appliance\" (see L for " -"plenty more detail about this). The maximum message size used by the " -"protocol is slightly less than 4 MB. For some API calls you may need to be " -"aware of this limit. The API calls which may be affected are individually " -"documented, with a link back to this section of the documentation." -msgstr "" - -#. type: textblock -#: ../src/guestfs.pod:893 -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 " -"a message, the maximum size that it can return is slightly under 4 MB. If " -"the requested file is larger than this then you will get an error." -msgstr "" - -#. type: textblock -#: ../src/guestfs.pod:899 -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 " -"and L document how to do this." -msgstr "" - -#. type: textblock -#: ../src/guestfs.pod:903 -msgid "" -"You might also consider mounting the disk image using our FUSE filesystem " -"support (L)." -msgstr "" - -#. type: =head2 -#: ../src/guestfs.pod:906 +#: ../src/guestfs.pod:882 msgid "KEYS AND PASSPHRASES" msgstr "" #. type: textblock -#: ../src/guestfs.pod:908 +#: ../src/guestfs.pod:884 msgid "" "Certain libguestfs calls take a parameter that contains sensitive key " "material, passed in as a C string." msgstr "" #. type: textblock -#: ../src/guestfs.pod:911 +#: ../src/guestfs.pod:887 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 " @@ -1821,7 +1780,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:916 +#: ../src/guestfs.pod:892 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, " @@ -1829,19 +1788,19 @@ msgid "" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:921 +#: ../src/guestfs.pod:897 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:923 +#: ../src/guestfs.pod:899 msgid "" "All high-level libguestfs actions are synchronous. If you want to use " "libguestfs asynchronously then you must create a thread." msgstr "" #. type: textblock -#: ../src/guestfs.pod:926 +#: ../src/guestfs.pod:902 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 " @@ -1849,33 +1808,33 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:930 +#: ../src/guestfs.pod:906 msgid "" "See the graphical program guestfs-browser for one possible architecture for " "multithreaded programs using libvirt and libguestfs." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:933 +#: ../src/guestfs.pod:909 msgid "PATH" msgstr "" #. type: textblock -#: ../src/guestfs.pod:935 +#: ../src/guestfs.pod:911 msgid "" -"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " +"Libguestfs needs a supermin appliance, which it finds by looking along an " "internal path." msgstr "" #. type: textblock -#: ../src/guestfs.pod:938 +#: ../src/guestfs.pod:914 msgid "" "By default it looks for these in the directory C<$libdir/guestfs> " "(eg. C or C)." msgstr "" #. type: textblock -#: ../src/guestfs.pod:941 +#: ../src/guestfs.pod:917 msgid "" "Use L or set the environment variable L " "to change the directories that libguestfs will search in. The value is a " @@ -1886,12 +1845,12 @@ msgid "" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:948 +#: ../src/guestfs.pod:924 msgid "QEMU WRAPPERS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:950 +#: ../src/guestfs.pod:926 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 " @@ -1899,7 +1858,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:954 +#: ../src/guestfs.pod:930 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 " @@ -1908,14 +1867,14 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:959 +#: ../src/guestfs.pod:935 msgid "" "Here is an example of a wrapper, where I have built my own copy of qemu from " "source:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:962 +#: ../src/guestfs.pod:938 #, no-wrap msgid "" " #!/bin/sh -\n" @@ -1926,7 +1885,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:966 +#: ../src/guestfs.pod:942 msgid "" "Save this script as C (or wherever), C, and " "then use it by setting the LIBGUESTFS_QEMU environment variable. For " @@ -1934,7 +1893,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:970 +#: ../src/guestfs.pod:946 #, no-wrap msgid "" " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" @@ -1942,26 +1901,26 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:972 +#: ../src/guestfs.pod:948 msgid "" "Note that libguestfs also calls qemu with the -help and -version options in " "order to determine features." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:975 +#: ../src/guestfs.pod:951 msgid "ATTACHING TO RUNNING DAEMONS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:977 +#: ../src/guestfs.pod:953 msgid "" "I This is B and has a tendency to eat " "babies. Use with caution." msgstr "" #. type: textblock -#: ../src/guestfs.pod:980 +#: ../src/guestfs.pod:956 msgid "" "I This section explains how to attach to a running daemon from a " "low level perspective. For most users, simply using virt tools such as " @@ -1969,12 +1928,12 @@ msgid "" msgstr "" #. type: =head3 -#: ../src/guestfs.pod:984 +#: ../src/guestfs.pod:960 msgid "Using guestfs_set_attach_method" msgstr "" #. type: textblock -#: ../src/guestfs.pod:986 +#: ../src/guestfs.pod:962 msgid "" "By calling L you can change how the library " "connects to the C daemon in L (read " @@ -1982,14 +1941,14 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:990 +#: ../src/guestfs.pod:966 msgid "" "The normal attach method is C, where a small appliance is created " "containing the daemon, and then the library connects to this." msgstr "" #. type: textblock -#: ../src/guestfs.pod:993 +#: ../src/guestfs.pod:969 msgid "" "Setting attach method to C> (where I is the path of a " "Unix domain socket) causes L to connect to an existing " @@ -1997,7 +1956,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:997 +#: ../src/guestfs.pod:973 msgid "" "The normal use for this is to connect to a running virtual machine that " "contains a C daemon, and send commands so you can read and write " @@ -2005,12 +1964,12 @@ msgid "" msgstr "" #. type: =head3 -#: ../src/guestfs.pod:1001 +#: ../src/guestfs.pod:977 msgid "Using guestfs_add_domain with live flag" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1003 +#: ../src/guestfs.pod:979 msgid "" "L provides some help for getting the correct attach " "method. If you pass the C option to this function, then (if the " @@ -2019,7 +1978,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1009 +#: ../src/guestfs.pod:985 #, no-wrap msgid "" " \n" @@ -2037,14 +1996,14 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1021 +#: ../src/guestfs.pod:997 msgid "" "L extracts C and sets the attach " "method to C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1024 +#: ../src/guestfs.pod:1000 msgid "" "Some of the libguestfs tools (including guestfish) support a I<--live> " "option which is passed through to L thus allowing you " @@ -2052,19 +2011,19 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1028 +#: ../src/guestfs.pod:1004 msgid "" "The virtual machine needs to have been set up beforehand so that it has the " "virtio-serial channel and so that guestfsd is running inside it." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1032 +#: ../src/guestfs.pod:1008 msgid "ABI GUARANTEE" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1034 +#: ../src/guestfs.pod:1010 msgid "" "We guarantee the libguestfs ABI (binary interface), for public, high-level " "actions as outlined in this section. Although we will deprecate some " @@ -2074,12 +2033,12 @@ msgid "" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1040 +#: ../src/guestfs.pod:1016 msgid "BLOCK DEVICE NAMING" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1042 +#: ../src/guestfs.pod:1018 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 " @@ -2094,7 +2053,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1054 +#: ../src/guestfs.pod:1030 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 " @@ -2102,7 +2061,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1058 +#: ../src/guestfs.pod:1034 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 " @@ -2110,7 +2069,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1063 +#: ../src/guestfs.pod:1039 msgid "" "Therefore libguestfs defines C as the I. " "Internally C names are translated, if necessary, to other names as " @@ -2119,7 +2078,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1069 +#: ../src/guestfs.pod:1045 msgid "" "Note that this I applies to parameters. The L, " "L and similar calls return the true names of the " @@ -2127,12 +2086,12 @@ msgid "" msgstr "" #. type: =head3 -#: ../src/guestfs.pod:1074 +#: ../src/guestfs.pod:1050 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1076 +#: ../src/guestfs.pod:1052 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 " @@ -2142,7 +2101,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1082 +#: ../src/guestfs.pod:1058 msgid "" "The algorithm is applied only to I which are known to be either " "device or partition names. Return values from functions such as " @@ -2150,54 +2109,54 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1090 +#: ../src/guestfs.pod:1066 msgid "Is the string a parameter which is a device or partition name?" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1094 +#: ../src/guestfs.pod:1070 msgid "Does the string begin with C?" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1098 +#: ../src/guestfs.pod:1074 msgid "" "Does the named device exist? If so, we use that device. However if I " "then we continue with this algorithm." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1103 +#: ../src/guestfs.pod:1079 msgid "Replace initial C string with C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1105 +#: ../src/guestfs.pod:1081 msgid "For example, change C to C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1107 +#: ../src/guestfs.pod:1083 msgid "If that named device exists, use it. If not, continue." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1111 +#: ../src/guestfs.pod:1087 msgid "Replace initial C string with C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1113 +#: ../src/guestfs.pod:1089 msgid "If that named device exists, use it. If not, return an error." msgstr "" #. type: =head3 -#: ../src/guestfs.pod:1117 +#: ../src/guestfs.pod:1093 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1119 +#: ../src/guestfs.pod:1095 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 " @@ -2205,50 +2164,50 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1123 +#: ../src/guestfs.pod:1099 msgid "" "Where possible for maximum future portability programs using libguestfs " "should use these future-proof techniques:" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1130 +#: ../src/guestfs.pod:1106 msgid "" "Use L or L to list actual " "device names, and then use those names directly." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1133 +#: ../src/guestfs.pod:1109 msgid "Since those device names exist by definition, they will never be translated." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1138 +#: ../src/guestfs.pod:1114 msgid "" "Use higher level ways to identify filesystems, such as LVM names, UUIDs and " "filesystem labels." msgstr "" #. type: =head1 -#: ../src/guestfs.pod:1143 +#: ../src/guestfs.pod:1119 msgid "SECURITY" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1145 +#: ../src/guestfs.pod:1121 msgid "" "This section discusses security implications of using libguestfs, " "particularly with untrusted or malicious guests or disk images." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1148 +#: ../src/guestfs.pod:1124 msgid "GENERAL SECURITY CONSIDERATIONS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1150 +#: ../src/guestfs.pod:1126 msgid "" "Be careful with any files or data that you download from a guest (by " "\"download\" we mean not just the L command but any " @@ -2258,42 +2217,42 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1160 +#: ../src/guestfs.pod:1136 msgid "the data (file etc) not being present" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1164 +#: ../src/guestfs.pod:1140 msgid "being present but empty" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1168 +#: ../src/guestfs.pod:1144 msgid "being much larger than normal" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1172 +#: ../src/guestfs.pod:1148 msgid "containing arbitrary 8 bit data" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1176 +#: ../src/guestfs.pod:1152 msgid "being in an unexpected character encoding" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1180 +#: ../src/guestfs.pod:1156 msgid "containing homoglyphs." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1184 +#: ../src/guestfs.pod:1160 msgid "SECURITY OF MOUNTING FILESYSTEMS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1186 +#: ../src/guestfs.pod:1162 msgid "" "When you mount a filesystem under Linux, mistakes in the kernel filesystem " "(VFS) module can sometimes be escalated into exploits by deliberately " @@ -2309,7 +2268,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1199 +#: ../src/guestfs.pod:1175 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 " @@ -2323,19 +2282,19 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1210 +#: ../src/guestfs.pod:1186 msgid "" "In any case callers can reduce the attack surface by forcing the filesystem " "type when mounting (use L)." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1213 +#: ../src/guestfs.pod:1189 msgid "PROTOCOL SECURITY" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1215 +#: ../src/guestfs.pod:1191 msgid "" "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a " "defined upper message size. However a program that uses libguestfs must " @@ -2345,12 +2304,12 @@ msgid "" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1221 +#: ../src/guestfs.pod:1197 msgid "INSPECTION SECURITY" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1223 +#: ../src/guestfs.pod:1199 msgid "" "Parts of the inspection API (see L) return untrusted strings " "directly from the guest, and these could contain any 8 bit data. Callers " @@ -2359,7 +2318,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1229 +#: ../src/guestfs.pod:1205 msgid "" "Guest configuration may be altered in unusual ways by the administrator of " "the virtual machine, and may not reflect reality (particularly for untrusted " @@ -2370,7 +2329,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1237 +#: ../src/guestfs.pod:1213 msgid "" "The inspection API parses guest configuration using two external libraries: " "Augeas (Linux configuration) and hivex (Windows Registry). Both are " @@ -2380,12 +2339,12 @@ msgid "" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1243 +#: ../src/guestfs.pod:1219 msgid "RUNNING UNTRUSTED GUEST COMMANDS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1245 +#: ../src/guestfs.pod:1221 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 " @@ -2395,24 +2354,24 @@ msgid "" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1251 +#: ../src/guestfs.pod:1227 msgid "CVE-2010-3851" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1253 +#: ../src/guestfs.pod:1229 msgid "https://bugzilla.redhat.com/642934" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1255 +#: ../src/guestfs.pod:1231 msgid "" "This security bug concerns the automatic disk format detection that qemu " "does on disk images." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1258 +#: ../src/guestfs.pod:1234 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 " @@ -2421,7 +2380,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1263 +#: ../src/guestfs.pod:1239 msgid "" "This allows a guest which has been given a raw disk image to write some " "other header. At next boot (or when the disk image is accessed by " @@ -2430,7 +2389,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1268 +#: ../src/guestfs.pod:1244 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 " @@ -2442,24 +2401,24 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1276 +#: ../src/guestfs.pod:1252 msgid "In libguestfs this is rather hard to exploit except under two circumstances:" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1283 +#: ../src/guestfs.pod:1259 msgid "You have enabled the network or have opened the disk in write mode." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1287 +#: ../src/guestfs.pod:1263 msgid "" "You are also running untrusted code from the guest (see L)." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1292 +#: ../src/guestfs.pod:1268 msgid "" "The way to avoid this is to specify the expected disk format when adding " "disks (the optional C option to L). You " @@ -2468,31 +2427,31 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1297 +#: ../src/guestfs.pod:1273 msgid "" "For disks added from libvirt using calls like L, the " "format is fetched from libvirt and passed through." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1300 +#: ../src/guestfs.pod:1276 msgid "" "For libguestfs tools, use the I<--format> command line parameter as " "appropriate." msgstr "" #. type: =head1 -#: ../src/guestfs.pod:1303 +#: ../src/guestfs.pod:1279 msgid "CONNECTION MANAGEMENT" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1305 +#: ../src/guestfs.pod:1281 msgid "guestfs_h *" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1307 +#: ../src/guestfs.pod:1283 msgid "" "C is the opaque type representing a connection handle. Create a " "handle by calling L. Call L to free the " @@ -2500,19 +2459,19 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1311 +#: ../src/guestfs.pod:1287 msgid "" "For information on using multiple handles and threads, see the section " -"L below." +"L above." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1314 +#: ../src/guestfs.pod:1290 msgid "guestfs_create" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1316 +#: ../src/guestfs.pod:1292 #, no-wrap msgid "" " guestfs_h *guestfs_create (void);\n" @@ -2520,43 +2479,44 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1318 +#: ../src/guestfs.pod:1294 msgid "Create a connection handle." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1320 +#: ../src/guestfs.pod:1296 msgid "" -"You have to call L (or one of the equivalent calls) " -"on the handle at least once." +"On success this returns a non-NULL pointer to a handle. On error it returns " +"NULL." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1323 +#: ../src/guestfs.pod:1299 msgid "" -"This function returns a non-NULL pointer to a handle on success or NULL on " -"error." +"You have to \"configure\" the handle after creating it. This includes " +"calling L (or one of the equivalent calls) on the " +"handle at least once." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1326 +#: ../src/guestfs.pod:1303 msgid "After configuring the handle, you have to call L." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1328 +#: ../src/guestfs.pod:1305 msgid "" -"You may also want to configure error handling for the handle. See L section below." +"You may also want to configure error handling for the handle. See the " +"L section below." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1331 +#: ../src/guestfs.pod:1308 msgid "guestfs_close" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1333 +#: ../src/guestfs.pod:1310 #, no-wrap msgid "" " void guestfs_close (guestfs_h *g);\n" @@ -2564,24 +2524,37 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1335 +#: ../src/guestfs.pod:1312 msgid "This closes the connection handle and frees up all resources used." msgstr "" +#. type: textblock +#: ../src/guestfs.pod:1314 +msgid "" +"If autosync was set on the handle and the handle was launched, then this " +"implicitly calls various functions to unmount filesystems and sync the " +"disk. See L for more details." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1318 +msgid "If a close callback was set on the handle, then it is called." +msgstr "" + #. type: =head1 -#: ../src/guestfs.pod:1337 +#: ../src/guestfs.pod:1320 msgid "ERROR HANDLING" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1339 +#: ../src/guestfs.pod:1322 msgid "" "API functions can return errors. For example, almost all functions that " "return C will return C<-1> to indicate an error." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1342 +#: ../src/guestfs.pod:1325 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 " @@ -2589,7 +2562,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1346 +#: ../src/guestfs.pod:1329 msgid "" "You can get at the additional information about the last error on the handle " "by calling L, L, and/or by setting " @@ -2597,7 +2570,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1351 +#: ../src/guestfs.pod:1334 msgid "" "When the handle is created, a default error handler is installed which " "prints the error message string to C. For small short-running " @@ -2605,7 +2578,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1355 +#: ../src/guestfs.pod:1338 #, no-wrap msgid "" " if (guestfs_launch (g) == -1)\n" @@ -2614,21 +2587,21 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1358 +#: ../src/guestfs.pod:1341 msgid "" "since the default error handler will ensure that an error message has been " "printed to C before the program exits." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1361 +#: ../src/guestfs.pod:1344 msgid "" "For other programs the caller will almost certainly want to install an " "alternate error handler or do error handling in-line like this:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1364 +#: ../src/guestfs.pod:1347 #, no-wrap msgid "" " g = guestfs_create ();\n" @@ -2636,7 +2609,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1366 +#: ../src/guestfs.pod:1349 #, no-wrap msgid "" " /* This disables the default behaviour of printing errors\n" @@ -2646,7 +2619,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1370 +#: ../src/guestfs.pod:1353 #, no-wrap msgid "" " if (guestfs_launch (g) == -1) {\n" @@ -2660,7 +2633,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1378 +#: ../src/guestfs.pod:1361 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 " @@ -2668,7 +2641,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1382 +#: ../src/guestfs.pod:1365 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 " @@ -2678,12 +2651,12 @@ msgid "" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1388 +#: ../src/guestfs.pod:1371 msgid "guestfs_last_error" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1390 +#: ../src/guestfs.pod:1373 #, no-wrap msgid "" " const char *guestfs_last_error (guestfs_h *g);\n" @@ -2691,26 +2664,26 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1392 +#: ../src/guestfs.pod:1375 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:1396 +#: ../src/guestfs.pod:1379 msgid "" "The lifetime of the returned string is until the next error occurs, or " "L is called." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1399 +#: ../src/guestfs.pod:1382 msgid "guestfs_last_errno" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1401 +#: ../src/guestfs.pod:1384 #, no-wrap msgid "" " int guestfs_last_errno (guestfs_h *g);\n" @@ -2718,27 +2691,27 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1403 +#: ../src/guestfs.pod:1386 msgid "This returns the last error number (errno) that happened on C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1405 +#: ../src/guestfs.pod:1388 msgid "If successful, an errno integer not equal to zero is returned." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1407 +#: ../src/guestfs.pod:1390 msgid "If no error, this returns 0. This call can return 0 in three situations:" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1414 +#: ../src/guestfs.pod:1397 msgid "There has not been any error on the handle." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1418 +#: ../src/guestfs.pod:1401 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 " @@ -2746,14 +2719,14 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1424 +#: ../src/guestfs.pod:1407 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:1430 +#: ../src/guestfs.pod:1413 msgid "" "Libguestfs tries to convert the errno from inside the applicance into a " "corresponding errno for the caller (not entirely trivial: the appliance " @@ -2764,12 +2737,12 @@ msgid "" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1438 +#: ../src/guestfs.pod:1421 msgid "guestfs_set_error_handler" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1440 +#: ../src/guestfs.pod:1423 #, no-wrap msgid "" " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" @@ -2782,7 +2755,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1447 +#: ../src/guestfs.pod:1430 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 " @@ -2790,14 +2763,14 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1451 +#: ../src/guestfs.pod:1434 msgid "" "C is not passed to the callback. To get that the callback must call " "L." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1454 +#: ../src/guestfs.pod:1437 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 " @@ -2805,22 +2778,22 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1458 +#: ../src/guestfs.pod:1441 msgid "The default handler prints messages on C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1460 +#: ../src/guestfs.pod:1443 msgid "If you set C to C then I handler is called." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1462 +#: ../src/guestfs.pod:1445 msgid "guestfs_get_error_handler" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1464 +#: ../src/guestfs.pod:1447 #, no-wrap msgid "" " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" @@ -2829,17 +2802,17 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1467 +#: ../src/guestfs.pod:1450 msgid "Returns the current error handler callback." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1469 +#: ../src/guestfs.pod:1452 msgid "guestfs_set_out_of_memory_handler" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1471 +#: ../src/guestfs.pod:1454 #, no-wrap msgid "" " typedef void (*guestfs_abort_cb) (void);\n" @@ -2849,29 +2822,29 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1475 +#: ../src/guestfs.pod:1458 msgid "" "The callback C will be called if there is an out of memory situation. " "I." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1478 +#: ../src/guestfs.pod:1461 msgid "The default is to call L." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1480 +#: ../src/guestfs.pod:1463 msgid "You cannot set C to C. You can't ignore out of memory situations." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1483 +#: ../src/guestfs.pod:1466 msgid "guestfs_get_out_of_memory_handler" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1485 +#: ../src/guestfs.pod:1468 #, no-wrap msgid "" " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" @@ -2879,42 +2852,42 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1487 +#: ../src/guestfs.pod:1470 msgid "This returns the current out of memory handler." msgstr "" #. type: =head1 -#: ../src/guestfs.pod:1489 +#: ../src/guestfs.pod:1472 msgid "API CALLS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1491 ../fish/guestfish.pod:989 +#: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1010 msgid "@ACTIONS@" msgstr "" #. type: =head1 -#: ../src/guestfs.pod:1493 +#: ../src/guestfs.pod:1476 msgid "STRUCTURES" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1495 +#: ../src/guestfs.pod:1478 msgid "@STRUCTS@" msgstr "" #. type: =head1 -#: ../src/guestfs.pod:1497 +#: ../src/guestfs.pod:1480 msgid "AVAILABILITY" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1499 +#: ../src/guestfs.pod:1482 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1501 +#: ../src/guestfs.pod:1484 msgid "" "Using L you can test availability of the following " "groups of functions. This test queries the appliance to see if the " @@ -2922,17 +2895,17 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1506 +#: ../src/guestfs.pod:1489 msgid "@AVAILABILITY@" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1508 +#: ../src/guestfs.pod:1491 msgid "GUESTFISH supported COMMAND" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1510 +#: ../src/guestfs.pod:1493 msgid "" "In L there is a handy interactive command C which " "prints out the available groups and whether they are supported by this build " @@ -2940,19 +2913,19 @@ msgid "" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1515 +#: ../src/guestfs.pod:1498 msgid "SINGLE CALLS AT COMPILE TIME" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1517 +#: ../src/guestfs.pod:1500 msgid "" "Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " "function, such as:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1520 +#: ../src/guestfs.pod:1503 #, no-wrap msgid "" " #define LIBGUESTFS_HAVE_DD 1\n" @@ -2960,12 +2933,12 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1522 +#: ../src/guestfs.pod:1505 msgid "if L is available." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1524 +#: ../src/guestfs.pod:1507 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 " @@ -2973,7 +2946,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1529 +#: ../src/guestfs.pod:1512 #, no-wrap msgid "" " AC_CHECK_LIB([guestfs],[guestfs_create])\n" @@ -2982,19 +2955,19 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1532 +#: ../src/guestfs.pod:1515 msgid "" "which would result in C being either defined or not defined " "in your program." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1535 +#: ../src/guestfs.pod:1518 msgid "SINGLE CALLS AT RUN TIME" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1537 +#: ../src/guestfs.pod:1520 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 " @@ -3004,7 +2977,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1544 +#: ../src/guestfs.pod:1527 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 " @@ -3012,7 +2985,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1548 +#: ../src/guestfs.pod:1531 #, no-wrap msgid "" " #include \n" @@ -3024,7 +2997,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1554 +#: ../src/guestfs.pod:1537 #, no-wrap msgid "" " main ()\n" @@ -3036,7 +3009,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1560 +#: ../src/guestfs.pod:1543 #, no-wrap msgid "" " /* Test if the function guestfs_dd is really available. */\n" @@ -3051,7 +3024,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1569 +#: ../src/guestfs.pod:1552 #, no-wrap msgid "" " if (!has_function)\n" @@ -3070,7 +3043,7 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1582 +#: ../src/guestfs.pod:1565 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 " @@ -3078,7 +3051,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1587 +#: ../src/guestfs.pod:1570 #, no-wrap msgid "" " Requires: libguestfs >= 1.0.80\n" @@ -3086,12 +3059,12 @@ msgid "" msgstr "" #. type: =head1 -#: ../src/guestfs.pod:1589 +#: ../src/guestfs.pod:1572 msgid "CALLS WITH OPTIONAL ARGUMENTS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1591 +#: ../src/guestfs.pod:1574 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 " @@ -3099,7 +3072,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1596 +#: ../src/guestfs.pod:1579 #, no-wrap msgid "" " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" @@ -3107,14 +3080,14 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1598 +#: ../src/guestfs.pod:1581 msgid "" "Call this with a list of optional arguments, terminated by C<-1>. So to " "call with no optional arguments specified:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1601 +#: ../src/guestfs.pod:1584 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename, -1);\n" @@ -3122,12 +3095,12 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1603 +#: ../src/guestfs.pod:1586 msgid "With a single optional argument:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1605 +#: ../src/guestfs.pod:1588 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -3137,12 +3110,12 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1609 +#: ../src/guestfs.pod:1592 msgid "With two:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1611 +#: ../src/guestfs.pod:1594 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -3153,19 +3126,19 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1616 +#: ../src/guestfs.pod:1599 msgid "" "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " "happen!" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1619 +#: ../src/guestfs.pod:1602 msgid "USING va_list FOR OPTIONAL ARGUMENTS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1621 +#: ../src/guestfs.pod:1604 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 " @@ -3173,7 +3146,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1625 +#: ../src/guestfs.pod:1608 #, no-wrap msgid "" " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" @@ -3182,12 +3155,12 @@ msgid "" msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1628 +#: ../src/guestfs.pod:1611 msgid "CONSTRUCTING OPTIONAL ARGUMENTS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1630 +#: ../src/guestfs.pod:1613 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 " @@ -3197,7 +3170,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1636 +#: ../src/guestfs.pod:1619 #, no-wrap msgid "" " struct guestfs_add_drive_opts_argv {\n" @@ -3212,12 +3185,12 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1645 +#: ../src/guestfs.pod:1628 msgid "You could call it like this:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1647 +#: ../src/guestfs.pod:1630 #, no-wrap msgid "" " struct guestfs_add_drive_opts_argv optargs = {\n" @@ -3230,7 +3203,7 @@ msgid "" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1654 +#: ../src/guestfs.pod:1637 #, no-wrap msgid "" " guestfs_add_drive_opts_argv (g, filename, &optargs);\n" @@ -3238,34 +3211,34 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1656 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532 +#: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:2779 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1262 ../fish/guestfish-actions.pod:1898 ../tools/virt-win-reg.pl:704 msgid "Notes:" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1662 +#: ../src/guestfs.pod:1645 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1667 +#: ../src/guestfs.pod:1650 msgid "You do not need to fill in all fields of the structure." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1671 +#: ../src/guestfs.pod:1654 msgid "" "There must be a one-to-one correspondence between fields of the structure " "that are filled in, and bits set in the bitmask." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1676 +#: ../src/guestfs.pod:1659 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1678 +#: ../src/guestfs.pod:1661 msgid "" "In other languages, optional arguments are expressed in the way that is " "natural for that language. We refer you to the language-specific " @@ -3273,176 +3246,128 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1682 +#: ../src/guestfs.pod:1665 msgid "For guestfish, see L." msgstr "" #. type: =head2 -#: ../src/guestfs.pod:1684 +#: ../src/guestfs.pod:1667 msgid "SETTING CALLBACKS TO HANDLE EVENTS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1686 +#: ../src/guestfs.pod:1669 msgid "" -"The child process generates events in some situations. Current events " -"include: receiving a log message, the child process exits." +"B This section documents the generic event mechanism introduced in " +"libguestfs 1.10, which you should use in new code if possible. The old " +"functions C, " +"C, " +"C, C and " +"C are no longer documented in this manual " +"page. Because of the ABI guarantee, the old functions continue to work." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1689 +#: ../src/guestfs.pod:1678 msgid "" -"Use the C functions to set a callback for different " -"types of events." +"Handles generate events when certain things happen, such as log messages " +"being generated, progress messages during long-running operations, or the " +"handle being closed. The API calls described below let you register a " +"callback to be called when events happen. You can register multiple " +"callbacks (for the same, different or overlapping sets of events), and " +"individually remove callbacks. If callbacks are not removed, then they " +"remain in force until the handle is closed." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1692 +#: ../src/guestfs.pod:1686 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." +"In the current implementation, events are only generated synchronously: that " +"means that events (and hence callbacks) can only happen while you are in the " +"middle of making another libguestfs call. The callback is called in the " +"same thread." msgstr "" -#. type: =head2 -#: ../src/guestfs.pod:1697 -msgid "guestfs_set_log_message_callback" +#. type: textblock +#: ../src/guestfs.pod:1691 +msgid "" +"Events may contain a payload, usually nothing (void), an array of 64 bit " +"unsigned integers, or a message buffer. Payloads are discussed later on." msgstr "" -#. type: verbatim +#. type: =head3 +#: ../src/guestfs.pod:1695 +msgid "CLASSES OF EVENTS" +msgstr "" + +#. type: =item #: ../src/guestfs.pod:1699 -#, 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" +msgid "GUESTFS_EVENT_CLOSE (payload type: void)" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1705 +#: ../src/guestfs.pod:1702 msgid "" -"The callback function C will be called whenever qemu or the guest writes " -"anything to the console." +"The callback function will be called while the handle is being closed " +"(synchronously from L)." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1708 -msgid "Use this function to capture kernel messages and similar." +#: ../src/guestfs.pod:1705 +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: textblock -#: ../src/guestfs.pod:1710 +#: ../src/guestfs.pod:1712 msgid "" -"Normally there is no log message handler, and log messages are just " -"discarded." +"If no callback is registered: the handle is closed without any callback " +"being invoked." msgstr "" -#. type: =head2 -#: ../src/guestfs.pod:1713 -msgid "guestfs_set_subprocess_quit_callback" -msgstr "" - -#. type: verbatim +#. type: =item #: ../src/guestfs.pod:1715 -#, 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" +msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1720 +#: ../src/guestfs.pod:1718 msgid "" -"The callback function C will be called when the child process quits, " -"either asynchronously or if killed by L. (This " +"The callback function 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 -#: ../src/guestfs.pod:1725 -msgid "guestfs_set_launch_done_callback" -msgstr "" - -#. type: verbatim -#: ../src/guestfs.pod:1727 -#, 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 -#: ../src/guestfs.pod:1732 -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 -#: ../src/guestfs.pod:1736 -msgid "guestfs_set_close_callback" -msgstr "" - -#. type: verbatim -#: ../src/guestfs.pod:1738 -#, 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" +#: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731 +msgid "If no callback is registered: the event is ignored." msgstr "" -#. type: textblock -#: ../src/guestfs.pod:1743 -msgid "" -"The callback function C will be called while the handle is being closed " -"(synchronously from L)." +#. type: =item +#: ../src/guestfs.pod:1724 +msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1746 +#: ../src/guestfs.pod:1727 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)." +"The callback function will be called when the child process becomes ready " +"first time after it has been launched. (This corresponds to a transition " +"from LAUNCHING to the READY state)." msgstr "" -#. type: =head2 -#: ../src/guestfs.pod:1754 -msgid "guestfs_set_progress_callback" -msgstr "" - -#. type: verbatim -#: ../src/guestfs.pod:1756 -#, 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" +#. type: =item +#: ../src/guestfs.pod:1733 +msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1763 +#: ../src/guestfs.pod:1736 msgid "" "Some long-running operations can generate progress messages. If this " "callback is registered, then it will be called each time a progress message " @@ -3452,40 +3377,48 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1769 +#: ../src/guestfs.pod:1742 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." +"The callback receives in the payload four unsigned 64 bit numbers which are " +"(in order): C, C, C, C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1775 +#: ../src/guestfs.pod:1745 +msgid "" +"The units of C are not defined, although for some operations C " +"may relate in some way to the amount of data to be transferred (eg. in bytes " +"or megabytes), and C may be the portion which has been " +"transferred." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1750 msgid "The only defined and stable parts of the API are:" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1781 +#: ../src/guestfs.pod:1756 msgid "" "The callback can display to the user some type of progress bar or indicator " "which shows the ratio of C:C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1786 +#: ../src/guestfs.pod:1761 msgid "0 E= C E= C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1790 +#: ../src/guestfs.pod:1765 msgid "" "If any progress notification is sent during a call, then a final progress " -"notification is always sent when C = C." +"notification is always sent when C = C (I the call " +"fails with an error)." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1793 +#: ../src/guestfs.pod:1769 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 " @@ -3493,25884 +3426,26118 @@ msgid "" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1799 +#: ../src/guestfs.pod:1775 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." +"For some calls we are unable to estimate the progress of the call, but we " +"can still generate progress messages to indicate activity. This is known as " +"\"pulse mode\", and is directly supported by certain progress bar " +"implementations (eg. GtkProgressBar)." msgstr "" -#. type: =head1 -#: ../src/guestfs.pod:1804 -msgid "PRIVATE DATA AREA" +#. type: textblock +#: ../src/guestfs.pod:1780 +msgid "" +"For these calls, zero or more progress messages are generated with " +"C and C, followed by a final message with " +"C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1806 +#: ../src/guestfs.pod:1784 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." +"As noted above, if the call fails with an error then the final message may " +"not be generated." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1810 -msgid "To attach a named piece of data, use the following call:" +#: ../src/guestfs.pod:1789 +msgid "" +"The callback also receives the procedure number (C) and serial " +"number (C) 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: verbatim -#: ../src/guestfs.pod:1812 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1795 +msgid "If no callback is registered: progress messages are discarded." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:1797 +msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:1800 msgid "" -" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" -"\n" +"The callback function is called whenever a log message is generated by qemu, " +"the appliance kernel, guestfsd (daemon), or utility programs." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1814 +#: ../src/guestfs.pod:1803 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." +"If the verbose flag (L) is set before launch " +"(L) then additional debug messages are generated." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1818 +#: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820 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." +"If no callback is registered: the messages are discarded unless the verbose " +"flag is set in which case they are sent to stderr. You can override the " +"printing of verbose messages to stderr by setting up a callback." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:1811 +msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1823 -msgid "To retrieve the pointer, use:" +#: ../src/guestfs.pod:1814 +msgid "" +"The callback function is called whenever a log message is generated by the " +"library part of libguestfs." msgstr "" -#. type: verbatim -#: ../src/guestfs.pod:1825 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1817 msgid "" -" void *guestfs_get_private (guestfs_h *g, const char *key);\n" -"\n" +"If the verbose flag (L) is set then additional debug " +"messages are generated." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:1825 +msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1827 +#: ../src/guestfs.pod:1828 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." +"The callback function is called whenever a trace message is generated. This " +"only applies if the trace flag (L) is set." msgstr "" #. type: textblock #: ../src/guestfs.pod:1831 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)." +"If no callback is registered: the messages are sent to stderr. You can " +"override the printing of trace messages to stderr by setting up a callback." msgstr "" -#. type: textblock +#. type: =head3 +#: ../src/guestfs.pod:1837 +msgid "guestfs_set_event_callback" +msgstr "" + +#. type: verbatim #: ../src/guestfs.pod:1839 +#, no-wrap msgid "" -"The private data area is implemented using a hash table, and should be " -"reasonably efficient for moderate numbers of keys." +" int guestfs_set_event_callback (guestfs_h *g,\n" +" guestfs_event_callback cb,\n" +" uint64_t event_bitmask,\n" +" int flags,\n" +" void *opaque);\n" +"\n" msgstr "" -#. type: =end -#: ../src/guestfs.pod:1842 ../src/guestfs.pod:1847 -msgid "html" +#. type: textblock +#: ../src/guestfs.pod:1845 +msgid "" +"This function registers a callback (C) for all event classes in the " +"C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1844 +#: ../src/guestfs.pod:1848 msgid "" -" " +"For example, to register for all log message events, you could call this " +"function with the bitmask C. " +"To register a single callback for all possible classes of events, use " +"C." msgstr "" -#. type: =head1 -#: ../src/guestfs.pod:1849 -msgid "ARCHITECTURE" +#. type: textblock +#: ../src/guestfs.pod:1854 +msgid "C should always be passed as 0." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1851 +#: ../src/guestfs.pod:1856 msgid "" -"Internally, libguestfs is implemented by running an appliance (a special " -"type of small virtual machine) using L. Qemu runs as a child " -"process of the main program." +"C is an opaque pointer which is passed to the callback. You can use " +"it for any purpose." msgstr "" -#. type: verbatim -#: ../src/guestfs.pod:1855 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:1859 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" +"The return value is the event handle (an integer) which you can use to " +"delete the callback (see below)." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1875 +#: ../src/guestfs.pod:1862 msgid "" -"The library, linked to the main program, creates the child process and hence " -"the appliance in the L function." +"If there is an error, this function returns C<-1>, and sets the error in the " +"handle in the usual way (see L etc.)" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1878 +#: ../src/guestfs.pod:1865 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." +"Callbacks remain in effect until they are deleted, or until the handle is " +"closed." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1887 +#: ../src/guestfs.pod:1868 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 -#: ../src/guestfs.pod:1894 -msgid "STATE MACHINE" +"In the case where multiple callbacks are registered for a particular event " +"class, all of the callbacks are called. The order in which multiple " +"callbacks are called is not defined." msgstr "" -#. type: textblock -#: ../src/guestfs.pod:1896 -msgid "libguestfs uses a state machine to model the child process:" +#. type: =head3 +#: ../src/guestfs.pod:1872 +msgid "guestfs_delete_event_callback" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1898 +#: ../src/guestfs.pod:1874 #, no-wrap msgid "" -" |\n" -" guestfs_create\n" -" |\n" -" |\n" -" ____V_____\n" -" / \\\n" -" | CONFIG |\n" -" \\__________/\n" -" ^ ^ ^ \\\n" -" / | \\ \\ guestfs_launch\n" -" / | _\\__V______\n" -" / | / \\\n" -" / | | LAUNCHING |\n" -" / | \\___________/\n" -" / | /\n" -" / | guestfs_launch\n" -" / | /\n" -" ______ / __|____V\n" -" / \\ ------> / \\\n" -" | BUSY | | READY |\n" -" \\______/ <------ \\________/\n" +" void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1920 +#: ../src/guestfs.pod:1876 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." +"Delete a callback that was previously registered. C should be " +"the integer that was returned by a previous call to " +"C on the same handle." msgstr "" -#. type: textblock -#: ../src/guestfs.pod:1925 +#. type: =head3 +#: ../src/guestfs.pod:1880 +msgid "guestfs_event_callback" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:1882 +#, 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_event_callback) (\n" +" guestfs_h *g,\n" +" void *opaque,\n" +" uint64_t event,\n" +" int event_handle,\n" +" int flags,\n" +" const char *buf, size_t buf_len,\n" +" const uint64_t *array, size_t array_len);\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1929 -msgid "" -"Configuration commands for qemu such as L can only be " -"issued when in the CONFIG state." +#: ../src/guestfs.pod:1891 +msgid "This is the type of the event callback function that you have to provide." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1932 +#: ../src/guestfs.pod:1894 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." +"The basic parameters are: the handle (C), the opaque user pointer " +"(C), the event class (eg. C), the event " +"handle, and C which in the current API you should ignore." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1938 +#: ../src/guestfs.pod:1898 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." +"The remaining parameters contain the event payload (if any). Each event may " +"contain a payload, which usually relates to the event class, but for future " +"proofing your code should be written to handle any payload for any event " +"class." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1944 +#: ../src/guestfs.pod:1903 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." +"C and C contain a message buffer (if C, then " +"there is no message buffer). Note that this message buffer can contain " +"arbitrary 8 bit data, including NUL bytes." msgstr "" -#. type: =head1 -#: ../src/guestfs.pod:1948 -msgid "INTERNALS" +#. type: textblock +#: ../src/guestfs.pod:1907 +msgid "" +"C and C is an array of 64 bit unsigned integers. At the " +"moment this is only used for progress messages." msgstr "" -#. type: =head2 -#: ../src/guestfs.pod:1950 -msgid "COMMUNICATION PROTOCOL" +#. type: =head3 +#: ../src/guestfs.pod:1910 +msgid "EXAMPLE: CAPTURING LOG MESSAGES" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1952 +#: ../src/guestfs.pod:1912 msgid "" -"Don't rely on using this protocol directly. This section documents how it " -"currently works, but it may change at any time." +"One motivation for the generic event API was to allow GUI programs to " +"capture debug and other messages. In libguestfs E 1.8 these were sent " +"unconditionally to C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1955 +#: ../src/guestfs.pod:1916 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)." +"Events associated with log messages are: C, " +"C and C. (Note that error " +"messages are not events; you must capture error messages separately)." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1959 +#: ../src/guestfs.pod:1921 msgid "" -"The detailed format of structures is in C (note: " -"this file is automatically generated)." +"Programs have to set up a callback to capture the classes of events of " +"interest:" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:1962 +#. type: verbatim +#: ../src/guestfs.pod:1924 +#, 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." -msgstr "" - -#. type: =head3 -#: ../src/guestfs.pod:1969 -msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" +" int eh =\n" +" guestfs_set_event_callback\n" +" (g, message_callback,\n" +" GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n" +" GUESTFS_EVENT_TRACE,\n" +" 0, NULL) == -1)\n" +" if (eh == -1) {\n" +" // handle error in the usual way\n" +" }\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1971 -msgid "For ordinary functions, the request message is:" +#: ../src/guestfs.pod:1934 +msgid "" +"The callback can then direct messages to the appropriate place. In this " +"example, messages are directed to syslog:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1973 +#: ../src/guestfs.pod:1937 #, 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" +" static void\n" +" message_callback (\n" +" guestfs_h *g,\n" +" void *opaque,\n" +" uint64_t event,\n" +" int event_handle,\n" +" int flags,\n" +" const char *buf, size_t buf_len,\n" +" const uint64_t *array, size_t array_len)\n" +" {\n" +" const int priority = LOG_USER|LOG_INFO;\n" +" if (buf_len > 0)\n" +" syslog (priority, \"event 0x%lx: %s\", event, buf);\n" +" }\n" "\n" msgstr "" +#. type: =head1 +#: ../src/guestfs.pod:1952 +msgid "PRIVATE DATA AREA" +msgstr "" + #. type: textblock -#: ../src/guestfs.pod:1978 +#: ../src/guestfs.pod:1954 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." +"You can attach named pieces of private data to the libguestfs handle, fetch " +"them by name, and walk over them, for the lifetime of the handle. This is " +"called the private data area and is only available from the C API." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1984 +#: ../src/guestfs.pod:1959 +msgid "To attach a named piece of data, use the following call:" +msgstr "" + +#. type: verbatim +#: ../src/guestfs.pod:1961 +#, no-wrap msgid "" -"Note also that many functions don't take any arguments, in which case the " -"C_args> is completely omitted." +" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1987 +#: ../src/guestfs.pod:1963 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." +"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 key is " +"overwritten." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1991 +#: ../src/guestfs.pod:1967 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." +"You can use any C you want, but your key should I start with an " +"underscore character. Keys beginning with an underscore character are " +"reserved for internal libguestfs purposes (eg. for implementing language " +"bindings). It is recommended that you prefix the key with some unique " +"string to avoid collisions with other users." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1999 -msgid "The reply message for ordinary functions is:" +#: ../src/guestfs.pod:1973 +msgid "To retrieve the pointer, use:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:2001 +#: ../src/guestfs.pod:1975 #, 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" +" void *guestfs_get_private (guestfs_h *g, const char *key);\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2006 +#: ../src/guestfs.pod:1977 msgid "" -"As above the C_ret> structure may be completely omitted for " -"functions that return no formal return values." +"This function returns C if either no data is found associated with " +"C, or if the user previously set the C's C pointer to " +"C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2009 -msgid "As above the total length of the reply is limited to C." +#: ../src/guestfs.pod:1981 +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)." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2012 -msgid "" -"In the case of an error, a flag is set in the header, and the reply message " -"is slightly changed:" +#: ../src/guestfs.pod:1988 +msgid "To walk over all entries, use these two functions:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:2015 +#: ../src/guestfs.pod:1990 #, 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" +" void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n" "\n" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2020 +#. type: verbatim +#: ../src/guestfs.pod:1992 +#, no-wrap msgid "" -"The C structure contains the error message as a " -"string." +" void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n" +"\n" msgstr "" -#. type: =head3 -#: ../src/guestfs.pod:2023 -msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" +#. type: textblock +#: ../src/guestfs.pod:1994 +msgid "" +"C returns the first key, pointer pair (\"first\" does " +"not have any particular meaning -- keys are not returned in any defined " +"order). A pointer to the key is returned in C<*key_rtn> and the " +"corresponding data pointer is returned from the function. C is " +"returned if there are no keys stored in the handle." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2025 +#: ../src/guestfs.pod:2000 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." +"C returns the next key, pointer pair. The return " +"value of this function is also C is there are no further entries to " +"return." msgstr "" -#. type: verbatim -#: ../src/guestfs.pod:2029 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2004 +msgid "Notes about walking over entries:" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2010 +msgid "You must not call C while walking over the entries." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2015 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" +"The handle maintains an internal iterator which is reset when you call " +"C. This internal iterator is invalidated when you " +"call C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2037 -msgid "The \"sequence of chunks\" is:" +#: ../src/guestfs.pod:2021 +msgid "If you have set the data pointer associated with a key to C, ie:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:2039 +#: ../src/guestfs.pod:2023 #, 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" +" guestfs_set_private (g, key, NULL);\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2047 -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." +#: ../src/guestfs.pod:2025 +msgid "then that C is not returned when walking." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2051 +#: ../src/guestfs.pod:2029 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)." +"C<*key_rtn> is only valid until the next call to C, " +"C or C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2056 +#: ../src/guestfs.pod:2035 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." +"The following example code shows how to print all keys and data pointers " +"that are associated with the handle C:" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2062 +#. type: verbatim +#: ../src/guestfs.pod:2038 +#, no-wrap 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." +" const char *key;\n" +" void *data = guestfs_first_private (g, &key);\n" +" while (data != NULL)\n" +" {\n" +" printf (\"key = %s, data = %p\\n\", key, data);\n" +" data = guestfs_next_private (g, &key);\n" +" }\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2071 +#: ../src/guestfs.pod:2046 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." +"More commonly you are only interested in keys that begin with an " +"application-specific prefix C. Modify the loop like so:" msgstr "" -#. type: =head3 -#: ../src/guestfs.pod:2077 -msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" +#. type: verbatim +#: ../src/guestfs.pod:2049 +#, no-wrap +msgid "" +" const char *key;\n" +" void *data = guestfs_first_private (g, &key);\n" +" while (data != NULL)\n" +" {\n" +" if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n" +" printf (\"key = %s, data = %p\\n\", key, data);\n" +" data = guestfs_next_private (g, &key);\n" +" }\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2079 +#: ../src/guestfs.pod:2058 msgid "" -"The protocol for FileOut parameters is exactly the same as for FileIn " -"parameters, but with the roles of daemon and library reversed." +"If you need to modify keys while walking, then you have to jump back to the " +"beginning of the loop. For example, to delete all keys prefixed with " +"C:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:2082 +#: ../src/guestfs.pod:2062 #, 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" +" const char *key;\n" +" void *data;\n" +" again:\n" +" data = guestfs_first_private (g, &key);\n" +" while (data != NULL)\n" +" {\n" +" if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n" +" {\n" +" guestfs_set_private (g, key, NULL);\n" +" /* note that 'key' pointer is now invalid, and so is\n" +" the internal iterator */\n" +" goto again;\n" +" }\n" +" data = guestfs_next_private (g, &key);\n" +" }\n" "\n" msgstr "" -#. type: =head3 +#. type: textblock +#: ../src/guestfs.pod:2078 +msgid "" +"Note that the above loop is guaranteed to terminate because the keys are " +"being deleted, but other manipulations of keys within the loop might not " +"terminate unless you also maintain an indication of which keys have been " +"visited." +msgstr "" + +#. type: =end +#: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088 +msgid "html" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2085 +msgid "" +" " +msgstr "" + +#. type: =head1 #: ../src/guestfs.pod:2090 -msgid "INITIAL MESSAGE" +msgid "ARCHITECTURE" msgstr "" #. type: textblock #: ../src/guestfs.pod:2092 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." +"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: =head3 +#. type: verbatim #: ../src/guestfs.pod:2096 -msgid "PROGRESS NOTIFICATION MESSAGES" +#, no-wrap +msgid "" +" ___________________\n" +" / \\\n" +" | main program |\n" +" | |\n" +" | | child process / appliance\n" +" | | __________________________\n" +" | | / qemu \\\n" +" +-------------------+ RPC | +-----------------+ |\n" +" | libguestfs <--------------------> guestfsd | |\n" +" | | | +-----------------+ |\n" +" \\___________________/ | | Linux kernel | |\n" +" | +--^--------------+ |\n" +" \\_________|________________/\n" +" |\n" +" _______v______\n" +" / \\\n" +" | Device or |\n" +" | disk image |\n" +" \\______________/\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2098 +#: ../src/guestfs.pod:2116 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." +"The library, linked to the main program, creates the child process and hence " +"the appliance in the L function." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2102 +#: ../src/guestfs.pod:2119 msgid "" -"The library turns them into progress callbacks (see " -"C) if there is a callback registered, or " -"discards them if not." +"Inside the appliance is a Linux kernel and a complete stack of userspace " +"tools (such as LVM and ext2 programs) and a small controlling daemon called " +"L. The library talks to L using remote procedure " +"calls (RPC). There is a mostly one-to-one correspondence between libguestfs " +"API calls and RPC calls to the daemon. Lastly the disk image(s) are " +"attached to the qemu process which translates device access by the " +"appliance's Linux kernel into accesses to the image." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2106 +#: ../src/guestfs.pod:2128 msgid "" -"The daemon self-limits the frequency of progress messages it sends (see " -"C). Not all calls generate progress " -"messages." +"A common misunderstanding is that the appliance \"is\" the virtual machine. " +"Although the disk image you are attached to might also be used by some " +"virtual machine, libguestfs doesn't know or care about this. (But you will " +"care if both libguestfs's qemu process and your virtual machine are trying " +"to update the disk image at the same time, since these usually results in " +"massive disk corruption)." msgstr "" #. type: =head1 -#: ../src/guestfs.pod:2110 -msgid "LIBGUESTFS VERSION NUMBERS" +#: ../src/guestfs.pod:2135 +msgid "STATE MACHINE" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2112 -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:" +#: ../src/guestfs.pod:2137 +msgid "libguestfs uses a state machine to model the child process:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:2117 +#: ../src/guestfs.pod:2139 #, 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" +" guestfs_create\n" +" |\n" +" |\n" +" ____V_____\n" +" / \\\n" +" | CONFIG |\n" +" \\__________/\n" +" ^ ^ ^ \\\n" +" / | \\ \\ guestfs_launch\n" +" / | _\\__V______\n" +" / | / \\\n" +" / | | LAUNCHING |\n" +" / | \\___________/\n" +" / | /\n" +" / | guestfs_launch\n" +" / | /\n" +" ______ / __|____V\n" +" / \\ ------> / \\\n" +" | BUSY | | READY |\n" +" \\______/ <------ \\________/\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2128 -msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." +#: ../src/guestfs.pod:2161 +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 -#: ../src/guestfs.pod:2130 +#: ../src/guestfs.pod:2166 msgid "" -"As time passes we cherry pick fixes from the development branch and backport " -"those into the stable branch, the effect being that the stable branch should " -"get more stable and less buggy over time. So the stable releases are ideal " -"for people who don't need new features but would just like the software to " -"work." +"The guest may be killed by L, or may die " +"asynchronously at any time (eg. due to some internal error), and that causes " +"the state to transition back to CONFIG." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2136 -msgid "Our criteria for backporting changes are:" +#: ../src/guestfs.pod:2170 +msgid "" +"Configuration commands for qemu such as L can only be " +"issued when in the CONFIG state." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2142 +#: ../src/guestfs.pod:2173 msgid "" -"Documentation changes which don't affect any code are backported unless the " -"documentation refers to a future feature which is not in stable." +"The API offers one call that goes from CONFIG through LAUNCHING to READY. " +"L blocks until the child process is READY to accept " +"commands (or until some failure or timeout). L internally " +"moves the state from CONFIG to LAUNCHING while it is running." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2148 +#: ../src/guestfs.pod:2179 msgid "" -"Bug fixes which are not controversial, fix obvious problems, and have been " -"well tested are backported." +"API actions such as L can only be issued when in the READY " +"state. These API calls block waiting for the command to be carried out " +"(ie. the state to transition to BUSY and then back to READY). There are no " +"non-blocking versions, and no way to issue more than one command per handle " +"at the same time." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2153 +#: ../src/guestfs.pod:2185 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." +"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: textblock -#: ../src/guestfs.pod:2159 -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." +#. type: =head1 +#: ../src/guestfs.pod:2189 +msgid "INTERNALS" +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:2191 +msgid "COMMUNICATION PROTOCOL" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2165 +#: ../src/guestfs.pod:2193 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:2173 -msgid "EXTENDING LIBGUESTFS" -msgstr "" - -#. type: =head2 -#: ../src/guestfs.pod:2175 -msgid "ADDING A NEW API ACTION" -msgstr "" - -#. type: textblock -#: ../src/guestfs.pod:2177 -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:2181 -msgid "To add a new API action there are two changes:" +"Don't rely on using this protocol directly. This section documents how it " +"currently works, but it may change at any time." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2187 +#: ../src/guestfs.pod:2196 msgid "" -"You need to add a description of the call (name, parameters, return type, " -"tests, documentation) to C." +"The protocol used to talk between the library and the daemon running inside " +"the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC " +"1014, RFC 1832, RFC 4506)." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2190 +#: ../src/guestfs.pod:2200 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." +"The detailed format of structures is in C (note: " +"this file is automatically generated)." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2198 +#: ../src/guestfs.pod:2203 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." +"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: textblock -#: ../src/guestfs.pod:2204 -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>." +#. type: =head3 +#: ../src/guestfs.pod:2210 +msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" msgstr "" #. type: textblock #: ../src/guestfs.pod:2212 -msgid "Implement the action (in C):" +msgid "For ordinary functions, the request message is:" msgstr "" -#. type: textblock +#. type: verbatim #: ../src/guestfs.pod:2214 +#, no-wrap msgid "" -"For daemon actions, implement the function CnameE> in the " -"C directory." +" total length (header + arguments,\n" +" but not including the length word itself)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs__args (encoded as XDR)\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2217 +#: ../src/guestfs.pod:2219 msgid "" -"For library actions, implement the function CnameE> " -"(note: double underscore) in the C directory." -msgstr "" - -#. type: textblock -#: ../src/guestfs.pod:2220 -msgid "In either case, use another function as an example of what to do." -msgstr "" - -#. type: textblock -#: ../src/guestfs.pod:2224 -msgid "After making these changes, use C to compile." +"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:2226 +#: ../src/guestfs.pod:2225 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:2230 -msgid "ADDING TESTS FOR AN API ACTION" +"Note also that many functions don't take any arguments, in which case the " +"C_args> is completely omitted." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2232 +#: ../src/guestfs.pod:2228 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." +"The header contains the procedure number (C) which is how the " +"receiver knows what type of args structure to expect, or none at all." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2238 +#: ../src/guestfs.pod:2232 msgid "" -"The following describes the test environment used when you add an API test " -"in C." +"For functions that take optional arguments, the optional arguments are " +"encoded in the C_args> structure in the same way as ordinary " +"arguments. A bitmask in the header indicates which optional arguments are " +"meaningful. The bitmask is also checked to see if it contains bits set " +"which the daemon does not know about (eg. if more optional arguments were " +"added in a later version of the library), and this causes the call to be " +"rejected." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2241 -msgid "The test environment has 4 block devices:" +#: ../src/guestfs.pod:2240 +msgid "The reply message for ordinary functions is:" msgstr "" -#. type: =item -#: ../src/guestfs.pod:2245 -msgid "C 500MB" +#. type: verbatim +#: ../src/guestfs.pod:2242 +#, 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 #: ../src/guestfs.pod:2247 -msgid "General block device for testing." -msgstr "" - -#. type: =item -#: ../src/guestfs.pod:2249 -msgid "C 50MB" -msgstr "" - -#. type: textblock -#: ../src/guestfs.pod:2251 msgid "" -"C is an ext2 filesystem used for testing filesystem write " -"operations." -msgstr "" - -#. type: =item -#: ../src/guestfs.pod:2254 -msgid "C 10MB" +"As above the C_ret> structure may be completely omitted for " +"functions that return no formal return values." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2256 -msgid "Used in a few tests where two block devices are needed." -msgstr "" - -#. type: =item -#: ../src/guestfs.pod:2258 -msgid "C" +#: ../src/guestfs.pod:2250 +msgid "As above the total length of the reply is limited to C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2260 -msgid "ISO with fixed content (see C)." +#: ../src/guestfs.pod:2253 +msgid "" +"In the case of an error, a flag is set in the header, and the reply message " +"is slightly changed:" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2264 +#. type: verbatim +#: ../src/guestfs.pod:2256 +#, no-wrap 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" +" total length (header + error,\n" +" but not including the length word itself)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs_message_error (encoded as XDR)\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2268 +#: ../src/guestfs.pod:2261 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." +"The C structure contains the error message as a " +"string." msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2274 -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." +#. type: =head3 +#: ../src/guestfs.pod:2264 +msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2280 +#: ../src/guestfs.pod:2266 msgid "" -"In addition, packagers can skip individual tests by setting environment " -"variables before running C." +"A C parameter indicates that we transfer a file I the guest. " +"The normal request message is sent (see above). However this is followed by " +"a sequence of file chunks." msgstr "" #. type: verbatim -#: ../src/guestfs.pod:2283 +#: ../src/guestfs.pod:2270 #, no-wrap msgid "" -" SKIP_TEST__=1\n" +" total length (header + arguments,\n" +" but not including the length word itself,\n" +" and not including the chunks)\n" +" struct guestfs_message_header (encoded as XDR)\n" +" struct guestfs__args (encoded as XDR)\n" +" sequence of chunks for FileIn param #0\n" +" sequence of chunks for FileIn param #1 etc.\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2285 -msgid "eg: C skips test #3 of L." -msgstr "" - -#. type: textblock -#: ../src/guestfs.pod:2287 -msgid "or:" +#: ../src/guestfs.pod:2278 +msgid "The \"sequence of chunks\" is:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:2289 +#: ../src/guestfs.pod:2280 #, no-wrap msgid "" -" SKIP_TEST_=1\n" +" length of chunk (not including length word itself)\n" +" struct guestfs_chunk (encoded as XDR)\n" +" length of chunk\n" +" struct guestfs_chunk (encoded as XDR)\n" +" ...\n" +" length of chunk\n" +" struct guestfs_chunk (with data.data_len == 0)\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2291 -msgid "eg: C skips all L tests." +#: ../src/guestfs.pod:2288 +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 -#: ../src/guestfs.pod:2293 -msgid "Packagers can run only certain tests by setting for example:" -msgstr "" - -#. type: verbatim -#: ../src/guestfs.pod:2295 -#, no-wrap +#: ../src/guestfs.pod:2292 msgid "" -" TEST_ONLY=\"vfs_type zerofree\"\n" -"\n" +"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 #: ../src/guestfs.pod:2297 msgid "" -"See C for more details of how these environment variables " -"work." -msgstr "" - -#. type: =head2 -#: ../src/guestfs.pod:2300 -msgid "DEBUGGING NEW API ACTIONS" +"Both the library (sender) I the daemon (receiver) may cancel the " +"transfer. The library does this by sending a chunk with a special flag set " +"to indicate cancellation. When the daemon sees this, it cancels the whole " +"RPC, does I send any reply, and goes back to reading the next request." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2302 -msgid "Test new actions work before submitting them." +#: ../src/guestfs.pod:2303 +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 -#: ../src/guestfs.pod:2304 -msgid "You can use guestfish to try out new commands." +#: ../src/guestfs.pod:2312 +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: textblock -#: ../src/guestfs.pod:2306 -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:2310 -msgid "FORMATTING CODE AND OTHER CONVENTIONS" -msgstr "" - -#. type: textblock -#: ../src/guestfs.pod:2312 -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." +#. type: =head3 +#: ../src/guestfs.pod:2318 +msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2318 +#: ../src/guestfs.pod:2320 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:" +"The protocol for FileOut parameters is exactly the same as for FileIn " +"parameters, but with the roles of daemon and library reversed." msgstr "" #. type: verbatim -#: ../src/guestfs.pod:2321 +#: ../src/guestfs.pod:2323 #, 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" +" 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: verbatim +#. type: =head3 #: ../src/guestfs.pod:2331 -#, 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" +msgid "INITIAL MESSAGE" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2343 -msgid "Enable warnings when compiling (and fix any problems this finds):" -msgstr "" - -#. type: verbatim -#: ../src/guestfs.pod:2346 -#, no-wrap +#: ../src/guestfs.pod:2333 msgid "" -" ./configure --enable-gcc-warnings\n" -"\n" +"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: textblock -#: ../src/guestfs.pod:2348 -msgid "Useful targets are:" +#. type: =head3 +#: ../src/guestfs.pod:2337 +msgid "PROGRESS NOTIFICATION MESSAGES" msgstr "" -#. type: verbatim -#: ../src/guestfs.pod:2350 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2339 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:2353 -msgid "DAEMON CUSTOM PRINTF FORMATTERS" +"The daemon may send progress notification messages at any time. These are " +"distinguished by the normal length word being replaced by " +"C, followed by a fixed size progress message." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2355 +#: ../src/guestfs.pod:2343 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:2360 -msgid "%Q" +"The library turns them into progress callbacks (see " +"L) if there is a callback registered, or discards " +"them if not." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2362 +#: ../src/guestfs.pod:2347 msgid "" -"Simple shell quoted string. Any spaces or other shell characters are " -"escaped for you." +"The daemon self-limits the frequency of progress messages it sends (see " +"C). Not all calls generate progress " +"messages." msgstr "" -#. type: =item -#: ../src/guestfs.pod:2365 -msgid "%R" +#. type: =head1 +#: ../src/guestfs.pod:2351 +msgid "LIBGUESTFS VERSION NUMBERS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2367 +#: ../src/guestfs.pod:2353 msgid "" -"Same as C<%Q> except the string is treated as a path which is prefixed by " -"the sysroot." -msgstr "" - -#. type: textblock -#: ../src/guestfs.pod:2372 ../fish/guestfish.pod:240 ../fish/guestfish.pod:599 -msgid "For example:" +"Since April 2010, libguestfs has started to make separate development and " +"stable releases, along with corresponding branches in our git repository. " +"These separate releases can be identified by version number:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:2374 +#: ../src/guestfs.pod:2358 #, no-wrap msgid "" -" asprintf (&cmd, \"cat %R\", path);\n" +" even numbers for stable: 1.2.x, 1.4.x, ...\n" +" .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n" +" |\n" +" v\n" +" 1 . 3 . 5\n" +" ^ ^\n" +" | |\n" +" | `-------- sub-version\n" +" |\n" +" `------ always '1' because we don't change the ABI\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2376 -msgid "would produce C" +#: ../src/guestfs.pod:2369 +msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2378 +#: ../src/guestfs.pod:2371 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." +"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: =head2 -#: ../src/guestfs.pod:2384 -msgid "SUBMITTING YOUR NEW API ACTIONS" +#. type: textblock +#: ../src/guestfs.pod:2377 +msgid "Our criteria for backporting changes are:" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2386 +#: ../src/guestfs.pod:2383 msgid "" -"Submit patches to the mailing list: " -"L and CC to " -"L." -msgstr "" - -#. type: =head2 -#: ../src/guestfs.pod:2390 -msgid "INTERNATIONALIZATION (I18N) SUPPORT" +"Documentation changes which don't affect any code are backported unless the " +"documentation refers to a future feature which is not in stable." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2392 -msgid "We support i18n (gettext anyhow) in the library." +#: ../src/guestfs.pod:2389 +msgid "" +"Bug fixes which are not controversial, fix obvious problems, and have been " +"well tested are backported." msgstr "" #. type: textblock #: ../src/guestfs.pod:2394 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." +"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 #: ../src/guestfs.pod:2400 msgid "" -"Debugging messages are never translated, since they are intended for the " -"programmers." +"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: =head2 -#: ../src/guestfs.pod:2403 -msgid "SOURCE CODE SUBDIRECTORIES" +#. type: textblock +#: ../src/guestfs.pod:2406 +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: =item -#: ../src/guestfs.pod:2407 ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3808 -msgid "C" +#. type: =head1 +#: ../src/guestfs.pod:2414 +msgid "EXTENDING LIBGUESTFS" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2409 -msgid "The libguestfs appliance, build scripts and so on." +#. type: =head2 +#: ../src/guestfs.pod:2416 +msgid "ADDING A NEW API ACTION" msgstr "" -#. type: =item -#: ../src/guestfs.pod:2411 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2418 +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:2413 -msgid "Automated tests of the C API." +#: ../src/guestfs.pod:2422 +msgid "To add a new API action there are two changes:" msgstr "" -#. type: =item -#: ../src/guestfs.pod:2415 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2428 +msgid "" +"You need to add a description of the call (name, parameters, return type, " +"tests, documentation) to C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2417 +#: ../src/guestfs.pod:2431 msgid "" -"The L, L and L commands and " -"documentation." +"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: =item -#: ../src/guestfs.pod:2420 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2439 +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:2422 -msgid "Outside contributions, experimental parts." +#: ../src/guestfs.pod:2445 +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: =item -#: ../src/guestfs.pod:2424 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2453 +msgid "Implement the action (in C):" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2426 +#: ../src/guestfs.pod:2455 msgid "" -"The daemon that runs inside the libguestfs appliance and carries out " -"actions." +"For daemon actions, implement the function CnameE> in the " +"C directory." msgstr "" -#. type: =item -#: ../src/guestfs.pod:2429 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2458 +msgid "" +"For library actions, implement the function CnameE> " +"(note: double underscore) in the C directory." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2431 -msgid "L command and documentation." +#: ../src/guestfs.pod:2461 +msgid "In either case, use another function as an example of what to do." msgstr "" -#. type: =item -#: ../src/guestfs.pod:2433 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2465 +msgid "After making these changes, use C to compile." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2435 -msgid "C API example code." +#: ../src/guestfs.pod:2467 +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: =item -#: ../src/guestfs.pod:2437 -msgid "C" +#. type: =head2 +#: ../src/guestfs.pod:2471 +msgid "ADDING TESTS FOR AN API ACTION" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2439 +#: ../src/guestfs.pod:2473 msgid "" -"L, the command-line shell, and various shell scripts built on " -"top such as L, L, L, " -"L." +"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: =item -#: ../src/guestfs.pod:2443 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2479 +msgid "" +"The following describes the test environment used when you add an API test " +"in C." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2445 -msgid "L, FUSE (userspace filesystem) built on top of libguestfs." +#: ../src/guestfs.pod:2482 +msgid "The test environment has 4 block devices:" msgstr "" #. type: =item -#: ../src/guestfs.pod:2447 -msgid "C" +#: ../src/guestfs.pod:2486 +msgid "C 500MB" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2449 -msgid "" -"The crucially important generator, used to automatically generate large " -"amounts of boilerplate C code for things like RPC and bindings." +#: ../src/guestfs.pod:2488 +msgid "General block device for testing." msgstr "" #. type: =item -#: ../src/guestfs.pod:2452 -msgid "C" +#: ../src/guestfs.pod:2490 +msgid "C 50MB" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2454 -msgid "Files used by the test suite." +#: ../src/guestfs.pod:2492 +msgid "" +"C is an ext2 filesystem used for testing filesystem write " +"operations." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2495 +msgid "C 10MB" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2456 -msgid "Some \"phony\" guest images which we test against." +#: ../src/guestfs.pod:2497 +msgid "Used in a few tests where two block devices are needed." msgstr "" #. type: =item -#: ../src/guestfs.pod:2458 -msgid "C" +#: ../src/guestfs.pod:2499 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2460 -msgid "L, the virtual machine image inspector." +#: ../src/guestfs.pod:2501 +msgid "ISO with fixed content (see C)." msgstr "" -#. type: =item -#: ../src/guestfs.pod:2462 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2505 +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:2464 -msgid "Logo used on the website. The fish is called Arthur by the way." +#: ../src/guestfs.pod:2509 +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: =item -#: ../src/guestfs.pod:2466 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2515 +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:2468 -msgid "M4 macros used by autoconf." +#: ../src/guestfs.pod:2521 +msgid "" +"In addition, packagers can skip individual tests by setting environment " +"variables before running C." msgstr "" -#. type: =item -#: ../src/guestfs.pod:2470 -msgid "C" +#. type: verbatim +#: ../src/guestfs.pod:2524 +#, no-wrap +msgid "" +" SKIP_TEST__=1\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2472 -msgid "Translations of simple gettext strings." +#: ../src/guestfs.pod:2526 +msgid "eg: C skips test #3 of L." msgstr "" -#. type: =item -#: ../src/guestfs.pod:2474 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2528 +msgid "or:" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2476 +#. type: verbatim +#: ../src/guestfs.pod:2530 +#, no-wrap 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." +" SKIP_TEST_=1\n" +"\n" msgstr "" -#. type: =item -#: ../src/guestfs.pod:2480 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2532 +msgid "eg: C skips all L tests." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2482 -msgid "Regression tests." +#: ../src/guestfs.pod:2534 +msgid "Packagers can run only certain tests by setting for example:" msgstr "" -#. type: =item -#: ../src/guestfs.pod:2484 -msgid "C" +#. type: verbatim +#: ../src/guestfs.pod:2536 +#, no-wrap +msgid "" +" TEST_ONLY=\"vfs_type zerofree\"\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2486 -msgid "L command and documentation." +#: ../src/guestfs.pod:2538 +msgid "" +"See C for more details of how these environment variables " +"work." msgstr "" -#. type: =item -#: ../src/guestfs.pod:2488 -msgid "C" +#. type: =head2 +#: ../src/guestfs.pod:2541 +msgid "DEBUGGING NEW API ACTIONS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2490 -msgid "Source code to the C library." +#: ../src/guestfs.pod:2543 +msgid "Test new actions work before submitting them." msgstr "" -#. type: =item -#: ../src/guestfs.pod:2492 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2545 +msgid "You can use guestfish to try out new commands." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2494 -msgid "Command line tools written in Perl (L and many others)." +#: ../src/guestfs.pod:2547 +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: =item -#: ../src/guestfs.pod:2496 -msgid "C" +#. type: =head2 +#: ../src/guestfs.pod:2551 +msgid "FORMATTING CODE AND OTHER CONVENTIONS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2498 +#: ../src/guestfs.pod:2553 msgid "" -"Test tool for end users to test if their qemu/kernel combination will work " -"with libguestfs." +"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: =item -#: ../src/guestfs.pod:2501 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2559 +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: =item -#: ../src/guestfs.pod:2503 -msgid "C" +#. type: verbatim +#: ../src/guestfs.pod:2562 +#, 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: =item -#: ../src/guestfs.pod:2505 -msgid "C" +#. type: verbatim +#: ../src/guestfs.pod:2572 +#, 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: =item -#: ../src/guestfs.pod:2507 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2584 +msgid "Enable warnings when compiling (and fix any problems this finds):" msgstr "" -#. type: =item -#: ../src/guestfs.pod:2509 -msgid "C" +#. type: verbatim +#: ../src/guestfs.pod:2587 +#, no-wrap +msgid "" +" ./configure --enable-gcc-warnings\n" +"\n" msgstr "" -#. type: =item -#: ../src/guestfs.pod:2511 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2589 +msgid "Useful targets are:" msgstr "" -#. type: =item -#: ../src/guestfs.pod:2513 -msgid "C" +#. type: verbatim +#: ../src/guestfs.pod:2591 +#, no-wrap +msgid "" +" make syntax-check # checks the syntax of the C code\n" +" make check # runs the test suite\n" +"\n" msgstr "" -#. type: =item -#: ../src/guestfs.pod:2515 -msgid "C" +#. type: =head2 +#: ../src/guestfs.pod:2594 +msgid "DAEMON CUSTOM PRINTF FORMATTERS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2517 -msgid "Language bindings." -msgstr "" - -#. type: =head1 -#: ../src/guestfs.pod:2521 ../fish/guestfish.pod:996 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 -msgid "ENVIRONMENT VARIABLES" +#: ../src/guestfs.pod:2596 +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:2525 ../fish/guestfish.pod:1022 -msgid "LIBGUESTFS_APPEND" +#: ../src/guestfs.pod:2601 +msgid "%Q" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2527 ../fish/guestfish.pod:1024 -msgid "Pass additional options to the guest kernel." +#: ../src/guestfs.pod:2603 +msgid "" +"Simple shell quoted string. Any spaces or other shell characters are " +"escaped for you." msgstr "" #. type: =item -#: ../src/guestfs.pod:2529 ../fish/guestfish.pod:1026 -msgid "LIBGUESTFS_DEBUG" +#: ../src/guestfs.pod:2606 +msgid "%R" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2531 +#: ../src/guestfs.pod:2608 msgid "" -"Set C to enable verbose messages. This has the same " -"effect as calling C." -msgstr "" - -#. type: =item -#: ../src/guestfs.pod:2534 ../fish/guestfish.pod:1031 -msgid "LIBGUESTFS_MEMSIZE" +"Same as C<%Q> except the string is treated as a path which is prefixed by " +"the sysroot." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2536 ../fish/guestfish.pod:1033 -msgid "Set the memory allocated to the qemu process, in megabytes. For example:" +#: ../src/guestfs.pod:2613 ../fish/guestfish.pod:242 ../fish/guestfish.pod:615 +msgid "For example:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:2539 ../fish/guestfish.pod:1036 +#: ../src/guestfs.pod:2615 #, no-wrap msgid "" -" LIBGUESTFS_MEMSIZE=700\n" +" asprintf (&cmd, \"cat %R\", path);\n" "\n" msgstr "" -#. type: =item -#: ../src/guestfs.pod:2541 ../fish/guestfish.pod:1038 -msgid "LIBGUESTFS_PATH" +#. type: textblock +#: ../src/guestfs.pod:2617 +msgid "would produce C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2543 +#: ../src/guestfs.pod:2619 msgid "" -"Set the path that libguestfs uses to search for kernel and initrd.img. See " -"the discussion of paths in section PATH above." -msgstr "" - -#. type: =item -#: ../src/guestfs.pod:2546 ../fish/guestfish.pod:1043 -msgid "LIBGUESTFS_QEMU" +"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:2625 +msgid "SUBMITTING YOUR NEW API ACTIONS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2548 ../fish/guestfish.pod:1045 +#: ../src/guestfs.pod:2627 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." +"Submit patches to the mailing list: " +"L and CC to " +"L." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:2631 +msgid "INTERNATIONALIZATION (I18N) SUPPORT" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2552 -msgid "See also L above." +#: ../src/guestfs.pod:2633 +msgid "We support i18n (gettext anyhow) in the library." msgstr "" -#. type: =item -#: ../src/guestfs.pod:2554 ../fish/guestfish.pod:1049 -msgid "LIBGUESTFS_TRACE" +#. type: textblock +#: ../src/guestfs.pod:2635 +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:2556 +#: ../src/guestfs.pod:2641 msgid "" -"Set C to enable command traces. This has the same " -"effect as calling C." +"Debugging messages are never translated, since they are intended for the " +"programmers." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:2644 +msgid "SOURCE CODE SUBDIRECTORIES" msgstr "" #. type: =item -#: ../src/guestfs.pod:2559 ../fish/guestfish.pod:1058 -msgid "TMPDIR" +#: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:3958 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2561 ../fish/guestfish.pod:1060 -msgid "" -"Location of temporary directory, defaults to C except for the cached " -"supermin appliance which defaults to C." +#: ../src/guestfs.pod:2650 +msgid "The libguestfs appliance, build scripts and so on." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2652 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2564 ../fish/guestfish.pod:1063 -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." +#: ../src/guestfs.pod:2654 +msgid "Automated tests of the C API." msgstr "" -#. type: =head1 -#: ../src/guestfs.pod:2572 ../fish/guestfish.pod:1121 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:238 ../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" +#. type: =item +#: ../src/guestfs.pod:2656 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2574 +#: ../src/guestfs.pod:2658 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." +"The L, L and L commands and " +"documentation." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2661 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2601 -msgid "" -"Tools with a similar purpose: L, L, L, " -"L, L." +#: ../src/guestfs.pod:2663 +msgid "Outside contributions, experimental parts." msgstr "" -#. type: =head1 -#: ../src/guestfs.pod:2608 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:548 -msgid "BUGS" +#. type: =item +#: ../src/guestfs.pod:2665 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2610 -msgid "To get a list of bugs against libguestfs use this link:" +#: ../src/guestfs.pod:2667 +msgid "" +"The daemon that runs inside the libguestfs appliance and carries out " +"actions." msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2612 -msgid "L" +#. type: =item +#: ../src/guestfs.pod:2670 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2614 -msgid "To report a new bug against libguestfs use this link:" +#: ../src/guestfs.pod:2672 +msgid "L command and documentation." msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2616 -msgid "L" +#. type: =item +#: ../src/guestfs.pod:2674 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2618 -msgid "When reporting a bug, please check:" +#: ../src/guestfs.pod:2676 +msgid "L command and documentation." msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2624 -msgid "That the bug hasn't been reported already." +#. type: =item +#: ../src/guestfs.pod:2678 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2628 -msgid "That you are testing a recent version." +#: ../src/guestfs.pod:2680 +msgid "C API example code." msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2632 -msgid "Describe the bug accurately, and give a way to reproduce it." +#. type: =item +#: ../src/guestfs.pod:2682 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2636 +#: ../src/guestfs.pod:2684 msgid "" -"Run libguestfs-test-tool and paste the B output into the " -"bug report." +"L, the command-line shell, and various shell scripts built on " +"top such as L, L, L, " +"L." msgstr "" -#. type: =head1 -#: ../src/guestfs.pod:2641 ../fish/guestfish.pod:1144 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:249 -msgid "AUTHORS" +#. type: =item +#: ../src/guestfs.pod:2688 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2643 ../fish/guestfish.pod:1146 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:251 -msgid "Richard W.M. Jones (C)" +#: ../src/guestfs.pod:2690 +msgid "L, FUSE (userspace filesystem) built on top of libguestfs." msgstr "" -#. type: =head1 -#: ../src/guestfs.pod:2645 ../fish/guestfish.pod:1148 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:253 ../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" +#. type: =item +#: ../src/guestfs.pod:2692 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2647 ../fish/guestfish.pod:1150 ../fuse/guestmount.pod:255 -msgid "Copyright (C) 2009-2010 Red Hat Inc. L" +#: ../src/guestfs.pod:2694 +msgid "" +"The crucially important generator, used to automatically generate large " +"amounts of boilerplate C code for things like RPC and bindings." msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2650 -msgid "" -"This library is free software; you can redistribute it and/or modify it " -"under the terms of the GNU Lesser General Public License as published by the " -"Free Software Foundation; either version 2 of the License, or (at your " -"option) any later version." +#. type: =item +#: ../src/guestfs.pod:2697 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2655 -msgid "" -"This library is distributed in the hope that it will be useful, but WITHOUT " -"ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or " -"FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License " -"for more details." +#: ../src/guestfs.pod:2699 +msgid "Files used by the test suite." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2660 -msgid "" -"You should have received a copy of the GNU Lesser General Public License " -"along with this library; if not, write to the Free Software Foundation, " -"Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA" +#: ../src/guestfs.pod:2701 +msgid "Some \"phony\" guest images which we test against." msgstr "" -#. type: =head2 -#: ../src/guestfs-actions.pod:1 -msgid "guestfs_add_cdrom" +#. type: =item +#: ../src/guestfs.pod:2703 +msgid "C" msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:3 -#, no-wrap -msgid "" -" int\n" -" guestfs_add_cdrom (guestfs_h *g,\n" -" const char *filename);\n" -"\n" +#. type: textblock +#: ../src/guestfs.pod:2705 +msgid "L, the virtual machine image inspector." msgstr "" -#. 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." +#. type: =item +#: ../src/guestfs.pod:2707 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7 -msgid "This is equivalent to the qemu parameter C<-cdrom filename>." +#: ../src/guestfs.pod:2709 +msgid "Logo used on the website. The fish is called Arthur by the way." msgstr "" -#. 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." +#. type: =item +#: ../src/guestfs.pod:2711 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:24 -msgid "" -"If you just want to add an ISO file (often you use this as an efficient way " -"to transfer large files into the guest), then you should probably use " -"C instead." +#: ../src/guestfs.pod:2713 +msgid "M4 macros used by autoconf." msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134 ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232 ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267 ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301 ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436 ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495 ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541 ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641 ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670 ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787 ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815 ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996 ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098 ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135 ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169 ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270 ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1332 ../src/guestfs-actions.pod:1438 ../src/guestfs-actions.pod:1472 ../src/guestfs-actions.pod:1690 ../src/guestfs-actions.pod:1712 ../src/guestfs-actions.pod:1799 ../src/guestfs-actions.pod:2261 ../src/guestfs-actions.pod:2405 ../src/guestfs-actions.pod:2466 ../src/guestfs-actions.pod:2501 ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3351 ../src/guestfs-actions.pod:3371 ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:3567 ../src/guestfs-actions.pod:3582 ../src/guestfs-actions.pod:3618 ../src/guestfs-actions.pod:3690 ../src/guestfs-actions.pod:3710 ../src/guestfs-actions.pod:3727 ../src/guestfs-actions.pod:3750 ../src/guestfs-actions.pod:3773 ../src/guestfs-actions.pod:3805 ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3843 ../src/guestfs-actions.pod:3878 ../src/guestfs-actions.pod:3890 ../src/guestfs-actions.pod:3926 ../src/guestfs-actions.pod:3942 ../src/guestfs-actions.pod:3955 ../src/guestfs-actions.pod:3970 ../src/guestfs-actions.pod:3987 ../src/guestfs-actions.pod:4080 ../src/guestfs-actions.pod:4100 ../src/guestfs-actions.pod:4113 ../src/guestfs-actions.pod:4164 ../src/guestfs-actions.pod:4182 ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4216 ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4261 ../src/guestfs-actions.pod:4276 ../src/guestfs-actions.pod:4296 ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:4458 ../src/guestfs-actions.pod:4477 ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:4508 ../src/guestfs-actions.pod:4525 ../src/guestfs-actions.pod:4538 ../src/guestfs-actions.pod:4553 ../src/guestfs-actions.pod:4568 ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4638 ../src/guestfs-actions.pod:4652 ../src/guestfs-actions.pod:4669 ../src/guestfs-actions.pod:4718 ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:4769 ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4814 ../src/guestfs-actions.pod:4832 ../src/guestfs-actions.pod:4966 ../src/guestfs-actions.pod:5023 ../src/guestfs-actions.pod:5045 ../src/guestfs-actions.pod:5063 ../src/guestfs-actions.pod:5095 ../src/guestfs-actions.pod:5161 ../src/guestfs-actions.pod:5178 ../src/guestfs-actions.pod:5191 ../src/guestfs-actions.pod:5205 ../src/guestfs-actions.pod:5494 ../src/guestfs-actions.pod:5513 ../src/guestfs-actions.pod:5532 ../src/guestfs-actions.pod:5544 ../src/guestfs-actions.pod:5556 ../src/guestfs-actions.pod:5570 ../src/guestfs-actions.pod:5582 ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5612 ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5652 ../src/guestfs-actions.pod:5671 ../src/guestfs-actions.pod:5701 ../src/guestfs-actions.pod:5717 ../src/guestfs-actions.pod:5740 ../src/guestfs-actions.pod:5758 ../src/guestfs-actions.pod:5777 ../src/guestfs-actions.pod:5798 ../src/guestfs-actions.pod:5817 ../src/guestfs-actions.pod:5834 ../src/guestfs-actions.pod:5862 ../src/guestfs-actions.pod:5886 ../src/guestfs-actions.pod:5905 ../src/guestfs-actions.pod:5929 ../src/guestfs-actions.pod:5944 ../src/guestfs-actions.pod:5959 ../src/guestfs-actions.pod:5978 ../src/guestfs-actions.pod:6015 ../src/guestfs-actions.pod:6038 ../src/guestfs-actions.pod:6064 ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6293 ../src/guestfs-actions.pod:6305 ../src/guestfs-actions.pod:6318 ../src/guestfs-actions.pod:6331 ../src/guestfs-actions.pod:6353 ../src/guestfs-actions.pod:6366 ../src/guestfs-actions.pod:6379 ../src/guestfs-actions.pod:6392 ../src/guestfs-actions.pod:6407 ../src/guestfs-actions.pod:6466 ../src/guestfs-actions.pod:6483 ../src/guestfs-actions.pod:6499 ../src/guestfs-actions.pod:6515 ../src/guestfs-actions.pod:6532 ../src/guestfs-actions.pod:6545 ../src/guestfs-actions.pod:6565 ../src/guestfs-actions.pod:6601 ../src/guestfs-actions.pod:6615 ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:6669 ../src/guestfs-actions.pod:6687 ../src/guestfs-actions.pod:6721 ../src/guestfs-actions.pod:6757 ../src/guestfs-actions.pod:6876 ../src/guestfs-actions.pod:6894 ../src/guestfs-actions.pod:6908 ../src/guestfs-actions.pod:6963 ../src/guestfs-actions.pod:6976 ../src/guestfs-actions.pod:7021 ../src/guestfs-actions.pod:7054 ../src/guestfs-actions.pod:7108 ../src/guestfs-actions.pod:7134 ../src/guestfs-actions.pod:7200 ../src/guestfs-actions.pod:7219 ../src/guestfs-actions.pod:7248 -msgid "This function returns 0 on success or -1 on error." +#. type: =item +#: ../src/guestfs.pod:2715 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248 ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172 -msgid "" -"This function is deprecated. In new code, use the C call " -"instead." +#: ../src/guestfs.pod:2717 +msgid "Translations of simple gettext strings." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2719 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251 ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1939 ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:4301 ../src/guestfs-actions.pod:7142 ../src/guestfs-actions.pod:7311 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175 ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319 ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:2908 ../fish/guestfish-actions.pod:4762 ../fish/guestfish-actions.pod:4859 +#: ../src/guestfs.pod:2721 msgid "" -"Deprecated functions will not be removed from the API, but the fact that " -"they are deprecated indicates that there are problems with correct use of " -"these functions." +"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: textblock -#: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136 ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1911 ../src/guestfs-actions.pod:2009 ../src/guestfs-actions.pod:2112 ../src/guestfs-actions.pod:3338 ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:5719 ../src/guestfs-actions.pod:5836 ../src/guestfs-actions.pod:5946 ../src/guestfs-actions.pod:6409 ../src/guestfs-actions.pod:6534 ../src/guestfs-actions.pod:7056 -msgid "(Added in 0.3)" +#. type: =item +#: ../src/guestfs.pod:2725 +msgid "C" msgstr "" -#. type: =head2 -#: ../src/guestfs-actions.pod:41 -msgid "guestfs_add_domain" +#. type: textblock +#: ../src/guestfs.pod:2727 +msgid "Regression tests." msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:43 -#, no-wrap -msgid "" -" int\n" -" guestfs_add_domain (guestfs_h *g,\n" -" const char *dom,\n" -" ...);\n" -"\n" +#. type: =item +#: ../src/guestfs.pod:2729 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145 ../src/guestfs-actions.pod:4315 -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." +#: ../src/guestfs.pod:2731 +msgid "L command and documentation." msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:53 -#, no-wrap -msgid "" -" GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n" -" GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n" -" GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n" -" GUESTFS_ADD_DOMAIN_LIVE, int live,\n" -"\n" +#. type: =item +#: ../src/guestfs.pod:2733 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:58 -msgid "" -"This function adds the disk(s) attached to the named libvirt domain C. " -"It works by connecting to libvirt, requesting the domain and domain XML from " -"libvirt, parsing it for disks, and calling C on each " -"one." +#: ../src/guestfs.pod:2735 +msgid "Source code to the C library." msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46 -msgid "" -"The number of disks added is returned. This operation is atomic: if an " -"error is returned, then no disks are added." +#. type: =item +#: ../src/guestfs.pod:2737 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49 -msgid "" -"This function does some minimal checks to make sure the libvirt domain is " -"not running (unless C is true). In a future version we will try " -"to acquire the libvirt lock on each disk." +#: ../src/guestfs.pod:2739 +msgid "Command line tools written in Perl (L and many others)." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2741 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53 +#: ../src/guestfs.pod:2743 msgid "" -"Disks must be accessible locally. This often means that adding disks from a " -"remote libvirt connection (see L) will fail " -"unless those disks are accessible via the same device path locally too." +"Test tool for end users to test if their qemu/kernel combination will work " +"with libguestfs." msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58 -msgid "" -"The optional C parameter sets the libvirt URI (see " -"L). If this is not set then we connect to the " -"default libvirt URI (or one set through an environment variable, see the " -"libvirt documentation for full details)." +#. type: =item +#: ../src/guestfs.pod:2746 +msgid "C" msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64 -msgid "" -"The optional C flag controls whether this call will try to connect to " -"a running virtual machine C process if it sees a suitable " -"EchannelE element in the libvirt XML definition. The default (if " -"the flag is omitted) is never to try. See L for more information." +#. type: =item +#: ../src/guestfs.pod:2748 +msgid "C" msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:88 -msgid "" -"The other optional parameters are passed directly through to " -"C." +#. type: =item +#: ../src/guestfs.pod:2750 +msgid "C" msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344 ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687 ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736 ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315 ../src/guestfs-actions.pod:1669 ../src/guestfs-actions.pod:1872 ../src/guestfs-actions.pod:1981 ../src/guestfs-actions.pod:2021 ../src/guestfs-actions.pod:2076 ../src/guestfs-actions.pod:2099 ../src/guestfs-actions.pod:2392 ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:2740 ../src/guestfs-actions.pod:4741 ../src/guestfs-actions.pod:4869 ../src/guestfs-actions.pod:5275 ../src/guestfs-actions.pod:5301 ../src/guestfs-actions.pod:6642 ../src/guestfs-actions.pod:7067 ../src/guestfs-actions.pod:7080 ../src/guestfs-actions.pod:7093 -msgid "On error this function returns -1." +#. type: =item +#: ../src/guestfs.pod:2752 +msgid "C" msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:93 -msgid "(Added in 1.7.4)" +#. type: =item +#: ../src/guestfs.pod:2754 +msgid "C" msgstr "" -#. type: =head2 -#: ../src/guestfs-actions.pod:95 -msgid "guestfs_add_domain_va" +#. type: =item +#: ../src/guestfs.pod:2756 +msgid "C" msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:97 -#, no-wrap -msgid "" -" int\n" -" guestfs_add_domain_va (guestfs_h *g,\n" -" const char *dom,\n" -" va_list args);\n" -"\n" +#. type: =item +#: ../src/guestfs.pod:2758 +msgid "C" msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:102 -msgid "This is the \"va_list variant\" of L." +#. type: =item +#: ../src/guestfs.pod:2760 +msgid "C" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115 ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219 ../src/guestfs-actions.pod:4368 ../src/guestfs-actions.pod:4380 -msgid "See L." +#: ../src/guestfs.pod:2762 +msgid "Language bindings." msgstr "" -#. type: =head2 -#: ../src/guestfs-actions.pod:106 -msgid "guestfs_add_domain_argv" +#. type: =head1 +#: ../src/guestfs.pod:2766 +msgid "LIMITS" msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:108 -#, no-wrap -msgid "" -" int\n" -" guestfs_add_domain_argv (guestfs_h *g,\n" -" const char *dom,\n" -" const struct guestfs_add_domain_argv *optargs);\n" -"\n" +#. type: =head2 +#: ../src/guestfs.pod:2768 +msgid "PROTOCOL LIMITS" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:113 -msgid "This is the \"argv variant\" of L." -msgstr "" - -#. type: =head2 -#: ../src/guestfs-actions.pod:117 -msgid "guestfs_add_drive" +#: ../src/guestfs.pod:2770 +msgid "" +"Internally libguestfs uses a message-based protocol to pass API calls and " +"their responses to and from a small \"appliance\" (see L for " +"plenty more detail about this). The maximum message size used by the " +"protocol is slightly less than 4 MB. For some API calls you may need to be " +"aware of this limit. The API calls which may be affected are individually " +"documented, with a link back to this section of the documentation." msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:119 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2778 msgid "" -" int\n" -" guestfs_add_drive (guestfs_h *g,\n" -" const char *filename);\n" -"\n" +"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 " +"a message, the maximum size that it can return is slightly under 4 MB. If " +"the requested file is larger than this then you will get an error." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:123 +#: ../src/guestfs.pod:2784 msgid "" -"This function is the equivalent of calling C with no " -"optional parameters, so the disk is added writable, with the format being " -"detected automatically." +"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 " +"and L document how to do this." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:127 +#: ../src/guestfs.pod:2788 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." +"You might also consider mounting the disk image using our FUSE filesystem " +"support (L)." msgstr "" #. type: =head2 -#: ../src/guestfs-actions.pod:138 -msgid "guestfs_add_drive_opts" +#: ../src/guestfs.pod:2791 +msgid "MAXIMUM NUMBER OF DISKS" msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:140 -#, no-wrap -msgid "" -" int\n" -" guestfs_add_drive_opts (guestfs_h *g,\n" -" const char *filename,\n" -" ...);\n" -"\n" +#. type: textblock +#: ../src/guestfs.pod:2793 +msgid "When using virtio disks (the default) the current limit is B<25> disks." msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:150 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2796 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" +"Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 " +"slots. However febootstrap only understands disks with names C " +"through C (26 letters) and it reserves one disk for its own " +"purposes." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97 +#: ../src/guestfs.pod:2801 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." +"We are working to substantially raise this limit in future versions but it " +"requires complex changes to qemu." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102 +#: ../src/guestfs.pod:2804 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)." +"In future versions of libguestfs it should also be possible to \"hot plug\" " +"disks (add and remove disks after calling L). This also " +"requires changes to qemu." msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108 -msgid "This call checks that C exists." +#. type: =head2 +#: ../src/guestfs.pod:2808 +msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4326 ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:2919 -msgid "The optional arguments are:" +#: ../src/guestfs.pod:2810 +msgid "Virtio limits the maximum number of partitions per disk to B<15>." msgstr "" -#. type: =item -#: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2812 +msgid "" +"This is because it reserves 4 bits for the minor device number (thus " +"C, and C through C)." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116 +#: ../src/guestfs.pod:2815 msgid "" -"If true then the image is treated as read-only. Writes are still allowed, " -"but they are stored in a temporary snapshot overlay which is discarded at " -"the end. The disk that you add is not modified." +"If you attach a disk with more than 15 partitions, the extra partitions are " +"ignored by libguestfs." msgstr "" -#. type: =item -#: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120 -msgid "C" +#. type: =head2 +#: ../src/guestfs.pod:2818 +msgid "MAXIMUM SIZE OF A DISK" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:179 -msgid "" -"This forces the image format. If you omit this (or use C " -"or C) then the format is automatically detected. " -"Possible formats include C and C." +#: ../src/guestfs.pod:2820 +msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126 +#: ../src/guestfs.pod:2822 msgid "" -"Automatic detection of the format opens you up to a potential security hole " -"when dealing with untrusted raw-format images. See CVE-2010-3851 and " -"RHBZ#642934. Specifying the format closes this security hole." -msgstr "" - -#. type: =item -#: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131 -msgid "C" +"We have tested block devices up to 1 exabyte (2**60 or " +"1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host " +"filesystem." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:190 +#: ../src/guestfs.pod:2826 msgid "" -"This rarely-used option lets you emulate the behaviour of the deprecated " -"C call (q.v.)" +"Although libguestfs probably does not impose any limit, the underlying host " +"storage will. If you store disk images on a host ext4 filesystem, then the " +"maximum size will be limited by the maximum ext4 file size (currently 16 " +"TB). If you store disk images as host logical volumes then you are limited " +"by the maximum size of an LV." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:197 -msgid "(Added in 1.5.23)" +#: ../src/guestfs.pod:2832 +msgid "" +"For the hugest disk image files, we recommend using XFS on the host for " +"storage." msgstr "" #. type: =head2 -#: ../src/guestfs-actions.pod:199 -msgid "guestfs_add_drive_opts_va" +#: ../src/guestfs.pod:2835 +msgid "MAXIMUM SIZE OF A PARTITION" msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:201 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2837 msgid "" -" int\n" -" guestfs_add_drive_opts_va (guestfs_h *g,\n" -" const char *filename,\n" -" va_list args);\n" -"\n" +"The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector " +"numbers. Assuming a 512 byte sector size, this means that MBR cannot " +"address a partition located beyond 2 TB on the disk." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:206 -msgid "This is the \"va_list variant\" of L." +#: ../src/guestfs.pod:2841 +msgid "" +"It is recommended that you use GPT partitions on disks which are larger than " +"this size. GPT uses 64 bit sector numbers and so can address partitions " +"which are theoretically larger than the largest disk we could support." msgstr "" #. type: =head2 -#: ../src/guestfs-actions.pod:210 -msgid "guestfs_add_drive_opts_argv" +#: ../src/guestfs.pod:2846 +msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES" msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:212 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2848 msgid "" -" int\n" -" guestfs_add_drive_opts_argv (guestfs_h *g,\n" -" const char *filename,\n" -" const struct guestfs_add_drive_opts_argv " -"*optargs);\n" -"\n" +"This depends on the filesystem type. libguestfs itself does not impose any " +"known limit. Consult Wikipedia or the filesystem documentation to find out " +"what these limits are." +msgstr "" + +#. type: =head2 +#: ../src/guestfs.pod:2852 +msgid "MAXIMUM UPLOAD AND DOWNLOAD" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:217 -msgid "This is the \"argv variant\" of L." +#: ../src/guestfs.pod:2854 +msgid "" +"The API functions L, L, " +"L, L and the like allow unlimited sized " +"uploads and downloads." msgstr "" #. type: =head2 -#: ../src/guestfs-actions.pod:221 -msgid "guestfs_add_drive_ro" +#: ../src/guestfs.pod:2858 +msgid "INSPECTION LIMITS" msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:223 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2860 msgid "" -" int\n" -" guestfs_add_drive_ro (guestfs_h *g,\n" -" const char *filename);\n" -"\n" +"The inspection code has several arbitrary limits on things like the size of " +"Windows Registry hive it will read, and the length of product name. These " +"are intended to stop a malicious guest from consuming arbitrary amounts of " +"memory and disk space on the host, and should not be reached in practice. " +"See the source code for more information." msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:227 -msgid "" -"This function is the equivalent of calling C with " -"the optional parameter C set to 1, so the " -"disk is added read-only, with the format being detected automatically." +#. type: =head1 +#: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1017 ../test-tool/libguestfs-test-tool.pod:82 +msgid "ENVIRONMENT VARIABLES" msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:234 -msgid "(Added in 1.0.38)" +#. type: =item +#: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1048 +msgid "LIBGUESTFS_APPEND" msgstr "" -#. type: =head2 -#: ../src/guestfs-actions.pod:236 -msgid "guestfs_add_drive_ro_with_if" +#. type: textblock +#: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1050 +msgid "Pass additional options to the guest kernel." msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:238 -#, no-wrap -msgid "" -" int\n" -" guestfs_add_drive_ro_with_if (guestfs_h *g,\n" -" const char *filename,\n" -" const char *iface);\n" -"\n" +#. type: =item +#: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1052 +msgid "LIBGUESTFS_DEBUG" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:243 +#: ../src/guestfs.pod:2876 msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." +"Set C to enable verbose messages. This has the same " +"effect as calling C." msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276 ../src/guestfs-actions.pod:2351 -msgid "(Added in 1.0.84)" +#. type: =item +#: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1057 +msgid "LIBGUESTFS_MEMSIZE" msgstr "" -#. type: =head2 -#: ../src/guestfs-actions.pod:257 -msgid "guestfs_add_drive_with_if" +#. type: textblock +#: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1059 +msgid "Set the memory allocated to the qemu process, in megabytes. For example:" msgstr "" #. type: verbatim -#: ../src/guestfs-actions.pod:259 +#: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1062 #, no-wrap msgid "" -" int\n" -" guestfs_add_drive_with_if (guestfs_h *g,\n" -" const char *filename,\n" -" const char *iface);\n" +" LIBGUESTFS_MEMSIZE=700\n" "\n" msgstr "" +#. type: =item +#: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1064 +msgid "LIBGUESTFS_PATH" +msgstr "" + #. type: textblock -#: ../src/guestfs-actions.pod:264 +#: ../src/guestfs.pod:2888 msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." +"Set the path that libguestfs uses to search for a supermin appliance. See " +"the discussion of paths in section L above." msgstr "" -#. type: =head2 -#: ../src/guestfs-actions.pod:278 -msgid "guestfs_aug_clear" +#. type: =item +#: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1069 +msgid "LIBGUESTFS_QEMU" msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:280 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1071 msgid "" -" int\n" -" guestfs_aug_clear (guestfs_h *g,\n" -" const char *augpath);\n" -"\n" +"Set the default qemu binary that libguestfs uses. If not set, then the qemu " +"which was found at compile time by the configure script is used." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183 -msgid "" -"Set the value associated with C to C. This is the same as the " -"L C command." +#: ../src/guestfs.pod:2897 +msgid "See also L above." msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2101 -msgid "(Added in 1.3.4)" +#. type: =item +#: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1075 +msgid "LIBGUESTFS_TRACE" msgstr "" -#. type: =head2 -#: ../src/guestfs-actions.pod:291 -msgid "guestfs_aug_close" +#. type: textblock +#: ../src/guestfs.pod:2901 +msgid "" +"Set C to enable command traces. This has the same " +"effect as calling C." msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:293 -#, no-wrap -msgid "" -" int\n" -" guestfs_aug_close (guestfs_h *g);\n" -"\n" +#. type: =item +#: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1084 +msgid "TMPDIR" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:296 +#: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1086 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." +"Location of temporary directory, defaults to C except for the cached " +"supermin appliance which defaults to C." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328 ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360 ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438 ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483 ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511 ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543 ../src/guestfs-actions.pod:5352 -msgid "(Added in 0.7)" -msgstr "" - -#. type: =head2 -#: ../src/guestfs-actions.pod:305 -msgid "guestfs_aug_defnode" -msgstr "" - -#. type: verbatim -#: ../src/guestfs-actions.pod:307 -#, no-wrap +#: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1089 msgid "" -" 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" +"If libguestfs was compiled to use the supermin appliance then the real " +"appliance is cached in this directory, shared between all handles belonging " +"to the same EUID. You can use C<$TMPDIR> to configure another directory to " +"use in case C is not large enough." msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199 -msgid "Defines a variable C whose value is the result of evaluating C." +#. type: =head1 +#: ../src/guestfs.pod:2917 ../fish/guestfish.pod:1156 ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:279 ../tools/virt-win-reg.pl:744 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257 +msgid "SEE ALSO" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:316 +#: ../src/guestfs.pod:2919 msgid "" -"If C evaluates to an empty nodeset, a node is created, equivalent to " -"calling C C, C. C will be the nodeset " -"containing that single node." +"L, L, L, " +"L, L, L, L, " +"L, L, L, L, " +"L, L, L, " +"L, L, L, " +"L, L, L, L, " +"L, L, L, L, " +"L." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206 +#: ../src/guestfs.pod:2946 msgid "" -"On success this returns a pair containing the number of nodes in the " -"nodeset, and a boolean flag if a node was created." +"Tools with a similar purpose: L, L, L, " +"L, L." msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:324 -msgid "" -"This function returns a C, or NULL if there was " -"an error. I after use>." +#. type: =head1 +#: ../src/guestfs.pod:2953 ../tools/virt-win-reg.pl:759 ../tools/virt-make-fs.pl:553 +msgid "BUGS" msgstr "" -#. type: =head2 -#: ../src/guestfs-actions.pod:330 -msgid "guestfs_aug_defvar" +#. type: textblock +#: ../src/guestfs.pod:2955 +msgid "To get a list of bugs against libguestfs use this link:" msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:332 -#, no-wrap -msgid "" -" int\n" -" guestfs_aug_defvar (guestfs_h *g,\n" -" const char *name,\n" -" const char *expr);\n" -"\n" +#. type: textblock +#: ../src/guestfs.pod:2957 +msgid "L" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214 -msgid "" -"Defines an Augeas variable C whose value is the result of evaluating " -"C. If C is NULL, then C is undefined." +#: ../src/guestfs.pod:2959 +msgid "To report a new bug against libguestfs use this link:" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218 -msgid "" -"On success this returns the number of nodes in C, or C<0> if C " -"evaluates to something which is not a nodeset." +#: ../src/guestfs.pod:2961 +msgid "L" msgstr "" -#. type: =head2 -#: ../src/guestfs-actions.pod:348 -msgid "guestfs_aug_get" +#. type: textblock +#: ../src/guestfs.pod:2963 +msgid "When reporting a bug, please check:" msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:350 -#, no-wrap -msgid "" -" char *\n" -" guestfs_aug_get (guestfs_h *g,\n" -" const char *augpath);\n" -"\n" +#. type: textblock +#: ../src/guestfs.pod:2969 +msgid "That the bug hasn't been reported already." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225 -msgid "" -"Look up the value associated with C. If C matches exactly one " -"node, the C is returned." +#: ../src/guestfs.pod:2973 +msgid "That you are testing a recent version." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857 ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935 ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054 ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201 ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1349 ../src/guestfs-actions.pod:1540 ../src/guestfs-actions.pod:1652 ../src/guestfs-actions.pod:1815 ../src/guestfs-actions.pod:1832 ../src/guestfs-actions.pod:1899 ../src/guestfs-actions.pod:1933 ../src/guestfs-actions.pod:1954 ../src/guestfs-actions.pod:2124 ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2523 ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2671 ../src/guestfs-actions.pod:2691 ../src/guestfs-actions.pod:2805 ../src/guestfs-actions.pod:2836 ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2922 ../src/guestfs-actions.pod:2945 ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4142 ../src/guestfs-actions.pod:4887 ../src/guestfs-actions.pod:5080 ../src/guestfs-actions.pod:5250 ../src/guestfs-actions.pod:5428 ../src/guestfs-actions.pod:5477 ../src/guestfs-actions.pod:6085 ../src/guestfs-actions.pod:6101 ../src/guestfs-actions.pod:6118 ../src/guestfs-actions.pod:6142 ../src/guestfs-actions.pod:6816 ../src/guestfs-actions.pod:6835 ../src/guestfs-actions.pod:6853 ../src/guestfs-actions.pod:7033 ../src/guestfs-actions.pod:7305 -msgid "" -"This function returns a string, or NULL on error. I." +#: ../src/guestfs.pod:2977 +msgid "Describe the bug accurately, and give a way to reproduce it." msgstr "" -#. type: =head2 -#: ../src/guestfs-actions.pod:362 -msgid "guestfs_aug_init" +#. type: textblock +#: ../src/guestfs.pod:2981 +msgid "" +"Run libguestfs-test-tool and paste the B output into the " +"bug report." msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:364 -#, no-wrap -msgid "" -" int\n" -" guestfs_aug_init (guestfs_h *g,\n" -" const char *root,\n" -" int flags);\n" -"\n" +#. type: =head1 +#: ../src/guestfs.pod:2986 ../fish/guestfish.pod:1180 ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290 +msgid "AUTHORS" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232 -msgid "" -"Create a new Augeas handle for editing configuration files. If there was " -"any previous Augeas handle associated with this guestfs session, then it is " -"closed." +#: ../src/guestfs.pod:2988 ../fish/guestfish.pod:1182 ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292 +msgid "Richard W.M. Jones (C)" msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:373 -msgid "You must call this before using any other C commands." +#. type: =head1 +#: ../src/guestfs.pod:2990 ../fish/guestfish.pod:1184 ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:294 ../tools/virt-win-reg.pl:774 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273 +msgid "COPYRIGHT" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239 -msgid "C is the filesystem root. C must not be NULL, use C instead." +#: ../src/guestfs.pod:2992 ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:99 +msgid "Copyright (C) 2009-2011 Red Hat Inc. L" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242 +#: ../src/guestfs.pod:2995 msgid "" -"The flags are the same as the flags defined in Eaugeas.hE, the " -"logical I of the following integers:" -msgstr "" - -#. type: =item -#: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248 -msgid "C = 1" +"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-actions.pod:387 ../fish/guestfish-actions.pod:250 -msgid "Keep the original file with a C<.augsave> extension." -msgstr "" - -#. type: =item -#: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252 -msgid "C = 2" +#: ../src/guestfs.pod:3000 +msgid "" +"This library is distributed in the hope that it will be useful, but WITHOUT " +"ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or " +"FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License " +"for more details." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254 +#: ../src/guestfs.pod:3005 msgid "" -"Save changes into a file with extension C<.augnew>, and do not overwrite " -"original. Overrides C." +"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: =item -#: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257 -msgid "C = 4" +#. type: =head2 +#: ../src/guestfs-actions.pod:1 +msgid "guestfs_add_cdrom" msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259 -msgid "Typecheck lenses (can be expensive)." +#. type: verbatim +#: ../src/guestfs-actions.pod:3 +#, no-wrap +msgid "" +" int\n" +" guestfs_add_cdrom (guestfs_h *g,\n" +" const char *filename);\n" +"\n" msgstr "" -#. type: =item -#: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261 -msgid "C = 8" +#. 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-actions.pod:400 ../fish/guestfish-actions.pod:263 -msgid "Do not use standard load path for modules." +#: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7 +msgid "This is equivalent to the qemu parameter I<-cdrom filename>." msgstr "" -#. type: =item -#: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265 -msgid "C = 16" +#. 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-actions.pod:404 ../fish/guestfish-actions.pod:267 -msgid "Make save a no-op, just record what would have been changed." +#: ../src/guestfs-actions.pod:24 +msgid "" +"If you just want to add an ISO file (often you use this as an efficient way " +"to transfer large files into the guest), then you should probably use " +"C instead." msgstr "" -#. type: =item -#: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269 -msgid "C = 32" +#. type: textblock +#: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140 ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307 ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547 ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676 ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821 ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:1020 ../src/guestfs-actions.pod:1104 ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1155 ../src/guestfs-actions.pod:1175 ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1276 ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1343 ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1483 ../src/guestfs-actions.pod:1698 ../src/guestfs-actions.pod:1720 ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:2269 ../src/guestfs-actions.pod:2413 ../src/guestfs-actions.pod:2474 ../src/guestfs-actions.pod:2509 ../src/guestfs-actions.pod:3529 ../src/guestfs-actions.pod:3544 ../src/guestfs-actions.pod:3569 ../src/guestfs-actions.pod:3736 ../src/guestfs-actions.pod:3750 ../src/guestfs-actions.pod:3763 ../src/guestfs-actions.pod:3777 ../src/guestfs-actions.pod:3792 ../src/guestfs-actions.pod:3828 ../src/guestfs-actions.pod:3900 ../src/guestfs-actions.pod:3920 ../src/guestfs-actions.pod:3937 ../src/guestfs-actions.pod:3960 ../src/guestfs-actions.pod:3983 ../src/guestfs-actions.pod:4015 ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4088 ../src/guestfs-actions.pod:4100 ../src/guestfs-actions.pod:4136 ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:4165 ../src/guestfs-actions.pod:4180 ../src/guestfs-actions.pod:4197 ../src/guestfs-actions.pod:4290 ../src/guestfs-actions.pod:4310 ../src/guestfs-actions.pod:4323 ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4392 ../src/guestfs-actions.pod:4410 ../src/guestfs-actions.pod:4426 ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4454 ../src/guestfs-actions.pod:4471 ../src/guestfs-actions.pod:4486 ../src/guestfs-actions.pod:4506 ../src/guestfs-actions.pod:4564 ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4668 ../src/guestfs-actions.pod:4687 ../src/guestfs-actions.pod:4706 ../src/guestfs-actions.pod:4718 ../src/guestfs-actions.pod:4735 ../src/guestfs-actions.pod:4748 ../src/guestfs-actions.pod:4763 ../src/guestfs-actions.pod:4778 ../src/guestfs-actions.pod:4813 ../src/guestfs-actions.pod:4846 ../src/guestfs-actions.pod:4883 ../src/guestfs-actions.pod:4903 ../src/guestfs-actions.pod:4917 ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4983 ../src/guestfs-actions.pod:5020 ../src/guestfs-actions.pod:5034 ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5079 ../src/guestfs-actions.pod:5097 ../src/guestfs-actions.pod:5231 ../src/guestfs-actions.pod:5288 ../src/guestfs-actions.pod:5310 ../src/guestfs-actions.pod:5328 ../src/guestfs-actions.pod:5360 ../src/guestfs-actions.pod:5426 ../src/guestfs-actions.pod:5443 ../src/guestfs-actions.pod:5456 ../src/guestfs-actions.pod:5470 ../src/guestfs-actions.pod:5759 ../src/guestfs-actions.pod:5778 ../src/guestfs-actions.pod:5797 ../src/guestfs-actions.pod:5809 ../src/guestfs-actions.pod:5821 ../src/guestfs-actions.pod:5835 ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5877 ../src/guestfs-actions.pod:5898 ../src/guestfs-actions.pod:5917 ../src/guestfs-actions.pod:5936 ../src/guestfs-actions.pod:5966 ../src/guestfs-actions.pod:5982 ../src/guestfs-actions.pod:6005 ../src/guestfs-actions.pod:6023 ../src/guestfs-actions.pod:6042 ../src/guestfs-actions.pod:6063 ../src/guestfs-actions.pod:6082 ../src/guestfs-actions.pod:6099 ../src/guestfs-actions.pod:6127 ../src/guestfs-actions.pod:6151 ../src/guestfs-actions.pod:6170 ../src/guestfs-actions.pod:6194 ../src/guestfs-actions.pod:6213 ../src/guestfs-actions.pod:6228 ../src/guestfs-actions.pod:6247 ../src/guestfs-actions.pod:6284 ../src/guestfs-actions.pod:6314 ../src/guestfs-actions.pod:6347 ../src/guestfs-actions.pod:6469 ../src/guestfs-actions.pod:6590 ../src/guestfs-actions.pod:6602 ../src/guestfs-actions.pod:6615 ../src/guestfs-actions.pod:6628 ../src/guestfs-actions.pod:6650 ../src/guestfs-actions.pod:6663 ../src/guestfs-actions.pod:6676 ../src/guestfs-actions.pod:6689 ../src/guestfs-actions.pod:6704 ../src/guestfs-actions.pod:6763 ../src/guestfs-actions.pod:6780 ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6812 ../src/guestfs-actions.pod:6829 ../src/guestfs-actions.pod:6842 ../src/guestfs-actions.pod:6862 ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6912 ../src/guestfs-actions.pod:6953 ../src/guestfs-actions.pod:6966 ../src/guestfs-actions.pod:6984 ../src/guestfs-actions.pod:7018 ../src/guestfs-actions.pod:7054 ../src/guestfs-actions.pod:7173 ../src/guestfs-actions.pod:7191 ../src/guestfs-actions.pod:7205 ../src/guestfs-actions.pod:7260 ../src/guestfs-actions.pod:7273 ../src/guestfs-actions.pod:7318 ../src/guestfs-actions.pod:7351 ../src/guestfs-actions.pod:7412 ../src/guestfs-actions.pod:7438 ../src/guestfs-actions.pod:7505 ../src/guestfs-actions.pod:7524 ../src/guestfs-actions.pod:7553 +msgid "This function returns 0 on success or -1 on error." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:408 -msgid "Do not load the tree in C." +#: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177 +msgid "" +"This function is deprecated. In new code, use the C call " +"instead." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:412 -msgid "To close the handle, you can call C." +#: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257 ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454 ../src/guestfs-actions.pod:1947 ../src/guestfs-actions.pod:1968 ../src/guestfs-actions.pod:4511 ../src/guestfs-actions.pod:4818 ../src/guestfs-actions.pod:6292 ../src/guestfs-actions.pod:6322 ../src/guestfs-actions.pod:6355 ../src/guestfs-actions.pod:6414 ../src/guestfs-actions.pod:7356 ../src/guestfs-actions.pod:7446 ../src/guestfs-actions.pod:7616 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1321 ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:3038 ../fish/guestfish-actions.pod:3235 ../fish/guestfish-actions.pod:4220 ../fish/guestfish-actions.pod:4243 ../fish/guestfish-actions.pod:4265 ../fish/guestfish-actions.pod:4303 ../fish/guestfish-actions.pod:4944 ../fish/guestfish-actions.pod:5042 +msgid "" +"Deprecated functions will not be removed from the API, but the fact that " +"they are deprecated indicates that there are problems with correct use of " +"these functions." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277 -msgid "To find out more about Augeas, see L." +#: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142 ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1919 ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2120 ../src/guestfs-actions.pod:3531 ../src/guestfs-actions.pod:3551 ../src/guestfs-actions.pod:4822 ../src/guestfs-actions.pod:5984 ../src/guestfs-actions.pod:6101 ../src/guestfs-actions.pod:6215 ../src/guestfs-actions.pod:6706 ../src/guestfs-actions.pod:6831 ../src/guestfs-actions.pod:7360 +msgid "(Added in 0.3)" msgstr "" #. type: =head2 -#: ../src/guestfs-actions.pod:420 -msgid "guestfs_aug_insert" +#: ../src/guestfs-actions.pod:41 +msgid "guestfs_add_domain" msgstr "" #. type: verbatim -#: ../src/guestfs-actions.pod:422 +#: ../src/guestfs-actions.pod:43 #, no-wrap msgid "" " int\n" -" guestfs_aug_insert (guestfs_h *g,\n" -" const char *augpath,\n" -" const char *label,\n" -" int before);\n" +" guestfs_add_domain (guestfs_h *g,\n" +" const char *dom,\n" +" ...);\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283 -msgid "" -"Create a new sibling C