X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=po-docs%2Flibguestfs-docs.pot;h=7b8d73853790eed00081308e581edc0e79a91217;hb=8a3a4c25d3bb63674c9ccf8483d9bfd89085fe47;hp=780948be2aded85656537d7aed32a2592641651e;hpb=bf0280bf589573c11529999a73e9ec642dea9d61;p=libguestfs.git diff --git a/po-docs/libguestfs-docs.pot b/po-docs/libguestfs-docs.pot index 780948b..7b8d738 100644 --- a/po-docs/libguestfs-docs.pot +++ b/po-docs/libguestfs-docs.pot @@ -6,9 +6,9 @@ #, fuzzy msgid "" msgstr "" -"Project-Id-Version: libguestfs 1.5.26\n" +"Project-Id-Version: libguestfs 1.7.7\n" "Report-Msgid-Bugs-To: libguestfs@redhat.com\n" -"POT-Creation-Date: 2010-10-29 15:47+0200\n" +"POT-Creation-Date: 2010-11-15 09:54+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -17,12 +17,12 @@ msgstr "" "Content-Transfer-Encoding: ENCODING" # type: =encoding -#: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 ../inspector/virt-inspector.pl:31 ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:30 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-cat.pl:29 ../tools/virt-tar.pl:29 ../tools/virt-rescue.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28 +#: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 ../inspector/virt-inspector.pl:31 ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:30 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-tar.pl:29 ../tools/virt-rescue.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28 msgid "utf8" msgstr "" # type: =head1 -#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pl:33 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:32 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-cat.pl:31 ../tools/virt-tar.pl:31 ../tools/virt-rescue.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 +#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pl:33 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:32 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-rescue.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 msgid "NAME" msgstr "" @@ -32,7 +32,7 @@ msgid "guestfs - Library for accessing and modifying virtual machine images" msgstr "" # type: =head1 -#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pl:37 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:36 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-cat.pl:35 ../tools/virt-tar.pl:35 ../tools/virt-rescue.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 +#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pl:37 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:36 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-rescue.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 msgid "SYNOPSIS" msgstr "" @@ -70,7 +70,7 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../inspector/virt-inspector.pl:43 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:42 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-cat.pl:41 ../tools/virt-tar.pl:72 ../tools/virt-rescue.pl:51 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40 +#: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../inspector/virt-inspector.pl:43 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:42 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:72 ../tools/virt-rescue.pl:51 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40 msgid "DESCRIPTION" msgstr "" @@ -753,7 +753,7 @@ msgid "There are many limitations to this:" msgstr "" # type: =item -#: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370 ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383 ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:1159 ../src/guestfs.pod:1164 ../src/guestfs.pod:1168 ../src/guestfs.pod:1384 ../src/guestfs.pod:1389 ../src/guestfs.pod:1393 ../src/guestfs.pod:1495 ../src/guestfs.pod:1499 ../src/guestfs.pod:1503 ../src/guestfs.pod:1508 ../src/guestfs.pod:1516 ../src/guestfs.pod:1535 ../src/guestfs.pod:1543 ../src/guestfs.pod:1773 ../src/guestfs.pod:1779 ../src/guestfs.pod:1784 ../src/guestfs.pod:1790 ../src/guestfs.pod:1897 ../src/guestfs.pod:1901 ../src/guestfs.pod:1905 ../src/guestfs.pod:1909 ../src/guestfs-actions.pod:14 ../src/guestfs-actions.pod:21 ../src/guestfs-actions.pod:438 ../src/guestfs-actions.pod:446 ../src/guestfs-actions.pod:453 ../src/guestfs-actions.pod:460 ../src/guestfs-actions.pod:1351 ../src/guestfs-actions.pod:1355 ../src/guestfs-actions.pod:1359 ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1371 ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1389 ../src/guestfs-actions.pod:1393 ../src/guestfs-actions.pod:1397 ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1524 ../src/guestfs-actions.pod:1529 ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1586 ../src/guestfs-actions.pod:1590 ../src/guestfs-actions.pod:1595 ../fish/guestfish.pod:364 ../fish/guestfish.pod:368 ../fish/guestfish.pod:372 ../fish/guestfish.pod:376 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:339 ../fish/guestfish-actions.pod:347 ../fish/guestfish-actions.pod:354 ../fish/guestfish-actions.pod:361 ../fish/guestfish-actions.pod:1056 ../fish/guestfish-actions.pod:1060 ../fish/guestfish-actions.pod:1064 ../fish/guestfish-actions.pod:1068 ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1094 ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102 ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1196 ../fish/guestfish-actions.pod:1201 ../fish/guestfish-actions.pod:1206 ../fish/guestfish-actions.pod:1248 ../fish/guestfish-actions.pod:1252 ../fish/guestfish-actions.pod:1257 ../inspector/virt-inspector.pl:584 ../inspector/virt-inspector.pl:588 ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348 ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363 +#: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370 ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383 ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:955 ../src/guestfs.pod:959 ../src/guestfs.pod:963 ../src/guestfs.pod:968 ../src/guestfs.pod:976 ../src/guestfs.pod:995 ../src/guestfs.pod:1003 ../src/guestfs.pod:1025 ../src/guestfs.pod:1029 ../src/guestfs.pod:1033 ../src/guestfs.pod:1037 ../src/guestfs.pod:1041 ../src/guestfs.pod:1045 ../src/guestfs.pod:1519 ../src/guestfs.pod:1524 ../src/guestfs.pod:1528 ../src/guestfs.pod:1638 ../src/guestfs.pod:1643 ../src/guestfs.pod:1647 ../src/guestfs.pod:1991 ../src/guestfs.pod:1997 ../src/guestfs.pod:2002 ../src/guestfs.pod:2008 ../src/guestfs.pod:2115 ../src/guestfs.pod:2119 ../src/guestfs.pod:2123 ../src/guestfs.pod:2127 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633 ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775 ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:376 ../fish/guestfish.pod:380 ../fish/guestfish.pod:384 ../fish/guestfish.pod:388 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:375 ../fish/guestfish-actions.pod:383 ../fish/guestfish-actions.pod:390 ../fish/guestfish-actions.pod:397 ../fish/guestfish-actions.pod:1067 ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075 ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087 ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095 ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109 ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203 ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259 ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268 ../inspector/virt-inspector.pl:550 ../inspector/virt-inspector.pl:554 ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348 ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363 msgid "*" msgstr "" @@ -818,30 +818,31 @@ msgid "" "A secure alternative is to use libguestfs to install a \"firstboot\" script " "(a script which runs when the guest next boots normally), and to have this " "script run the commands you want in the normal context of the running guest, " -"network security and so on." +"network security and so on. For information about other security issues, " +"see L." msgstr "" # type: textblock -#: ../src/guestfs.pod:411 +#: ../src/guestfs.pod:412 msgid "" "The two main API calls to run commands are L and " "L (there are also variations)." msgstr "" # type: textblock -#: ../src/guestfs.pod:414 +#: ../src/guestfs.pod:415 msgid "" "The difference is that L runs commands using the shell, so any " "shell globs, redirections, etc will work." msgstr "" # type: =head2 -#: ../src/guestfs.pod:417 +#: ../src/guestfs.pod:418 msgid "CONFIGURATION FILES" msgstr "" # type: textblock -#: ../src/guestfs.pod:419 +#: ../src/guestfs.pod:420 msgid "" "To read and write configuration files in Linux guest filesystems, we " "strongly recommend using Augeas. For example, Augeas understands how to " @@ -850,7 +851,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:424 +#: ../src/guestfs.pod:425 msgid "" "The main Augeas calls are bound through the C APIs. We don't " "document Augeas itself here because there is excellent documentation on the " @@ -858,7 +859,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:428 +#: ../src/guestfs.pod:429 msgid "" "If you don't want to use Augeas (you fool!) then try calling " "L to get the file as a list of lines which you can " @@ -866,29 +867,29 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:432 +#: ../src/guestfs.pod:433 msgid "SELINUX" msgstr "" # type: textblock -#: ../src/guestfs.pod:434 +#: ../src/guestfs.pod:435 msgid "" "We support SELinux guests. To ensure that labeling happens correctly in " "SELinux guests, you need to enable SELinux and load the guest's policy:" msgstr "" # type: =item -#: ../src/guestfs.pod:440 +#: ../src/guestfs.pod:441 ../src/guestfs.pod:1140 ../src/guestfs.pod:1271 msgid "1." msgstr "" # type: textblock -#: ../src/guestfs.pod:442 +#: ../src/guestfs.pod:443 msgid "Before launching, do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:444 +#: ../src/guestfs.pod:445 #, no-wrap msgid "" " guestfs_set_selinux (g, 1);\n" @@ -896,19 +897,19 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:446 +#: ../src/guestfs.pod:447 ../src/guestfs.pod:1144 ../src/guestfs.pod:1275 msgid "2." msgstr "" # type: textblock -#: ../src/guestfs.pod:448 +#: ../src/guestfs.pod:449 msgid "" "After mounting the guest's filesystem(s), load the policy. This is best " "done by running the L command in the guest itself:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:452 +#: ../src/guestfs.pod:453 #, no-wrap msgid "" " guestfs_sh (g, \"/usr/sbin/load_policy\");\n" @@ -916,26 +917,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:454 +#: ../src/guestfs.pod:455 msgid "" "(Older versions of C require you to specify the name of the " "policy file)." msgstr "" # type: =item -#: ../src/guestfs.pod:457 +#: ../src/guestfs.pod:458 ../src/guestfs.pod:1281 msgid "3." msgstr "" # type: textblock -#: ../src/guestfs.pod:459 +#: ../src/guestfs.pod:460 msgid "" "Optionally, set the security context for the API. The correct security " "context to use can only be known by inspecting the guest. As an example:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:463 +#: ../src/guestfs.pod:464 #, no-wrap msgid "" " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n" @@ -943,24 +944,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:467 +#: ../src/guestfs.pod:468 msgid "This will work for running commands and editing existing files." msgstr "" # type: textblock -#: ../src/guestfs.pod:469 +#: ../src/guestfs.pod:470 msgid "" "When new files are created, you may need to label them explicitly, for " "example by running the external command C." msgstr "" # type: =head2 -#: ../src/guestfs.pod:473 +#: ../src/guestfs.pod:474 msgid "UMASK" msgstr "" # type: textblock -#: ../src/guestfs.pod:475 +#: ../src/guestfs.pod:476 msgid "" "Certain calls are affected by the current file mode creation mask (the " "\"umask\"). In particular ones which create files or directories, such as " @@ -970,14 +971,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:481 +#: ../src/guestfs.pod:482 msgid "" "The default umask is C<022>, so files are created with modes such as C<0644> " "and directories with C<0755>." msgstr "" # type: textblock -#: ../src/guestfs.pod:484 +#: ../src/guestfs.pod:485 msgid "" "There are two ways to avoid being affected by umask. Either set umask to 0 " "(call C early after launching). Or call " @@ -985,17 +986,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:488 +#: ../src/guestfs.pod:489 msgid "For more information about umask, see L." msgstr "" # type: =head1 -#: ../src/guestfs.pod:490 ../fish/guestfish.pod:630 +#: ../src/guestfs.pod:491 ../fish/guestfish.pod:669 msgid "ENCRYPTED DISKS" msgstr "" # type: textblock -#: ../src/guestfs.pod:492 +#: ../src/guestfs.pod:493 msgid "" "Libguestfs allows you to access Linux guests which have been encrypted using " "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) " @@ -1004,21 +1005,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:498 +#: ../src/guestfs.pod:499 msgid "" "Use L to identify LUKS-encrypted block devices (it " "returns the string C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:501 +#: ../src/guestfs.pod:502 msgid "" "Then open these devices by calling L. Obviously you " "will require the passphrase!" msgstr "" # type: textblock -#: ../src/guestfs.pod:504 +#: ../src/guestfs.pod:505 msgid "" "Opening a LUKS device creates a new device mapper device called " "C (where C is the string you supply to " @@ -1027,7 +1028,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:510 +#: ../src/guestfs.pod:511 msgid "" "LVM volume groups on the device can be made visible by calling " "L followed by L. The logical " @@ -1035,7 +1036,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:514 +#: ../src/guestfs.pod:515 msgid "" "Use the reverse process to close a LUKS device. Unmount any logical volumes " "on it, deactivate the volume groups by caling C in the usual way." msgstr "" # type: textblock -#: ../src/guestfs.pod:532 +#: ../src/guestfs.pod:533 msgid "" "Then call L. This function uses other libguestfs calls " "and certain heuristics, and returns a list of operating systems that were " @@ -1080,7 +1081,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:541 +#: ../src/guestfs.pod:542 msgid "" "For each root, you can then call various C functions " "to get additional details about that operating system. For example, call " @@ -1089,7 +1090,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:547 +#: ../src/guestfs.pod:548 msgid "" "Un*x-like and Linux-based operating systems usually consist of several " "filesystems which are mounted at boot time (for example, a separate boot " @@ -1100,7 +1101,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:554 +#: ../src/guestfs.pod:555 #, no-wrap msgid "" " /boot => /dev/sda1\n" @@ -1110,14 +1111,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:558 +#: ../src/guestfs.pod:559 msgid "" "The caller can then make calls to L to mount the " "filesystems as suggested." msgstr "" # type: textblock -#: ../src/guestfs.pod:561 +#: ../src/guestfs.pod:562 msgid "" "Be careful to mount filesystems in the right order (eg. C before " "C). Sorting the keys of the hash by length, shortest first, should " @@ -1125,7 +1126,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:565 +#: ../src/guestfs.pod:566 msgid "" "Inspection currently only works for some common operating systems. " "Contributors are welcome to send patches for other operating systems that we " @@ -1133,7 +1134,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:569 +#: ../src/guestfs.pod:570 msgid "" "Encrypted disks must be opened before inspection. See L " "for more details. The L function just ignores any " @@ -1141,7 +1142,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:573 +#: ../src/guestfs.pod:574 msgid "" "A note on the implementation: The call L performs " "inspection and caches the results in the guest handle. Subsequent calls to " @@ -1151,19 +1152,19 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:580 +#: ../src/guestfs.pod:581 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:582 +#: ../src/guestfs.pod:583 msgid "" "Libguestfs can mount NTFS partitions. It does this using the " "L driver." msgstr "" # type: textblock -#: ../src/guestfs.pod:585 +#: ../src/guestfs.pod:586 msgid "" "DOS and Windows still use drive letters, and the filesystems are always " "treated as case insensitive by Windows itself, and therefore you might find " @@ -1173,7 +1174,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:591 +#: ../src/guestfs.pod:592 msgid "" "Drive letter mappings are outside the scope of libguestfs. You have to use " "libguestfs to read the appropriate Windows Registry and configuration files, " @@ -1182,21 +1183,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:596 +#: ../src/guestfs.pod:597 msgid "" "Replacing backslash characters with forward slash characters is also outside " "the scope of libguestfs, but something that you can easily do." msgstr "" # type: textblock -#: ../src/guestfs.pod:599 +#: ../src/guestfs.pod:600 msgid "" "Where we can help is in resolving the case insensitivity of paths. For " "this, call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:602 +#: ../src/guestfs.pod:603 msgid "" "Libguestfs also provides some help for decoding Windows Registry \"hive\" " "files, through the library C which is part of the libguestfs project " @@ -1207,19 +1208,19 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:610 +#: ../src/guestfs.pod:611 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:612 +#: ../src/guestfs.pod:613 msgid "" "Although we don't want to discourage you from using the C API, we will " "mention here that the same API is also available in other languages." msgstr "" # type: textblock -#: ../src/guestfs.pod:615 +#: ../src/guestfs.pod:616 msgid "" "The API is broadly identical in all supported languages. This means that " "the C call C is C<$g-Emount($path)> in Perl, " @@ -1228,14 +1229,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:621 +#: ../src/guestfs.pod:622 msgid "" "Error messages are automatically transformed into exceptions if the language " "supports it." msgstr "" # type: textblock -#: ../src/guestfs.pod:624 +#: ../src/guestfs.pod:625 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 " @@ -1243,36 +1244,36 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:630 +#: ../src/guestfs.pod:631 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:632 +#: ../src/guestfs.pod:633 msgid "" "You can use the I header file from C++ programs. The C++ API is " "identical to the C API. C++ classes and exceptions are not used." msgstr "" # type: =item -#: ../src/guestfs.pod:636 +#: ../src/guestfs.pod:637 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:638 +#: ../src/guestfs.pod:639 msgid "" "The C# bindings are highly experimental. Please read the warnings at the " "top of C." msgstr "" # type: =item -#: ../src/guestfs.pod:641 +#: ../src/guestfs.pod:642 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:643 +#: ../src/guestfs.pod:644 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 " @@ -1280,66 +1281,66 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:647 +#: ../src/guestfs.pod:648 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:649 +#: ../src/guestfs.pod:650 msgid "" "Full documentation is contained in the Javadoc which is distributed with " "libguestfs." msgstr "" # type: =item -#: ../src/guestfs.pod:652 +#: ../src/guestfs.pod:653 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:654 +#: ../src/guestfs.pod:655 msgid "For documentation see the file C." msgstr "" # type: =item -#: ../src/guestfs.pod:656 +#: ../src/guestfs.pod:657 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:658 +#: ../src/guestfs.pod:659 msgid "For documentation see L." msgstr "" # type: =item -#: ../src/guestfs.pod:660 +#: ../src/guestfs.pod:661 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:662 +#: ../src/guestfs.pod:663 msgid "" "For documentation see C supplied with libguestfs sources or in " "the php-libguestfs package for your distribution." msgstr "" # type: textblock -#: ../src/guestfs.pod:665 +#: ../src/guestfs.pod:666 msgid "The PHP binding only works correctly on 64 bit machines." msgstr "" # type: =item -#: ../src/guestfs.pod:667 +#: ../src/guestfs.pod:668 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:669 +#: ../src/guestfs.pod:670 msgid "For documentation do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:671 +#: ../src/guestfs.pod:672 #, no-wrap msgid "" " $ python\n" @@ -1349,34 +1350,34 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:675 +#: ../src/guestfs.pod:676 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:677 +#: ../src/guestfs.pod:678 msgid "" "Use the Guestfs module. There is no Ruby-specific documentation, but you " "can find examples written in Ruby in the libguestfs source." msgstr "" # type: =item -#: ../src/guestfs.pod:680 +#: ../src/guestfs.pod:681 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:682 +#: ../src/guestfs.pod:683 msgid "For documentation see L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:686 +#: ../src/guestfs.pod:687 msgid "LIBGUESTFS GOTCHAS" msgstr "" # type: textblock -#: ../src/guestfs.pod:688 +#: ../src/guestfs.pod:689 msgid "" "L: \"A feature of a " "system [...] that works in the way it is documented but is counterintuitive " @@ -1384,7 +1385,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:692 +#: ../src/guestfs.pod:693 msgid "" "Since we developed libguestfs and the associated tools, there are several " "things we would have designed differently, but are now stuck with for " @@ -1393,12 +1394,12 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:700 +#: ../src/guestfs.pod:701 msgid "Autosync / forgetting to sync." msgstr "" # type: textblock -#: ../src/guestfs.pod:702 +#: ../src/guestfs.pod:703 msgid "" "When modifying a filesystem from C or another language, you B unmount " "all filesystems and call L explicitly before you close the " @@ -1406,7 +1407,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:706 +#: ../src/guestfs.pod:707 #, no-wrap msgid "" " guestfs_set_autosync (g, 1);\n" @@ -1414,7 +1415,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:708 +#: ../src/guestfs.pod:709 msgid "" "to have the unmount/sync done automatically for you when the handle 'g' is " "closed. (This feature is called \"autosync\", L " @@ -1422,7 +1423,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:712 +#: ../src/guestfs.pod:713 msgid "" "If you forget to do this, then it is entirely possible that your changes " "won't be written out, or will be partially written, or (very rarely) that " @@ -1430,7 +1431,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:716 +#: ../src/guestfs.pod:717 msgid "" "Note that in L autosync is the default. So quick and dirty " "guestfish scripts that forget to sync will work just fine, which can make " @@ -1438,19 +1439,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:720 +#: ../src/guestfs.pod:721 msgid "" "Update: Autosync is enabled by default for all API users starting from " "libguestfs 1.5.24." msgstr "" # type: =item -#: ../src/guestfs.pod:723 +#: ../src/guestfs.pod:724 msgid "Mount option C<-o sync> should not be the default." msgstr "" # type: textblock -#: ../src/guestfs.pod:725 +#: ../src/guestfs.pod:726 msgid "" "If you use L, then C<-o sync,noatime> are added implicitly. " "However C<-o sync> does not add any reliability benefit, but does have a " @@ -1458,31 +1459,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:729 +#: ../src/guestfs.pod:730 msgid "" "The work around is to use L and set the mount " "options that you actually want to use." msgstr "" # type: =item -#: ../src/guestfs.pod:732 +#: ../src/guestfs.pod:733 msgid "Read-only should be the default." msgstr "" # type: textblock -#: ../src/guestfs.pod:734 +#: ../src/guestfs.pod:735 msgid "" "In L, I<--ro> should be the default, and you should have to " "specify I<--rw> if you want to make changes to the image." msgstr "" # type: textblock -#: ../src/guestfs.pod:737 +#: ../src/guestfs.pod:738 msgid "This would reduce the potential to corrupt live VM images." msgstr "" # type: textblock -#: ../src/guestfs.pod:739 +#: ../src/guestfs.pod:740 msgid "" "Note that many filesystems change the disk when you just mount and unmount, " "even if you didn't perform any writes. You need to use " @@ -1490,12 +1491,12 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:743 +#: ../src/guestfs.pod:744 msgid "guestfish command line is hard to use." msgstr "" # type: textblock -#: ../src/guestfs.pod:745 +#: ../src/guestfs.pod:746 msgid "" "C doesn't do what people expect (open C for " "examination). It tries to run a guestfish command C which doesn't " @@ -1505,12 +1506,12 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:752 +#: ../src/guestfs.pod:753 msgid "guestfish megabyte modifiers don't work right on all commands" msgstr "" # type: textblock -#: ../src/guestfs.pod:754 +#: ../src/guestfs.pod:755 msgid "" "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for " "other modifiers). What guestfish actually does is to multiply the number " @@ -1520,12 +1521,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:761 +#: ../src/guestfs.pod:762 msgid "The most common is L. The guestfish command:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:763 +#: ../src/guestfs.pod:764 #, no-wrap msgid "" " lvcreate LV VG 100M\n" @@ -1533,7 +1534,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:765 +#: ../src/guestfs.pod:766 msgid "" "does not do what you might expect. Instead because L is " "already expecting megabytes, this tries to create a 100 I (100 " @@ -1542,40 +1543,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:770 +#: ../src/guestfs.pod:771 msgid "" "This could be fixed in the generator by specially marking parameters and " "return values which take bytes or other units." msgstr "" # type: =item -#: ../src/guestfs.pod:773 -msgid "Library should return errno with error messages." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:775 -msgid "" -"It would be a nice-to-have to be able to get the original value of 'errno' " -"from inside the appliance along error paths (where set). Currently " -"L goes through hoops to try to reverse the error message " -"string into an errno, see the function error() in fuse/guestmount.c." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:781 -msgid "" -"In libguestfs 1.5.4, the protocol was changed so that the Linux errno is " -"sent back from the daemon." -msgstr "" - -# type: =item -#: ../src/guestfs.pod:784 +#: ../src/guestfs.pod:774 msgid "Ambiguity between devices and paths" msgstr "" # type: textblock -#: ../src/guestfs.pod:786 +#: ../src/guestfs.pod:776 msgid "" "There is a subtle ambiguity in the API between a device name " "(eg. C) and a similar pathname. A file might just happen to be " @@ -1583,7 +1563,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:791 +#: ../src/guestfs.pod:781 msgid "" "In the current API we usually resolve this ambiguity by having two separate " "calls, for example L and L. " @@ -1592,7 +1572,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:797 +#: ../src/guestfs.pod:787 msgid "" "To avoid both the ambiguity and the need to duplicate some calls, we could " "make paths/devices into structured names. One way to do this would be to " @@ -1602,7 +1582,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:803 +#: ../src/guestfs.pod:793 #, no-wrap msgid "" " type path = Path of string | Device of int | Partition of int * int\n" @@ -1610,12 +1590,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:805 +#: ../src/guestfs.pod:795 msgid "which would allow you to pass arguments like:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:807 +#: ../src/guestfs.pod:797 #, no-wrap msgid "" " Path \"/foo/bar\"\n" @@ -1626,19 +1606,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:812 +#: ../src/guestfs.pod:802 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:817 +#: ../src/guestfs.pod:807 msgid "PROTOCOL LIMITS" msgstr "" # type: textblock -#: ../src/guestfs.pod:819 +#: ../src/guestfs.pod:809 msgid "" "Internally libguestfs uses a message-based protocol to pass API calls and " "their responses to and from a small \"appliance\" (see L for " @@ -1649,7 +1629,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:827 +#: ../src/guestfs.pod:817 msgid "" "A simple call such as L returns its result (the file data) in " "a simple string. Because this string is at some point internally encoded as " @@ -1658,7 +1638,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:833 +#: ../src/guestfs.pod:823 msgid "" "In order to transfer large files into and out of the guest filesystem, you " "need to use particular calls that support this. The sections L " @@ -1666,26 +1646,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:837 +#: ../src/guestfs.pod:827 msgid "" "You might also consider mounting the disk image using our FUSE filesystem " "support (L)." msgstr "" # type: =head2 -#: ../src/guestfs.pod:840 +#: ../src/guestfs.pod:830 msgid "KEYS AND PASSPHRASES" msgstr "" # type: textblock -#: ../src/guestfs.pod:842 +#: ../src/guestfs.pod:832 msgid "" "Certain libguestfs calls take a parameter that contains sensitive key " "material, passed in as a C string." msgstr "" # type: textblock -#: ../src/guestfs.pod:845 +#: ../src/guestfs.pod:835 msgid "" "In the future we would hope to change the libguestfs implementation so that " "keys are L-ed into physical RAM, and thus can never end up in " @@ -1694,169 +1674,834 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:850 +#: ../src/guestfs.pod:840 msgid "" "Therefore you should be aware that any key parameter you pass to libguestfs " "might end up being written out to the swap partition. If this is a concern, " "scrub the swap partition or don't use libguestfs on encrypted devices." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:855 -msgid "CONNECTION MANAGEMENT" +# type: =head2 +#: ../src/guestfs.pod:845 +msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:847 +msgid "" +"All high-level libguestfs actions are synchronous. If you want to use " +"libguestfs asynchronously then you must create a thread." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:850 +msgid "" +"Only use the handle from a single thread. Either use the handle exclusively " +"from one thread, or provide your own mutex so that two threads cannot issue " +"calls on the same handle at the same time." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:854 +msgid "" +"See the graphical program guestfs-browser for one possible architecture for " +"multithreaded programs using libvirt and libguestfs." msgstr "" # type: =head2 #: ../src/guestfs.pod:857 -msgid "guestfs_h *" +msgid "PATH" msgstr "" # type: textblock #: ../src/guestfs.pod:859 msgid "" -"C is the opaque type representing a connection handle. Create a " -"handle by calling L. Call L to free the " -"handle and release all resources used." +"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " +"internal path." msgstr "" # type: textblock -#: ../src/guestfs.pod:863 +#: ../src/guestfs.pod:862 msgid "" -"For information on using multiple handles and threads, see the section " -"L below." +"By default it looks for these in the directory C<$libdir/guestfs> " +"(eg. C or C)." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:865 +msgid "" +"Use L or set the environment variable L " +"to change the directories that libguestfs will search in. The value is a " +"colon-separated list of paths. The current directory is I searched " +"unless the path contains an empty element or C<.>. For example " +"C would search the current directory and " +"then C." msgstr "" # type: =head2 -#: ../src/guestfs.pod:866 -msgid "guestfs_create" +#: ../src/guestfs.pod:872 +msgid "QEMU WRAPPERS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:874 +msgid "" +"If you want to compile your own qemu, run qemu from a non-standard location, " +"or pass extra arguments to qemu, then you can write a shell-script wrapper " +"around qemu." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:878 +msgid "" +"There is one important rule to remember: you I> as the " +"last command in the shell script (so that qemu replaces the shell and " +"becomes the direct child of the libguestfs-using program). If you don't do " +"this, then the qemu process won't be cleaned up correctly." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:883 +msgid "" +"Here is an example of a wrapper, where I have built my own copy of qemu from " +"source:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:868 +#: ../src/guestfs.pod:886 #, no-wrap msgid "" -" guestfs_h *guestfs_create (void);\n" +" #!/bin/sh -\n" +" qemudir=/home/rjones/d/qemu\n" +" exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios " +"\"$@\"\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:870 -msgid "Create a connection handle." +#: ../src/guestfs.pod:890 +msgid "" +"Save this script as C (or wherever), C, and " +"then use it by setting the LIBGUESTFS_QEMU environment variable. For " +"example:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:894 +#, no-wrap +msgid "" +" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:872 +#: ../src/guestfs.pod:896 msgid "" -"You have to call L (or one of the equivalent calls) " -"on the handle at least once." +"Note that libguestfs also calls qemu with the -help and -version options in " +"order to determine features." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:899 +msgid "ABI GUARANTEE" msgstr "" # type: textblock -#: ../src/guestfs.pod:875 +#: ../src/guestfs.pod:901 msgid "" -"This function returns a non-NULL pointer to a handle on success or NULL on " -"error." +"We guarantee the libguestfs ABI (binary interface), for public, high-level " +"actions as outlined in this section. Although we will deprecate some " +"actions, for example if they get replaced by newer calls, we will keep the " +"old actions forever. This allows you the developer to program in confidence " +"against the libguestfs API." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:907 +msgid "BLOCK DEVICE NAMING" msgstr "" # type: textblock -#: ../src/guestfs.pod:878 -msgid "After configuring the handle, you have to call L." +#: ../src/guestfs.pod:909 +msgid "" +"In the kernel there is now quite a profusion of schemata for naming block " +"devices (in this context, by I I mean a physical or virtual " +"hard drive). The original Linux IDE driver used names starting with " +"C. SCSI devices have historically used a different naming scheme, " +"C. When the Linux kernel I driver became a popular " +"replacement for the old IDE driver (particularly for SATA devices) those " +"devices also used the C scheme. Additionally we now have virtual " +"machines with paravirtualized drivers. This has created several different " +"naming systems, such as C for virtio disks and C for " +"Xen PV disks." msgstr "" # type: textblock -#: ../src/guestfs.pod:880 +#: ../src/guestfs.pod:921 msgid "" -"You may also want to configure error handling for the handle. See L section below." +"As discussed above, libguestfs uses a qemu appliance running an embedded " +"Linux kernel to access block devices. We can run a variety of appliances " +"based on a variety of Linux kernels." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:883 -msgid "guestfs_close" +# type: textblock +#: ../src/guestfs.pod:925 +msgid "" +"This causes a problem for libguestfs because many API calls use device or " +"partition names. Working scripts and the recipe (example) scripts that we " +"make available over the internet could fail if the naming scheme changes." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:885 -#, no-wrap +# type: textblock +#: ../src/guestfs.pod:930 msgid "" -" void guestfs_close (guestfs_h *g);\n" -"\n" +"Therefore libguestfs defines C as the I. " +"Internally C names are translated, if necessary, to other names as " +"required. For example, under RHEL 5 which uses the C scheme, any " +"device parameter C is translated to C transparently." msgstr "" # type: textblock -#: ../src/guestfs.pod:887 -msgid "This closes the connection handle and frees up all resources used." +#: ../src/guestfs.pod:936 +msgid "" +"Note that this I applies to parameters. The L, " +"L and similar calls return the true names of the " +"devices and partitions as known to the appliance." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:889 -msgid "ERROR HANDLING" +# type: =head3 +#: ../src/guestfs.pod:941 +msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:943 +msgid "" +"Usually this translation is transparent. However in some (very rare) cases " +"you may need to know the exact algorithm. Such cases include where you use " +"L to add a mixture of virtio and IDE devices to the " +"qemu-based appliance, so have a mixture of C and C " +"devices." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:949 +msgid "" +"The algorithm is applied only to I which are known to be either " +"device or partition names. Return values from functions such as " +"L are never changed." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:957 +msgid "Is the string a parameter which is a device or partition name?" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:961 +msgid "Does the string begin with C?" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:965 +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:970 +msgid "Replace initial C string with C." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:972 +msgid "For example, change C to C." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:974 +msgid "If that named device exists, use it. If not, continue." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:978 +msgid "Replace initial C string with C." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:980 +msgid "If that named device exists, use it. If not, return an error." +msgstr "" + +# type: =head3 +#: ../src/guestfs.pod:984 +msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:986 +msgid "" +"Although the standard naming scheme and automatic translation is useful for " +"simple programs and guestfish scripts, for larger programs it is best not to " +"rely on this mechanism." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:990 +msgid "" +"Where possible for maximum future portability programs using libguestfs " +"should use these future-proof techniques:" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:997 +msgid "" +"Use L or L to list actual " +"device names, and then use those names directly." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1000 +msgid "Since those device names exist by definition, they will never be translated." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1005 +msgid "" +"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " +"filesystem labels." +msgstr "" + +# type: =head1 +#: ../src/guestfs.pod:1010 +msgid "SECURITY" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1012 +msgid "" +"This section discusses security implications of using libguestfs, " +"particularly with untrusted or malicious guests or disk images." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1015 +msgid "GENERAL SECURITY CONSIDERATIONS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1017 +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 " +"command that reads files, filenames, directories or anything else from a " +"disk image). An attacker could manipulate the data to fool your program " +"into doing the wrong thing. Consider cases such as:" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1027 +msgid "the data (file etc) not being present" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1031 +msgid "being present but empty" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1035 +msgid "being much larger than normal" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1039 +msgid "containing arbitrary 8 bit data" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1043 +msgid "being in an unexpected character encoding" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1047 +msgid "containing homoglyphs." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1051 +msgid "SECURITY OF MOUNTING FILESYSTEMS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1053 +msgid "" +"When you mount a filesystem under Linux, mistakes in the kernel filesystem " +"(VFS) module can sometimes be escalated into exploits by deliberately " +"creating a malicious, malformed filesystem. These exploits are very severe " +"for two reasons. Firstly there are very many filesystem drivers in the " +"kernel, and many of them are infrequently used and not much developer " +"attention has been paid to the code. Linux userspace helps potential " +"crackers by detecting the filesystem type and automatically choosing the " +"right VFS driver, even if that filesystem type is obscure or unexpected for " +"the administrator. Secondly, a kernel-level exploit is like a local root " +"exploit (worse in some ways), giving immediate and total access to the " +"system right down to the hardware level." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1066 +msgid "" +"That explains why you should never mount a filesystem from an untrusted " +"guest on your host kernel. How about libguestfs? We run a Linux kernel " +"inside a qemu virtual machine, usually running as a non-root user. The " +"attacker would need to write a filesystem which first exploited the kernel, " +"and then exploited either qemu virtualization (eg. a faulty qemu driver) or " +"the libguestfs protocol, and finally to be as serious as the host kernel " +"exploit it would need to escalate its privileges to root. This multi-step " +"escalation, performed by a static piece of data, is thought to be extremely " +"hard to do, although we never say 'never' about security issues." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1077 +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:1080 +msgid "PROTOCOL SECURITY" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1082 +msgid "" +"The protocol is designed to be secure, being based on RFC 4506 (XDR) with a " +"defined upper message size. However a program that uses libguestfs must " +"also take care - for example you can write a program that downloads a binary " +"from a disk image and executes it locally, and no amount of protocol " +"security will save you from the consequences." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1088 +msgid "INSPECTION SECURITY" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1090 +msgid "" +"Parts of the inspection API (see L) return untrusted strings " +"directly from the guest, and these could contain any 8 bit data. Callers " +"should be careful to escape these before printing them to a structured file " +"(for example, use HTML escaping if creating a web page)." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1096 +msgid "" +"The inspection API parses guest configuration using two external libraries: " +"Augeas (Linux configuration) and hivex (Windows Registry). Both are " +"designed to be robust in the face of malicious data, although denial of " +"service attacks are still possible, for example with oversized configuration " +"files." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1102 +msgid "RUNNING UNTRUSTED GUEST COMMANDS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1104 +msgid "" +"Be very cautious about running commands from the guest. By running a " +"command in the guest, you are giving CPU time to a binary that you do not " +"control, under the same user account as the library, albeit wrapped in qemu " +"virtualization. More information and alternatives can be found in the " +"section L." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1110 +msgid "CVE-2010-3851" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1112 +msgid "https://bugzilla.redhat.com/642934" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1114 +msgid "" +"This security bug concerns the automatic disk format detection that qemu " +"does on disk images." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1117 +msgid "" +"A raw disk image is just the raw bytes, there is no header. Other disk " +"images like qcow2 contain a special header. Qemu deals with this by looking " +"for one of the known headers, and if none is found then assuming the disk " +"image must be raw." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1122 +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 " +"libguestfs) qemu would do autodetection and think the disk image format was, " +"say, qcow2 based on the header written by the guest." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1127 +msgid "" +"This in itself would not be a problem, but qcow2 offers many features, one " +"of which is to allow a disk image to refer to another image (called the " +"\"backing disk\"). It does this by placing the path to the backing disk " +"into the qcow2 header. This path is not validated and could point to any " +"host file (eg. \"/etc/passwd\"). The backing disk is then exposed through " +"\"holes\" in the qcow2 disk image, which of course is completely under the " +"control of the attacker." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1135 +msgid "In libguestfs this is rather hard to exploit except under two circumstances:" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1142 +msgid "You have enabled the network or have opened the disk in write mode." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1146 +msgid "" +"You are also running untrusted code from the guest (see L)." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1151 +msgid "" +"The way to avoid this is to specify the expected disk format when adding " +"disks (the optional C option to L). You " +"should always do this if the disk is raw format, and it's a good idea for " +"other cases too." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1156 +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:1159 +msgid "" +"For libguestfs tools, use the I<--format> command line parameter as " +"appropriate." +msgstr "" + +# type: =head1 +#: ../src/guestfs.pod:1162 +msgid "CONNECTION MANAGEMENT" +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1164 +msgid "guestfs_h *" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1166 +msgid "" +"C is the opaque type representing a connection handle. Create a " +"handle by calling L. Call L to free the " +"handle and release all resources used." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1170 +msgid "" +"For information on using multiple handles and threads, see the section " +"L below." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1173 +msgid "guestfs_create" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1175 +#, no-wrap +msgid "" +" guestfs_h *guestfs_create (void);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1177 +msgid "Create a connection handle." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1179 +msgid "" +"You have to call L (or one of the equivalent calls) " +"on the handle at least once." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1182 +msgid "" +"This function returns a non-NULL pointer to a handle on success or NULL on " +"error." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1185 +msgid "After configuring the handle, you have to call L." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1187 +msgid "" +"You may also want to configure error handling for the handle. See L section below." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1190 +msgid "guestfs_close" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1192 +#, no-wrap +msgid "" +" void guestfs_close (guestfs_h *g);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1194 +msgid "This closes the connection handle and frees up all resources used." +msgstr "" + +# type: =head1 +#: ../src/guestfs.pod:1196 +msgid "ERROR HANDLING" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1198 +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:1201 +msgid "" +"Additional information is available for errors: an error message string and " +"optionally an error number (errno) if the thing that failed was a system " +"call." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1205 +msgid "" +"You can get at the additional information about the last error on the handle " +"by calling L, L, and/or by setting " +"up an error handler with L." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1210 +msgid "" +"When the handle is created, a default error handler is installed which " +"prints the error message string to C. For small short-running " +"command line programs it is sufficient to do:" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1214 +#, no-wrap +msgid "" +" if (guestfs_launch (g) == -1)\n" +" exit (EXIT_FAILURE);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1217 +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:1220 +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:1223 +#, no-wrap +msgid "" +" g = guestfs_create ();\n" +" \n" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1225 +#, no-wrap +msgid "" +" /* This disables the default behaviour of printing errors\n" +" on stderr. */\n" +" guestfs_set_error_handler (g, NULL, NULL);\n" +" \n" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1229 +#, no-wrap +msgid "" +" if (guestfs_launch (g) == -1) {\n" +" /* Examine the error message and print it etc. */\n" +" char *msg = guestfs_last_error (g);\n" +" int errnum = guestfs_last_errno (g);\n" +" fprintf (stderr, \"%s\\n\", msg);\n" +" /* ... */\n" +" }\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1237 +msgid "" +"Out of memory errors are handled differently. The default action is to call " +"L. If this is undesirable, then you can set a handler using " +"L." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1241 +msgid "" +"L returns C if the handle cannot be created, and " +"because there is no handle if this happens there is no way to get additional " +"error information. However L is supposed to be a " +"lightweight operation which can only fail because of insufficient memory (it " +"returns NULL in this case)." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1247 +msgid "guestfs_last_error" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1249 +#, no-wrap +msgid "" +" const char *guestfs_last_error (guestfs_h *g);\n" +"\n" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1251 +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:1255 +msgid "" +"The lifetime of the returned string is until the next error occurs, or " +"L is called." +msgstr "" + +# type: =head2 +#: ../src/guestfs.pod:1258 +msgid "guestfs_last_errno" msgstr "" -# type: textblock -#: ../src/guestfs.pod:891 +# type: verbatim +#: ../src/guestfs.pod:1260 +#, no-wrap msgid "" -"The convention in all functions that return C is that they return C<-1> " -"to indicate an error. You can get additional information on errors by " -"calling L and/or by setting up an error handler with " -"L." +" int guestfs_last_errno (guestfs_h *g);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:896 -msgid "The default error handler prints the information string to C." +#: ../src/guestfs.pod:1262 +msgid "This returns the last error number (errno) that happened on C." msgstr "" # type: textblock -#: ../src/guestfs.pod:898 -msgid "" -"Out of memory errors are handled differently. The default action is to call " -"L. If this is undesirable, then you can set a handler using " -"L." +#: ../src/guestfs.pod:1264 +msgid "If successful, an errno integer not equal to zero is returned." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:902 -msgid "guestfs_last_error" +# type: textblock +#: ../src/guestfs.pod:1266 +msgid "If no error, this returns 0. This call can return 0 in three situations:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:904 -#, no-wrap -msgid "" -" const char *guestfs_last_error (guestfs_h *g);\n" -"\n" +# type: textblock +#: ../src/guestfs.pod:1273 +msgid "There has not been any error on the handle." msgstr "" # type: textblock -#: ../src/guestfs.pod:906 +#: ../src/guestfs.pod:1277 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." +"There has been an error but the errno was meaningless. This corresponds to " +"the case where the error did not come from a failed system call, but for " +"some other reason." msgstr "" # type: textblock -#: ../src/guestfs.pod:910 +#: ../src/guestfs.pod:1283 msgid "" -"The lifetime of the returned string is until the next error occurs, or " -"L is called." +"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:913 +#: ../src/guestfs.pod:1289 msgid "" -"The error string is not localized (ie. is always in English), because this " -"makes searching for error messages in search engines give the largest number " -"of results." +"Libguestfs tries to convert the errno from inside the applicance into a " +"corresponding errno for the caller (not entirely trivial: the appliance " +"might be running a completely different operating system from the library " +"and error numbers are not standardized across Un*xen). If this could not be " +"done, then the error is translated to C. In practice this should " +"only happen in very rare circumstances." msgstr "" # type: =head2 -#: ../src/guestfs.pod:917 +#: ../src/guestfs.pod:1297 msgid "guestfs_set_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:919 +#: ../src/guestfs.pod:1299 #, no-wrap msgid "" " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" @@ -1869,7 +2514,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:926 +#: ../src/guestfs.pod:1306 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 " @@ -1877,7 +2522,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:930 +#: ../src/guestfs.pod:1310 +msgid "" +"C is not passed to the callback. To get that the callback must call " +"L." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:1313 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 " @@ -1885,22 +2537,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:934 +#: ../src/guestfs.pod:1317 msgid "The default handler prints messages on C." msgstr "" # type: textblock -#: ../src/guestfs.pod:936 +#: ../src/guestfs.pod:1319 msgid "If you set C to C then I handler is called." msgstr "" # type: =head2 -#: ../src/guestfs.pod:938 +#: ../src/guestfs.pod:1321 msgid "guestfs_get_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:940 +#: ../src/guestfs.pod:1323 #, no-wrap msgid "" " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" @@ -1909,17 +2561,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:943 +#: ../src/guestfs.pod:1326 msgid "Returns the current error handler callback." msgstr "" # type: =head2 -#: ../src/guestfs.pod:945 +#: ../src/guestfs.pod:1328 msgid "guestfs_set_out_of_memory_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:947 +#: ../src/guestfs.pod:1330 #, no-wrap msgid "" " typedef void (*guestfs_abort_cb) (void);\n" @@ -1929,29 +2581,29 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:951 +#: ../src/guestfs.pod:1334 msgid "" "The callback C will be called if there is an out of memory situation. " "I." msgstr "" # type: textblock -#: ../src/guestfs.pod:954 +#: ../src/guestfs.pod:1337 msgid "The default is to call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:956 +#: ../src/guestfs.pod:1339 msgid "You cannot set C to C. You can't ignore out of memory situations." msgstr "" # type: =head2 -#: ../src/guestfs.pod:959 +#: ../src/guestfs.pod:1342 msgid "guestfs_get_out_of_memory_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:961 +#: ../src/guestfs.pod:1344 #, no-wrap msgid "" " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" @@ -1959,87 +2611,42 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:963 +#: ../src/guestfs.pod:1346 msgid "This returns the current out of memory handler." msgstr "" # type: =head1 -#: ../src/guestfs.pod:965 -msgid "PATH" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:967 -msgid "" -"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " -"internal path." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:970 -msgid "" -"By default it looks for these in the directory C<$libdir/guestfs> " -"(eg. C or C)." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:973 -msgid "" -"Use L or set the environment variable L " -"to change the directories that libguestfs will search in. The value is a " -"colon-separated list of paths. The current directory is I searched " -"unless the path contains an empty element or C<.>. For example " -"C would search the current directory and " -"then C." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:980 -msgid "HIGH-LEVEL API ACTIONS" -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:982 -msgid "ABI GUARANTEE" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:984 -msgid "" -"We guarantee the libguestfs ABI (binary interface), for public, high-level " -"actions as outlined in this section. Although we will deprecate some " -"actions, for example if they get replaced by newer calls, we will keep the " -"old actions forever. This allows you the developer to program in confidence " -"against the libguestfs API." +#: ../src/guestfs.pod:1348 +msgid "API CALLS" msgstr "" # type: textblock -#: ../src/guestfs.pod:990 ../fish/guestfish.pod:860 +#: ../src/guestfs.pod:1350 ../fish/guestfish.pod:907 msgid "@ACTIONS@" msgstr "" # type: =head1 -#: ../src/guestfs.pod:992 +#: ../src/guestfs.pod:1352 msgid "STRUCTURES" msgstr "" # type: textblock -#: ../src/guestfs.pod:994 +#: ../src/guestfs.pod:1354 msgid "@STRUCTS@" msgstr "" # type: =head1 -#: ../src/guestfs.pod:996 +#: ../src/guestfs.pod:1356 msgid "AVAILABILITY" msgstr "" # type: =head2 -#: ../src/guestfs.pod:998 +#: ../src/guestfs.pod:1358 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1000 +#: ../src/guestfs.pod:1360 msgid "" "Using L you can test availability of the following " "groups of functions. This test queries the appliance to see if the " @@ -2047,17 +2654,17 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1005 +#: ../src/guestfs.pod:1365 msgid "@AVAILABILITY@" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1007 +#: ../src/guestfs.pod:1367 msgid "GUESTFISH supported COMMAND" msgstr "" # type: textblock -#: ../src/guestfs.pod:1009 +#: ../src/guestfs.pod:1369 msgid "" "In L there is a handy interactive command C which " "prints out the available groups and whether they are supported by this build " @@ -2065,19 +2672,19 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1014 +#: ../src/guestfs.pod:1374 msgid "SINGLE CALLS AT COMPILE TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:1016 +#: ../src/guestfs.pod:1376 msgid "" "Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " "function, such as:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1019 +#: ../src/guestfs.pod:1379 #, no-wrap msgid "" " #define LIBGUESTFS_HAVE_DD 1\n" @@ -2085,12 +2692,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1021 +#: ../src/guestfs.pod:1381 msgid "if L is available." msgstr "" # type: textblock -#: ../src/guestfs.pod:1023 +#: ../src/guestfs.pod:1383 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 " @@ -2098,7 +2705,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1028 +#: ../src/guestfs.pod:1388 #, no-wrap msgid "" " AC_CHECK_LIB([guestfs],[guestfs_create])\n" @@ -2107,19 +2714,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1031 +#: ../src/guestfs.pod:1391 msgid "" "which would result in C being either defined or not defined " "in your program." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1034 +#: ../src/guestfs.pod:1394 msgid "SINGLE CALLS AT RUN TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:1036 +#: ../src/guestfs.pod:1396 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 " @@ -2129,7 +2736,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1043 +#: ../src/guestfs.pod:1403 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 " @@ -2137,7 +2744,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1047 +#: ../src/guestfs.pod:1407 #, no-wrap msgid "" " #include \n" @@ -2149,7 +2756,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1053 +#: ../src/guestfs.pod:1413 #, no-wrap msgid "" " main ()\n" @@ -2161,7 +2768,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1059 +#: ../src/guestfs.pod:1419 #, no-wrap msgid "" " /* Test if the function guestfs_dd is really available. */\n" @@ -2176,7 +2783,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1068 +#: ../src/guestfs.pod:1428 #, no-wrap msgid "" " if (!has_function)\n" @@ -2195,7 +2802,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1081 +#: ../src/guestfs.pod:1441 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 " @@ -2203,7 +2810,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1086 +#: ../src/guestfs.pod:1446 #, no-wrap msgid "" " Requires: libguestfs >= 1.0.80\n" @@ -2211,12 +2818,12 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1088 +#: ../src/guestfs.pod:1448 msgid "CALLS WITH OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1090 +#: ../src/guestfs.pod:1450 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 " @@ -2224,7 +2831,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1095 +#: ../src/guestfs.pod:1455 #, no-wrap msgid "" " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" @@ -2232,14 +2839,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1097 +#: ../src/guestfs.pod:1457 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:1100 +#: ../src/guestfs.pod:1460 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename, -1);\n" @@ -2247,12 +2854,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1102 +#: ../src/guestfs.pod:1462 msgid "With a single optional argument:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1104 +#: ../src/guestfs.pod:1464 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -2262,12 +2869,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1108 +#: ../src/guestfs.pod:1468 msgid "With two:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1110 +#: ../src/guestfs.pod:1470 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -2278,19 +2885,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1115 +#: ../src/guestfs.pod:1475 msgid "" "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " "happen!" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1118 +#: ../src/guestfs.pod:1478 msgid "USING va_list FOR OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1120 +#: ../src/guestfs.pod:1480 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 " @@ -2298,7 +2905,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1124 +#: ../src/guestfs.pod:1484 #, no-wrap msgid "" " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" @@ -2307,292 +2914,122 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1127 +#: ../src/guestfs.pod:1487 msgid "CONSTRUCTING OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1129 +#: ../src/guestfs.pod:1489 msgid "" "The third variant is useful where you need to construct these calls. You " "pass in a structure where you fill in the optional fields. The structure " -"has a bitmask as the first element which you must set to indicate which " -"fields you have filled in. For our example function the structure and call " -"are declared:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:1135 -#, no-wrap -msgid "" -" struct guestfs_add_drive_opts_argv {\n" -" uint64_t bitmask;\n" -" int readonly;\n" -" const char *format;\n" -" /* ... */\n" -" };\n" -" int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n" -" const struct guestfs_add_drive_opts_argv *optargs);\n" -"\n" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1144 -msgid "You could call it like this:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:1146 -#, no-wrap -msgid "" -" struct guestfs_add_drive_opts_argv optargs = {\n" -" .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n" -" .readonly = 1,\n" -" .format = \"qcow2\"\n" -" };\n" -" \n" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:1153 -#, no-wrap -msgid "" -" guestfs_add_drive_opts_argv (g, filename, &optargs);\n" -"\n" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1155 ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1244 -msgid "Notes:" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1161 -msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1166 -msgid "You do not need to fill in all fields of the structure." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1170 -msgid "" -"There must be a one-to-one correspondence between fields of the structure " -"that are filled in, and bits set in the bitmask." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1175 -msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1177 -msgid "" -"In other languages, optional arguments are expressed in the way that is " -"natural for that language. We refer you to the language-specific " -"documentation for more details on that." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1181 -msgid "For guestfish, see L." -msgstr "" - -# type: =end -#: ../src/guestfs.pod:1183 ../src/guestfs.pod:1188 -msgid "html" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1185 -msgid "" -" " -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1190 -msgid "ARCHITECTURE" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1192 -msgid "" -"Internally, libguestfs is implemented by running an appliance (a special " -"type of small virtual machine) using L. Qemu runs as a child " -"process of the main program." -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:1196 -#, no-wrap -msgid "" -" ___________________\n" -" / \\\n" -" | main program |\n" -" | |\n" -" | | child process / appliance\n" -" | | __________________________\n" -" | | / qemu \\\n" -" +-------------------+ RPC | +-----------------+ |\n" -" | libguestfs <--------------------> guestfsd | |\n" -" | | | +-----------------+ |\n" -" \\___________________/ | | Linux kernel | |\n" -" | +--^--------------+ |\n" -" \\_________|________________/\n" -" |\n" -" _______v______\n" -" / \\\n" -" | Device or |\n" -" | disk image |\n" -" \\______________/\n" -"\n" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1216 -msgid "" -"The library, linked to the main program, creates the child process and hence " -"the appliance in the L function." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1219 -msgid "" -"Inside the appliance is a Linux kernel and a complete stack of userspace " -"tools (such as LVM and ext2 programs) and a small controlling daemon called " -"L. The library talks to L using remote procedure " -"calls (RPC). There is a mostly one-to-one correspondence between libguestfs " -"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:1228 -msgid "" -"A common misunderstanding is that the appliance \"is\" the virtual machine. " -"Although the disk image you are attached to might also be used by some " -"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)." +"has a bitmask as the first element which you must set to indicate which " +"fields you have filled in. For our example function the structure and call " +"are declared:" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1235 -msgid "STATE MACHINE" +# type: verbatim +#: ../src/guestfs.pod:1495 +#, no-wrap +msgid "" +" struct guestfs_add_drive_opts_argv {\n" +" uint64_t bitmask;\n" +" int readonly;\n" +" const char *format;\n" +" /* ... */\n" +" };\n" +" int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n" +" const struct guestfs_add_drive_opts_argv *optargs);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1237 -msgid "libguestfs uses a state machine to model the child process:" +#: ../src/guestfs.pod:1504 +msgid "You could call it like this:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1239 +#: ../src/guestfs.pod:1506 #, 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" +" struct guestfs_add_drive_opts_argv optargs = {\n" +" .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n" +" GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n" +" .readonly = 1,\n" +" .format = \"qcow2\"\n" +" };\n" +" \n" +msgstr "" + +# type: verbatim +#: ../src/guestfs.pod:1513 +#, no-wrap +msgid "" +" guestfs_add_drive_opts_argv (g, filename, &optargs);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:1261 -msgid "" -"The normal transitions are (1) CONFIG (when the handle is created, but there " -"is no child process), (2) LAUNCHING (when the child process is booting up), " -"(3) alternating between READY and BUSY as commands are issued to, and " -"carried out by, the child process." +#: ../src/guestfs.pod:1515 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255 +msgid "Notes:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1266 -msgid "" -"The guest may be killed by L, or may die " -"asynchronously at any time (eg. due to some internal error), and that causes " -"the state to transition back to CONFIG." +#: ../src/guestfs.pod:1521 +msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." msgstr "" # type: textblock -#: ../src/guestfs.pod:1270 -msgid "" -"Configuration commands for qemu such as L can only be " -"issued when in the CONFIG state." +#: ../src/guestfs.pod:1526 +msgid "You do not need to fill in all fields of the structure." msgstr "" # type: textblock -#: ../src/guestfs.pod:1273 +#: ../src/guestfs.pod:1530 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." +"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:1535 +msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:1279 +#: ../src/guestfs.pod:1537 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." +"In other languages, optional arguments are expressed in the way that is " +"natural for that language. We refer you to the language-specific " +"documentation for more details on that." msgstr "" # type: textblock -#: ../src/guestfs.pod:1285 -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." +#: ../src/guestfs.pod:1541 +msgid "For guestfish, see L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1289 +#: ../src/guestfs.pod:1543 msgid "SETTING CALLBACKS TO HANDLE EVENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1291 +#: ../src/guestfs.pod:1545 msgid "" "The child process generates events in some situations. Current events " "include: receiving a log message, the child process exits." msgstr "" # type: textblock -#: ../src/guestfs.pod:1294 +#: ../src/guestfs.pod:1548 msgid "" "Use the C functions to set a callback for different " "types of events." msgstr "" # type: textblock -#: ../src/guestfs.pod:1297 +#: ../src/guestfs.pod:1551 msgid "" "Only I can be registered for each handle. " "Calling C again overwrites the previous callback of " @@ -2601,12 +3038,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1302 +#: ../src/guestfs.pod:1556 msgid "guestfs_set_log_message_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1304 +#: ../src/guestfs.pod:1558 #, no-wrap msgid "" " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n" @@ -2618,31 +3055,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1310 +#: ../src/guestfs.pod:1564 msgid "" "The callback function C will be called whenever qemu or the guest writes " "anything to the console." msgstr "" # type: textblock -#: ../src/guestfs.pod:1313 +#: ../src/guestfs.pod:1567 msgid "Use this function to capture kernel messages and similar." msgstr "" # type: textblock -#: ../src/guestfs.pod:1315 +#: ../src/guestfs.pod:1569 msgid "" "Normally there is no log message handler, and log messages are just " "discarded." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1318 +#: ../src/guestfs.pod:1572 msgid "guestfs_set_subprocess_quit_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1320 +#: ../src/guestfs.pod:1574 #, no-wrap msgid "" " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n" @@ -2653,7 +3090,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1325 +#: ../src/guestfs.pod:1579 msgid "" "The callback function C will be called when the child process quits, " "either asynchronously or if killed by L. (This " @@ -2661,12 +3098,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1330 +#: ../src/guestfs.pod:1584 msgid "guestfs_set_launch_done_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1332 +#: ../src/guestfs.pod:1586 #, no-wrap msgid "" " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n" @@ -2677,7 +3114,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1337 +#: ../src/guestfs.pod:1591 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 " @@ -2685,12 +3122,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1341 +#: ../src/guestfs.pod:1595 msgid "guestfs_set_close_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1343 +#: ../src/guestfs.pod:1597 #, no-wrap msgid "" " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n" @@ -2701,14 +3138,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1348 +#: ../src/guestfs.pod:1602 msgid "" "The callback function C will be called while the handle is being closed " "(synchronously from L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1351 +#: ../src/guestfs.pod:1605 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 " @@ -2719,12 +3156,12 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1359 +#: ../src/guestfs.pod:1613 msgid "guestfs_set_progress_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1361 +#: ../src/guestfs.pod:1615 #, no-wrap msgid "" " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n" @@ -2737,7 +3174,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1368 +#: ../src/guestfs.pod:1622 msgid "" "Some long-running operations can generate progress messages. If this " "callback is registered, then it will be called each time a progress message " @@ -2747,7 +3184,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1374 +#: ../src/guestfs.pod:1628 msgid "" "The callback receives two numbers: C and C. The units of " "C are not defined, although for some operations C may relate " @@ -2756,31 +3193,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1380 +#: ../src/guestfs.pod:1634 msgid "The only defined and stable parts of the API are:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1386 +#: ../src/guestfs.pod:1640 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:1391 +#: ../src/guestfs.pod:1645 msgid "0 E= C E= C" msgstr "" # type: textblock -#: ../src/guestfs.pod:1395 +#: ../src/guestfs.pod:1649 msgid "" "If any progress notification is sent during a call, then a final progress " "notification is always sent when C = C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1398 +#: ../src/guestfs.pod:1652 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 " @@ -2788,7 +3225,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1404 +#: ../src/guestfs.pod:1658 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 " @@ -2797,12 +3234,12 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1409 +#: ../src/guestfs.pod:1663 msgid "PRIVATE DATA AREA" msgstr "" # type: textblock -#: ../src/guestfs.pod:1411 +#: ../src/guestfs.pod:1665 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 " @@ -2810,12 +3247,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1415 +#: ../src/guestfs.pod:1669 msgid "To attach a named piece of data, use the following call:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1417 +#: ../src/guestfs.pod:1671 #, no-wrap msgid "" " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" @@ -2823,7 +3260,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1419 +#: ../src/guestfs.pod:1673 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 " @@ -2831,7 +3268,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1423 +#: ../src/guestfs.pod:1677 msgid "" "You can use any C you want, but names beginning with an underscore " "character are reserved for internal libguestfs purposes (for implementing " @@ -2840,12 +3277,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1428 +#: ../src/guestfs.pod:1682 msgid "To retrieve the pointer, use:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1430 +#: ../src/guestfs.pod:1684 #, no-wrap msgid "" " void *guestfs_get_private (guestfs_h *g, const char *key);\n" @@ -2853,7 +3290,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1432 +#: ../src/guestfs.pod:1686 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 " @@ -2861,7 +3298,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1436 +#: ../src/guestfs.pod:1690 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 " @@ -2873,188 +3310,201 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1444 +#: ../src/guestfs.pod:1698 msgid "" "The private data area is implemented using a hash table, and should be " "reasonably efficient for moderate numbers of keys." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1447 -msgid "BLOCK DEVICE NAMING" +# type: =end +#: ../src/guestfs.pod:1701 ../src/guestfs.pod:1706 +msgid "html" msgstr "" # type: textblock -#: ../src/guestfs.pod:1449 +#: ../src/guestfs.pod:1703 msgid "" -"In the kernel there is now quite a profusion of schemata for naming block " -"devices (in this context, by I I mean a physical or virtual " -"hard drive). The original Linux IDE driver used names starting with " -"C. SCSI devices have historically used a different naming scheme, " -"C. When the Linux kernel I driver became a popular " -"replacement for the old IDE driver (particularly for SATA devices) those " -"devices also used the C scheme. Additionally we now have virtual " -"machines with paravirtualized drivers. This has created several different " -"naming systems, such as C for virtio disks and C for " -"Xen PV disks." +" " msgstr "" -# type: textblock -#: ../src/guestfs.pod:1461 -msgid "" -"As discussed above, libguestfs uses a qemu appliance running an embedded " -"Linux kernel to access block devices. We can run a variety of appliances " -"based on a variety of Linux kernels." +# type: =head1 +#: ../src/guestfs.pod:1708 +msgid "ARCHITECTURE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1465 +#: ../src/guestfs.pod:1710 msgid "" -"This causes a problem for libguestfs because many API calls use device or " -"partition names. Working scripts and the recipe (example) scripts that we " -"make available over the internet could fail if the naming scheme changes." +"Internally, libguestfs is implemented by running an appliance (a special " +"type of small virtual machine) using L. Qemu runs as a child " +"process of the main program." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1470 +# type: verbatim +#: ../src/guestfs.pod:1714 +#, no-wrap msgid "" -"Therefore libguestfs defines C as the I. " -"Internally C names are translated, if necessary, to other names as " -"required. For example, under RHEL 5 which uses the C scheme, any " -"device parameter C is translated to C transparently." +" ___________________\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:1476 +#: ../src/guestfs.pod:1734 msgid "" -"Note that this I applies to parameters. The L, " -"L and similar calls return the true names of the " -"devices and partitions as known to the appliance." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1481 -msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" +"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:1483 +#: ../src/guestfs.pod:1737 msgid "" -"Usually this translation is transparent. However in some (very rare) cases " -"you may need to know the exact algorithm. Such cases include where you use " -"L to add a mixture of virtio and IDE devices to the " -"qemu-based appliance, so have a mixture of C and C " -"devices." +"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:1489 +#: ../src/guestfs.pod:1746 msgid "" -"The algorithm is applied only to I which are known to be either " -"device or partition names. Return values from functions such as " -"L are never changed." +"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: textblock -#: ../src/guestfs.pod:1497 -msgid "Is the string a parameter which is a device or partition name?" +# type: =head1 +#: ../src/guestfs.pod:1753 +msgid "STATE MACHINE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1501 -msgid "Does the string begin with C?" +#: ../src/guestfs.pod:1755 +msgid "libguestfs uses a state machine to model the child process:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1505 +# type: verbatim +#: ../src/guestfs.pod:1757 +#, no-wrap 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:1510 -msgid "Replace initial C string with C." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1512 -msgid "For example, change C to C." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1514 -msgid "If that named device exists, use it. If not, continue." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1518 -msgid "Replace initial C string with C." +" |\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:1520 -msgid "If that named device exists, use it. If not, return an error." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1524 -msgid "PORTABILITY CONCERNS" +#: ../src/guestfs.pod:1779 +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:1526 +#: ../src/guestfs.pod:1784 msgid "" -"Although the standard naming scheme and automatic translation is useful for " -"simple programs and guestfish scripts, for larger programs it is best not to " -"rely on this mechanism." +"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:1530 +#: ../src/guestfs.pod:1788 msgid "" -"Where possible for maximum future portability programs using libguestfs " -"should use these future-proof techniques:" +"Configuration commands for qemu such as L can only be " +"issued when in the CONFIG state." msgstr "" # type: textblock -#: ../src/guestfs.pod:1537 +#: ../src/guestfs.pod:1791 msgid "" -"Use L or L to list actual " -"device names, and then use those names directly." +"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:1540 -msgid "Since those device names exist by definition, they will never be translated." +#: ../src/guestfs.pod:1797 +msgid "" +"API actions such as L can only be issued when in the READY " +"state. These API calls block waiting for the command to be carried out " +"(ie. the state to transition to BUSY and then back to READY). There are no " +"non-blocking versions, and no way to issue more than one command per handle " +"at the same time." msgstr "" # type: textblock -#: ../src/guestfs.pod:1545 +#: ../src/guestfs.pod:1803 msgid "" -"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " -"filesystem labels." +"Finally, the child process sends asynchronous messages back to the main " +"program, such as kernel log messages. You can register a callback to " +"receive these messages." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1550 +#: ../src/guestfs.pod:1807 msgid "INTERNALS" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1552 +#: ../src/guestfs.pod:1809 msgid "COMMUNICATION PROTOCOL" msgstr "" # type: textblock -#: ../src/guestfs.pod:1554 +#: ../src/guestfs.pod:1811 msgid "" "Don't rely on using this protocol directly. This section documents how it " "currently works, but it may change at any time." msgstr "" # type: textblock -#: ../src/guestfs.pod:1557 +#: ../src/guestfs.pod:1814 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 " @@ -3062,14 +3512,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1561 +#: ../src/guestfs.pod:1818 msgid "" "The detailed format of structures is in C (note: " "this file is automatically generated)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1564 +#: ../src/guestfs.pod:1821 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 " @@ -3079,17 +3529,17 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1571 +#: ../src/guestfs.pod:1828 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" msgstr "" # type: textblock -#: ../src/guestfs.pod:1573 +#: ../src/guestfs.pod:1830 msgid "For ordinary functions, the request message is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1575 +#: ../src/guestfs.pod:1832 #, no-wrap msgid "" " total length (header + arguments,\n" @@ -3100,7 +3550,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1580 +#: ../src/guestfs.pod:1837 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 " @@ -3109,26 +3559,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1586 +#: ../src/guestfs.pod:1843 msgid "" "Note also that many functions don't take any arguments, in which case the " "C_args> is completely omitted." msgstr "" # type: textblock -#: ../src/guestfs.pod:1589 +#: ../src/guestfs.pod:1846 msgid "" "The header contains the procedure number (C) which is how the " "receiver knows what type of args structure to expect, or none at all." msgstr "" # type: textblock -#: ../src/guestfs.pod:1593 +#: ../src/guestfs.pod:1850 msgid "The reply message for ordinary functions is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1595 +#: ../src/guestfs.pod:1852 #, no-wrap msgid "" " total length (header + ret,\n" @@ -3139,26 +3589,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1600 +#: ../src/guestfs.pod:1857 msgid "" "As above the C_ret> structure may be completely omitted for " "functions that return no formal return values." msgstr "" # type: textblock -#: ../src/guestfs.pod:1603 +#: ../src/guestfs.pod:1860 msgid "As above the total length of the reply is limited to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1606 +#: ../src/guestfs.pod:1863 msgid "" "In the case of an error, a flag is set in the header, and the reply message " "is slightly changed:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1609 +#: ../src/guestfs.pod:1866 #, no-wrap msgid "" " total length (header + error,\n" @@ -3169,19 +3619,19 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1614 +#: ../src/guestfs.pod:1871 msgid "" "The C structure contains the error message as a " "string." msgstr "" # type: =head3 -#: ../src/guestfs.pod:1617 +#: ../src/guestfs.pod:1874 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1619 +#: ../src/guestfs.pod:1876 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 " @@ -3189,7 +3639,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1623 +#: ../src/guestfs.pod:1880 #, no-wrap msgid "" " total length (header + arguments,\n" @@ -3203,12 +3653,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1631 +#: ../src/guestfs.pod:1888 msgid "The \"sequence of chunks\" is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1633 +#: ../src/guestfs.pod:1890 #, no-wrap msgid "" " length of chunk (not including length word itself)\n" @@ -3222,7 +3672,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1641 +#: ../src/guestfs.pod:1898 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 " @@ -3230,7 +3680,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1645 +#: ../src/guestfs.pod:1902 msgid "" "At time of writing there are no functions that have more than one FileIn " "parameter. However this is (theoretically) supported, by sending the " @@ -3239,7 +3689,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1650 +#: ../src/guestfs.pod:1907 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 " @@ -3248,7 +3698,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1656 +#: ../src/guestfs.pod:1913 msgid "" "The daemon may also cancel. It does this by writing a special word " "C to the socket. The library listens for this during " @@ -3260,7 +3710,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1665 +#: ../src/guestfs.pod:1922 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 " @@ -3270,19 +3720,19 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1671 +#: ../src/guestfs.pod:1928 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1673 +#: ../src/guestfs.pod:1930 msgid "" "The protocol for FileOut parameters is exactly the same as for FileIn " "parameters, but with the roles of daemon and library reversed." msgstr "" # type: verbatim -#: ../src/guestfs.pod:1676 +#: ../src/guestfs.pod:1933 #, no-wrap msgid "" " total length (header + ret,\n" @@ -3296,12 +3746,12 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1684 +#: ../src/guestfs.pod:1941 msgid "INITIAL MESSAGE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1686 +#: ../src/guestfs.pod:1943 msgid "" "When the daemon launches it sends an initial word (C) " "which indicates that the guest and daemon is alive. This is what " @@ -3309,12 +3759,12 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1690 +#: ../src/guestfs.pod:1947 msgid "PROGRESS NOTIFICATION MESSAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:1692 +#: ../src/guestfs.pod:1949 msgid "" "The daemon may send progress notification messages at any time. These are " "distinguished by the normal length word being replaced by " @@ -3322,7 +3772,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1696 +#: ../src/guestfs.pod:1953 msgid "" "The library turns them into progress callbacks (see " "C) if there is a callback registered, or " @@ -3330,7 +3780,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1700 +#: ../src/guestfs.pod:1957 msgid "" "The daemon self-limits the frequency of progress messages it sends (see " "C). Not all calls generate progress " @@ -3338,102 +3788,12 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1704 -msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1706 -msgid "" -"All high-level libguestfs actions are synchronous. If you want to use " -"libguestfs asynchronously then you must create a thread." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1709 -msgid "" -"Only use the handle from a single thread. Either use the handle exclusively " -"from one thread, or provide your own mutex so that two threads cannot issue " -"calls on the same handle at the same time." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1713 -msgid "" -"See the graphical program guestfs-browser for one possible architecture for " -"multithreaded programs using libvirt and libguestfs." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1716 -msgid "QEMU WRAPPERS" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1718 -msgid "" -"If you want to compile your own qemu, run qemu from a non-standard location, " -"or pass extra arguments to qemu, then you can write a shell-script wrapper " -"around qemu." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1722 -msgid "" -"There is one important rule to remember: you I> as the " -"last command in the shell script (so that qemu replaces the shell and " -"becomes the direct child of the libguestfs-using program). If you don't do " -"this, then the qemu process won't be cleaned up correctly." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1727 -msgid "" -"Here is an example of a wrapper, where I have built my own copy of qemu from " -"source:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:1730 -#, no-wrap -msgid "" -" #!/bin/sh -\n" -" qemudir=/home/rjones/d/qemu\n" -" exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios " -"\"$@\"\n" -"\n" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1734 -msgid "" -"Save this script as C (or wherever), C, and " -"then use it by setting the LIBGUESTFS_QEMU environment variable. For " -"example:" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:1738 -#, no-wrap -msgid "" -" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" -"\n" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1740 -msgid "" -"Note that libguestfs also calls qemu with the -help and -version options in " -"order to determine features." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1743 +#: ../src/guestfs.pod:1961 msgid "LIBGUESTFS VERSION NUMBERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1745 +#: ../src/guestfs.pod:1963 msgid "" "Since April 2010, libguestfs has started to make separate development and " "stable releases, along with corresponding branches in our git repository. " @@ -3441,7 +3801,7 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1750 +#: ../src/guestfs.pod:1968 #, no-wrap msgid "" " even numbers for stable: 1.2.x, 1.4.x, ...\n" @@ -3458,12 +3818,12 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1761 +#: ../src/guestfs.pod:1979 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." msgstr "" # type: textblock -#: ../src/guestfs.pod:1763 +#: ../src/guestfs.pod:1981 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 " @@ -3473,26 +3833,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1769 +#: ../src/guestfs.pod:1987 msgid "Our criteria for backporting changes are:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1775 +#: ../src/guestfs.pod:1993 msgid "" "Documentation changes which don't affect any code are backported unless the " "documentation refers to a future feature which is not in stable." msgstr "" # type: textblock -#: ../src/guestfs.pod:1781 +#: ../src/guestfs.pod:1999 msgid "" "Bug fixes which are not controversial, fix obvious problems, and have been " "well tested are backported." msgstr "" # type: textblock -#: ../src/guestfs.pod:1786 +#: ../src/guestfs.pod:2004 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 " @@ -3500,7 +3860,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1792 +#: ../src/guestfs.pod:2010 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 " @@ -3508,7 +3868,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1798 +#: ../src/guestfs.pod:2016 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 " @@ -3519,44 +3879,44 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1806 ../fish/guestfish.pod:867 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255 +#: ../src/guestfs.pod:2024 ../fish/guestfish.pod:914 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255 msgid "ENVIRONMENT VARIABLES" msgstr "" # type: =item -#: ../src/guestfs.pod:1810 ../fish/guestfish.pod:893 +#: ../src/guestfs.pod:2028 ../fish/guestfish.pod:940 msgid "LIBGUESTFS_APPEND" msgstr "" # type: textblock -#: ../src/guestfs.pod:1812 ../fish/guestfish.pod:895 +#: ../src/guestfs.pod:2030 ../fish/guestfish.pod:942 msgid "Pass additional options to the guest kernel." msgstr "" # type: =item -#: ../src/guestfs.pod:1814 ../fish/guestfish.pod:897 +#: ../src/guestfs.pod:2032 ../fish/guestfish.pod:944 msgid "LIBGUESTFS_DEBUG" msgstr "" # type: textblock -#: ../src/guestfs.pod:1816 +#: ../src/guestfs.pod:2034 msgid "" "Set C to enable verbose messages. This has the same " "effect as calling C." msgstr "" # type: =item -#: ../src/guestfs.pod:1819 ../fish/guestfish.pod:902 +#: ../src/guestfs.pod:2037 ../fish/guestfish.pod:949 msgid "LIBGUESTFS_MEMSIZE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1821 ../fish/guestfish.pod:904 +#: ../src/guestfs.pod:2039 ../fish/guestfish.pod:951 msgid "Set the memory allocated to the qemu process, in megabytes. For example:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1824 ../fish/guestfish.pod:907 +#: ../src/guestfs.pod:2042 ../fish/guestfish.pod:954 #, no-wrap msgid "" " LIBGUESTFS_MEMSIZE=700\n" @@ -3564,58 +3924,58 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:1826 ../fish/guestfish.pod:909 +#: ../src/guestfs.pod:2044 ../fish/guestfish.pod:956 msgid "LIBGUESTFS_PATH" msgstr "" # type: textblock -#: ../src/guestfs.pod:1828 +#: ../src/guestfs.pod:2046 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:1831 ../fish/guestfish.pod:914 +#: ../src/guestfs.pod:2049 ../fish/guestfish.pod:961 msgid "LIBGUESTFS_QEMU" msgstr "" # type: textblock -#: ../src/guestfs.pod:1833 ../fish/guestfish.pod:916 +#: ../src/guestfs.pod:2051 ../fish/guestfish.pod:963 msgid "" "Set the default qemu binary that libguestfs uses. If not set, then the qemu " "which was found at compile time by the configure script is used." msgstr "" # type: textblock -#: ../src/guestfs.pod:1837 +#: ../src/guestfs.pod:2055 msgid "See also L above." msgstr "" # type: =item -#: ../src/guestfs.pod:1839 ../fish/guestfish.pod:920 +#: ../src/guestfs.pod:2057 ../fish/guestfish.pod:967 msgid "LIBGUESTFS_TRACE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1841 +#: ../src/guestfs.pod:2059 msgid "" "Set C to enable command traces. This has the same " "effect as calling C." msgstr "" # type: =item -#: ../src/guestfs.pod:1844 ../fish/guestfish.pod:929 +#: ../src/guestfs.pod:2062 ../fish/guestfish.pod:976 msgid "TMPDIR" msgstr "" # type: textblock -#: ../src/guestfs.pod:1846 ../fish/guestfish.pod:931 +#: ../src/guestfs.pod:2064 ../fish/guestfish.pod:978 msgid "Location of temporary directory, defaults to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1848 ../fish/guestfish.pod:933 +#: ../src/guestfs.pod:2066 ../fish/guestfish.pod:980 msgid "" "If libguestfs was compiled to use the supermin appliance then the real " "appliance is cached in this directory, shared between all handles belonging " @@ -3624,12 +3984,12 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1856 ../fish/guestfish.pod:991 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:214 ../inspector/virt-inspector.pl:570 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640 ../tools/virt-ls.pl:232 ../tools/virt-resize.pl:1486 ../tools/virt-list-filesystems.pl:186 ../tools/virt-cat.pl:185 ../tools/virt-tar.pl:281 ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:254 +#: ../src/guestfs.pod:2074 ../fish/guestfish.pod:1038 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../inspector/virt-inspector.pl:536 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640 ../tools/virt-ls.pl:232 ../tools/virt-resize.pl:1486 ../tools/virt-list-filesystems.pl:186 ../tools/virt-tar.pl:281 ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:254 msgid "SEE ALSO" msgstr "" # type: textblock -#: ../src/guestfs.pod:1858 +#: ../src/guestfs.pod:2076 msgid "" "L, L, L, L, " "L, L, L, " @@ -3639,187 +3999,330 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1876 +#: ../src/guestfs.pod:2094 msgid "" "Tools with a similar purpose: L, L, L, " "L, L." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1883 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548 +#: ../src/guestfs.pod:2101 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548 msgid "BUGS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1885 +#: ../src/guestfs.pod:2103 msgid "To get a list of bugs against libguestfs use this link:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1887 +#: ../src/guestfs.pod:2105 msgid "L" msgstr "" # type: textblock -#: ../src/guestfs.pod:1889 +#: ../src/guestfs.pod:2107 msgid "To report a new bug against libguestfs use this link:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1891 +#: ../src/guestfs.pod:2109 msgid "L" msgstr "" # type: textblock -#: ../src/guestfs.pod:1893 +#: ../src/guestfs.pod:2111 msgid "When reporting a bug, please check:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1899 +#: ../src/guestfs.pod:2117 msgid "That the bug hasn't been reported already." msgstr "" # type: textblock -#: ../src/guestfs.pod:1903 +#: ../src/guestfs.pod:2121 msgid "That you are testing a recent version." msgstr "" # type: textblock -#: ../src/guestfs.pod:1907 +#: ../src/guestfs.pod:2125 msgid "Describe the bug accurately, and give a way to reproduce it." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1911 +# type: textblock +#: ../src/guestfs.pod:2129 +msgid "" +"Run libguestfs-test-tool and paste the B output into the " +"bug report." +msgstr "" + +# type: =head1 +#: ../src/guestfs.pod:2134 ../fish/guestfish.pod:1055 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244 ../inspector/virt-inspector.pl:546 +msgid "AUTHORS" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:2136 ../fish/guestfish.pod:1057 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246 +msgid "Richard W.M. Jones (C)" +msgstr "" + +# type: =head1 +#: ../src/guestfs.pod:2138 ../fish/guestfish.pod:1059 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../inspector/virt-inspector.pl:560 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653 ../tools/virt-ls.pl:247 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:296 ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:269 +msgid "COPYRIGHT" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:2140 ../fish/guestfish.pod:1061 ../fuse/guestmount.pod:250 +msgid "Copyright (C) 2009-2010 Red Hat Inc. L" +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:2143 +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." +msgstr "" + +# type: textblock +#: ../src/guestfs.pod:2148 +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.pod:2153 +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" +msgstr "" + +# type: =head2 +#: ../src/guestfs-actions.pod:1 +msgid "guestfs_add_cdrom" +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" +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." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7 +msgid "This is equivalent to the qemu parameter C<-cdrom filename>." +msgstr "" + +# type: textblock +#: ../src/guestfs-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: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: textblock +#: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126 ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428 ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487 ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633 ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988 ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090 ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161 ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262 ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464 ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704 ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2213 ../src/guestfs-actions.pod:2357 ../src/guestfs-actions.pod:2418 ../src/guestfs-actions.pod:2453 ../src/guestfs-actions.pod:3049 ../src/guestfs-actions.pod:3064 ../src/guestfs-actions.pod:3084 ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3223 ../src/guestfs-actions.pod:3236 ../src/guestfs-actions.pod:3250 ../src/guestfs-actions.pod:3265 ../src/guestfs-actions.pod:3301 ../src/guestfs-actions.pod:3373 ../src/guestfs-actions.pod:3393 ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3433 ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:3488 ../src/guestfs-actions.pod:3507 ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:3561 ../src/guestfs-actions.pod:3573 ../src/guestfs-actions.pod:3609 ../src/guestfs-actions.pod:3625 ../src/guestfs-actions.pod:3638 ../src/guestfs-actions.pod:3653 ../src/guestfs-actions.pod:3670 ../src/guestfs-actions.pod:3763 ../src/guestfs-actions.pod:3783 ../src/guestfs-actions.pod:3796 ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:3865 ../src/guestfs-actions.pod:3883 ../src/guestfs-actions.pod:3899 ../src/guestfs-actions.pod:3913 ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:3959 ../src/guestfs-actions.pod:3979 ../src/guestfs-actions.pod:4028 ../src/guestfs-actions.pod:4059 ../src/guestfs-actions.pod:4078 ../src/guestfs-actions.pod:4097 ../src/guestfs-actions.pod:4109 ../src/guestfs-actions.pod:4126 ../src/guestfs-actions.pod:4139 ../src/guestfs-actions.pod:4154 ../src/guestfs-actions.pod:4169 ../src/guestfs-actions.pod:4204 ../src/guestfs-actions.pod:4219 ../src/guestfs-actions.pod:4239 ../src/guestfs-actions.pod:4253 ../src/guestfs-actions.pod:4270 ../src/guestfs-actions.pod:4319 ../src/guestfs-actions.pod:4356 ../src/guestfs-actions.pod:4370 ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4415 ../src/guestfs-actions.pod:4433 ../src/guestfs-actions.pod:4567 ../src/guestfs-actions.pod:4624 ../src/guestfs-actions.pod:4646 ../src/guestfs-actions.pod:4664 ../src/guestfs-actions.pod:4696 ../src/guestfs-actions.pod:4762 ../src/guestfs-actions.pod:4779 ../src/guestfs-actions.pod:4792 ../src/guestfs-actions.pod:4806 ../src/guestfs-actions.pod:5095 ../src/guestfs-actions.pod:5114 ../src/guestfs-actions.pod:5128 ../src/guestfs-actions.pod:5140 ../src/guestfs-actions.pod:5154 ../src/guestfs-actions.pod:5166 ../src/guestfs-actions.pod:5180 ../src/guestfs-actions.pod:5196 ../src/guestfs-actions.pod:5217 ../src/guestfs-actions.pod:5236 ../src/guestfs-actions.pod:5255 ../src/guestfs-actions.pod:5273 ../src/guestfs-actions.pod:5296 ../src/guestfs-actions.pod:5314 ../src/guestfs-actions.pod:5333 ../src/guestfs-actions.pod:5354 ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5418 ../src/guestfs-actions.pod:5442 ../src/guestfs-actions.pod:5461 ../src/guestfs-actions.pod:5485 ../src/guestfs-actions.pod:5500 ../src/guestfs-actions.pod:5515 ../src/guestfs-actions.pod:5534 ../src/guestfs-actions.pod:5571 ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:5620 ../src/guestfs-actions.pod:5728 ../src/guestfs-actions.pod:5849 ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5874 ../src/guestfs-actions.pod:5887 ../src/guestfs-actions.pod:5909 ../src/guestfs-actions.pod:5922 ../src/guestfs-actions.pod:5935 ../src/guestfs-actions.pod:5948 ../src/guestfs-actions.pod:5963 ../src/guestfs-actions.pod:6022 ../src/guestfs-actions.pod:6039 ../src/guestfs-actions.pod:6055 ../src/guestfs-actions.pod:6071 ../src/guestfs-actions.pod:6088 ../src/guestfs-actions.pod:6101 ../src/guestfs-actions.pod:6121 ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6171 ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:6243 ../src/guestfs-actions.pod:6272 ../src/guestfs-actions.pod:6303 ../src/guestfs-actions.pod:6422 ../src/guestfs-actions.pod:6440 ../src/guestfs-actions.pod:6454 ../src/guestfs-actions.pod:6509 ../src/guestfs-actions.pod:6522 ../src/guestfs-actions.pod:6567 ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6654 ../src/guestfs-actions.pod:6680 ../src/guestfs-actions.pod:6746 ../src/guestfs-actions.pod:6765 ../src/guestfs-actions.pod:6794 +msgid "This function returns 0 on success or -1 on error." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167 +msgid "" +"This function is deprecated. In new code, use the C call " +"instead." +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243 ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942 ../src/guestfs-actions.pod:6688 ../src/guestfs-actions.pod:6857 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156 ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951 ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322 ../fish/guestfish-actions.pod:4427 ../fish/guestfish-actions.pod:4524 +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:39 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3066 ../src/guestfs-actions.pod:4206 ../src/guestfs-actions.pod:5275 ../src/guestfs-actions.pod:5392 ../src/guestfs-actions.pod:5502 ../src/guestfs-actions.pod:5965 ../src/guestfs-actions.pod:6090 ../src/guestfs-actions.pod:6602 +msgid "(Added in 0.3)" +msgstr "" + +# type: =head2 +#: ../src/guestfs-actions.pod:41 +msgid "guestfs_add_domain" +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" +msgstr "" + +# type: textblock +#: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137 +msgid "" +"You may supply a list of optional arguments to this call. Use zero or more " +"of the following pairs of parameters, and terminate the list with C<-1> on " +"its own. See L." +msgstr "" + +# type: verbatim +#: ../src/guestfs-actions.pod:53 +#, no-wrap msgid "" -"Run libguestfs-test-tool and paste the B output into the " -"bug report." +" GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n" +" GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n" +" GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n" +"\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1916 ../fish/guestfish.pod:1008 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:225 ../inspector/virt-inspector.pl:580 -msgid "AUTHORS" +# type: textblock +#: ../src/guestfs-actions.pod:57 +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." msgstr "" # type: textblock -#: ../src/guestfs.pod:1918 ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:227 -msgid "Richard W.M. Jones (C)" +#: ../src/guestfs-actions.pod:62 ../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." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1920 ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:229 ../inspector/virt-inspector.pl:594 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653 ../tools/virt-ls.pl:247 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:202 ../tools/virt-cat.pl:199 ../tools/virt-tar.pl:296 ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:269 -msgid "COPYRIGHT" +# type: textblock +#: ../src/guestfs-actions.pod:65 ../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." msgstr "" # type: textblock -#: ../src/guestfs.pod:1922 ../fish/guestfish.pod:1014 ../fuse/guestmount.pod:231 -msgid "Copyright (C) 2009-2010 Red Hat Inc. L" +#: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53 +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." msgstr "" # type: textblock -#: ../src/guestfs.pod:1925 +#: ../src/guestfs-actions.pod:74 msgid "" -"This library is free software; you can redistribute it and/or modify it " -"under the terms of the GNU Lesser General Public License as published by the " -"Free Software Foundation; either version 2 of the License, or (at your " -"option) any later version." +"The 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). If you are using the C API " +"directly then it is more flexible to create the libvirt connection object " +"yourself, get the domain object, and call C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1930 +#: ../src/guestfs-actions.pod:82 msgid "" -"This library is distributed in the hope that it will be useful, but WITHOUT " -"ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or " -"FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License " -"for more details." +"The other optional parameters are passed directly through to " +"C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1935 -msgid "" -"You should have received a copy of the GNU Lesser General Public License " -"along with this library; if not, write to the Free Software Foundation, " -"Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA" +#: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:336 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728 ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307 ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864 ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003 ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2344 ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:4342 ../src/guestfs-actions.pod:4470 ../src/guestfs-actions.pod:4876 ../src/guestfs-actions.pod:4902 ../src/guestfs-actions.pod:6198 ../src/guestfs-actions.pod:6613 ../src/guestfs-actions.pod:6626 ../src/guestfs-actions.pod:6639 +msgid "On error this function returns -1." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:1 -msgid "guestfs_add_cdrom" +#: ../src/guestfs-actions.pod:87 +msgid "guestfs_add_domain_va" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:3 +#: ../src/guestfs-actions.pod:89 #, no-wrap msgid "" -" int guestfs_add_cdrom (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" int\n" +" guestfs_add_domain_va (guestfs_h *g,\n" +" const char *dom,\n" +" va_list args);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:6 ../fish/guestfish-actions.pod:5 -msgid "This function adds a virtual CD-ROM disk image to the guest." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:8 ../fish/guestfish-actions.pod:7 -msgid "This is equivalent to the qemu parameter C<-cdrom filename>." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:16 -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." +#: ../src/guestfs-actions.pod:94 +msgid "This is the \"va_list variant\" of L." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:23 -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-actions.pod:96 ../src/guestfs-actions.pod:107 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211 +msgid "See L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:54 ../src/guestfs-actions.pod:112 ../src/guestfs-actions.pod:144 ../src/guestfs-actions.pod:155 ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:190 ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:304 ../src/guestfs-actions.pod:321 ../src/guestfs-actions.pod:332 ../src/guestfs-actions.pod:368 ../src/guestfs-actions.pod:390 ../src/guestfs-actions.pod:405 ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:496 ../src/guestfs-actions.pod:507 ../src/guestfs-actions.pod:519 ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:615 ../src/guestfs-actions.pod:626 ../src/guestfs-actions.pod:637 ../src/guestfs-actions.pod:783 ../src/guestfs-actions.pod:800 ../src/guestfs-actions.pod:815 ../src/guestfs-actions.pod:890 ../src/guestfs-actions.pod:905 ../src/guestfs-actions.pod:921 ../src/guestfs-actions.pod:932 ../src/guestfs-actions.pod:949 ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1040 ../src/guestfs-actions.pod:1068 ../src/guestfs-actions.pod:1090 ../src/guestfs-actions.pod:1121 ../src/guestfs-actions.pod:1209 ../src/guestfs-actions.pod:1240 ../src/guestfs-actions.pod:1440 ../src/guestfs-actions.pod:1459 ../src/guestfs-actions.pod:1540 ../src/guestfs-actions.pod:1888 ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2096 ../src/guestfs-actions.pod:2541 ../src/guestfs-actions.pod:2553 ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:2678 ../src/guestfs-actions.pod:2689 ../src/guestfs-actions.pod:2699 ../src/guestfs-actions.pod:2710 ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2752 ../src/guestfs-actions.pod:2816 ../src/guestfs-actions.pod:2833 ../src/guestfs-actions.pod:2847 ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2887 ../src/guestfs-actions.pod:2916 ../src/guestfs-actions.pod:2932 ../src/guestfs-actions.pod:2948 ../src/guestfs-actions.pod:2977 ../src/guestfs-actions.pod:2986 ../src/guestfs-actions.pod:3019 ../src/guestfs-actions.pod:3032 ../src/guestfs-actions.pod:3042 ../src/guestfs-actions.pod:3054 ../src/guestfs-actions.pod:3068 ../src/guestfs-actions.pod:3148 ../src/guestfs-actions.pod:3165 ../src/guestfs-actions.pod:3175 ../src/guestfs-actions.pod:3220 ../src/guestfs-actions.pod:3235 ../src/guestfs-actions.pod:3250 ../src/guestfs-actions.pod:3263 ../src/guestfs-actions.pod:3274 ../src/guestfs-actions.pod:3285 ../src/guestfs-actions.pod:3299 ../src/guestfs-actions.pod:3311 ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3374 ../src/guestfs-actions.pod:3402 ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:3443 ../src/guestfs-actions.pod:3457 ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:3479 ../src/guestfs-actions.pod:3491 ../src/guestfs-actions.pod:3523 ../src/guestfs-actions.pod:3535 ../src/guestfs-actions.pod:3552 ../src/guestfs-actions.pod:3563 ../src/guestfs-actions.pod:3577 ../src/guestfs-actions.pod:3617 ../src/guestfs-actions.pod:3648 ../src/guestfs-actions.pod:3659 ../src/guestfs-actions.pod:3684 ../src/guestfs-actions.pod:3698 ../src/guestfs-actions.pod:3713 ../src/guestfs-actions.pod:3835 ../src/guestfs-actions.pod:3887 ../src/guestfs-actions.pod:3906 ../src/guestfs-actions.pod:3921 ../src/guestfs-actions.pod:3947 ../src/guestfs-actions.pod:4004 ../src/guestfs-actions.pod:4018 ../src/guestfs-actions.pod:4028 ../src/guestfs-actions.pod:4039 ../src/guestfs-actions.pod:4294 ../src/guestfs-actions.pod:4310 ../src/guestfs-actions.pod:4321 ../src/guestfs-actions.pod:4330 ../src/guestfs-actions.pod:4341 ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4361 ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4392 ../src/guestfs-actions.pod:4408 ../src/guestfs-actions.pod:4424 ../src/guestfs-actions.pod:4439 ../src/guestfs-actions.pod:4459 ../src/guestfs-actions.pod:4474 ../src/guestfs-actions.pod:4490 ../src/guestfs-actions.pod:4508 ../src/guestfs-actions.pod:4524 ../src/guestfs-actions.pod:4538 ../src/guestfs-actions.pod:4563 ../src/guestfs-actions.pod:4584 ../src/guestfs-actions.pod:4600 ../src/guestfs-actions.pod:4621 ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4645 ../src/guestfs-actions.pod:4661 ../src/guestfs-actions.pod:4695 ../src/guestfs-actions.pod:4715 ../src/guestfs-actions.pod:4738 ../src/guestfs-actions.pod:4828 ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4943 ../src/guestfs-actions.pod:4953 ../src/guestfs-actions.pod:4963 ../src/guestfs-actions.pod:4982 ../src/guestfs-actions.pod:4992 ../src/guestfs-actions.pod:5002 ../src/guestfs-actions.pod:5012 ../src/guestfs-actions.pod:5024 ../src/guestfs-actions.pod:5074 ../src/guestfs-actions.pod:5088 ../src/guestfs-actions.pod:5101 ../src/guestfs-actions.pod:5114 ../src/guestfs-actions.pod:5128 ../src/guestfs-actions.pod:5138 ../src/guestfs-actions.pod:5155 ../src/guestfs-actions.pod:5185 ../src/guestfs-actions.pod:5196 ../src/guestfs-actions.pod:5231 ../src/guestfs-actions.pod:5241 ../src/guestfs-actions.pod:5256 ../src/guestfs-actions.pod:5282 ../src/guestfs-actions.pod:5310 ../src/guestfs-actions.pod:5414 ../src/guestfs-actions.pod:5429 ../src/guestfs-actions.pod:5440 ../src/guestfs-actions.pod:5486 ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5533 ../src/guestfs-actions.pod:5560 ../src/guestfs-actions.pod:5602 ../src/guestfs-actions.pod:5625 ../src/guestfs-actions.pod:5682 ../src/guestfs-actions.pod:5698 ../src/guestfs-actions.pod:5724 -msgid "This function returns 0 on success or -1 on error." +# type: =head2 +#: ../src/guestfs-actions.pod:98 +msgid "guestfs_add_domain_argv" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:31 ../src/guestfs-actions.pod:157 ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:117 ../fish/guestfish-actions.pod:131 +# type: verbatim +#: ../src/guestfs-actions.pod:100 +#, no-wrap msgid "" -"This function is deprecated. In new code, use the C call " -"instead." +" int\n" +" guestfs_add_domain_argv (guestfs_h *g,\n" +" const char *dom,\n" +" const struct guestfs_add_domain_argv *optargs);\n" +"\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:34 ../src/guestfs-actions.pod:160 ../src/guestfs-actions.pod:178 ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1667 ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5778 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:120 ../fish/guestfish-actions.pod:134 ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:1297 ../fish/guestfish-actions.pod:1311 ../fish/guestfish-actions.pod:4349 ../fish/guestfish-actions.pod:4446 -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." +#: ../src/guestfs-actions.pod:105 +msgid "This is the \"argv variant\" of L." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:38 +#: ../src/guestfs-actions.pod:109 msgid "guestfs_add_drive" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:40 +#: ../src/guestfs-actions.pod:111 #, no-wrap msgid "" -" int guestfs_add_drive (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" int\n" +" guestfs_add_drive (guestfs_h *g,\n" +" const char *filename);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:43 +#: ../src/guestfs-actions.pod:115 msgid "" "This function is the equivalent of calling C with no " "optional parameters, so the disk is added writable, with the format being " @@ -3827,7 +4330,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:47 +#: ../src/guestfs-actions.pod:119 msgid "" "Automatic detection of the format opens you up to a potential security hole " "when dealing with untrusted raw-format images. See CVE-2010-3851 and " @@ -3837,30 +4340,23 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:56 +#: ../src/guestfs-actions.pod:130 msgid "guestfs_add_drive_opts" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:58 +#: ../src/guestfs-actions.pod:132 #, no-wrap msgid "" -" int guestfs_add_drive_opts (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\t...);\n" +" int\n" +" guestfs_add_drive_opts (guestfs_h *g,\n" +" const char *filename,\n" +" ...);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:62 -msgid "" -"You may supply a list of optional arguments to this call. Use zero or more " -"of the following pairs of parameters, and terminate the list with C<-1> on " -"its own. See L." -msgstr "" - # type: verbatim -#: ../src/guestfs-actions.pod:67 +#: ../src/guestfs-actions.pod:142 #, no-wrap msgid "" " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n" @@ -3870,7 +4366,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:56 +#: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:92 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 " @@ -3878,7 +4374,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:61 +#: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:97 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 " @@ -3887,22 +4383,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:67 +#: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:103 msgid "This call checks that C exists." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:84 ../fish/guestfish-actions.pod:69 +#: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:105 msgid "The optional arguments are:" msgstr "" # type: =item -#: ../src/guestfs-actions.pod:88 ../fish/guestfish-actions.pod:73 +#: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:109 msgid "C" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:90 ../fish/guestfish-actions.pod:75 +#: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:111 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 " @@ -3910,12 +4406,12 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs-actions.pod:94 ../fish/guestfish-actions.pod:79 +#: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:115 msgid "C" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:96 +#: ../src/guestfs-actions.pod:171 msgid "" "This forces the image format. If you omit this (or use C " "or C) then the format is automatically detected. " @@ -3923,7 +4419,7 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:100 ../fish/guestfish-actions.pod:85 +#: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:121 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 " @@ -3931,193 +4427,222 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs-actions.pod:105 ../fish/guestfish-actions.pod:90 +#: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:126 msgid "C" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:107 +#: ../src/guestfs-actions.pod:182 msgid "" "This rarely-used option lets you emulate the behaviour of the deprecated " "C call (q.v.)" msgstr "" +# type: textblock +#: ../src/guestfs-actions.pod:189 +msgid "(Added in 1.5.23)" +msgstr "" + # type: =head2 -#: ../src/guestfs-actions.pod:114 +#: ../src/guestfs-actions.pod:191 msgid "guestfs_add_drive_opts_va" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:116 +#: ../src/guestfs-actions.pod:193 #, no-wrap msgid "" -" int guestfs_add_drive_opts_va (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tva_list args);\n" +" int\n" +" guestfs_add_drive_opts_va (guestfs_h *g,\n" +" const char *filename,\n" +" va_list args);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:120 +#: ../src/guestfs-actions.pod:198 msgid "This is the \"va_list variant\" of L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:122 ../src/guestfs-actions.pod:132 -msgid "See L." -msgstr "" - # type: =head2 -#: ../src/guestfs-actions.pod:124 +#: ../src/guestfs-actions.pod:202 msgid "guestfs_add_drive_opts_argv" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:126 +#: ../src/guestfs-actions.pod:204 #, no-wrap msgid "" -" int guestfs_add_drive_opts_argv (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst struct guestfs_add_drive_opts_argv *optargs);\n" +" int\n" +" guestfs_add_drive_opts_argv (guestfs_h *g,\n" +" const char *filename,\n" +" const struct guestfs_add_drive_opts_argv " +"*optargs);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:130 +#: ../src/guestfs-actions.pod:209 msgid "This is the \"argv variant\" of L." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:134 +#: ../src/guestfs-actions.pod:213 msgid "guestfs_add_drive_ro" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:136 +#: ../src/guestfs-actions.pod:215 #, no-wrap msgid "" -" int guestfs_add_drive_ro (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" int\n" +" guestfs_add_drive_ro (guestfs_h *g,\n" +" const char *filename);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:139 +#: ../src/guestfs-actions.pod:219 msgid "" "This function is the equivalent of calling C with " "the optional parameter C set to 1, so the " "disk is added read-only, with the format being detected automatically." msgstr "" +# type: textblock +#: ../src/guestfs-actions.pod:226 +msgid "(Added in 1.0.38)" +msgstr "" + # type: =head2 -#: ../src/guestfs-actions.pod:146 +#: ../src/guestfs-actions.pod:228 msgid "guestfs_add_drive_ro_with_if" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:148 +#: ../src/guestfs-actions.pod:230 #, no-wrap msgid "" -" int guestfs_add_drive_ro_with_if (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst char *iface);\n" +" int\n" +" guestfs_add_drive_ro_with_if (guestfs_h *g,\n" +" const char *filename,\n" +" const char *iface);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:152 +#: ../src/guestfs-actions.pod:235 msgid "" "This is the same as C but it allows you to specify the " "QEMU interface emulation to use at run time." msgstr "" +# type: textblock +#: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:2303 +msgid "(Added in 1.0.84)" +msgstr "" + # type: =head2 -#: ../src/guestfs-actions.pod:164 +#: ../src/guestfs-actions.pod:249 msgid "guestfs_add_drive_with_if" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:166 +#: ../src/guestfs-actions.pod:251 #, no-wrap msgid "" -" int guestfs_add_drive_with_if (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst char *iface);\n" +" int\n" +" guestfs_add_drive_with_if (guestfs_h *g,\n" +" const char *filename,\n" +" const char *iface);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:170 +#: ../src/guestfs-actions.pod:256 msgid "" "This is the same as C but it allows you to specify the " "QEMU interface emulation to use at run time." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:182 +#: ../src/guestfs-actions.pod:270 msgid "guestfs_aug_clear" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:184 +#: ../src/guestfs-actions.pod:272 #, no-wrap msgid "" -" int guestfs_aug_clear (guestfs_h *g,\n" -"\t\tconst char *augpath);\n" +" int\n" +" guestfs_aug_clear (guestfs_h *g,\n" +" const char *augpath);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:187 ../fish/guestfish-actions.pod:142 +#: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:178 msgid "" "Set the value associated with C to C. This is the same as the " "L C command." msgstr "" +# type: textblock +#: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083 +msgid "(Added in 1.3.4)" +msgstr "" + # type: =head2 -#: ../src/guestfs-actions.pod:192 +#: ../src/guestfs-actions.pod:283 msgid "guestfs_aug_close" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:194 +#: ../src/guestfs-actions.pod:285 #, no-wrap msgid "" -" int guestfs_aug_close (guestfs_h *g);\n" +" int\n" +" guestfs_aug_close (guestfs_h *g);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:196 +#: ../src/guestfs-actions.pod:288 msgid "" "Close the current Augeas handle and free up any resources used by it. After " "calling this, you have to call C again before you can use " "any other Augeas functions." msgstr "" +# type: textblock +#: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320 ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535 ../src/guestfs-actions.pod:4953 +msgid "(Added in 0.7)" +msgstr "" + # type: =head2 -#: ../src/guestfs-actions.pod:203 +#: ../src/guestfs-actions.pod:297 msgid "guestfs_aug_defnode" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:205 +#: ../src/guestfs-actions.pod:299 #, no-wrap msgid "" -" struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *g,\n" -"\t\tconst char *name,\n" -"\t\tconst char *expr,\n" -"\t\tconst char *val);\n" +" struct guestfs_int_bool *\n" +" guestfs_aug_defnode (guestfs_h *g,\n" +" const char *name,\n" +" const char *expr,\n" +" const char *val);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:210 ../fish/guestfish-actions.pod:158 +#: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:194 msgid "Defines a variable C whose value is the result of evaluating C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:213 +#: ../src/guestfs-actions.pod:308 msgid "" "If C evaluates to an empty nodeset, a node is created, equivalent to " "calling C C, C. C will be the nodeset " @@ -4125,98 +4650,96 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:217 ../fish/guestfish-actions.pod:165 +#: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:201 msgid "" "On success this returns a pair containing the number of nodes in the " "nodeset, and a boolean flag if a node was created." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:221 +#: ../src/guestfs-actions.pod:316 msgid "" "This function returns a C, or NULL if there was " "an error. I after use>." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:225 +#: ../src/guestfs-actions.pod:322 msgid "guestfs_aug_defvar" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:227 +#: ../src/guestfs-actions.pod:324 #, no-wrap msgid "" -" int guestfs_aug_defvar (guestfs_h *g,\n" -"\t\tconst char *name,\n" -"\t\tconst char *expr);\n" +" int\n" +" guestfs_aug_defvar (guestfs_h *g,\n" +" const char *name,\n" +" const char *expr);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:231 ../fish/guestfish-actions.pod:173 +#: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:209 msgid "" "Defines an Augeas variable C whose value is the result of evaluating " "C. If C is NULL, then C is undefined." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:235 ../fish/guestfish-actions.pod:177 +#: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:213 msgid "" "On success this returns the number of nodes in C, or C<0> if C " "evaluates to something which is not a nodeset." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:379 ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:558 ../src/guestfs-actions.pod:573 ../src/guestfs-actions.pod:589 ../src/guestfs-actions.pod:1107 ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1685 ../src/guestfs-actions.pod:1716 ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:1776 ../src/guestfs-actions.pod:2001 ../src/guestfs-actions.pod:2229 ../src/guestfs-actions.pod:2247 ../src/guestfs-actions.pod:3637 ../src/guestfs-actions.pod:3744 ../src/guestfs-actions.pod:4098 ../src/guestfs-actions.pod:4121 ../src/guestfs-actions.pod:5220 ../src/guestfs-actions.pod:5570 ../src/guestfs-actions.pod:5580 ../src/guestfs-actions.pod:5590 -msgid "On error this function returns -1." -msgstr "" - # type: =head2 -#: ../src/guestfs-actions.pod:240 +#: ../src/guestfs-actions.pod:340 msgid "guestfs_aug_get" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:242 +#: ../src/guestfs-actions.pod:342 #, no-wrap msgid "" -" char *guestfs_aug_get (guestfs_h *g,\n" -"\t\tconst char *augpath);\n" +" char *\n" +" guestfs_aug_get (guestfs_h *g,\n" +" const char *augpath);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:245 ../fish/guestfish-actions.pod:184 +#: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:220 msgid "" "Look up the value associated with C. If C matches exactly one " "node, the C is returned." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:248 ../src/guestfs-actions.pod:676 ../src/guestfs-actions.pod:691 ../src/guestfs-actions.pod:748 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:965 ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:1135 ../src/guestfs-actions.pod:1299 ../src/guestfs-actions.pod:1408 ../src/guestfs-actions.pod:1553 ../src/guestfs-actions.pod:1567 ../src/guestfs-actions.pod:1643 ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1795 ../src/guestfs-actions.pod:1934 ../src/guestfs-actions.pod:2115 ../src/guestfs-actions.pod:2181 ../src/guestfs-actions.pod:2297 ../src/guestfs-actions.pod:2332 ../src/guestfs-actions.pod:2352 ../src/guestfs-actions.pod:2667 ../src/guestfs-actions.pod:2964 ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3201 ../src/guestfs-actions.pod:3759 ../src/guestfs-actions.pod:3935 ../src/guestfs-actions.pod:4076 ../src/guestfs-actions.pod:4237 ../src/guestfs-actions.pod:4280 ../src/guestfs-actions.pod:4756 ../src/guestfs-actions.pod:4769 ../src/guestfs-actions.pod:4783 ../src/guestfs-actions.pod:4804 ../src/guestfs-actions.pod:5363 ../src/guestfs-actions.pod:5379 ../src/guestfs-actions.pod:5394 ../src/guestfs-actions.pod:5542 ../src/guestfs-actions.pod:5772 +#: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927 ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046 ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341 ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824 ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936 ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2268 ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2548 ../src/guestfs-actions.pod:2684 ../src/guestfs-actions.pod:2713 ../src/guestfs-actions.pod:2735 ../src/guestfs-actions.pod:2795 ../src/guestfs-actions.pod:2818 ../src/guestfs-actions.pod:3195 ../src/guestfs-actions.pod:3545 ../src/guestfs-actions.pod:3715 ../src/guestfs-actions.pod:3825 ../src/guestfs-actions.pod:4488 ../src/guestfs-actions.pod:4681 ../src/guestfs-actions.pod:4851 ../src/guestfs-actions.pod:5029 ../src/guestfs-actions.pod:5078 ../src/guestfs-actions.pod:5641 ../src/guestfs-actions.pod:5657 ../src/guestfs-actions.pod:5674 ../src/guestfs-actions.pod:5698 ../src/guestfs-actions.pod:6362 ../src/guestfs-actions.pod:6381 ../src/guestfs-actions.pod:6399 ../src/guestfs-actions.pod:6579 ../src/guestfs-actions.pod:6851 msgid "" "This function returns a string, or NULL on error. I." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:251 +#: ../src/guestfs-actions.pod:354 msgid "guestfs_aug_init" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:253 +#: ../src/guestfs-actions.pod:356 #, no-wrap msgid "" -" int guestfs_aug_init (guestfs_h *g,\n" -"\t\tconst char *root,\n" -"\t\tint flags);\n" +" int\n" +" guestfs_aug_init (guestfs_h *g,\n" +" const char *root,\n" +" int flags);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:257 ../fish/guestfish-actions.pod:191 +#: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:227 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 " @@ -4224,192 +4747,201 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:261 +#: ../src/guestfs-actions.pod:365 msgid "You must call this before using any other C commands." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:264 ../fish/guestfish-actions.pod:198 +#: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:234 msgid "C is the filesystem root. C must not be NULL, use C instead." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:267 ../fish/guestfish-actions.pod:201 +#: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:237 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:273 ../fish/guestfish-actions.pod:207 +#: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:243 msgid "C = 1" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:209 +#: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:245 msgid "Keep the original file with a C<.augsave> extension." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:277 ../fish/guestfish-actions.pod:211 +#: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:247 msgid "C = 2" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:279 ../fish/guestfish-actions.pod:213 +#: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:249 msgid "" "Save changes into a file with extension C<.augnew>, and do not overwrite " "original. Overrides C." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:282 ../fish/guestfish-actions.pod:216 +#: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:252 msgid "C = 4" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:218 +#: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:254 msgid "Typecheck lenses (can be expensive)." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:286 ../fish/guestfish-actions.pod:220 +#: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:256 msgid "C = 8" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:288 ../fish/guestfish-actions.pod:222 +#: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:258 msgid "Do not use standard load path for modules." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:224 +#: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:260 msgid "C = 16" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:292 ../fish/guestfish-actions.pod:226 +#: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:262 msgid "Make save a no-op, just record what would have been changed." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:294 ../fish/guestfish-actions.pod:228 +#: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:264 msgid "C = 32" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:296 +#: ../src/guestfs-actions.pod:400 msgid "Do not load the tree in C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:300 +#: ../src/guestfs-actions.pod:404 msgid "To close the handle, you can call C." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:302 ../fish/guestfish-actions.pod:236 +#: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:272 msgid "To find out more about Augeas, see L." msgstr "" # type: =head2 -#: ../src/guestfs-actions.pod:306 +#: ../src/guestfs-actions.pod:412 msgid "guestfs_aug_insert" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:308 +#: ../src/guestfs-actions.pod:414 #, no-wrap msgid "" -" int guestfs_aug_insert (guestfs_h *g,\n" -"\t\tconst char *augpath,\n" -"\t\tconst char *label,\n" -"\t\tint before);\n" +" int\n" +" guestfs_aug_insert (guestfs_h *g,\n" +" const char *augpath,\n" +" const char *label,\n" +" int before);\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:242 +#: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:278 msgid "" "Create a new sibling C