From 5b656fac03146c331cd1310f22febf631b2d8e36 Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Mon, 10 Jan 2011 09:42:43 +0000 Subject: [PATCH] Version 1.8.1. --- AUTHORS | 1 + BUGS | 86 +- configure.ac | 2 +- java/Makefile.inc | 2 +- po-docs/ja.po | 32209 +++++++++++++++++++++++++---------------- po-docs/libguestfs-docs.pot | 32534 +++++++++++++++++++++++------------------- po/es.po | 40 +- po/gu.po | 40 +- po/hi.po | 40 +- po/kn.po | 40 +- po/libguestfs.pot | 40 +- po/ml.po | 40 +- po/mr.po | 38 +- po/nl.po | 38 +- po/or.po | 38 +- po/pa.po | 40 +- po/pl.po | 38 +- po/ta.po | 40 +- po/te.po | 38 +- 19 files changed, 38049 insertions(+), 27295 deletions(-) diff --git a/AUTHORS b/AUTHORS index 291144d..6cc2123 100644 --- a/AUTHORS +++ b/AUTHORS @@ -2,6 +2,7 @@ Ani Peter Charles Duffy Daniel Berrange Daniel Cabrera +Douglas Schilling Landgraf Geert Warrink Guido Günther Jim Meyering diff --git a/BUGS b/BUGS index dcdb182..c9778d1 100644 --- a/BUGS +++ b/BUGS @@ -1,5 +1,5 @@ NOTE: This file is automatically generated from "update-bugs.sh". -Last updated: 2010-12-19 15:38:46 +Last updated: 2011-01-10 10:11:04 This contains a local list of the bugs that are open against libguestfs. Bugs are tracked in the Red Hat Bugzilla database @@ -23,24 +23,12 @@ Bugs in NEW or ASSIGNED state are open and waiting for someone to fix. 563450 NEW https://bugzilla.redhat.com/show_bug.cgi?id=563450 list-devices returns devices of different types out of order -627835 NEW https://bugzilla.redhat.com/show_bug.cgi?id=627835 - libguestfs protocol loses synchronization if you 'upload' before mounting disks - 547488 NEW https://bugzilla.redhat.com/show_bug.cgi?id=547488 guestfish cannot tab complete filenames that contain spaces -627833 NEW https://bugzilla.redhat.com/show_bug.cgi?id=627833 - get-e2uuid should use blkid instead of "tune2fs -l" to get filesystem UUID - -633174 NEW https://bugzilla.redhat.com/show_bug.cgi?id=633174 - some guestfish sub commands can not handle special files properly - 643991 NEW https://bugzilla.redhat.com/show_bug.cgi?id=643991 CVE-2010-3851 libguestfs: missing disk format specifier when adding a disk [fedora-all] -657472 NEW https://bugzilla.redhat.com/show_bug.cgi?id=657472 - checksum: wrong check sum type causes umount to fail - 501884 NEW https://bugzilla.redhat.com/show_bug.cgi?id=501884 virt-inspector still configured, even if there are missing deps @@ -80,9 +68,6 @@ Bugs in NEW or ASSIGNED state are open and waiting for someone to fix. 598772 NEW https://bugzilla.redhat.com/show_bug.cgi?id=598772 guestfish 'help' command should indicate error in exit status with an unknown command -600144 NEW https://bugzilla.redhat.com/show_bug.cgi?id=600144 - document that mkmountpoint and umount-all cannot be mixed - 602997 NEW https://bugzilla.redhat.com/show_bug.cgi?id=602997 part-get-bootable gives wrong result with an unordered part layout @@ -92,12 +77,6 @@ Bugs in NEW or ASSIGNED state are open and waiting for someone to fix. 604041 NEW https://bugzilla.redhat.com/show_bug.cgi?id=604041 guestmount absolute symlinks don't work -612308 NEW https://bugzilla.redhat.com/show_bug.cgi?id=612308 - qemu -net / vlan option deprecated. Use -netdev instead. - -615223 NEW https://bugzilla.redhat.com/show_bug.cgi?id=615223 - vfs-type could not read just-created filesystem - 617436 NEW https://bugzilla.redhat.com/show_bug.cgi?id=617436 guestfish: fails to tilde expand '~' when the $HOME env is unset @@ -122,9 +101,6 @@ Bugs in NEW or ASSIGNED state are open and waiting for someone to fix. 627675 NEW https://bugzilla.redhat.com/show_bug.cgi?id=627675 libguestfs inspector code cannot handle /dev/disk/by-id/* paths -627832 NEW https://bugzilla.redhat.com/show_bug.cgi?id=627832 - [RFE] guestfish should print outputs in a suitable base (eg. octal for modes) - 634649 NEW https://bugzilla.redhat.com/show_bug.cgi?id=634649 [RFE] Align a NTFS partition within qcow2 over LVM to start at offset which is a multiple of 8 @@ -146,6 +122,24 @@ Bugs in NEW or ASSIGNED state are open and waiting for someone to fix. 660687 NEW https://bugzilla.redhat.com/show_bug.cgi?id=660687 guestmount: "touch" command fails: touch: setting times of `timestamp': Invalid argument +664558 NEW https://bugzilla.redhat.com/show_bug.cgi?id=664558 + RFE: Allow to set log callback in Ruby bindings + +666577 NEW https://bugzilla.redhat.com/show_bug.cgi?id=666577 + libguestfs: unknown filesystem /dev/fd0 + +666578 NEW https://bugzilla.redhat.com/show_bug.cgi?id=666578 + libguestfs: unknown filesystem label SWAP-sda2 + +666579 NEW https://bugzilla.redhat.com/show_bug.cgi?id=666579 + libguestfs: unknown filesystem /dev/hd{x} (cdrom) + +667610 NEW https://bugzilla.redhat.com/show_bug.cgi?id=667610 + Multiple bugs, memory leaks in libguestfs ruby bindings + +668115 NEW https://bugzilla.redhat.com/show_bug.cgi?id=668115 + virt-filesystems command fails on guest with corrupt filesystem label + 576879 ASSIGNED https://bugzilla.redhat.com/show_bug.cgi?id=576879 libguestfs protocol loses synchronization if you 'upload' before mounting disks @@ -167,12 +161,6 @@ Bugs in NEW or ASSIGNED state are open and waiting for someone to fix. 541618 ASSIGNED https://bugzilla.redhat.com/show_bug.cgi?id=541618 guestfish not able to mount freebsd ufs2 partitions automatically -639601 ASSIGNED https://bugzilla.redhat.com/show_bug.cgi?id=639601 - "virt-ls" command failed to parse domain name "#" - -639602 ASSIGNED https://bugzilla.redhat.com/show_bug.cgi?id=639602 - ""virt-list-filesystems" fails to parse the command line argument if the domain name is "#". - -------------------------------------------------- Bugs in MODIFIED, POST or ON_QA state are fixed. You can help by testing the fixes. @@ -204,6 +192,9 @@ You can help by testing the fixes. 592883 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=592883 can not edit files on images mounted with guestmount cmd +627835 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=627835 + libguestfs protocol loses synchronization if you 'upload' before mounting disks + 501889 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=501889 write-file does not support strings containing ASCII NUL @@ -213,12 +204,15 @@ You can help by testing the fixes. 588651 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=588651 guestfish 'strings-e' cmd does not give proper error message or hint +627833 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=627833 + get-e2uuid should use blkid instead of "tune2fs -l" to get filesystem UUID + +633174 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=633174 + some guestfish sub commands can not handle special files properly + 657499 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=657499 checksum: wrong check sum type causes umount to fail -657502 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=657502 - virt-inspector depends on EPEL package perl-String-ShellQuote but does not require it - 501893 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=501893 String parameters should be checked for != NULL @@ -243,15 +237,27 @@ You can help by testing the fixes. 599503 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=599503 document that mkmountpoint and umount-all cannot be mixed +600144 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=600144 + document that mkmountpoint and umount-all cannot be mixed + 602592 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=602592 [RFE] expose guestfs_close in perl bindings +612308 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=612308 + qemu -net / vlan option deprecated. Use -netdev instead. + 613593 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=613593 Rebase libguestfs in RHEL 6.1 +615223 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=615223 + vfs-type could not read just-created filesystem + 619334 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=619334 RFE: Enable coredump capture in the appliance +627832 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=627832 + [RFE] guestfish should print outputs in a suitable base (eg. octal for modes) + 633096 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=633096 virt-resize calculates block device size incorrectly, doesn't work with qcow2 target @@ -273,6 +279,12 @@ You can help by testing the fixes. 639405 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=639405 Interrupted cached appliance creation leaves libguestfs unusable +639601 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=639601 + "virt-ls" command failed to parse domain name "#" + +639602 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=639602 + ""virt-list-filesystems" fails to parse the command line argument if the domain name is "#". + 639986 MODIFIED https://bugzilla.redhat.com/show_bug.cgi?id=639986 virt-df --csv does not properly quote " in libvirt domain names @@ -324,6 +336,12 @@ You can help by testing the fixes. -------------------------------------------------- These bugs are in the VERIFIED state. +657472 VERIFIED https://bugzilla.redhat.com/show_bug.cgi?id=657472 + checksum: wrong check sum type causes umount to fail + +657502 VERIFIED https://bugzilla.redhat.com/show_bug.cgi?id=657502 + virt-inspector depends on EPEL package perl-String-ShellQuote but does not require it + 579664 VERIFIED https://bugzilla.redhat.com/show_bug.cgi?id=579664 guestfish doesn't report error when there is not enough space for image allocation diff --git a/configure.ac b/configure.ac index 75ad485..071f7b4 100644 --- a/configure.ac +++ b/configure.ac @@ -18,7 +18,7 @@ # major/minor/release must be numbers m4_define([libguestfs_major], [1]) m4_define([libguestfs_minor], [8]) -m4_define([libguestfs_release], [0]) +m4_define([libguestfs_release], [1]) # extra can be any string m4_define([libguestfs_extra], []) diff --git a/java/Makefile.inc b/java/Makefile.inc index 545f555..49b7db0 100644 --- a/java/Makefile.inc +++ b/java/Makefile.inc @@ -3,7 +3,7 @@ # generator/generator_*.ml # ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST. # -# Copyright (C) 2009-2010 Red Hat Inc. +# Copyright (C) 2009-2011 Red Hat Inc. # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by diff --git a/po-docs/ja.po b/po-docs/ja.po index cc54fdf..8f66dc2 100644 --- a/po-docs/ja.po +++ b/po-docs/ja.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: libguestfs@redhat.com\n" -"POT-Creation-Date: 2010-12-19 15:52+0000\n" +"POT-Creation-Date: 2011-01-10 10:10+0000\n" "PO-Revision-Date: 2010-09-02 14:46+0100\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,30 +16,36 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -# type: =encoding -#: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 -#: ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 -msgid "utf8" -msgstr "" - # type: =head1 +#. type: =head1 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 +#: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 +#: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 +#: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 +#: ../tools/virt-list-partitions.pl:30 msgid "NAME" msgstr "名前" # type: textblock +#. type: textblock #: ../src/guestfs.pod:5 msgid "guestfs - Library for accessing and modifying virtual machine images" msgstr "" # type: =head1 +#. type: =head1 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 +#: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 +#: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 +#: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 +#: ../tools/virt-list-partitions.pl:34 msgid "SYNOPSIS" msgstr "" # type: verbatim +#. type: verbatim #: ../src/guestfs.pod:9 #, no-wrap msgid "" @@ -48,6 +54,7 @@ msgid "" msgstr "" # type: verbatim +#. type: verbatim #: ../src/guestfs.pod:11 #, no-wrap msgid "" @@ -62,6 +69,7 @@ msgid "" msgstr "" # type: verbatim +#. type: verbatim #: ../src/guestfs.pod:19 #, no-wrap msgid "" @@ -72,12 +80,18 @@ msgid "" msgstr "" # type: =head1 +#. type: =head1 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 +#: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 +#: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 +#: ../tools/virt-tar.pl:72 ../tools/virt-make-fs.pl:47 +#: ../tools/virt-list-partitions.pl:40 msgid "DESCRIPTION" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:25 msgid "" "Libguestfs is a library for accessing and modifying guest disk images. " @@ -89,6 +103,7 @@ msgid "" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:33 msgid "" "Libguestfs uses Linux kernel and qemu code, and can access any type of guest " @@ -98,6 +113,7 @@ msgid "" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:38 msgid "" "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, " @@ -106,6 +122,7 @@ msgid "" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:43 msgid "" "Libguestfs is a library that can be linked with C and C++ management " @@ -115,6 +132,7 @@ msgid "" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:48 msgid "" "You don't need to be root to use libguestfs, although obviously you do need " @@ -122,6 +140,7 @@ msgid "" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:51 msgid "" "Libguestfs is a large API because it can do many things. For a gentle " @@ -129,6 +148,7 @@ msgid "" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:54 msgid "" "There are also some example programs in the L manual " @@ -136,11 +156,13 @@ msgid "" msgstr "" # type: =head1 +#. type: =head1 #: ../src/guestfs.pod:57 msgid "API OVERVIEW" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:59 msgid "" "This section provides a gentler overview of the libguestfs API. We also try " @@ -149,11 +171,13 @@ msgid "" msgstr "" # type: =head2 +#. type: =head2 #: ../src/guestfs.pod:64 msgid "HANDLES" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:66 msgid "" "Before you can use libguestfs calls, you have to create a handle. Then you " @@ -164,11 +188,13 @@ msgid "" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:73 msgid "The general structure of all libguestfs-using programs looks like this:" msgstr "" # type: verbatim +#. type: verbatim #: ../src/guestfs.pod:76 #, no-wrap msgid "" @@ -177,6 +203,7 @@ msgid "" msgstr "" # type: verbatim +#. type: verbatim #: ../src/guestfs.pod:78 #, no-wrap msgid "" @@ -188,6 +215,7 @@ msgid "" msgstr "" # type: verbatim +#. type: verbatim #: ../src/guestfs.pod:83 #, no-wrap msgid "" @@ -200,6 +228,7 @@ msgid "" msgstr "" # type: verbatim +#. type: verbatim #: ../src/guestfs.pod:89 #, no-wrap msgid "" @@ -211,6 +240,7 @@ msgid "" msgstr "" # type: verbatim +#. type: verbatim #: ../src/guestfs.pod:94 #, no-wrap msgid "" @@ -221,6 +251,7 @@ msgid "" msgstr "" # type: verbatim +#. type: verbatim #: ../src/guestfs.pod:98 #, no-wrap msgid "" @@ -232,6 +263,7 @@ msgid "" msgstr "" # type: verbatim +#. type: verbatim #: ../src/guestfs.pod:103 #, no-wrap msgid "" @@ -244,6 +276,7 @@ msgid "" msgstr "" # type: verbatim +#. type: verbatim #: ../src/guestfs.pod:109 #, no-wrap msgid "" @@ -253,6 +286,7 @@ msgid "" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:112 msgid "" "The code above doesn't include any error checking. In real code you should " @@ -265,11 +299,13 @@ msgid "" msgstr "" # type: =head2 +#. type: =head2 #: ../src/guestfs.pod:121 msgid "DISK IMAGES" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:123 msgid "" "The image filename (C<\"guest.img\"> in the example above) could be a disk " @@ -280,6 +316,7 @@ msgid "" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:129 msgid "" "The call you should use in modern code for adding drives is L. In either case " @@ -321,6 +362,7 @@ msgid "" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:147 msgid "" "Be extremely cautious if the disk image is in use, eg. if it is being used " @@ -329,6 +371,7 @@ msgid "" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:151 msgid "" "You must add at least one disk image, and you may add multiple disk images. " @@ -337,6 +380,7 @@ msgid "" msgstr "" # type: textblock +#. type: textblock #: ../src/guestfs.pod:156 msgid "" "Once L has been called you cannot add any more images. You " @@ -345,63 +389,74 @@ msgid "" msgstr "" # type: =head2 +#. type: =head2 #: ../src/guestfs.pod:161 msgid "MOUNTING" msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:163 msgid "" "Before you can read or write files, create directories and so on in a disk " "image that contains filesystems, you have to mount those filesystems using " -"L. If you already know that a disk image contains (for " -"example) one partition with a filesystem on that partition, then you can " -"mount it directly:" +"L or L. If you already know that " +"a disk image contains (for example) one partition with a filesystem on that " +"partition, then you can mount it directly:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:169 +#. type: verbatim +#: ../src/guestfs.pod:170 #, no-wrap msgid "" -" guestfs_mount (g, \"/dev/sda1\", \"/\");\n" +" guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:171 +#. type: textblock +#: ../src/guestfs.pod:172 msgid "" "where C means literally the first partition (C<1>) of the first " "disk image that we added (C). If the disk contains Linux LVM2 " -"logical volumes you could refer to those instead (eg. C)." +"logical volumes you could refer to those instead (eg. C). Note " +"that these are libguestfs virtual devices, and are nothing to do with host " +"devices." msgstr "" -# type: textblock -#: ../src/guestfs.pod:175 +#. type: textblock +#: ../src/guestfs.pod:178 msgid "" "If you are given a disk image and you don't know what it contains then you " "have to find out. Libguestfs can do that too: use L and L to list possible partitions and " "LVs, and either try mounting each to see what is mountable, or else examine " -"them with L or L. Libguestfs also has a " -"set of APIs for inspection of disk images (see L below). But " -"you might find it easier to look at higher level programs built on top of " -"libguestfs, in particular L." +"them with L or L. To list just " +"filesystems, use L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:185 +#. type: textblock +#: ../src/guestfs.pod:186 msgid "" -"To mount a disk image read-only, use L. There are " +"Libguestfs also has a set of APIs for inspection of unknown disk images (see " +"L below). But you might find it easier to look at higher level " +"programs built on top of libguestfs, in particular L." +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:191 +msgid "" +"To mount a filesystem read-only, use L. There are " "several other variations of the C call." msgstr "" # type: =head2 -#: ../src/guestfs.pod:188 +#. type: =head2 +#: ../src/guestfs.pod:194 msgid "FILESYSTEM ACCESS AND MODIFICATION" msgstr "" # type: textblock -#: ../src/guestfs.pod:190 +#. type: textblock +#: ../src/guestfs.pod:196 msgid "" "The majority of the libguestfs API consists of fairly low-level calls for " "accessing and modifying the files, directories, symlinks etc on mounted " @@ -411,21 +466,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:196 +#. type: textblock +#: ../src/guestfs.pod:202 msgid "" "Specify filenames as full paths, starting with C<\"/\"> and including the " "mount point." msgstr "" # type: textblock -#: ../src/guestfs.pod:199 +#. type: textblock +#: ../src/guestfs.pod:205 msgid "" "For example, if you mounted a filesystem at C<\"/\"> and you want to read " "the file called C<\"etc/passwd\"> then you could do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:202 +#. type: verbatim +#: ../src/guestfs.pod:208 #, no-wrap msgid "" " char *data = guestfs_cat (g, \"/etc/passwd\");\n" @@ -433,7 +491,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:204 +#. type: textblock +#: ../src/guestfs.pod:210 msgid "" "This would return C as a newly allocated buffer containing the full " "content of that file (with some conditions: see also L below), " @@ -441,14 +500,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:208 +#. type: textblock +#: ../src/guestfs.pod:214 msgid "" "As another example, to create a top-level directory on that filesystem " "called C<\"var\"> you would do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:211 +#. type: verbatim +#: ../src/guestfs.pod:217 #, no-wrap msgid "" " guestfs_mkdir (g, \"/var\");\n" @@ -456,12 +517,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:213 +#. type: textblock +#: ../src/guestfs.pod:219 msgid "To create a symlink you could do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:215 +#. type: verbatim +#: ../src/guestfs.pod:221 #, no-wrap msgid "" " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n" @@ -470,14 +533,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:218 +#. type: textblock +#: ../src/guestfs.pod:224 msgid "" "Libguestfs will reject attempts to use relative paths and there is no " "concept of a current working directory." msgstr "" # type: textblock -#: ../src/guestfs.pod:221 +#. type: textblock +#: ../src/guestfs.pod:227 msgid "" "Libguestfs can return errors in many situations: for example if the " "filesystem isn't writable, or if a file or directory that you requested " @@ -487,33 +552,38 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:227 +#. type: textblock +#: ../src/guestfs.pod:233 msgid "" "File writes are affected by the per-handle umask, set by calling L and defaulting to 022. See L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:230 +#. type: =head2 +#: ../src/guestfs.pod:236 msgid "PARTITIONING" msgstr "" # type: textblock -#: ../src/guestfs.pod:232 +#. type: textblock +#: ../src/guestfs.pod:238 msgid "" "Libguestfs contains API calls to read, create and modify partition tables on " "disk images." msgstr "" # type: textblock -#: ../src/guestfs.pod:235 +#. type: textblock +#: ../src/guestfs.pod:241 msgid "" "In the common case where you want to create a single partition covering the " "whole disk, you should use the L call:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:239 +#. type: verbatim +#: ../src/guestfs.pod:245 #, no-wrap msgid "" " const char *parttype = \"mbr\";\n" @@ -524,18 +594,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:244 +#. type: textblock +#: ../src/guestfs.pod:250 msgid "" "Obviously this effectively wipes anything that was on that disk image before." msgstr "" # type: =head2 -#: ../src/guestfs.pod:247 +#. type: =head2 +#: ../src/guestfs.pod:253 msgid "LVM2" msgstr "" # type: textblock -#: ../src/guestfs.pod:249 +#. type: textblock +#: ../src/guestfs.pod:255 msgid "" "Libguestfs provides access to a large part of the LVM2 API, such as L and L. It won't make much sense unless " @@ -544,27 +617,30 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:254 +#. type: textblock +#: ../src/guestfs.pod:260 msgid "" "This author strongly recommends reading the LVM HOWTO, online at L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:257 +#. type: =head2 +#: ../src/guestfs.pod:263 msgid "DOWNLOADING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:259 +#. type: textblock +#: ../src/guestfs.pod:265 msgid "" "Use L to download small, text only files. This call is " "limited to files which are less than 2 MB and which cannot contain any ASCII " -"NUL (C<\\0>) characters. However it has a very simple to use API." +"NUL (C<\\0>) characters. However the API is very simple to use." msgstr "" # type: textblock -#: ../src/guestfs.pod:264 +#. type: textblock +#: ../src/guestfs.pod:269 msgid "" "L can be used to read files which contain arbitrary 8 " "bit data, since it returns a (pointer, size) pair. However it is still " @@ -572,31 +648,36 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:268 +#. type: textblock +#: ../src/guestfs.pod:273 msgid "" "L can be used to download any file, with no limits on " "content or size (even files larger than 4 GB)." msgstr "" # type: textblock -#: ../src/guestfs.pod:271 +#. type: textblock +#: ../src/guestfs.pod:276 msgid "" "To download multiple files, see L and L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:274 +#. type: =head2 +#: ../src/guestfs.pod:279 msgid "UPLOADING" msgstr "" # type: textblock -#: ../src/guestfs.pod:276 +#. type: textblock +#: ../src/guestfs.pod:281 msgid "" "It's often the case that you want to write a file or files to the disk image." msgstr "" # type: textblock -#: ../src/guestfs.pod:279 +#. type: textblock +#: ../src/guestfs.pod:284 msgid "" "To write a small file with fixed content, use L. To create " "a file of all zeroes, use L (sparse) or L. This call has no limits on " "file content or size (even files larger than 4 GB)." msgstr "" # type: textblock -#: ../src/guestfs.pod:288 +#. type: textblock +#: ../src/guestfs.pod:293 msgid "" "To upload multiple files, see L and L." msgstr "" # type: textblock -#: ../src/guestfs.pod:290 +#. type: textblock +#: ../src/guestfs.pod:295 msgid "" "However the fastest way to upload I is to " "turn them into a squashfs or CD ISO (see L and L to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:311 +#. type: textblock +#: ../src/guestfs.pod:316 msgid "" "Use L to copy a single file, or L to copy " "directories recursively." msgstr "" # type: =item -#: ../src/guestfs.pod:314 +#. type: =item +#: ../src/guestfs.pod:319 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:316 +#. type: textblock +#: ../src/guestfs.pod:321 msgid "" "Use L which efficiently uses L to copy between files and " "devices in the guest." msgstr "" # type: textblock -#: ../src/guestfs.pod:319 +#. type: textblock +#: ../src/guestfs.pod:324 msgid "Example: duplicate the contents of an LV:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:321 +#. type: verbatim +#: ../src/guestfs.pod:326 #, no-wrap msgid "" " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n" @@ -683,7 +775,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:323 +#. type: textblock +#: ../src/guestfs.pod:328 msgid "" "The destination (C) must be at least as large as the source " "(C). To copy less than the whole source device, use L to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:329 +#. type: textblock +#: ../src/guestfs.pod:334 msgid "Use L. See L above." msgstr "" # type: =item -#: ../src/guestfs.pod:331 +#. type: =item +#: ../src/guestfs.pod:336 msgid "B to B" msgstr "" # type: textblock -#: ../src/guestfs.pod:333 +#. type: textblock +#: ../src/guestfs.pod:338 msgid "Use L. See L above." msgstr "" # type: =head2 -#: ../src/guestfs.pod:337 +#. type: =head2 +#: ../src/guestfs.pod:342 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS" msgstr "" # type: textblock -#: ../src/guestfs.pod:339 +#. type: textblock +#: ../src/guestfs.pod:344 msgid "" "Calls like L, L, L, L etc appear to only take filenames as arguments, so it " @@ -727,54 +826,60 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:347 +#. type: textblock +#: ../src/guestfs.pod:352 msgid "For example, L writes its output to stdout by doing:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:350 +#. type: verbatim +#: ../src/guestfs.pod:355 #, no-wrap msgid "" -" guestfs_download (filename, \"/dev/stdout\");\n" +" guestfs_download (g, filename, \"/dev/stdout\");\n" "\n" msgstr "" # type: textblock -#: ../src/guestfs.pod:352 +#. type: textblock +#: ../src/guestfs.pod:357 msgid "and you can write tar output to a pipe C by doing:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:354 +#. type: verbatim +#: ../src/guestfs.pod:359 #, no-wrap msgid "" " char devfd[64];\n" " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n" -" guestfs_tar_out (\"/\", devfd);\n" +" guestfs_tar_out (g, \"/\", devfd);\n" "\n" msgstr "" # type: =head2 -#: ../src/guestfs.pod:358 +#. type: =head2 +#: ../src/guestfs.pod:363 msgid "LISTING FILES" msgstr "" # type: textblock -#: ../src/guestfs.pod:360 +#. type: textblock +#: ../src/guestfs.pod:365 msgid "" "L is just designed for humans to read (mainly when using the " "L-equivalent command C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:363 +#. type: textblock +#: ../src/guestfs.pod:368 msgid "" "L is a quick way to get a list of files in a directory from " "programs, as a flat list of strings." msgstr "" # type: textblock -#: ../src/guestfs.pod:366 +#. type: textblock +#: ../src/guestfs.pod:371 msgid "" "L is a programmatic way to get a list of files in a " "directory, plus additional information about each one. It is more " @@ -782,18 +887,21 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:370 +#. type: textblock +#: ../src/guestfs.pod:375 msgid "" "L and L can be used to recursively list files." msgstr "" # type: =head2 -#: ../src/guestfs.pod:373 +#. type: =head2 +#: ../src/guestfs.pod:378 msgid "RUNNING COMMANDS" msgstr "" # type: textblock -#: ../src/guestfs.pod:375 +#. type: textblock +#: ../src/guestfs.pod:380 msgid "" "Although libguestfs is primarily an API for manipulating files inside guest " "images, we also provide some limited facilities for running commands inside " @@ -801,97 +909,110 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:379 +#. type: textblock +#: ../src/guestfs.pod:384 msgid "There are many limitations to this:" msgstr "" # type: =item -#: ../src/guestfs.pod:383 ../src/guestfs.pod:388 ../src/guestfs.pod:393 -#: ../src/guestfs.pod:397 ../src/guestfs.pod:402 ../src/guestfs.pod:406 -#: ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:1006 -#: ../src/guestfs.pod:1010 ../src/guestfs.pod:1014 ../src/guestfs.pod:1019 -#: ../src/guestfs.pod:1027 ../src/guestfs.pod:1046 ../src/guestfs.pod:1054 -#: ../src/guestfs.pod:1076 ../src/guestfs.pod:1080 ../src/guestfs.pod:1084 -#: ../src/guestfs.pod:1088 ../src/guestfs.pod:1092 ../src/guestfs.pod:1096 -#: ../src/guestfs.pod:1578 ../src/guestfs.pod:1583 ../src/guestfs.pod:1587 -#: ../src/guestfs.pod:1697 ../src/guestfs.pod:1702 ../src/guestfs.pod:1706 -#: ../src/guestfs.pod:2058 ../src/guestfs.pod:2064 ../src/guestfs.pod:2069 -#: ../src/guestfs.pod:2075 ../src/guestfs.pod:2187 ../src/guestfs.pod:2191 -#: ../src/guestfs.pod:2195 ../src/guestfs.pod:2199 +#. type: =item +#: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 +#: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 +#: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1011 +#: ../src/guestfs.pod:1015 ../src/guestfs.pod:1019 ../src/guestfs.pod:1024 +#: ../src/guestfs.pod:1032 ../src/guestfs.pod:1051 ../src/guestfs.pod:1059 +#: ../src/guestfs.pod:1081 ../src/guestfs.pod:1085 ../src/guestfs.pod:1089 +#: ../src/guestfs.pod:1093 ../src/guestfs.pod:1097 ../src/guestfs.pod:1101 +#: ../src/guestfs.pod:1583 ../src/guestfs.pod:1588 ../src/guestfs.pod:1592 +#: ../src/guestfs.pod:1702 ../src/guestfs.pod:1707 ../src/guestfs.pod:1711 +#: ../src/guestfs.pod:2063 ../src/guestfs.pod:2069 ../src/guestfs.pod:2074 +#: ../src/guestfs.pod:2080 ../src/guestfs.pod:2534 ../src/guestfs.pod:2538 +#: ../src/guestfs.pod:2542 ../src/guestfs.pod:2546 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 -#: ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:579 -#: ../src/guestfs-actions.pod:586 ../src/guestfs-actions.pod:593 -#: ../src/guestfs-actions.pod:1589 ../src/guestfs-actions.pod:1593 -#: ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:1601 -#: ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1613 -#: ../src/guestfs-actions.pod:1617 ../src/guestfs-actions.pod:1627 -#: ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1635 -#: ../src/guestfs-actions.pod:1773 ../src/guestfs-actions.pod:1777 -#: ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1787 -#: ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1852 -#: ../src/guestfs-actions.pod:1857 ../fish/guestfish.pod:427 +#: ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577 +#: ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591 +#: ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591 +#: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 +#: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 +#: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625 +#: ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633 +#: ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775 +#: ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785 +#: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 +#: ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:427 #: ../fish/guestfish.pod:431 ../fish/guestfish.pod:435 #: ../fish/guestfish.pod:439 ../fish/guestfish-actions.pod:13 -#: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod: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 +#: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:373 +#: ../fish/guestfish-actions.pod:381 ../fish/guestfish-actions.pod:388 +#: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:1065 +#: ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1073 +#: ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1085 +#: ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1093 +#: ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107 +#: ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1201 +#: ../fish/guestfish-actions.pod:1205 ../fish/guestfish-actions.pod:1210 +#: ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1257 +#: ../fish/guestfish-actions.pod:1261 ../fish/guestfish-actions.pod:1266 +#: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 +#: ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 +#: ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360 msgid "*" msgstr "" # type: textblock -#: ../src/guestfs.pod:385 +#. type: textblock +#: ../src/guestfs.pod:390 msgid "" "The kernel version that the command runs under will be different from what " "it expects." msgstr "" # type: textblock -#: ../src/guestfs.pod:390 +#. type: textblock +#: ../src/guestfs.pod:395 msgid "" "If the command needs to communicate with daemons, then most likely they " "won't be running." msgstr "" # type: textblock -#: ../src/guestfs.pod:395 +#. type: textblock +#: ../src/guestfs.pod:400 msgid "The command will be running in limited memory." msgstr "" # type: textblock -#: ../src/guestfs.pod:399 +#. type: textblock +#: ../src/guestfs.pod:404 msgid "" "The network may not be available unless you enable it (see L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:404 +#. type: textblock +#: ../src/guestfs.pod:409 msgid "Only supports Linux guests (not Windows, BSD, etc)." msgstr "" # type: textblock -#: ../src/guestfs.pod:408 +#. type: textblock +#: ../src/guestfs.pod:413 msgid "" "Architecture limitations (eg. won't work for a PPC guest on an X86 host)." msgstr "" # type: textblock -#: ../src/guestfs.pod:413 +#. type: textblock +#: ../src/guestfs.pod:418 msgid "" "For SELinux guests, you may need to enable SELinux and load policy first. " "See L in this manpage." msgstr "" # type: textblock -#: ../src/guestfs.pod:418 +#. type: textblock +#: ../src/guestfs.pod:423 msgid "" "I It is not safe to run commands from untrusted, possibly " "malicious guests. These commands may attempt to exploit your program by " @@ -903,7 +1024,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:427 +#. type: textblock +#: ../src/guestfs.pod:432 msgid "" "A secure alternative is to use libguestfs to install a \"firstboot\" script " "(a script which runs when the guest next boots normally), and to have this " @@ -913,26 +1035,30 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:435 +#. type: textblock +#: ../src/guestfs.pod:440 msgid "" "The two main API calls to run commands are L and L (there are also variations)." msgstr "" # type: textblock -#: ../src/guestfs.pod:438 +#. type: textblock +#: ../src/guestfs.pod:443 msgid "" "The difference is that L runs commands using the shell, so any " "shell globs, redirections, etc will work." msgstr "" # type: =head2 -#: ../src/guestfs.pod:441 +#. type: =head2 +#: ../src/guestfs.pod:446 msgid "CONFIGURATION FILES" msgstr "" # type: textblock -#: ../src/guestfs.pod:443 +#. type: textblock +#: ../src/guestfs.pod:448 msgid "" "To read and write configuration files in Linux guest filesystems, we " "strongly recommend using Augeas. For example, Augeas understands how to " @@ -941,7 +1067,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:448 +#. type: textblock +#: ../src/guestfs.pod:453 msgid "" "The main Augeas calls are bound through the C APIs. We don't " "document Augeas itself here because there is excellent documentation on the " @@ -949,7 +1076,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:452 +#. type: textblock +#: ../src/guestfs.pod:457 msgid "" "If you don't want to use Augeas (you fool!) then try calling L to get the file as a list of lines which you can iterate " @@ -957,29 +1085,35 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:456 +#. type: =head2 +#: ../src/guestfs.pod:461 msgid "SELINUX" msgstr "" # type: textblock -#: ../src/guestfs.pod:458 +#. type: textblock +#: ../src/guestfs.pod:463 msgid "" "We support SELinux guests. To ensure that labeling happens correctly in " "SELinux guests, you need to enable SELinux and load the guest's policy:" msgstr "" # type: =item -#: ../src/guestfs.pod:464 ../src/guestfs.pod:1199 ../src/guestfs.pod:1330 +#. type: =item +#: ../src/guestfs.pod:469 ../src/guestfs.pod:1204 ../src/guestfs.pod:1335 +#: ../src/guestfs.pod:2108 msgid "1." msgstr "" # type: textblock -#: ../src/guestfs.pod:466 +#. type: textblock +#: ../src/guestfs.pod:471 msgid "Before launching, do:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:468 +#. type: verbatim +#: ../src/guestfs.pod:473 #, no-wrap msgid "" " guestfs_set_selinux (g, 1);\n" @@ -987,19 +1121,23 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:470 ../src/guestfs.pod:1203 ../src/guestfs.pod:1334 +#. type: =item +#: ../src/guestfs.pod:475 ../src/guestfs.pod:1208 ../src/guestfs.pod:1339 +#: ../src/guestfs.pod:2133 msgid "2." msgstr "" # type: textblock -#: ../src/guestfs.pod:472 +#. type: textblock +#: ../src/guestfs.pod:477 msgid "" "After mounting the guest's filesystem(s), load the policy. This is best " "done by running the L command in the guest itself:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:476 +#. type: verbatim +#: ../src/guestfs.pod:481 #, no-wrap msgid "" " guestfs_sh (g, \"/usr/sbin/load_policy\");\n" @@ -1007,26 +1145,30 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:478 +#. type: textblock +#: ../src/guestfs.pod:483 msgid "" "(Older versions of C require you to specify the name of the " "policy file)." msgstr "" # type: =item -#: ../src/guestfs.pod:481 ../src/guestfs.pod:1340 +#. type: =item +#: ../src/guestfs.pod:486 ../src/guestfs.pod:1345 msgid "3." msgstr "" # type: textblock -#: ../src/guestfs.pod:483 +#. type: textblock +#: ../src/guestfs.pod:488 msgid "" "Optionally, set the security context for the API. The correct security " "context to use can only be known by inspecting the guest. As an example:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:487 +#. type: verbatim +#: ../src/guestfs.pod:492 #, no-wrap msgid "" " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n" @@ -1034,24 +1176,28 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:491 +#. type: textblock +#: ../src/guestfs.pod:496 msgid "This will work for running commands and editing existing files." msgstr "" # type: textblock -#: ../src/guestfs.pod:493 +#. type: textblock +#: ../src/guestfs.pod:498 msgid "" "When new files are created, you may need to label them explicitly, for " "example by running the external command C." msgstr "" # type: =head2 -#: ../src/guestfs.pod:497 +#. type: =head2 +#: ../src/guestfs.pod:502 msgid "UMASK" msgstr "" # type: textblock -#: ../src/guestfs.pod:499 +#. type: textblock +#: ../src/guestfs.pod:504 msgid "" "Certain calls are affected by the current file mode creation mask (the " "\"umask\"). In particular ones which create files or directories, such as " @@ -1061,14 +1207,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:505 +#. type: textblock +#: ../src/guestfs.pod:510 msgid "" "The default umask is C<022>, so files are created with modes such as C<0644> " "and directories with C<0755>." msgstr "" # type: textblock -#: ../src/guestfs.pod:508 +#. type: textblock +#: ../src/guestfs.pod:513 msgid "" "There are two ways to avoid being affected by umask. Either set umask to 0 " "(call C early after launching). Or call L." msgstr "" # type: =head1 -#: ../src/guestfs.pod:514 ../fish/guestfish.pod:720 +#. type: =head1 +#: ../src/guestfs.pod:519 ../fish/guestfish.pod:720 msgid "ENCRYPTED DISKS" msgstr "" # type: textblock -#: ../src/guestfs.pod:516 +#. type: textblock +#: ../src/guestfs.pod:521 msgid "" "Libguestfs allows you to access Linux guests which have been encrypted using " "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) " @@ -1095,21 +1246,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:522 +#. type: textblock +#: ../src/guestfs.pod:527 msgid "" "Use L to identify LUKS-encrypted block devices (it " "returns the string C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:525 +#. type: textblock +#: ../src/guestfs.pod:530 msgid "" "Then open these devices by calling L. Obviously you " "will require the passphrase!" msgstr "" # type: textblock -#: ../src/guestfs.pod:528 +#. type: textblock +#: ../src/guestfs.pod:533 msgid "" "Opening a LUKS device creates a new device mapper device called C (where C is the string you supply to L followed by L. The logical volume" @@ -1126,7 +1281,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:538 +#. type: textblock +#: ../src/guestfs.pod:543 msgid "" "Use the reverse process to close a LUKS device. Unmount any logical volumes " "on it, deactivate the volume groups by caling C in the usual way." msgstr "" # type: textblock -#: ../src/guestfs.pod:556 +#. type: textblock +#: ../src/guestfs.pod:561 msgid "" "Then call L. This function uses other libguestfs calls " "and certain heuristics, and returns a list of operating systems that were " @@ -1171,7 +1331,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:565 +#. type: textblock +#: ../src/guestfs.pod:570 msgid "" "For each root, you can then call various C functions " "to get additional details about that operating system. For example, call L /dev/sda1\n" @@ -1201,21 +1364,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:582 +#. type: textblock +#: ../src/guestfs.pod:587 msgid "" "The caller can then make calls to L to mount the " "filesystems as suggested." msgstr "" # type: textblock -#: ../src/guestfs.pod:585 +#. type: textblock +#: ../src/guestfs.pod:590 msgid "" "Be careful to mount filesystems in the right order (eg. C before C). Sorting the keys of the hash by length, shortest first, should work." msgstr "" # type: textblock -#: ../src/guestfs.pod:589 +#. type: textblock +#: ../src/guestfs.pod:594 msgid "" "Inspection currently only works for some common operating systems. " "Contributors are welcome to send patches for other operating systems that we " @@ -1223,7 +1389,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:593 +#. type: textblock +#: ../src/guestfs.pod:598 msgid "" "Encrypted disks must be opened before inspection. See L " "for more details. The L function just ignores any " @@ -1231,7 +1398,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:597 +#. type: textblock +#: ../src/guestfs.pod:602 msgid "" "A note on the implementation: The call L performs " "inspection and caches the results in the guest handle. Subsequent calls to " @@ -1244,24 +1412,28 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:606 +#. type: =head2 +#: ../src/guestfs.pod:611 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:608 +#. type: textblock +#: ../src/guestfs.pod:613 msgid "" "Libguestfs can mount NTFS partitions. It does this using the L driver." msgstr "" # type: =head3 -#: ../src/guestfs.pod:611 +#. type: =head3 +#: ../src/guestfs.pod:616 msgid "DRIVE LETTERS AND PATHS" msgstr "" # type: textblock -#: ../src/guestfs.pod:613 +#. type: textblock +#: ../src/guestfs.pod:618 msgid "" "DOS and Windows still use drive letters, and the filesystems are always " "treated as case insensitive by Windows itself, and therefore you might find " @@ -1271,7 +1443,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:619 +#. type: textblock +#: ../src/guestfs.pod:624 msgid "" "Drive letter mappings are outside the scope of libguestfs. You have to use " "libguestfs to read the appropriate Windows Registry and configuration files, " @@ -1280,26 +1453,30 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:624 +#. type: textblock +#: ../src/guestfs.pod:629 msgid "" "Replacing backslash characters with forward slash characters is also outside " "the scope of libguestfs, but something that you can easily do." msgstr "" # type: textblock -#: ../src/guestfs.pod:627 +#. type: textblock +#: ../src/guestfs.pod:632 msgid "" "Where we can help is in resolving the case insensitivity of paths. For " "this, call L." msgstr "" # type: =head3 -#: ../src/guestfs.pod:630 +#. type: =head3 +#: ../src/guestfs.pod:635 msgid "ACCESSING THE WINDOWS REGISTRY" msgstr "" # type: textblock -#: ../src/guestfs.pod:632 +#. type: textblock +#: ../src/guestfs.pod:637 msgid "" "Libguestfs also provides some help for decoding Windows Registry \"hive\" " "files, through the library C which is part of the libguestfs project " @@ -1310,12 +1487,14 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:640 +#. type: =head3 +#: ../src/guestfs.pod:645 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS" msgstr "" # type: textblock -#: ../src/guestfs.pod:642 +#. type: textblock +#: ../src/guestfs.pod:647 msgid "" "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to " "provide something which looks like a Linux symlink. The way it tries to do " @@ -1323,14 +1502,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:646 +#. type: textblock +#: ../src/guestfs.pod:651 msgid "" "L" msgstr "" # type: textblock -#: ../src/guestfs.pod:648 +#. type: textblock +#: ../src/guestfs.pod:653 msgid "" "The essential problem is that ntfs-3g simply does not have enough " "information to do a correct job. NTFS links can contain drive letters and " @@ -1340,7 +1521,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:655 +#. type: textblock +#: ../src/guestfs.pod:660 msgid "" "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L to read the C extended " @@ -1349,53 +1531,61 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:660 +#. type: =head3 +#: ../src/guestfs.pod:665 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS" msgstr "" # type: textblock -#: ../src/guestfs.pod:662 +#. type: textblock +#: ../src/guestfs.pod:667 msgid "" "There are other useful extended attributes that can be read from ntfs-3g " "filesystems (using L). See:" msgstr "" # type: textblock -#: ../src/guestfs.pod:665 +#. type: textblock +#: ../src/guestfs.pod:670 msgid "" "L" msgstr "" # type: =head2 -#: ../src/guestfs.pod:667 +#. type: =head2 +#: ../src/guestfs.pod:672 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:669 +#. type: textblock +#: ../src/guestfs.pod:674 msgid "" "Although we don't want to discourage you from using the C API, we will " "mention here that the same API is also available in other languages." msgstr "" -# type: textblock -#: ../src/guestfs.pod:672 +#. type: textblock +#: ../src/guestfs.pod:677 msgid "" "The API is broadly identical in all supported languages. This means that " -"the C call C is C<$g-Emount($path)> in Perl, C in Python, and C in OCaml. In other " -"words, a straightforward, predictable isomorphism between each language." +"the C call C is C<$g-Eadd_drive_ro($file)> " +"in Perl, C in Python, and C in " +"OCaml. In other words, a straightforward, predictable isomorphism between " +"each language." msgstr "" # type: textblock -#: ../src/guestfs.pod:678 +#. type: textblock +#: ../src/guestfs.pod:683 msgid "" "Error messages are automatically transformed into exceptions if the language " "supports it." msgstr "" # type: textblock -#: ../src/guestfs.pod:681 +#. type: textblock +#: ../src/guestfs.pod:686 msgid "" "We don't try to \"object orientify\" parts of the API in OO languages, " "although contributors are welcome to write higher level APIs above what we " @@ -1403,36 +1593,42 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:687 +#. type: =item +#: ../src/guestfs.pod:692 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:689 +#. type: textblock +#: ../src/guestfs.pod:694 msgid "" "You can use the I header file from C++ programs. The C++ API is " "identical to the C API. C++ classes and exceptions are not used." msgstr "" # type: =item -#: ../src/guestfs.pod:693 +#. type: =item +#: ../src/guestfs.pod:698 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:695 +#. type: textblock +#: ../src/guestfs.pod:700 msgid "" "The C# bindings are highly experimental. Please read the warnings at the " "top of C." msgstr "" # type: =item -#: ../src/guestfs.pod:698 +#. type: =item +#: ../src/guestfs.pod:703 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:700 +#. type: textblock +#: ../src/guestfs.pod:705 msgid "" "This is the only language binding that is working but incomplete. Only " "calls which return simple integers have been bound in Haskell, and we are " @@ -1440,91 +1636,103 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:704 +#. type: =item +#: ../src/guestfs.pod:709 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:706 +#. type: textblock +#: ../src/guestfs.pod:711 msgid "" "Full documentation is contained in the Javadoc which is distributed with " "libguestfs." msgstr "" # type: =item -#: ../src/guestfs.pod:709 +#. type: =item +#: ../src/guestfs.pod:714 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:711 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:716 +msgid "See L." msgstr "" # type: =item -#: ../src/guestfs.pod:713 +#. type: =item +#: ../src/guestfs.pod:718 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:715 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:720 +msgid "See L." msgstr "" # type: =item -#: ../src/guestfs.pod:717 +#. type: =item +#: ../src/guestfs.pod:722 msgid "B" msgstr "" # type: textblock -#: ../src/guestfs.pod:719 +#. type: textblock +#: ../src/guestfs.pod:724 msgid "" "For documentation see C supplied with libguestfs sources or in " "the php-libguestfs package for your distribution." msgstr "" # type: textblock -#: ../src/guestfs.pod:722 +#. type: textblock +#: ../src/guestfs.pod:727 msgid "The PHP binding only works correctly on 64 bit machines." msgstr "" # type: =item -#: ../src/guestfs.pod:724 +#. type: =item +#: ../src/guestfs.pod:729 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:726 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:731 +msgid "See L." msgstr "" # type: =item -#: ../src/guestfs.pod:728 +#. type: =item +#: ../src/guestfs.pod:733 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:730 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:735 +msgid "See L." msgstr "" # type: =item -#: ../src/guestfs.pod:732 +#. type: =item +#: ../src/guestfs.pod:737 msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:734 -msgid "For documentation see L." +#. type: textblock +#: ../src/guestfs.pod:739 +msgid "See L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:738 +#. type: =head2 +#: ../src/guestfs.pod:743 msgid "LIBGUESTFS GOTCHAS" msgstr "" # type: textblock -#: ../src/guestfs.pod:740 +#. type: textblock +#: ../src/guestfs.pod:745 msgid "" "L: \"A feature of a " "system [...] that works in the way it is documented but is counterintuitive " @@ -1532,7 +1740,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:744 +#. type: textblock +#: ../src/guestfs.pod:749 msgid "" "Since we developed libguestfs and the associated tools, there are several " "things we would have designed differently, but are now stuck with for " @@ -1541,12 +1750,14 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:752 +#. type: =item +#: ../src/guestfs.pod:757 msgid "Autosync / forgetting to sync." msgstr "" # type: textblock -#: ../src/guestfs.pod:754 +#. type: textblock +#: ../src/guestfs.pod:759 msgid "" "When modifying a filesystem from C or another language, you B unmount " "all filesystems and call L explicitly before you close the " @@ -1554,7 +1765,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:758 +#. type: verbatim +#: ../src/guestfs.pod:763 #, no-wrap msgid "" " guestfs_set_autosync (g, 1);\n" @@ -1562,14 +1774,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:760 +#. type: textblock +#: ../src/guestfs.pod:765 msgid "" "to have the unmount/sync done automatically for you when the handle 'g' is " "closed. (This feature is called \"autosync\", L q.v.)" msgstr "" # type: textblock -#: ../src/guestfs.pod:764 +#. type: textblock +#: ../src/guestfs.pod:769 msgid "" "If you forget to do this, then it is entirely possible that your changes " "won't be written out, or will be partially written, or (very rarely) that " @@ -1577,7 +1791,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:768 +#. type: textblock +#: ../src/guestfs.pod:773 msgid "" "Note that in L autosync is the default. So quick and dirty " "guestfish scripts that forget to sync will work just fine, which can make " @@ -1585,19 +1800,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:772 +#. type: textblock +#: ../src/guestfs.pod:777 msgid "" "Update: Autosync is enabled by default for all API users starting from " "libguestfs 1.5.24." msgstr "" # type: =item -#: ../src/guestfs.pod:775 +#. type: =item +#: ../src/guestfs.pod:780 msgid "Mount option C<-o sync> should not be the default." msgstr "" # type: textblock -#: ../src/guestfs.pod:777 +#. type: textblock +#: ../src/guestfs.pod:782 msgid "" "If you use L, then C<-o sync,noatime> are added implicitly. " "However C<-o sync> does not add any reliability benefit, but does have a " @@ -1605,31 +1823,36 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:781 +#. type: textblock +#: ../src/guestfs.pod:786 msgid "" "The work around is to use L and set the mount " "options that you actually want to use." msgstr "" # type: =item -#: ../src/guestfs.pod:784 +#. type: =item +#: ../src/guestfs.pod:789 msgid "Read-only should be the default." msgstr "" # type: textblock -#: ../src/guestfs.pod:786 +#. type: textblock +#: ../src/guestfs.pod:791 msgid "" "In L, I<--ro> should be the default, and you should have to " "specify I<--rw> if you want to make changes to the image." msgstr "" # type: textblock -#: ../src/guestfs.pod:789 +#. type: textblock +#: ../src/guestfs.pod:794 msgid "This would reduce the potential to corrupt live VM images." msgstr "" # type: textblock -#: ../src/guestfs.pod:791 +#. type: textblock +#: ../src/guestfs.pod:796 msgid "" "Note that many filesystems change the disk when you just mount and unmount, " "even if you didn't perform any writes. You need to use L doesn't do what people expect (open C for " "examination). It tries to run a guestfish command C which doesn't " @@ -1652,12 +1877,14 @@ msgid "" msgstr "" # type: =item -#: ../src/guestfs.pod:804 +#. type: =item +#: ../src/guestfs.pod:809 msgid "guestfish megabyte modifiers don't work right on all commands" msgstr "" # type: textblock -#: ../src/guestfs.pod:806 +#. type: textblock +#: ../src/guestfs.pod:811 msgid "" "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for " "other modifiers). What guestfish actually does is to multiply the number " @@ -1667,12 +1894,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:813 +#. type: textblock +#: ../src/guestfs.pod:818 msgid "The most common is L. The guestfish command:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:815 +#. type: verbatim +#: ../src/guestfs.pod:820 #, no-wrap msgid "" " lvcreate LV VG 100M\n" @@ -1680,7 +1909,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:817 +#. type: textblock +#: ../src/guestfs.pod:822 msgid "" "does not do what you might expect. Instead because L is " "already expecting megabytes, this tries to create a 100 I (100 " @@ -1689,19 +1919,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:822 +#. type: textblock +#: ../src/guestfs.pod:827 msgid "" "This could be fixed in the generator by specially marking parameters and " "return values which take bytes or other units." msgstr "" # type: =item -#: ../src/guestfs.pod:825 +#. type: =item +#: ../src/guestfs.pod:830 msgid "Ambiguity between devices and paths" msgstr "" # type: textblock -#: ../src/guestfs.pod:827 +#. type: textblock +#: ../src/guestfs.pod:832 msgid "" "There is a subtle ambiguity in the API between a device name (eg. C) and a similar pathname. A file might just happen to be called " @@ -1709,7 +1942,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:832 +#. type: textblock +#: ../src/guestfs.pod:837 msgid "" "In the current API we usually resolve this ambiguity by having two separate " "calls, for example L and L. " @@ -1718,7 +1952,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:838 +#. type: textblock +#: ../src/guestfs.pod:843 msgid "" "To avoid both the ambiguity and the need to duplicate some calls, we could " "make paths/devices into structured names. One way to do this would be to " @@ -1728,7 +1963,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:844 +#. type: verbatim +#: ../src/guestfs.pod:849 #, no-wrap msgid "" " type path = Path of string | Device of int | Partition of int * int\n" @@ -1736,12 +1972,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:846 +#. type: textblock +#: ../src/guestfs.pod:851 msgid "which would allow you to pass arguments like:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:848 +#. type: verbatim +#: ../src/guestfs.pod:853 #, no-wrap msgid "" " Path \"/foo/bar\"\n" @@ -1752,19 +1990,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:853 +#. type: textblock +#: ../src/guestfs.pod:858 msgid "" "As you can see there are still problems to resolve even with this " "representation. Also consider how it might work in guestfish." msgstr "" # type: =head2 -#: ../src/guestfs.pod:858 +#. type: =head2 +#: ../src/guestfs.pod:863 msgid "PROTOCOL LIMITS" msgstr "" # type: textblock -#: ../src/guestfs.pod:860 +#. type: textblock +#: ../src/guestfs.pod:865 msgid "" "Internally libguestfs uses a message-based protocol to pass API calls and " "their responses to and from a small \"appliance\" (see L for " @@ -1775,7 +2016,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:868 +#. type: textblock +#: ../src/guestfs.pod:873 msgid "" "A simple call such as L returns its result (the file data) in " "a simple string. Because this string is at some point internally encoded as " @@ -1784,7 +2026,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:874 +#. type: textblock +#: ../src/guestfs.pod:879 msgid "" "In order to transfer large files into and out of the guest filesystem, you " "need to use particular calls that support this. The sections L " @@ -1792,26 +2035,30 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:878 +#. type: textblock +#: ../src/guestfs.pod:883 msgid "" "You might also consider mounting the disk image using our FUSE filesystem " "support (L)." msgstr "" # type: =head2 -#: ../src/guestfs.pod:881 +#. type: =head2 +#: ../src/guestfs.pod:886 msgid "KEYS AND PASSPHRASES" msgstr "" # type: textblock -#: ../src/guestfs.pod:883 +#. type: textblock +#: ../src/guestfs.pod:888 msgid "" "Certain libguestfs calls take a parameter that contains sensitive key " "material, passed in as a C string." msgstr "" # type: textblock -#: ../src/guestfs.pod:886 +#. type: textblock +#: ../src/guestfs.pod:891 msgid "" "In the future we would hope to change the libguestfs implementation so that " "keys are L-ed into physical RAM, and thus can never end up in " @@ -1820,7 +2067,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:891 +#. type: textblock +#: ../src/guestfs.pod:896 msgid "" "Therefore you should be aware that any key parameter you pass to libguestfs " "might end up being written out to the swap partition. If this is a concern, " @@ -1828,19 +2076,22 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:896 +#. type: =head2 +#: ../src/guestfs.pod:901 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" msgstr "" # type: textblock -#: ../src/guestfs.pod:898 +#. type: textblock +#: ../src/guestfs.pod:903 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:901 +#. type: textblock +#: ../src/guestfs.pod:906 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 " @@ -1848,33 +2099,38 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:905 +#. type: textblock +#: ../src/guestfs.pod:910 msgid "" "See the graphical program guestfs-browser for one possible architecture for " "multithreaded programs using libvirt and libguestfs." msgstr "" # type: =head1 -#: ../src/guestfs.pod:908 +#. type: =head2 +#: ../src/guestfs.pod:913 msgid "PATH" msgstr "" # type: textblock -#: ../src/guestfs.pod:910 +#. type: textblock +#: ../src/guestfs.pod:915 msgid "" "Libguestfs needs a kernel and initrd.img, which it finds by looking along an " "internal path." msgstr "" # type: textblock -#: ../src/guestfs.pod:913 +#. type: textblock +#: ../src/guestfs.pod:918 msgid "" "By default it looks for these in the directory C<$libdir/guestfs> (eg. C or C)." msgstr "" # type: textblock -#: ../src/guestfs.pod:916 +#. type: textblock +#: ../src/guestfs.pod:921 msgid "" "Use L or set the environment variable L " "to change the directories that libguestfs will search in. The value is a " @@ -1885,12 +2141,14 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:923 +#. type: =head2 +#: ../src/guestfs.pod:928 msgid "QEMU WRAPPERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:925 +#. type: textblock +#: ../src/guestfs.pod:930 msgid "" "If you want to compile your own qemu, run qemu from a non-standard location, " "or pass extra arguments to qemu, then you can write a shell-script wrapper " @@ -1898,7 +2156,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:929 +#. type: textblock +#: ../src/guestfs.pod:934 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 " @@ -1907,14 +2166,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:934 +#. type: textblock +#: ../src/guestfs.pod:939 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:937 +#. type: verbatim +#: ../src/guestfs.pod:942 #, no-wrap msgid "" " #!/bin/sh -\n" @@ -1924,7 +2185,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:941 +#. type: textblock +#: ../src/guestfs.pod:946 msgid "" "Save this script as C (or wherever), C, and " "then use it by setting the LIBGUESTFS_QEMU environment variable. For " @@ -1932,7 +2194,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:945 +#. type: verbatim +#: ../src/guestfs.pod:950 #, no-wrap msgid "" " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" @@ -1940,19 +2203,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:947 +#. type: textblock +#: ../src/guestfs.pod:952 msgid "" "Note that libguestfs also calls qemu with the -help and -version options in " "order to determine features." msgstr "" # type: =head2 -#: ../src/guestfs.pod:950 +#. type: =head2 +#: ../src/guestfs.pod:955 msgid "ABI GUARANTEE" msgstr "" # type: textblock -#: ../src/guestfs.pod:952 +#. type: textblock +#: ../src/guestfs.pod:957 msgid "" "We guarantee the libguestfs ABI (binary interface), for public, high-level " "actions as outlined in this section. Although we will deprecate some " @@ -1962,12 +2228,14 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:958 +#. type: =head2 +#: ../src/guestfs.pod:963 msgid "BLOCK DEVICE NAMING" msgstr "" # type: textblock -#: ../src/guestfs.pod:960 +#. type: textblock +#: ../src/guestfs.pod:965 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 " @@ -1981,7 +2249,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:972 +#. type: textblock +#: ../src/guestfs.pod:977 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 " @@ -1989,7 +2258,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:976 +#. type: textblock +#: ../src/guestfs.pod:981 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 " @@ -1997,7 +2267,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:981 +#. type: textblock +#: ../src/guestfs.pod:986 msgid "" "Therefore libguestfs defines C as the I. " "Internally C names are translated, if necessary, to other names as " @@ -2006,7 +2277,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:987 +#. type: textblock +#: ../src/guestfs.pod:992 msgid "" "Note that this I applies to parameters. The L, " "L and similar calls return the true names of the " @@ -2014,12 +2286,14 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:992 +#. type: =head3 +#: ../src/guestfs.pod:997 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" msgstr "" # type: textblock -#: ../src/guestfs.pod:994 +#. type: textblock +#: ../src/guestfs.pod:999 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 " @@ -2028,7 +2302,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1000 +#. type: textblock +#: ../src/guestfs.pod:1005 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?" msgstr "" # type: textblock -#: ../src/guestfs.pod:1016 +#. type: textblock +#: ../src/guestfs.pod:1021 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:1021 +#. type: textblock +#: ../src/guestfs.pod:1026 msgid "Replace initial C string with C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1023 +#. type: textblock +#: ../src/guestfs.pod:1028 msgid "For example, change C to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1025 +#. type: textblock +#: ../src/guestfs.pod:1030 msgid "If that named device exists, use it. If not, continue." msgstr "" # type: textblock -#: ../src/guestfs.pod:1029 +#. type: textblock +#: ../src/guestfs.pod:1034 msgid "Replace initial C string with C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1031 +#. type: textblock +#: ../src/guestfs.pod:1036 msgid "If that named device exists, use it. If not, return an error." msgstr "" # type: =head3 -#: ../src/guestfs.pod:1035 +#. type: =head3 +#: ../src/guestfs.pod:1040 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING" msgstr "" # type: textblock -#: ../src/guestfs.pod:1037 +#. type: textblock +#: ../src/guestfs.pod:1042 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 " @@ -2091,51 +2376,59 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1041 +#. type: textblock +#: ../src/guestfs.pod:1046 msgid "" "Where possible for maximum future portability programs using libguestfs " "should use these future-proof techniques:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1048 +#. type: textblock +#: ../src/guestfs.pod:1053 msgid "" "Use L or L to list actual " "device names, and then use those names directly." msgstr "" # type: textblock -#: ../src/guestfs.pod:1051 +#. type: textblock +#: ../src/guestfs.pod:1056 msgid "" "Since those device names exist by definition, they will never be translated." msgstr "" # type: textblock -#: ../src/guestfs.pod:1056 +#. type: textblock +#: ../src/guestfs.pod:1061 msgid "" "Use higher level ways to identify filesystems, such as LVM names, UUIDs and " "filesystem labels." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1061 +#. type: =head1 +#: ../src/guestfs.pod:1066 msgid "SECURITY" msgstr "" # type: textblock -#: ../src/guestfs.pod:1063 +#. type: textblock +#: ../src/guestfs.pod:1068 msgid "" "This section discusses security implications of using libguestfs, " "particularly with untrusted or malicious guests or disk images." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1066 +#. type: =head2 +#: ../src/guestfs.pod:1071 msgid "GENERAL SECURITY CONSIDERATIONS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1068 +#. type: textblock +#: ../src/guestfs.pod:1073 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 " @@ -2145,42 +2438,50 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1078 +#. type: textblock +#: ../src/guestfs.pod:1083 msgid "the data (file etc) not being present" msgstr "" # type: textblock -#: ../src/guestfs.pod:1082 +#. type: textblock +#: ../src/guestfs.pod:1087 msgid "being present but empty" msgstr "" # type: textblock -#: ../src/guestfs.pod:1086 +#. type: textblock +#: ../src/guestfs.pod:1091 msgid "being much larger than normal" msgstr "" # type: textblock -#: ../src/guestfs.pod:1090 +#. type: textblock +#: ../src/guestfs.pod:1095 msgid "containing arbitrary 8 bit data" msgstr "" # type: textblock -#: ../src/guestfs.pod:1094 +#. type: textblock +#: ../src/guestfs.pod:1099 msgid "being in an unexpected character encoding" msgstr "" # type: textblock -#: ../src/guestfs.pod:1098 +#. type: textblock +#: ../src/guestfs.pod:1103 msgid "containing homoglyphs." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1102 +#. type: =head2 +#: ../src/guestfs.pod:1107 msgid "SECURITY OF MOUNTING FILESYSTEMS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1104 +#. type: textblock +#: ../src/guestfs.pod:1109 msgid "" "When you mount a filesystem under Linux, mistakes in the kernel filesystem " "(VFS) module can sometimes be escalated into exploits by deliberately " @@ -2196,7 +2497,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1117 +#. type: textblock +#: ../src/guestfs.pod:1122 msgid "" "That explains why you should never mount a filesystem from an untrusted " "guest on your host kernel. How about libguestfs? We run a Linux kernel " @@ -2210,19 +2512,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1128 +#. type: textblock +#: ../src/guestfs.pod:1133 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:1131 +#. type: =head2 +#: ../src/guestfs.pod:1136 msgid "PROTOCOL SECURITY" msgstr "" # type: textblock -#: ../src/guestfs.pod:1133 +#. type: textblock +#: ../src/guestfs.pod:1138 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 " @@ -2232,12 +2537,14 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1139 +#. type: =head2 +#: ../src/guestfs.pod:1144 msgid "INSPECTION SECURITY" msgstr "" # type: textblock -#: ../src/guestfs.pod:1141 +#. type: textblock +#: ../src/guestfs.pod:1146 msgid "" "Parts of the inspection API (see L) return untrusted strings " "directly from the guest, and these could contain any 8 bit data. Callers " @@ -2246,7 +2553,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1147 +#. type: textblock +#: ../src/guestfs.pod:1152 msgid "" "Guest configuration may be altered in unusual ways by the administrator of " "the virtual machine, and may not reflect reality (particularly for untrusted " @@ -2257,7 +2565,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1155 +#. type: textblock +#: ../src/guestfs.pod:1160 msgid "" "The inspection API parses guest configuration using two external libraries: " "Augeas (Linux configuration) and hivex (Windows Registry). Both are " @@ -2267,12 +2576,14 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1161 +#. type: =head2 +#: ../src/guestfs.pod:1166 msgid "RUNNING UNTRUSTED GUEST COMMANDS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1163 +#. type: textblock +#: ../src/guestfs.pod:1168 msgid "" "Be very cautious about running commands from the guest. By running a " "command in the guest, you are giving CPU time to a binary that you do not " @@ -2282,24 +2593,28 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1169 +#. type: =head2 +#: ../src/guestfs.pod:1174 msgid "CVE-2010-3851" msgstr "" # type: textblock -#: ../src/guestfs.pod:1171 +#. type: textblock +#: ../src/guestfs.pod:1176 msgid "https://bugzilla.redhat.com/642934" msgstr "" # type: textblock -#: ../src/guestfs.pod:1173 +#. type: textblock +#: ../src/guestfs.pod:1178 msgid "" "This security bug concerns the automatic disk format detection that qemu " "does on disk images." msgstr "" # type: textblock -#: ../src/guestfs.pod:1176 +#. type: textblock +#: ../src/guestfs.pod:1181 msgid "" "A raw disk image is just the raw bytes, there is no header. Other disk " "images like qcow2 contain a special header. Qemu deals with this by looking " @@ -2308,7 +2623,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1181 +#. type: textblock +#: ../src/guestfs.pod:1186 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 " @@ -2317,7 +2633,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1186 +#. type: textblock +#: ../src/guestfs.pod:1191 msgid "" "This in itself would not be a problem, but qcow2 offers many features, one " "of which is to allow a disk image to refer to another image (called the " @@ -2329,25 +2646,29 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1194 +#. type: textblock +#: ../src/guestfs.pod:1199 msgid "" "In libguestfs this is rather hard to exploit except under two circumstances:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1201 +#. type: textblock +#: ../src/guestfs.pod:1206 msgid "You have enabled the network or have opened the disk in write mode." msgstr "" # type: textblock -#: ../src/guestfs.pod:1205 +#. type: textblock +#: ../src/guestfs.pod:1210 msgid "" "You are also running untrusted code from the guest (see L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1210 +#. type: textblock +#: ../src/guestfs.pod:1215 msgid "" "The way to avoid this is to specify the expected disk format when adding " "disks (the optional C option to L). You " @@ -2356,31 +2677,36 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1215 +#. type: textblock +#: ../src/guestfs.pod:1220 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:1218 +#. type: textblock +#: ../src/guestfs.pod:1223 msgid "" "For libguestfs tools, use the I<--format> command line parameter as " "appropriate." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1221 +#. type: =head1 +#: ../src/guestfs.pod:1226 msgid "CONNECTION MANAGEMENT" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1223 +#. type: =head2 +#: ../src/guestfs.pod:1228 msgid "guestfs_h *" msgstr "" # type: textblock -#: ../src/guestfs.pod:1225 +#. type: textblock +#: ../src/guestfs.pod:1230 msgid "" "C is the opaque type representing a connection handle. Create a " "handle by calling L. Call L to free the " @@ -2388,19 +2714,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1229 +#. type: textblock +#: ../src/guestfs.pod:1234 msgid "" "For information on using multiple handles and threads, see the section L below." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1232 +#. type: =head2 +#: ../src/guestfs.pod:1237 msgid "guestfs_create" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1234 +#. type: verbatim +#: ../src/guestfs.pod:1239 #, no-wrap msgid "" " guestfs_h *guestfs_create (void);\n" @@ -2408,43 +2737,50 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1236 +#. type: textblock +#: ../src/guestfs.pod:1241 msgid "Create a connection handle." msgstr "" # type: textblock -#: ../src/guestfs.pod:1238 +#. type: textblock +#: ../src/guestfs.pod:1243 msgid "" "You have to call L (or one of the equivalent calls) " "on the handle at least once." msgstr "" # type: textblock -#: ../src/guestfs.pod:1241 +#. type: textblock +#: ../src/guestfs.pod:1246 msgid "" "This function returns a non-NULL pointer to a handle on success or NULL on " "error." msgstr "" # type: textblock -#: ../src/guestfs.pod:1244 +#. type: textblock +#: ../src/guestfs.pod:1249 msgid "After configuring the handle, you have to call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1246 +#. type: textblock +#: ../src/guestfs.pod:1251 msgid "" "You may also want to configure error handling for the handle. See L section below." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1249 +#. type: =head2 +#: ../src/guestfs.pod:1254 msgid "guestfs_close" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1251 +#. type: verbatim +#: ../src/guestfs.pod:1256 #, no-wrap msgid "" " void guestfs_close (guestfs_h *g);\n" @@ -2452,24 +2788,28 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1253 +#. type: textblock +#: ../src/guestfs.pod:1258 msgid "This closes the connection handle and frees up all resources used." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1255 +#. type: =head1 +#: ../src/guestfs.pod:1260 msgid "ERROR HANDLING" msgstr "" # type: textblock -#: ../src/guestfs.pod:1257 +#. type: textblock +#: ../src/guestfs.pod:1262 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:1260 +#. type: textblock +#: ../src/guestfs.pod:1265 msgid "" "Additional information is available for errors: an error message string and " "optionally an error number (errno) if the thing that failed was a system " @@ -2477,7 +2817,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1264 +#. type: textblock +#: ../src/guestfs.pod:1269 msgid "" "You can get at the additional information about the last error on the handle " "by calling L, L, and/or by setting " @@ -2485,7 +2826,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1269 +#. type: textblock +#: ../src/guestfs.pod:1274 msgid "" "When the handle is created, a default error handler is installed which " "prints the error message string to C. For small short-running " @@ -2493,7 +2835,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1273 +#. type: verbatim +#: ../src/guestfs.pod:1278 #, no-wrap msgid "" " if (guestfs_launch (g) == -1)\n" @@ -2502,21 +2845,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1276 +#. type: textblock +#: ../src/guestfs.pod:1281 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:1279 +#. type: textblock +#: ../src/guestfs.pod:1284 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:1282 +#. type: verbatim +#: ../src/guestfs.pod:1287 #, no-wrap msgid "" " g = guestfs_create ();\n" @@ -2524,7 +2870,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1284 +#. type: verbatim +#: ../src/guestfs.pod:1289 #, no-wrap msgid "" " /* This disables the default behaviour of printing errors\n" @@ -2534,7 +2881,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1288 +#. type: verbatim +#: ../src/guestfs.pod:1293 #, no-wrap msgid "" " if (guestfs_launch (g) == -1) {\n" @@ -2548,7 +2896,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1296 +#. type: textblock +#: ../src/guestfs.pod:1301 msgid "" "Out of memory errors are handled differently. The default action is to call " "L. If this is undesirable, then you can set a handler using L returns C if the handle cannot be created, and " "because there is no handle if this happens there is no way to get additional " @@ -2566,12 +2916,14 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1306 +#. type: =head2 +#: ../src/guestfs.pod:1311 msgid "guestfs_last_error" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1308 +#. type: verbatim +#: ../src/guestfs.pod:1313 #, no-wrap msgid "" " const char *guestfs_last_error (guestfs_h *g);\n" @@ -2579,26 +2931,30 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1310 +#. type: textblock +#: ../src/guestfs.pod:1315 msgid "" "This returns the last error message that happened on C. If there has not " "been an error since the handle was created, then this returns C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1314 +#. type: textblock +#: ../src/guestfs.pod:1319 msgid "" "The lifetime of the returned string is until the next error occurs, or L is called." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1317 +#. type: =head2 +#: ../src/guestfs.pod:1322 msgid "guestfs_last_errno" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1319 +#. type: verbatim +#: ../src/guestfs.pod:1324 #, no-wrap msgid "" " int guestfs_last_errno (guestfs_h *g);\n" @@ -2606,28 +2962,33 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1321 +#. type: textblock +#: ../src/guestfs.pod:1326 msgid "This returns the last error number (errno) that happened on C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1323 +#. type: textblock +#: ../src/guestfs.pod:1328 msgid "If successful, an errno integer not equal to zero is returned." msgstr "" # type: textblock -#: ../src/guestfs.pod:1325 +#. type: textblock +#: ../src/guestfs.pod:1330 msgid "" "If no error, this returns 0. This call can return 0 in three situations:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1332 +#. type: textblock +#: ../src/guestfs.pod:1337 msgid "There has not been any error on the handle." msgstr "" # type: textblock -#: ../src/guestfs.pod:1336 +#. type: textblock +#: ../src/guestfs.pod:1341 msgid "" "There has been an error but the errno was meaningless. This corresponds to " "the case where the error did not come from a failed system call, but for " @@ -2635,14 +2996,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1342 +#. type: textblock +#: ../src/guestfs.pod:1347 msgid "" "There was an error from a failed system call, but for some reason the errno " "was not captured and returned. This usually indicates a bug in libguestfs." msgstr "" # type: textblock -#: ../src/guestfs.pod:1348 +#. type: textblock +#: ../src/guestfs.pod:1353 msgid "" "Libguestfs tries to convert the errno from inside the applicance into a " "corresponding errno for the caller (not entirely trivial: the appliance " @@ -2653,12 +3016,14 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1356 +#. type: =head2 +#: ../src/guestfs.pod:1361 msgid "guestfs_set_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1358 +#. type: verbatim +#: ../src/guestfs.pod:1363 #, no-wrap msgid "" " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" @@ -2671,7 +3036,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1365 +#. type: textblock +#: ../src/guestfs.pod:1370 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 " @@ -2679,14 +3045,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1369 +#. type: textblock +#: ../src/guestfs.pod:1374 msgid "" "C is not passed to the callback. To get that the callback must call " "L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1372 +#. type: textblock +#: ../src/guestfs.pod:1377 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 " @@ -2694,22 +3062,26 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1376 +#. type: textblock +#: ../src/guestfs.pod:1381 msgid "The default handler prints messages on C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1378 +#. type: textblock +#: ../src/guestfs.pod:1383 msgid "If you set C to C then I handler is called." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1380 +#. type: =head2 +#: ../src/guestfs.pod:1385 msgid "guestfs_get_error_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1382 +#. type: verbatim +#: ../src/guestfs.pod:1387 #, no-wrap msgid "" " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" @@ -2718,17 +3090,20 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1385 +#. type: textblock +#: ../src/guestfs.pod:1390 msgid "Returns the current error handler callback." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1387 +#. type: =head2 +#: ../src/guestfs.pod:1392 msgid "guestfs_set_out_of_memory_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1389 +#. type: verbatim +#: ../src/guestfs.pod:1394 #, no-wrap msgid "" " typedef void (*guestfs_abort_cb) (void);\n" @@ -2738,30 +3113,35 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1393 +#. type: textblock +#: ../src/guestfs.pod:1398 msgid "" "The callback C will be called if there is an out of memory situation. " "I." msgstr "" # type: textblock -#: ../src/guestfs.pod:1396 +#. type: textblock +#: ../src/guestfs.pod:1401 msgid "The default is to call L." msgstr "" # type: textblock -#: ../src/guestfs.pod:1398 +#. type: textblock +#: ../src/guestfs.pod:1403 msgid "" "You cannot set C to C. You can't ignore out of memory situations." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1401 +#. type: =head2 +#: ../src/guestfs.pod:1406 msgid "guestfs_get_out_of_memory_handler" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1403 +#. type: verbatim +#: ../src/guestfs.pod:1408 #, no-wrap msgid "" " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" @@ -2769,42 +3149,50 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1405 +#. type: textblock +#: ../src/guestfs.pod:1410 msgid "This returns the current out of memory handler." msgstr "" # type: =head1 -#: ../src/guestfs.pod:1407 +#. type: =head1 +#: ../src/guestfs.pod:1412 msgid "API CALLS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1409 ../fish/guestfish.pod:958 +#. type: textblock +#: ../src/guestfs.pod:1414 ../fish/guestfish.pod:958 msgid "@ACTIONS@" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1411 +#. type: =head1 +#: ../src/guestfs.pod:1416 msgid "STRUCTURES" msgstr "" # type: textblock -#: ../src/guestfs.pod:1413 +#. type: textblock +#: ../src/guestfs.pod:1418 msgid "@STRUCTS@" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1415 +#. type: =head1 +#: ../src/guestfs.pod:1420 msgid "AVAILABILITY" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1417 +#. type: =head2 +#: ../src/guestfs.pod:1422 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1419 +#. type: textblock +#: ../src/guestfs.pod:1424 msgid "" "Using L you can test availability of the following " "groups of functions. This test queries the appliance to see if the " @@ -2812,17 +3200,20 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1424 +#. type: textblock +#: ../src/guestfs.pod:1429 msgid "@AVAILABILITY@" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1426 +#. type: =head2 +#: ../src/guestfs.pod:1431 msgid "GUESTFISH supported COMMAND" msgstr "" # type: textblock -#: ../src/guestfs.pod:1428 +#. type: textblock +#: ../src/guestfs.pod:1433 msgid "" "In L there is a handy interactive command C which " "prints out the available groups and whether they are supported by this build " @@ -2830,19 +3221,22 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1433 +#. type: =head2 +#: ../src/guestfs.pod:1438 msgid "SINGLE CALLS AT COMPILE TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:1435 +#. type: textblock +#: ../src/guestfs.pod:1440 msgid "" "Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " "function, such as:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1438 +#. type: verbatim +#: ../src/guestfs.pod:1443 #, no-wrap msgid "" " #define LIBGUESTFS_HAVE_DD 1\n" @@ -2850,12 +3244,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1440 +#. type: textblock +#: ../src/guestfs.pod:1445 msgid "if L is available." msgstr "" # type: textblock -#: ../src/guestfs.pod:1442 +#. type: textblock +#: ../src/guestfs.pod:1447 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 " @@ -2863,7 +3259,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1447 +#. type: verbatim +#: ../src/guestfs.pod:1452 #, no-wrap msgid "" " AC_CHECK_LIB([guestfs],[guestfs_create])\n" @@ -2872,19 +3269,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1450 +#. type: textblock +#: ../src/guestfs.pod:1455 msgid "" "which would result in C being either defined or not defined " "in your program." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1453 +#. type: =head2 +#: ../src/guestfs.pod:1458 msgid "SINGLE CALLS AT RUN TIME" msgstr "" # type: textblock -#: ../src/guestfs.pod:1455 +#. type: textblock +#: ../src/guestfs.pod:1460 msgid "" "Testing at compile time doesn't guarantee that a function really exists in " "the library. The reason is that you might be dynamically linked against a " @@ -2894,7 +3294,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1462 +#. type: textblock +#: ../src/guestfs.pod:1467 msgid "" "You can use L to test if a function is available at run time, as " "in this example program (note that you still need the compile time check as " @@ -2902,7 +3303,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1466 +#. type: verbatim +#: ../src/guestfs.pod:1471 #, no-wrap msgid "" " #include \n" @@ -2914,7 +3316,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1472 +#. type: verbatim +#: ../src/guestfs.pod:1477 #, no-wrap msgid "" " main ()\n" @@ -2926,7 +3329,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1478 +#. type: verbatim +#: ../src/guestfs.pod:1483 #, no-wrap msgid "" " /* Test if the function guestfs_dd is really available. */\n" @@ -2941,7 +3345,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1487 +#. type: verbatim +#: ../src/guestfs.pod:1492 #, no-wrap msgid "" " if (!has_function)\n" @@ -2960,7 +3365,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1500 +#. type: textblock +#: ../src/guestfs.pod:1505 msgid "" "You may think the above is an awful lot of hassle, and it is. There are " "other ways outside of the C linking system to ensure that this kind of " @@ -2968,7 +3374,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1505 +#. type: verbatim +#: ../src/guestfs.pod:1510 #, no-wrap msgid "" " Requires: libguestfs >= 1.0.80\n" @@ -2976,12 +3383,14 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1507 +#. type: =head1 +#: ../src/guestfs.pod:1512 msgid "CALLS WITH OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1509 +#. type: textblock +#: ../src/guestfs.pod:1514 msgid "" "A recent feature of the API is the introduction of calls which take optional " "arguments. In C these are declared 3 ways. The main way is as a call which " @@ -2989,7 +3398,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1514 +#. type: verbatim +#: ../src/guestfs.pod:1519 #, no-wrap msgid "" " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" @@ -2997,14 +3407,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1516 +#. type: textblock +#: ../src/guestfs.pod:1521 msgid "" "Call this with a list of optional arguments, terminated by C<-1>. So to " "call with no optional arguments specified:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1519 +#. type: verbatim +#: ../src/guestfs.pod:1524 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename, -1);\n" @@ -3012,12 +3424,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1521 +#. type: textblock +#: ../src/guestfs.pod:1526 msgid "With a single optional argument:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1523 +#. type: verbatim +#: ../src/guestfs.pod:1528 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -3027,12 +3441,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1527 +#. type: textblock +#: ../src/guestfs.pod:1532 msgid "With two:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1529 +#. type: verbatim +#: ../src/guestfs.pod:1534 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" @@ -3043,19 +3459,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1534 +#. type: textblock +#: ../src/guestfs.pod:1539 msgid "" "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " "happen!" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1537 +#. type: =head2 +#: ../src/guestfs.pod:1542 msgid "USING va_list FOR OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1539 +#. type: textblock +#: ../src/guestfs.pod:1544 msgid "" "The second variant has the same name with the suffix C<_va>, which works the " "same way but takes a C. See the C manual for details. For the " @@ -3063,7 +3482,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1543 +#. type: verbatim +#: ../src/guestfs.pod:1548 #, no-wrap msgid "" " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" @@ -3072,12 +3492,14 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1546 +#. type: =head2 +#: ../src/guestfs.pod:1551 msgid "CONSTRUCTING OPTIONAL ARGUMENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1548 +#. type: textblock +#: ../src/guestfs.pod:1553 msgid "" "The third variant is useful where you need to construct these calls. You " "pass in a structure where you fill in the optional fields. The structure " @@ -3087,7 +3509,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1554 +#. type: verbatim +#: ../src/guestfs.pod:1559 #, no-wrap msgid "" " struct guestfs_add_drive_opts_argv {\n" @@ -3102,12 +3525,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1563 +#. type: textblock +#: ../src/guestfs.pod:1568 msgid "You could call it like this:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1565 +#. type: verbatim +#: ../src/guestfs.pod:1570 #, no-wrap msgid "" " struct guestfs_add_drive_opts_argv optargs = {\n" @@ -3120,7 +3545,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1572 +#. type: verbatim +#: ../src/guestfs.pod:1577 #, no-wrap msgid "" " guestfs_add_drive_opts_argv (g, filename, &optargs);\n" @@ -3128,36 +3554,42 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1574 ../src/guestfs-actions.pod:11 -#: ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:9 -#: ../fish/guestfish-actions.pod:1255 +#. type: textblock +#: ../src/guestfs.pod:1579 ../src/guestfs-actions.pod:11 +#: ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9 +#: ../fish/guestfish-actions.pod:1253 ../tools/virt-win-reg.pl:532 msgid "Notes:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1580 +#. type: textblock +#: ../src/guestfs.pod:1585 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." msgstr "" # type: textblock -#: ../src/guestfs.pod:1585 +#. type: textblock +#: ../src/guestfs.pod:1590 msgid "You do not need to fill in all fields of the structure." msgstr "" # type: textblock -#: ../src/guestfs.pod:1589 +#. type: textblock +#: ../src/guestfs.pod:1594 msgid "" "There must be a one-to-one correspondence between fields of the structure " "that are filled in, and bits set in the bitmask." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1594 +#. type: =head2 +#: ../src/guestfs.pod:1599 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" msgstr "" # type: textblock -#: ../src/guestfs.pod:1596 +#. type: textblock +#: ../src/guestfs.pod:1601 msgid "" "In other languages, optional arguments are expressed in the way that is " "natural for that language. We refer you to the language-specific " @@ -3165,31 +3597,36 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1600 +#. type: textblock +#: ../src/guestfs.pod:1605 msgid "For guestfish, see L." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1602 +#. type: =head2 +#: ../src/guestfs.pod:1607 msgid "SETTING CALLBACKS TO HANDLE EVENTS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1604 +#. type: textblock +#: ../src/guestfs.pod:1609 msgid "" "The child process generates events in some situations. Current events " "include: receiving a log message, the child process exits." msgstr "" # type: textblock -#: ../src/guestfs.pod:1607 +#. type: textblock +#: ../src/guestfs.pod:1612 msgid "" "Use the C functions to set a callback for different " "types of events." msgstr "" # type: textblock -#: ../src/guestfs.pod:1610 +#. type: textblock +#: ../src/guestfs.pod:1615 msgid "" "Only I can be registered for each handle. " "Calling C again overwrites the previous callback of " @@ -3198,12 +3635,14 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1615 +#. type: =head2 +#: ../src/guestfs.pod:1620 msgid "guestfs_set_log_message_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1617 +#. type: verbatim +#: ../src/guestfs.pod:1622 #, no-wrap msgid "" " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n" @@ -3215,31 +3654,36 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1623 +#. type: textblock +#: ../src/guestfs.pod:1628 msgid "" "The callback function C will be called whenever qemu or the guest writes " "anything to the console." msgstr "" # type: textblock -#: ../src/guestfs.pod:1626 +#. type: textblock +#: ../src/guestfs.pod:1631 msgid "Use this function to capture kernel messages and similar." msgstr "" # type: textblock -#: ../src/guestfs.pod:1628 +#. type: textblock +#: ../src/guestfs.pod:1633 msgid "" "Normally there is no log message handler, and log messages are just " "discarded." msgstr "" # type: =head2 -#: ../src/guestfs.pod:1631 +#. type: =head2 +#: ../src/guestfs.pod:1636 msgid "guestfs_set_subprocess_quit_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1633 +#. type: verbatim +#: ../src/guestfs.pod:1638 #, no-wrap msgid "" " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n" @@ -3250,7 +3694,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1638 +#. type: textblock +#: ../src/guestfs.pod:1643 msgid "" "The callback function C will be called when the child process quits, " "either asynchronously or if killed by L. (This " @@ -3258,12 +3703,14 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1643 +#. type: =head2 +#: ../src/guestfs.pod:1648 msgid "guestfs_set_launch_done_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1645 +#. type: verbatim +#: ../src/guestfs.pod:1650 #, no-wrap msgid "" " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n" @@ -3274,7 +3721,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1650 +#. type: textblock +#: ../src/guestfs.pod:1655 msgid "" "The callback function C will be called when the child process becomes " "ready first time after it has been launched. (This corresponds to a " @@ -3282,12 +3730,14 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1654 +#. type: =head2 +#: ../src/guestfs.pod:1659 msgid "guestfs_set_close_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1656 +#. type: verbatim +#: ../src/guestfs.pod:1661 #, no-wrap msgid "" " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n" @@ -3298,14 +3748,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1661 +#. type: textblock +#: ../src/guestfs.pod:1666 msgid "" "The callback function C will be called while the handle is being closed " "(synchronously from L)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1664 +#. type: textblock +#: ../src/guestfs.pod:1669 msgid "" "Note that libguestfs installs an L handler to try to clean up " "handles that are open when the program exits. This means that this callback " @@ -3316,12 +3768,14 @@ msgid "" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1672 +#. type: =head2 +#: ../src/guestfs.pod:1677 msgid "guestfs_set_progress_callback" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1674 +#. type: verbatim +#: ../src/guestfs.pod:1679 #, no-wrap msgid "" " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n" @@ -3334,7 +3788,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1681 +#. type: textblock +#: ../src/guestfs.pod:1686 msgid "" "Some long-running operations can generate progress messages. If this " "callback is registered, then it will be called each time a progress message " @@ -3344,7 +3799,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1687 +#. type: textblock +#: ../src/guestfs.pod:1692 msgid "" "The callback receives two numbers: C and C. The units of " "C are not defined, although for some operations C may relate " @@ -3353,31 +3809,36 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1693 +#. type: textblock +#: ../src/guestfs.pod:1698 msgid "The only defined and stable parts of the API are:" msgstr "" # type: textblock -#: ../src/guestfs.pod:1699 +#. type: textblock +#: ../src/guestfs.pod:1704 msgid "" "The callback can display to the user some type of progress bar or indicator " "which shows the ratio of C:C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1704 +#. type: textblock +#: ../src/guestfs.pod:1709 msgid "0 E= C E= C" msgstr "" # type: textblock -#: ../src/guestfs.pod:1708 +#. type: textblock +#: ../src/guestfs.pod:1713 msgid "" "If any progress notification is sent during a call, then a final progress " "notification is always sent when C = C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1711 +#. type: textblock +#: ../src/guestfs.pod:1716 msgid "" "This is to simplify caller code, so callers can easily set the progress " "indicator to \"100%\" at the end of the operation, without requiring special " @@ -3385,7 +3846,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1717 +#. type: textblock +#: ../src/guestfs.pod:1722 msgid "" "The callback also receives the procedure number and serial number of the " "call. These are only useful for debugging protocol issues, and the callback " @@ -3394,12 +3856,14 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1722 +#. type: =head1 +#: ../src/guestfs.pod:1727 msgid "PRIVATE DATA AREA" msgstr "" # type: textblock -#: ../src/guestfs.pod:1724 +#. type: textblock +#: ../src/guestfs.pod:1729 msgid "" "You can attach named pieces of private data to the libguestfs handle, and " "fetch them by name for the lifetime of the handle. This is called the " @@ -3407,12 +3871,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1728 +#. type: textblock +#: ../src/guestfs.pod:1733 msgid "To attach a named piece of data, use the following call:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1730 +#. type: verbatim +#: ../src/guestfs.pod:1735 #, no-wrap msgid "" " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" @@ -3420,7 +3886,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1732 +#. type: textblock +#: ../src/guestfs.pod:1737 msgid "" "C is the name to associate with this data, and C is an arbitrary " "pointer (which can be C). Any previous item with the same name is " @@ -3428,7 +3895,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1736 +#. type: textblock +#: ../src/guestfs.pod:1741 msgid "" "You can use any C you want, but names beginning with an underscore " "character are reserved for internal libguestfs purposes (for implementing " @@ -3437,12 +3905,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1741 +#. type: textblock +#: ../src/guestfs.pod:1746 msgid "To retrieve the pointer, use:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1743 +#. type: verbatim +#: ../src/guestfs.pod:1748 #, no-wrap msgid "" " void *guestfs_get_private (guestfs_h *g, const char *key);\n" @@ -3450,7 +3920,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1745 +#. type: textblock +#: ../src/guestfs.pod:1750 msgid "" "This function returns C if either no data is found associated with " "C, or if the user previously set the C's C pointer to " @@ -3458,7 +3929,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1749 +#. type: textblock +#: ../src/guestfs.pod:1754 msgid "" "Libguestfs does not try to look at or interpret the C pointer in any " "way. As far as libguestfs is concerned, it need not be a valid pointer at " @@ -3470,31 +3942,36 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1757 +#. type: textblock +#: ../src/guestfs.pod:1762 msgid "" "The private data area is implemented using a hash table, and should be " "reasonably efficient for moderate numbers of keys." msgstr "" # type: =end -#: ../src/guestfs.pod:1760 ../src/guestfs.pod:1765 +#. type: =end +#: ../src/guestfs.pod:1765 ../src/guestfs.pod:1770 msgid "html" msgstr "" # type: textblock -#: ../src/guestfs.pod:1762 +#. type: textblock +#: ../src/guestfs.pod:1767 msgid "" " " msgstr "" # type: =head1 -#: ../src/guestfs.pod:1767 +#. type: =head1 +#: ../src/guestfs.pod:1772 msgid "ARCHITECTURE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1769 +#. type: textblock +#: ../src/guestfs.pod:1774 msgid "" "Internally, libguestfs is implemented by running an appliance (a special " "type of small virtual machine) using L. Qemu runs as a child " @@ -3502,7 +3979,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1773 +#. type: verbatim +#: ../src/guestfs.pod:1778 #, no-wrap msgid "" " ___________________\n" @@ -3528,14 +4006,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1793 +#. type: textblock +#: ../src/guestfs.pod:1798 msgid "" "The library, linked to the main program, creates the child process and hence " "the appliance in the L function." msgstr "" # type: textblock -#: ../src/guestfs.pod:1796 +#. type: textblock +#: ../src/guestfs.pod:1801 msgid "" "Inside the appliance is a Linux kernel and a complete stack of userspace " "tools (such as LVM and ext2 programs) and a small controlling daemon called " @@ -3547,7 +4027,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1805 +#. type: textblock +#: ../src/guestfs.pod:1810 msgid "" "A common misunderstanding is that the appliance \"is\" the virtual machine. " "Although the disk image you are attached to might also be used by some " @@ -3558,17 +4039,20 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1812 +#. type: =head1 +#: ../src/guestfs.pod:1817 msgid "STATE MACHINE" msgstr "" # type: textblock -#: ../src/guestfs.pod:1814 +#. type: textblock +#: ../src/guestfs.pod:1819 msgid "libguestfs uses a state machine to model the child process:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1816 +#. type: verbatim +#: ../src/guestfs.pod:1821 #, no-wrap msgid "" " |\n" @@ -3596,7 +4080,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1838 +#. type: textblock +#: ../src/guestfs.pod:1843 msgid "" "The normal transitions are (1) CONFIG (when the handle is created, but there " "is no child process), (2) LAUNCHING (when the child process is booting up), " @@ -3605,7 +4090,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1843 +#. type: textblock +#: ../src/guestfs.pod:1848 msgid "" "The guest may be killed by L, or may die " "asynchronously at any time (eg. due to some internal error), and that causes " @@ -3613,14 +4099,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1847 +#. type: textblock +#: ../src/guestfs.pod:1852 msgid "" "Configuration commands for qemu such as L can only be " "issued when in the CONFIG state." msgstr "" # type: textblock -#: ../src/guestfs.pod:1850 +#. type: textblock +#: ../src/guestfs.pod:1855 msgid "" "The API offers one call that goes from CONFIG through LAUNCHING to READY. " "L blocks until the child process is READY to accept " @@ -3629,7 +4117,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1856 +#. type: textblock +#: ../src/guestfs.pod:1861 msgid "" "API actions such as L can only be issued when in the READY " "state. These API calls block waiting for the command to be carried out (ie. " @@ -3639,7 +4128,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1862 +#. type: textblock +#: ../src/guestfs.pod:1867 msgid "" "Finally, the child process sends asynchronous messages back to the main " "program, such as kernel log messages. You can register a callback to " @@ -3647,24 +4137,28 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:1866 +#. type: =head1 +#: ../src/guestfs.pod:1871 msgid "INTERNALS" msgstr "" # type: =head2 -#: ../src/guestfs.pod:1868 +#. type: =head2 +#: ../src/guestfs.pod:1873 msgid "COMMUNICATION PROTOCOL" msgstr "" # type: textblock -#: ../src/guestfs.pod:1870 +#. type: textblock +#: ../src/guestfs.pod:1875 msgid "" "Don't rely on using this protocol directly. This section documents how it " "currently works, but it may change at any time." msgstr "" # type: textblock -#: ../src/guestfs.pod:1873 +#. type: textblock +#: ../src/guestfs.pod:1878 msgid "" "The protocol used to talk between the library and the daemon running inside " "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC " @@ -3672,14 +4166,16 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1877 +#. type: textblock +#: ../src/guestfs.pod:1882 msgid "" "The detailed format of structures is in C (note: " "this file is automatically generated)." msgstr "" # type: textblock -#: ../src/guestfs.pod:1880 +#. type: textblock +#: ../src/guestfs.pod:1885 msgid "" "There are two broad cases, ordinary functions that don't have any C " "and C parameters, which are handled with very simple request/reply " @@ -3689,17 +4185,20 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1887 +#. type: =head3 +#: ../src/guestfs.pod:1892 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" msgstr "" # type: textblock -#: ../src/guestfs.pod:1889 +#. type: textblock +#: ../src/guestfs.pod:1894 msgid "For ordinary functions, the request message is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1891 +#. type: verbatim +#: ../src/guestfs.pod:1896 #, no-wrap msgid "" " total length (header + arguments,\n" @@ -3710,7 +4209,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1896 +#. type: textblock +#: ../src/guestfs.pod:1901 msgid "" "The total length field allows the daemon to allocate a fixed size buffer " "into which it slurps the rest of the message. As a result, the total length " @@ -3719,21 +4219,24 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1902 +#. type: textblock +#: ../src/guestfs.pod:1907 msgid "" "Note also that many functions don't take any arguments, in which case the " "C_args> is completely omitted." msgstr "" # type: textblock -#: ../src/guestfs.pod:1905 +#. type: textblock +#: ../src/guestfs.pod:1910 msgid "" "The header contains the procedure number (C) which is how the " "receiver knows what type of args structure to expect, or none at all." msgstr "" # type: textblock -#: ../src/guestfs.pod:1909 +#. type: textblock +#: ../src/guestfs.pod:1914 msgid "" "For functions that take optional arguments, the optional arguments are " "encoded in the C_args> structure in the same way as ordinary " @@ -3745,12 +4248,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1917 +#. type: textblock +#: ../src/guestfs.pod:1922 msgid "The reply message for ordinary functions is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1919 +#. type: verbatim +#: ../src/guestfs.pod:1924 #, no-wrap msgid "" " total length (header + ret,\n" @@ -3761,27 +4266,31 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1924 +#. type: textblock +#: ../src/guestfs.pod:1929 msgid "" "As above the C_ret> structure may be completely omitted for " "functions that return no formal return values." msgstr "" # type: textblock -#: ../src/guestfs.pod:1927 +#. type: textblock +#: ../src/guestfs.pod:1932 msgid "" "As above the total length of the reply is limited to C." msgstr "" # type: textblock -#: ../src/guestfs.pod:1930 +#. type: textblock +#: ../src/guestfs.pod:1935 msgid "" "In the case of an error, a flag is set in the header, and the reply message " "is slightly changed:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1933 +#. type: verbatim +#: ../src/guestfs.pod:1938 #, no-wrap msgid "" " total length (header + error,\n" @@ -3792,19 +4301,22 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1938 +#. type: textblock +#: ../src/guestfs.pod:1943 msgid "" "The C structure contains the error message as a " "string." msgstr "" # type: =head3 -#: ../src/guestfs.pod:1941 +#. type: =head3 +#: ../src/guestfs.pod:1946 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1943 +#. type: textblock +#: ../src/guestfs.pod:1948 msgid "" "A C parameter indicates that we transfer a file I the guest. " "The normal request message is sent (see above). However this is followed by " @@ -3812,7 +4324,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1947 +#. type: verbatim +#: ../src/guestfs.pod:1952 #, no-wrap msgid "" " total length (header + arguments,\n" @@ -3826,12 +4339,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1955 +#. type: textblock +#: ../src/guestfs.pod:1960 msgid "The \"sequence of chunks\" is:" msgstr "" # type: verbatim -#: ../src/guestfs.pod:1957 +#. type: verbatim +#: ../src/guestfs.pod:1962 #, no-wrap msgid "" " length of chunk (not including length word itself)\n" @@ -3845,7 +4360,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1965 +#. type: textblock +#: ../src/guestfs.pod:1970 msgid "" "The final chunk has the C field set to zero. Additionally a flag " "is set in the final chunk to indicate either successful completion or early " @@ -3853,7 +4369,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1969 +#. type: textblock +#: ../src/guestfs.pod:1974 msgid "" "At time of writing there are no functions that have more than one FileIn " "parameter. However this is (theoretically) supported, by sending the " @@ -3862,7 +4379,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1974 +#. type: textblock +#: ../src/guestfs.pod:1979 msgid "" "Both the library (sender) I the daemon (receiver) may cancel the " "transfer. The library does this by sending a chunk with a special flag set " @@ -3871,7 +4389,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1980 +#. type: textblock +#: ../src/guestfs.pod:1985 msgid "" "The daemon may also cancel. It does this by writing a special word " "C to the socket. The library listens for this during " @@ -3883,7 +4402,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:1989 +#. type: textblock +#: ../src/guestfs.pod:1994 msgid "" "This protocol allows the transfer of arbitrary sized files (no 32 bit " "limit), and also files where the size is not known in advance (eg. from " @@ -3893,19 +4413,22 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:1995 +#. type: =head3 +#: ../src/guestfs.pod:2000 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:1997 +#. type: textblock +#: ../src/guestfs.pod:2002 msgid "" "The protocol for FileOut parameters is exactly the same as for FileIn " "parameters, but with the roles of daemon and library reversed." msgstr "" # type: verbatim -#: ../src/guestfs.pod:2000 +#. type: verbatim +#: ../src/guestfs.pod:2005 #, no-wrap msgid "" " total length (header + ret,\n" @@ -3919,12 +4442,14 @@ msgid "" msgstr "" # type: =head3 -#: ../src/guestfs.pod:2008 +#. type: =head3 +#: ../src/guestfs.pod:2013 msgid "INITIAL MESSAGE" msgstr "" # type: textblock -#: ../src/guestfs.pod:2010 +#. type: textblock +#: ../src/guestfs.pod:2015 msgid "" "When the daemon launches it sends an initial word (C) " "which indicates that the guest and daemon is alive. This is what L) if there is a callback registered, or " @@ -3953,7 +4481,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:2024 +#. type: textblock +#: ../src/guestfs.pod:2029 msgid "" "The daemon self-limits the frequency of progress messages it sends (see " "C). Not all calls generate progress " @@ -3961,12 +4490,14 @@ msgid "" msgstr "" # type: =head1 -#: ../src/guestfs.pod:2028 +#. type: =head1 +#: ../src/guestfs.pod:2033 msgid "LIBGUESTFS VERSION NUMBERS" msgstr "" # type: textblock -#: ../src/guestfs.pod:2030 +#. type: textblock +#: ../src/guestfs.pod:2035 msgid "" "Since April 2010, libguestfs has started to make separate development and " "stable releases, along with corresponding branches in our git repository. " @@ -3974,7 +4505,8 @@ msgid "" msgstr "" # type: verbatim -#: ../src/guestfs.pod:2035 +#. type: verbatim +#: ../src/guestfs.pod:2040 #, no-wrap msgid "" " even numbers for stable: 1.2.x, 1.4.x, ...\n" @@ -3991,12 +4523,14 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:2046 +#. type: textblock +#: ../src/guestfs.pod:2051 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." msgstr "" # type: textblock -#: ../src/guestfs.pod:2048 +#. type: textblock +#: ../src/guestfs.pod:2053 msgid "" "As time passes we cherry pick fixes from the development branch and backport " "those into the stable branch, the effect being that the stable branch should " @@ -4006,26 +4540,30 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:2054 +#. type: textblock +#: ../src/guestfs.pod:2059 msgid "Our criteria for backporting changes are:" msgstr "" # type: textblock -#: ../src/guestfs.pod:2060 +#. type: textblock +#: ../src/guestfs.pod:2065 msgid "" "Documentation changes which don't affect any code are backported unless the " "documentation refers to a future feature which is not in stable." msgstr "" # type: textblock -#: ../src/guestfs.pod:2066 +#. type: textblock +#: ../src/guestfs.pod:2071 msgid "" "Bug fixes which are not controversial, fix obvious problems, and have been " "well tested are backported." msgstr "" # type: textblock -#: ../src/guestfs.pod:2071 +#. type: textblock +#: ../src/guestfs.pod:2076 msgid "" "Simple rearrangements of code which shouldn't affect how it works get " "backported. This is so that the code in the two branches doesn't get too " @@ -4033,7 +4571,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:2077 +#. type: textblock +#: ../src/guestfs.pod:2082 msgid "" "We I backport new features, new APIs, new tools etc, except in one " "exceptional case: the new feature is required in order to implement an " @@ -4041,7 +4580,8 @@ msgid "" msgstr "" # type: textblock -#: ../src/guestfs.pod:2083 +#. type: textblock +#: ../src/guestfs.pod:2088 msgid "" "A new stable branch starts when we think the new features in development are " "substantial and compelling enough over the current stable branch to warrant " @@ -4051,22505 +4591,29250 @@ msgid "" "will stabilize over time." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:2091 ../fish/guestfish.pod:965 -#: ../test-tool/libguestfs-test-tool.pod:104 -msgid "ENVIRONMENT VARIABLES" +#. type: =head1 +#: ../src/guestfs.pod:2096 +msgid "EXTENDING LIBGUESTFS" msgstr "" -# type: =item -#: ../src/guestfs.pod:2095 ../fish/guestfish.pod:991 -msgid "LIBGUESTFS_APPEND" +#. type: =head2 +#: ../src/guestfs.pod:2098 +msgid "ADDING A NEW API ACTION" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2097 ../fish/guestfish.pod:993 -msgid "Pass additional options to the guest kernel." +#. type: textblock +#: ../src/guestfs.pod:2100 +msgid "" +"Large amounts of boilerplate code in libguestfs (RPC, bindings, " +"documentation) are generated, and this makes it easy to extend the " +"libguestfs API." msgstr "" -# type: =item -#: ../src/guestfs.pod:2099 ../fish/guestfish.pod:995 -msgid "LIBGUESTFS_DEBUG" +#. type: textblock +#: ../src/guestfs.pod:2104 +msgid "To add a new API action there are two changes:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2101 +#. type: textblock +#: ../src/guestfs.pod:2110 msgid "" -"Set C to enable verbose messages. This has the same " -"effect as calling C." +"You need to add a description of the call (name, parameters, return type, " +"tests, documentation) to C." msgstr "" -# type: =item -#: ../src/guestfs.pod:2104 ../fish/guestfish.pod:1000 -msgid "LIBGUESTFS_MEMSIZE" +#. type: textblock +#: ../src/guestfs.pod:2113 +msgid "" +"There are two sorts of API action, depending on whether the call goes " +"through to the daemon in the appliance, or is serviced entirely by the " +"library (see L above). L is an example of the " +"former, since the sync is done in the appliance. L is " +"an example of the latter, since a trace flag is maintained in the handle and " +"all tracing is done on the library side." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2106 ../fish/guestfish.pod:1002 +#. type: textblock +#: ../src/guestfs.pod:2121 msgid "" -"Set the memory allocated to the qemu process, in megabytes. For example:" +"Most new actions are of the first type, and get added to the " +"C list. Each function has a unique procedure number used " +"in the RPC protocol which is assigned to that action when we publish " +"libguestfs and cannot be reused. Take the latest procedure number and " +"increment it." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:2109 ../fish/guestfish.pod:1005 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2127 msgid "" -" LIBGUESTFS_MEMSIZE=700\n" -"\n" +"For library-only actions of the second type, add to the " +"C list. Since these functions are serviced by the " +"library and do not travel over the RPC mechanism to the daemon, these " +"functions do not need a procedure number, and so the procedure number is set " +"to C<-1>." msgstr "" -# type: =item -#: ../src/guestfs.pod:2111 ../fish/guestfish.pod:1007 -msgid "LIBGUESTFS_PATH" +#. type: textblock +#: ../src/guestfs.pod:2135 +msgid "Implement the action (in C):" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2113 +#. type: textblock +#: ../src/guestfs.pod:2137 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:2116 ../fish/guestfish.pod:1012 -msgid "LIBGUESTFS_QEMU" +"For daemon actions, implement the function CnameE> in the " +"C directory." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2118 ../fish/guestfish.pod:1014 +#. type: textblock +#: ../src/guestfs.pod:2140 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." +"For library actions, implement the function CnameE> " +"(note: double underscore) in the C directory." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2122 -msgid "See also L above." +#. type: textblock +#: ../src/guestfs.pod:2143 +msgid "In either case, use another function as an example of what to do." msgstr "" -# type: =item -#: ../src/guestfs.pod:2124 ../fish/guestfish.pod:1018 -msgid "LIBGUESTFS_TRACE" +#. type: textblock +#: ../src/guestfs.pod:2147 +msgid "After making these changes, use C to compile." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2126 +#. type: textblock +#: ../src/guestfs.pod:2149 msgid "" -"Set C to enable command traces. This has the same " -"effect as calling C." +"Note that you don't need to implement the RPC, language bindings, manual " +"pages or anything else. It's all automatically generated from the OCaml " +"description." msgstr "" -# type: =item -#: ../src/guestfs.pod:2129 ../fish/guestfish.pod:1027 -msgid "TMPDIR" +#. type: =head2 +#: ../src/guestfs.pod:2153 +msgid "ADDING TESTS FOR AN API ACTION" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2131 ../fish/guestfish.pod:1029 -msgid "Location of temporary directory, defaults to C." +#. type: textblock +#: ../src/guestfs.pod:2155 +msgid "" +"You can supply zero or as many tests as you want per API call. The tests " +"can either be added as part of the API description (C), or in some rarer cases you may want to drop a script " +"into C. Note that adding a script to C is " +"slower, so if possible use the first method." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2133 ../fish/guestfish.pod:1031 +#. type: textblock +#: ../src/guestfs.pod:2161 msgid "" -"If libguestfs was compiled to use the supermin appliance then the real " -"appliance is cached in this directory, shared between all handles belonging " -"to the same EUID. You can use C<$TMPDIR> to configure another directory to " -"use in case C is not large enough." +"The following describes the test environment used when you add an API test " +"in C." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:2141 ../fish/guestfish.pod:1089 -#: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 -msgid "SEE ALSO" +#. type: textblock +#: ../src/guestfs.pod:2164 +msgid "The test environment has 4 block devices:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2143 -msgid "" -"L, L, L, L, L, L, L, L, " -"L, L, L, L, L, L, L, L, L, L, L, " -"L, L, L." +#. type: =item +#: ../src/guestfs.pod:2168 +msgid "C 500MB" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2166 -msgid "" -"Tools with a similar purpose: L, L, L, L, L." +#. type: textblock +#: ../src/guestfs.pod:2170 +msgid "General block device for testing." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:2173 -msgid "BUGS" +#. type: =item +#: ../src/guestfs.pod:2172 +msgid "C 50MB" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2175 -msgid "To get a list of bugs against libguestfs use this link:" +#. type: textblock +#: ../src/guestfs.pod:2174 +msgid "" +"C is an ext2 filesystem used for testing filesystem write " +"operations." msgstr "" -# type: textblock +#. type: =item #: ../src/guestfs.pod:2177 -msgid "" -"L" +msgid "C 10MB" msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:2179 -msgid "To report a new bug against libguestfs use this link:" +msgid "Used in a few tests where two block devices are needed." msgstr "" -# type: textblock +#. type: =item #: ../src/guestfs.pod:2181 -msgid "" -"L" +msgid "C" msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:2183 -msgid "When reporting a bug, please check:" +msgid "ISO with fixed content (see C)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2189 -msgid "That the bug hasn't been reported already." +#. type: textblock +#: ../src/guestfs.pod:2187 +msgid "" +"To be able to run the tests in a reasonable amount of time, the libguestfs " +"appliance and block devices are reused between tests. So don't try testing " +"L :-x" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2193 -msgid "That you are testing a recent version." +#. type: textblock +#: ../src/guestfs.pod:2191 +msgid "" +"Each test starts with an initial scenario, selected using one of the " +"C expressions, described in C. These " +"initialize the disks mentioned above in a particular way as documented in " +"C. You should not assume anything about the previous " +"contents of other disks that are not initialized." msgstr "" -# type: textblock +#. type: textblock #: ../src/guestfs.pod:2197 -msgid "Describe the bug accurately, and give a way to reproduce it." +msgid "" +"You can add a prerequisite clause to any individual test. This is a run-" +"time check, which, if it fails, causes the test to be skipped. Useful if " +"testing a command which might not work on all variations of libguestfs " +"builds. A test that has prerequisite of C means to run " +"unconditionally." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2201 +#. type: textblock +#: ../src/guestfs.pod:2203 msgid "" -"Run libguestfs-test-tool and paste the B output into the " -"bug report." +"In addition, packagers can skip individual tests by setting environment " +"variables before running C." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:2206 ../fish/guestfish.pod:1108 -#: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244 -msgid "AUTHORS" +#. type: verbatim +#: ../src/guestfs.pod:2206 +#, no-wrap +msgid "" +" SKIP_TEST__=1\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2208 ../fish/guestfish.pod:1110 -#: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246 -msgid "Richard W.M. Jones (C)" +#. type: textblock +#: ../src/guestfs.pod:2208 +msgid "eg: C skips test #3 of L." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:2210 ../fish/guestfish.pod:1112 -#: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 -msgid "COPYRIGHT" +#. type: textblock +#: ../src/guestfs.pod:2210 +msgid "or:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2212 ../fish/guestfish.pod:1114 -#: ../fuse/guestmount.pod:250 -msgid "Copyright (C) 2009-2010 Red Hat Inc. L" +#. type: verbatim +#: ../src/guestfs.pod:2212 +#, no-wrap +msgid "" +" SKIP_TEST_=1\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2215 -msgid "" -"This library is free software; you can redistribute it and/or modify it " -"under the terms of the GNU Lesser General Public License as published by the " -"Free Software Foundation; either version 2 of the License, or (at your " -"option) any later version." +#. type: textblock +#: ../src/guestfs.pod:2214 +msgid "eg: C skips all L tests." msgstr "" -# type: textblock -#: ../src/guestfs.pod:2220 -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." +#. type: textblock +#: ../src/guestfs.pod:2216 +msgid "Packagers can run only certain tests by setting for example:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:2225 +#. type: verbatim +#: ../src/guestfs.pod:2218 +#, no-wrap 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" +" TEST_ONLY=\"vfs_type zerofree\"\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1 -msgid "guestfs_add_cdrom" +#. type: textblock +#: ../src/guestfs.pod:2220 +msgid "" +"See C for more details of how these environment variables " +"work." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:3 -#, no-wrap -msgid "" -" int\n" -" guestfs_add_cdrom (guestfs_h *g,\n" -" const char *filename);\n" -"\n" +#. type: =head2 +#: ../src/guestfs.pod:2223 +msgid "DEBUGGING NEW API ACTIONS" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5 -msgid "This function adds a virtual CD-ROM disk image to the guest." +#. type: textblock +#: ../src/guestfs.pod:2225 +msgid "Test new actions work before submitting them." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7 -msgid "This is equivalent to the qemu parameter C<-cdrom filename>." +#. type: textblock +#: ../src/guestfs.pod:2227 +msgid "You can use guestfish to try out new commands." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:17 +#. type: textblock +#: ../src/guestfs.pod:2229 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." +"Debugging the daemon is a problem because it runs inside a minimal " +"environment. However you can fprintf messages in the daemon to stderr, and " +"they will show up if you use C." msgstr "" -# type: 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." +#. type: =head2 +#: ../src/guestfs.pod:2233 +msgid "FORMATTING CODE AND OTHER CONVENTIONS" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:128 -#: ../src/guestfs-actions.pod:189 ../src/guestfs-actions.pod:226 -#: ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261 -#: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:295 -#: ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430 -#: ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:489 -#: ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535 -#: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:635 -#: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:664 -#: ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781 -#: ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809 -#: ../src/guestfs-actions.pod:970 ../src/guestfs-actions.pod:990 -#: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1092 -#: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1129 -#: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1163 -#: ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264 -#: ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1326 -#: ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1466 -#: ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706 -#: ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:2243 -#: ../src/guestfs-actions.pod:2387 ../src/guestfs-actions.pod:2448 -#: ../src/guestfs-actions.pod:2483 ../src/guestfs-actions.pod:3222 -#: ../src/guestfs-actions.pod:3237 ../src/guestfs-actions.pod:3257 -#: ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3424 -#: ../src/guestfs-actions.pod:3437 ../src/guestfs-actions.pod:3451 -#: ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3502 -#: ../src/guestfs-actions.pod:3574 ../src/guestfs-actions.pod:3594 -#: ../src/guestfs-actions.pod:3611 ../src/guestfs-actions.pod:3634 -#: ../src/guestfs-actions.pod:3657 ../src/guestfs-actions.pod:3689 -#: ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:3727 -#: ../src/guestfs-actions.pod:3762 ../src/guestfs-actions.pod:3774 -#: ../src/guestfs-actions.pod:3810 ../src/guestfs-actions.pod:3826 -#: ../src/guestfs-actions.pod:3839 ../src/guestfs-actions.pod:3854 -#: ../src/guestfs-actions.pod:3871 ../src/guestfs-actions.pod:3964 -#: ../src/guestfs-actions.pod:3984 ../src/guestfs-actions.pod:3997 -#: ../src/guestfs-actions.pod:4048 ../src/guestfs-actions.pod:4066 -#: ../src/guestfs-actions.pod:4084 ../src/guestfs-actions.pod:4100 -#: ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4128 -#: ../src/guestfs-actions.pod:4145 ../src/guestfs-actions.pod:4160 -#: ../src/guestfs-actions.pod:4180 ../src/guestfs-actions.pod:4224 -#: ../src/guestfs-actions.pod:4295 ../src/guestfs-actions.pod:4326 -#: ../src/guestfs-actions.pod:4345 ../src/guestfs-actions.pod:4364 -#: ../src/guestfs-actions.pod:4376 ../src/guestfs-actions.pod:4393 -#: ../src/guestfs-actions.pod:4406 ../src/guestfs-actions.pod:4421 -#: ../src/guestfs-actions.pod:4436 ../src/guestfs-actions.pod:4471 -#: ../src/guestfs-actions.pod:4486 ../src/guestfs-actions.pod:4506 -#: ../src/guestfs-actions.pod:4520 ../src/guestfs-actions.pod:4537 -#: ../src/guestfs-actions.pod:4586 ../src/guestfs-actions.pod:4623 -#: ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4665 -#: ../src/guestfs-actions.pod:4682 ../src/guestfs-actions.pod:4700 -#: ../src/guestfs-actions.pod:4834 ../src/guestfs-actions.pod:4891 -#: ../src/guestfs-actions.pod:4913 ../src/guestfs-actions.pod:4931 -#: ../src/guestfs-actions.pod:4963 ../src/guestfs-actions.pod:5029 -#: ../src/guestfs-actions.pod:5046 ../src/guestfs-actions.pod:5059 -#: ../src/guestfs-actions.pod:5073 ../src/guestfs-actions.pod:5362 -#: ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:5395 -#: ../src/guestfs-actions.pod:5407 ../src/guestfs-actions.pod:5421 -#: ../src/guestfs-actions.pod:5433 ../src/guestfs-actions.pod:5447 -#: ../src/guestfs-actions.pod:5463 ../src/guestfs-actions.pod:5484 -#: ../src/guestfs-actions.pod:5503 ../src/guestfs-actions.pod:5522 -#: ../src/guestfs-actions.pod:5540 ../src/guestfs-actions.pod:5563 -#: ../src/guestfs-actions.pod:5581 ../src/guestfs-actions.pod:5600 -#: ../src/guestfs-actions.pod:5621 ../src/guestfs-actions.pod:5640 -#: ../src/guestfs-actions.pod:5657 ../src/guestfs-actions.pod:5685 -#: ../src/guestfs-actions.pod:5709 ../src/guestfs-actions.pod:5728 -#: ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5767 -#: ../src/guestfs-actions.pod:5782 ../src/guestfs-actions.pod:5801 -#: ../src/guestfs-actions.pod:5838 ../src/guestfs-actions.pod:5861 -#: ../src/guestfs-actions.pod:5887 ../src/guestfs-actions.pod:5995 -#: ../src/guestfs-actions.pod:6116 ../src/guestfs-actions.pod:6128 -#: ../src/guestfs-actions.pod:6141 ../src/guestfs-actions.pod:6154 -#: ../src/guestfs-actions.pod:6176 ../src/guestfs-actions.pod:6189 -#: ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6215 -#: ../src/guestfs-actions.pod:6230 ../src/guestfs-actions.pod:6289 -#: ../src/guestfs-actions.pod:6306 ../src/guestfs-actions.pod:6322 -#: ../src/guestfs-actions.pod:6338 ../src/guestfs-actions.pod:6355 -#: ../src/guestfs-actions.pod:6368 ../src/guestfs-actions.pod:6388 -#: ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6438 -#: ../src/guestfs-actions.pod:6479 ../src/guestfs-actions.pod:6492 -#: ../src/guestfs-actions.pod:6510 ../src/guestfs-actions.pod:6544 -#: ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:6699 -#: ../src/guestfs-actions.pod:6717 ../src/guestfs-actions.pod:6731 -#: ../src/guestfs-actions.pod:6786 ../src/guestfs-actions.pod:6799 -#: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6877 -#: ../src/guestfs-actions.pod:6931 ../src/guestfs-actions.pod:6957 -#: ../src/guestfs-actions.pod:7023 ../src/guestfs-actions.pod:7042 -#: ../src/guestfs-actions.pod:7071 -msgid "This function returns 0 on success or -1 on error." +#. type: textblock +#: ../src/guestfs.pod:2235 +msgid "" +"Our C source code generally adheres to some basic code-formatting " +"conventions. The existing code base is not totally consistent on this " +"front, but we do prefer that contributed code be formatted similarly. In " +"short, use spaces-not-TABs for indentation, use 2 spaces for each " +"indentation level, and other than that, follow the K&R style." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:242 -#: ../src/guestfs-actions.pod:263 ../fish/guestfish-actions.pod:28 -#: ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167 +#. type: textblock +#: ../src/guestfs.pod:2241 msgid "" -"This function is deprecated. In new code, use the C call " -"instead." +"If you use Emacs, add the following to one of one of your start-up files (e." +"g., ~/.emacs), to help ensure that you get indentation right:" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:245 -#: ../src/guestfs-actions.pod:266 ../src/guestfs-actions.pod:1437 -#: ../src/guestfs-actions.pod:1923 ../src/guestfs-actions.pod:1944 -#: ../src/guestfs-actions.pod:4185 ../src/guestfs-actions.pod:6965 -#: ../src/guestfs-actions.pod:7134 ../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:2818 -#: ../fish/guestfish-actions.pod:4620 ../fish/guestfish-actions.pod:4717 +#. type: verbatim +#: ../src/guestfs.pod:2244 +#, no-wrap 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." +" ;;; In libguestfs, indent with spaces everywhere (not TABs).\n" +" ;;; Exceptions: Makefile and ChangeLog modes.\n" +" (add-hook 'find-file-hook\n" +" '(lambda () (if (and buffer-file-name\n" +" (string-match \"/libguestfs\\\\>\"\n" +" (buffer-file-name))\n" +" (not (string-equal mode-name \"Change Log\"))\n" +" (not (string-equal mode-name \"Makefile\")))\n" +" (setq indent-tabs-mode nil))))\n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:130 -#: ../src/guestfs-actions.pod:1094 ../src/guestfs-actions.pod:1895 -#: ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:2096 -#: ../src/guestfs-actions.pod:3224 ../src/guestfs-actions.pod:3239 -#: ../src/guestfs-actions.pod:4473 ../src/guestfs-actions.pod:5542 -#: ../src/guestfs-actions.pod:5659 ../src/guestfs-actions.pod:5769 -#: ../src/guestfs-actions.pod:6232 ../src/guestfs-actions.pod:6357 -#: ../src/guestfs-actions.pod:6879 -msgid "(Added in 0.3)" +#. type: verbatim +#: ../src/guestfs.pod:2254 +#, no-wrap +msgid "" +" ;;; When editing C sources in libguestfs, use this style.\n" +" (defun libguestfs-c-mode ()\n" +" \"C mode with adjusted defaults for use with libguestfs.\"\n" +" (interactive)\n" +" (c-set-style \"K&R\")\n" +" (setq c-indent-level 2)\n" +" (setq c-basic-offset 2))\n" +" (add-hook 'c-mode-hook\n" +" '(lambda () (if (string-match \"/libguestfs\\\\>\"\n" +" (buffer-file-name))\n" +" (libguestfs-c-mode))))\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:41 -msgid "guestfs_add_domain" +#. type: textblock +#: ../src/guestfs.pod:2266 +msgid "Enable warnings when compiling (and fix any problems this finds):" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:43 +#. type: verbatim +#: ../src/guestfs.pod:2269 #, no-wrap msgid "" -" int\n" -" guestfs_add_domain (guestfs_h *g,\n" -" const char *dom,\n" -" ...);\n" +" ./configure --enable-gcc-warnings\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:139 -#: ../src/guestfs-actions.pod:4199 -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." +#. type: textblock +#: ../src/guestfs.pod:2271 +msgid "Useful targets are:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:53 +#. type: verbatim +#: ../src/guestfs.pod:2273 #, no-wrap msgid "" -" GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n" -" GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n" -" GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n" +" make syntax-check # checks the syntax of the C code\n" +" make check # runs the test suite\n" "\n" msgstr "" -# 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." +#. type: =head2 +#: ../src/guestfs.pod:2276 +msgid "DAEMON CUSTOM PRINTF FORMATTERS" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46 +#. type: textblock +#: ../src/guestfs.pod:2278 msgid "" -"The number of disks added is returned. This operation is atomic: if an " -"error is returned, then no disks are added." +"In the daemon code we have created custom printf formatters C<%Q> and C<%R>, " +"which are used to do shell quoting." msgstr "" -# 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." +#. type: =item +#: ../src/guestfs.pod:2283 +msgid "%Q" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53 +#. type: textblock +#: ../src/guestfs.pod:2285 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." +"Simple shell quoted string. Any spaces or other shell characters are " +"escaped for you." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:74 -msgid "" -"The optional C parameter sets the libvirt URI (see L). If this is not set then we connect to the default " -"libvirt URI (or one set through an environment variable, see the libvirt " -"documentation for full details). 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." +#. type: =item +#: ../src/guestfs.pod:2288 +msgid "%R" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:82 +#. type: textblock +#: ../src/guestfs.pod:2290 msgid "" -"The other optional parameters are passed directly through to " -"C." +"Same as C<%Q> except the string is treated as a path which is prefixed by " +"the sysroot." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:338 -#: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:681 -#: ../src/guestfs-actions.pod:712 ../src/guestfs-actions.pod:730 -#: ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:1309 -#: ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1866 -#: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2005 -#: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2083 -#: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2662 -#: ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:4609 -#: ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:5143 -#: ../src/guestfs-actions.pod:5169 ../src/guestfs-actions.pod:6465 -#: ../src/guestfs-actions.pod:6890 ../src/guestfs-actions.pod:6903 -#: ../src/guestfs-actions.pod:6916 -msgid "On error this function returns -1." +#. type: textblock +#: ../src/guestfs.pod:2295 ../fish/guestfish.pod:240 ../fish/guestfish.pod:594 +msgid "For example:" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:87 -msgid "(Added in 1.7.4)" -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:89 -msgid "guestfs_add_domain_va" -msgstr "" - -# type: verbatim -#: ../src/guestfs-actions.pod:91 +#. type: verbatim +#: ../src/guestfs.pod:2297 #, no-wrap msgid "" -" int\n" -" guestfs_add_domain_va (guestfs_h *g,\n" -" const char *dom,\n" -" va_list args);\n" +" asprintf (&cmd, \"cat %R\", path);\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:96 -msgid "This is the \"va_list variant\" of L." +#. type: textblock +#: ../src/guestfs.pod:2299 +msgid "would produce C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:98 ../src/guestfs-actions.pod:109 -#: ../src/guestfs-actions.pod:202 ../src/guestfs-actions.pod:213 -#: ../src/guestfs-actions.pod:4236 ../src/guestfs-actions.pod:4248 -msgid "See L." +#. type: textblock +#: ../src/guestfs.pod:2301 +msgid "" +"I Do I use these when you are passing parameters to the C functions. These parameters do NOT need to be quoted because " +"they are not passed via the shell (instead, straight to exec). You probably " +"want to use the C function however." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:100 -msgid "guestfs_add_domain_argv" +#. type: =head2 +#: ../src/guestfs.pod:2307 +msgid "SUBMITTING YOUR NEW API ACTIONS" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:102 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2309 msgid "" -" int\n" -" guestfs_add_domain_argv (guestfs_h *g,\n" -" const char *dom,\n" -" const struct guestfs_add_domain_argv *optargs);\n" -"\n" +"Submit patches to the mailing list: L and CC to L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:107 -msgid "This is the \"argv variant\" of L." +#. type: =head2 +#: ../src/guestfs.pod:2313 +msgid "INTERNATIONALIZATION (I18N) SUPPORT" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:111 -msgid "guestfs_add_drive" +#. type: textblock +#: ../src/guestfs.pod:2315 +msgid "We support i18n (gettext anyhow) in the library." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:113 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2317 msgid "" -" int\n" -" guestfs_add_drive (guestfs_h *g,\n" -" const char *filename);\n" -"\n" +"However many messages come from the daemon, and we don't translate those at " +"the moment. One reason is that the appliance generally has all locale files " +"removed from it, because they take up a lot of space. So we'd have to readd " +"some of those, as well as copying our PO files into the appliance." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:117 +#. type: textblock +#: ../src/guestfs.pod:2323 msgid "" -"This function is the equivalent of calling C with no " -"optional parameters, so the disk is added writable, with the format being " -"detected automatically." +"Debugging messages are never translated, since they are intended for the " +"programmers." msgstr "" -# type: textblock -#: ../src/guestfs-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 " -"RHBZ#642934. Specifying the format closes this security hole. Therefore " -"you should think about replacing calls to this function with calls to " -"C, and specifying the format." +#. type: =head2 +#: ../src/guestfs.pod:2326 +msgid "SOURCE CODE SUBDIRECTORIES" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:132 -msgid "guestfs_add_drive_opts" +#. type: =item +#: ../src/guestfs.pod:2330 +msgid "C" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:134 -#, no-wrap -msgid "" -" int\n" -" guestfs_add_drive_opts (guestfs_h *g,\n" -" const char *filename,\n" -" ...);\n" -"\n" +#. type: textblock +#: ../src/guestfs.pod:2332 +msgid "The libguestfs appliance, build scripts and so on." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:144 -#, no-wrap -msgid "" -" GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n" -" GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n" -"\n" +#. type: =item +#: ../src/guestfs.pod:2334 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:148 ../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 " -"second time as C, and so on." +#. type: textblock +#: ../src/guestfs.pod:2336 +msgid "Automated tests of the C API." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:153 ../fish/guestfish-actions.pod:97 +#. type: =item +#: ../src/guestfs.pod:2338 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2340 msgid "" -"You don't necessarily need to be root when using libguestfs. However you " -"obviously do need sufficient permissions to access the filename for whatever " -"operations you want to perform (ie. read access if you just want to read the " -"image or write access if you want to modify the image)." +"The L, L and L commands and " +"documentation." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:103 -msgid "This call checks that C exists." +#. type: =item +#: ../src/guestfs.pod:2343 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:161 ../src/guestfs-actions.pod:4209 -#: ../fish/guestfish-actions.pod:105 ../fish/guestfish-actions.pod:2829 -msgid "The optional arguments are:" +#. type: textblock +#: ../src/guestfs.pod:2345 +msgid "Outside contributions, experimental parts." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109 -msgid "C" +#. type: =item +#: ../src/guestfs.pod:2347 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:167 ../fish/guestfish-actions.pod:111 +#. type: textblock +#: ../src/guestfs.pod:2349 msgid "" -"If true then the image is treated as read-only. Writes are still allowed, " -"but they are stored in a temporary snapshot overlay which is discarded at " -"the end. The disk that you add is not modified." +"The daemon that runs inside the libguestfs appliance and carries out actions." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:115 -msgid "C" +#. type: =item +#: ../src/guestfs.pod:2352 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:173 -msgid "" -"This forces the image format. If you omit this (or use C " -"or C) then the format is automatically detected. " -"Possible formats include C and C." +#. type: textblock +#: ../src/guestfs.pod:2354 +msgid "L command and documentation." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:177 ../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 " -"RHBZ#642934. Specifying the format closes this security hole." +#. type: =item +#: ../src/guestfs.pod:2356 +msgid "C" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:182 ../fish/guestfish-actions.pod:126 -msgid "C" +#. type: textblock +#: ../src/guestfs.pod:2358 +msgid "C API example code." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:184 -msgid "" -"This rarely-used option lets you emulate the behaviour of the deprecated " -"C call (q.v.)" +#. type: =item +#: ../src/guestfs.pod:2360 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:191 -msgid "(Added in 1.5.23)" +#. type: textblock +#: ../src/guestfs.pod:2362 +msgid "L, the command-line shell." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:193 -msgid "guestfs_add_drive_opts_va" +#. type: =item +#: ../src/guestfs.pod:2364 +msgid "C" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:195 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2366 msgid "" -" int\n" -" guestfs_add_drive_opts_va (guestfs_h *g,\n" -" const char *filename,\n" -" va_list args);\n" -"\n" +"L, FUSE (userspace filesystem) built on top of libguestfs." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:200 -msgid "This is the \"va_list variant\" of L." +#. type: =item +#: ../src/guestfs.pod:2368 +msgid "C" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:204 -msgid "guestfs_add_drive_opts_argv" +#. type: textblock +#: ../src/guestfs.pod:2370 +msgid "" +"The crucially important generator, used to automatically generate large " +"amounts of boilerplate C code for things like RPC and bindings." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:206 -#, no-wrap -msgid "" -" int\n" -" guestfs_add_drive_opts_argv (guestfs_h *g,\n" -" const char *filename,\n" -" const struct guestfs_add_drive_opts_argv *optargs);\n" -"\n" +#. type: =item +#: ../src/guestfs.pod:2373 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:211 -msgid "This is the \"argv variant\" of L." +#. type: textblock +#: ../src/guestfs.pod:2375 +msgid "Files used by the test suite." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:215 -msgid "guestfs_add_drive_ro" +#. type: textblock +#: ../src/guestfs.pod:2377 +msgid "Some \"phony\" guest images which we test against." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:217 -#, no-wrap -msgid "" -" int\n" -" guestfs_add_drive_ro (guestfs_h *g,\n" -" const char *filename);\n" -"\n" +#. type: =item +#: ../src/guestfs.pod:2379 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:221 -msgid "" -"This function is the equivalent of calling C with " -"the optional parameter C set to 1, so the " -"disk is added read-only, with the format being detected automatically." +#. type: textblock +#: ../src/guestfs.pod:2381 +msgid "L, the virtual machine image inspector." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:228 -msgid "(Added in 1.0.38)" +#. type: =item +#: ../src/guestfs.pod:2383 +msgid "C" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:230 -msgid "guestfs_add_drive_ro_with_if" +#. type: textblock +#: ../src/guestfs.pod:2385 +msgid "M4 macros used by autoconf." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:232 -#, no-wrap -msgid "" -" int\n" -" guestfs_add_drive_ro_with_if (guestfs_h *g,\n" -" const char *filename,\n" -" const char *iface);\n" -"\n" +#. type: =item +#: ../src/guestfs.pod:2387 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:237 +#. type: textblock +#: ../src/guestfs.pod:2389 +msgid "Translations of simple gettext strings." +msgstr "" + +#. type: =item +#: ../src/guestfs.pod:2391 +msgid "C" +msgstr "" + +#. type: textblock +#: ../src/guestfs.pod:2393 msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." +"The build infrastructure and PO files for translations of manpages and POD " +"files. Eventually this will be combined with the C directory, but that " +"is rather complicated." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:249 ../src/guestfs-actions.pod:270 -#: ../src/guestfs-actions.pod:2333 -msgid "(Added in 1.0.84)" +#. type: =item +#: ../src/guestfs.pod:2397 +msgid "C" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:251 -msgid "guestfs_add_drive_with_if" +#. type: textblock +#: ../src/guestfs.pod:2399 +msgid "Regression tests." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:253 -#, no-wrap -msgid "" -" int\n" -" guestfs_add_drive_with_if (guestfs_h *g,\n" -" const char *filename,\n" -" const char *iface);\n" -"\n" +#. type: =item +#: ../src/guestfs.pod:2401 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:258 -msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." +#. type: textblock +#: ../src/guestfs.pod:2403 +msgid "L command and documentation." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:272 -msgid "guestfs_aug_clear" +#. type: =item +#: ../src/guestfs.pod:2405 +msgid "C" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:274 -#, no-wrap -msgid "" -" int\n" -" guestfs_aug_clear (guestfs_h *g,\n" -" const char *augpath);\n" -"\n" +#. type: textblock +#: ../src/guestfs.pod:2407 +msgid "Source code to the C library." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:178 -msgid "" -"Set the value associated with C to C. This is the same as the " -"L C command." +#. type: =item +#: ../src/guestfs.pod:2409 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:283 ../src/guestfs-actions.pod:2085 -msgid "(Added in 1.3.4)" +#. type: textblock +#: ../src/guestfs.pod:2411 +msgid "Command line tools written in Perl (L and many others)." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:285 -msgid "guestfs_aug_close" +#. type: =item +#: ../src/guestfs.pod:2413 +msgid "C" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:287 -#, no-wrap +#. type: textblock +#: ../src/guestfs.pod:2415 msgid "" -" int\n" -" guestfs_aug_close (guestfs_h *g);\n" -"\n" +"Test tool for end users to test if their qemu/kernel combination will work " +"with libguestfs." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:290 -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." +#. type: =item +#: ../src/guestfs.pod:2418 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:297 ../src/guestfs-actions.pod:322 -#: ../src/guestfs-actions.pod:340 ../src/guestfs-actions.pod:354 -#: ../src/guestfs-actions.pod:412 ../src/guestfs-actions.pod:432 -#: ../src/guestfs-actions.pod:446 ../src/guestfs-actions.pod:477 -#: ../src/guestfs-actions.pod:491 ../src/guestfs-actions.pod:505 -#: ../src/guestfs-actions.pod:519 ../src/guestfs-actions.pod:537 -#: ../src/guestfs-actions.pod:5220 -msgid "(Added in 0.7)" +#. type: =item +#: ../src/guestfs.pod:2420 +msgid "C" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:299 -msgid "guestfs_aug_defnode" +#. type: =item +#: ../src/guestfs.pod:2422 +msgid "C" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:301 -#, no-wrap -msgid "" -" struct guestfs_int_bool *\n" -" guestfs_aug_defnode (guestfs_h *g,\n" -" const char *name,\n" -" const char *expr,\n" -" const char *val);\n" -"\n" +#. type: =item +#: ../src/guestfs.pod:2424 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:307 ../fish/guestfish-actions.pod:194 -msgid "" -"Defines a variable C whose value is the result of evaluating C." +#. type: =item +#: ../src/guestfs.pod:2426 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:310 -msgid "" -"If C evaluates to an empty nodeset, a node is created, equivalent to " -"calling C C, C. C will be the nodeset " -"containing that single node." +#. type: =item +#: ../src/guestfs.pod:2428 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:314 ../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." +#. type: =item +#: ../src/guestfs.pod:2430 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:318 -msgid "" -"This function returns a C, or NULL if there was " -"an error. I after use>." +#. type: =item +#: ../src/guestfs.pod:2432 +msgid "C" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:324 -msgid "guestfs_aug_defvar" +#. type: textblock +#: ../src/guestfs.pod:2434 +msgid "Language bindings." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:326 -#, no-wrap -msgid "" -" int\n" -" guestfs_aug_defvar (guestfs_h *g,\n" -" const char *name,\n" -" const char *expr);\n" -"\n" +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:2438 ../fish/guestfish.pod:965 +#: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 +msgid "ENVIRONMENT VARIABLES" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:331 ../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." +# type: =item +#. type: =item +#: ../src/guestfs.pod:2442 ../fish/guestfish.pod:991 +msgid "LIBGUESTFS_APPEND" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:335 ../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." +#. type: textblock +#: ../src/guestfs.pod:2444 ../fish/guestfish.pod:993 +msgid "Pass additional options to the guest kernel." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:342 -msgid "guestfs_aug_get" +# type: =item +#. type: =item +#: ../src/guestfs.pod:2446 ../fish/guestfish.pod:995 +msgid "LIBGUESTFS_DEBUG" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:344 -#, no-wrap +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2448 msgid "" -" char *\n" -" guestfs_aug_get (guestfs_h *g,\n" -" const char *augpath);\n" -"\n" +"Set C to enable verbose messages. This has the same " +"effect as calling C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:348 ../fish/guestfish-actions.pod:220 -msgid "" -"Look up the value associated with C. If C matches exactly one " -"node, the C is returned." +# type: =item +#. type: =item +#: ../src/guestfs.pod:2451 ../fish/guestfish.pod:1000 +msgid "LIBGUESTFS_MEMSIZE" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:351 ../src/guestfs-actions.pod:851 -#: ../src/guestfs-actions.pod:869 ../src/guestfs-actions.pod:929 -#: ../src/guestfs-actions.pod:945 ../src/guestfs-actions.pod:1048 -#: ../src/guestfs-actions.pod:1178 ../src/guestfs-actions.pod:1195 -#: ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1343 -#: ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1646 -#: ../src/guestfs-actions.pod:1809 ../src/guestfs-actions.pod:1826 -#: ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:1938 -#: ../src/guestfs-actions.pod:2108 ../src/guestfs-actions.pod:2298 -#: ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2586 -#: ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2744 -#: ../src/guestfs-actions.pod:2775 ../src/guestfs-actions.pod:2799 -#: ../src/guestfs-actions.pod:2861 ../src/guestfs-actions.pod:2884 -#: ../src/guestfs-actions.pod:3396 ../src/guestfs-actions.pod:3746 -#: ../src/guestfs-actions.pod:3916 ../src/guestfs-actions.pod:4026 -#: ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:4948 -#: ../src/guestfs-actions.pod:5118 ../src/guestfs-actions.pod:5296 -#: ../src/guestfs-actions.pod:5345 ../src/guestfs-actions.pod:5908 -#: ../src/guestfs-actions.pod:5924 ../src/guestfs-actions.pod:5941 -#: ../src/guestfs-actions.pod:5965 ../src/guestfs-actions.pod:6639 -#: ../src/guestfs-actions.pod:6658 ../src/guestfs-actions.pod:6676 -#: ../src/guestfs-actions.pod:6856 ../src/guestfs-actions.pod:7128 +#. type: textblock +#: ../src/guestfs.pod:2453 ../fish/guestfish.pod:1002 msgid "" -"This function returns a string, or NULL on error. I." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:356 -msgid "guestfs_aug_init" +"Set the memory allocated to the qemu process, in megabytes. For example:" msgstr "" # type: verbatim -#: ../src/guestfs-actions.pod:358 +#. type: verbatim +#: ../src/guestfs.pod:2456 ../fish/guestfish.pod:1005 #, no-wrap msgid "" -" int\n" -" guestfs_aug_init (guestfs_h *g,\n" -" const char *root,\n" -" int flags);\n" +" LIBGUESTFS_MEMSIZE=700\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:363 ../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 " -"closed." +# type: =item +#. type: =item +#: ../src/guestfs.pod:2458 ../fish/guestfish.pod:1007 +msgid "LIBGUESTFS_PATH" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:367 -msgid "You must call this before using any other C commands." +#. type: textblock +#: ../src/guestfs.pod:2460 +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: textblock -#: ../src/guestfs-actions.pod:370 ../fish/guestfish-actions.pod:234 -msgid "" -"C is the filesystem root. C must not be NULL, use C instead." +# type: =item +#. type: =item +#: ../src/guestfs.pod:2463 ../fish/guestfish.pod:1012 +msgid "LIBGUESTFS_QEMU" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:373 ../fish/guestfish-actions.pod:237 +#. type: textblock +#: ../src/guestfs.pod:2465 ../fish/guestfish.pod:1014 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:379 ../fish/guestfish-actions.pod:243 -msgid "C = 1" +"Set the default qemu binary that libguestfs uses. If not set, then the qemu " +"which was found at compile time by the configure script is used." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245 -msgid "Keep the original file with a C<.augsave> extension." +#. type: textblock +#: ../src/guestfs.pod:2469 +msgid "See also L above." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247 -msgid "C = 2" +#. type: =item +#: ../src/guestfs.pod:2471 ../fish/guestfish.pod:1018 +msgid "LIBGUESTFS_TRACE" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:249 +#. type: textblock +#: ../src/guestfs.pod:2473 msgid "" -"Save changes into a file with extension C<.augnew>, and do not overwrite " -"original. Overrides C." +"Set C to enable command traces. This has the same " +"effect as calling C." msgstr "" # type: =item -#: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252 -msgid "C = 4" +#. type: =item +#: ../src/guestfs.pod:2476 ../fish/guestfish.pod:1027 +msgid "TMPDIR" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254 -msgid "Typecheck lenses (can be expensive)." +#. type: textblock +#: ../src/guestfs.pod:2478 ../fish/guestfish.pod:1029 +msgid "Location of temporary directory, defaults to C." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256 -msgid "C = 8" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2480 ../fish/guestfish.pod:1031 +msgid "" +"If libguestfs was compiled to use the supermin appliance then the real " +"appliance is cached in this directory, shared between all handles belonging " +"to the same EUID. You can use C<$TMPDIR> to configure another directory to " +"use in case C is not large enough." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258 -msgid "Do not use standard load path for modules." +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:2488 ../fish/guestfish.pod:1089 +#: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 +#: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:572 +#: ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189 +#: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 +#: ../tools/virt-list-partitions.pl:257 +msgid "SEE ALSO" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260 -msgid "C = 16" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2490 +msgid "" +"L, L, L, L, L, L, L, L, " +"L, L, L, L, L, L, L, L, L, L, L, " +"L, L, L." msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262 -msgid "Make save a no-op, just record what would have been changed." +#. type: textblock +#: ../src/guestfs.pod:2513 +msgid "" +"Tools with a similar purpose: L, L, L, L, L." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:264 -msgid "C = 32" +# type: =head1 +#. type: =head1 +#: ../src/guestfs.pod:2520 ../tools/virt-win-reg.pl:587 +#: ../tools/virt-make-fs.pl:548 +msgid "BUGS" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:402 -msgid "Do not load the tree in C." +#. type: textblock +#: ../src/guestfs.pod:2522 +msgid "To get a list of bugs against libguestfs use this link:" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:406 -msgid "To close the handle, you can call C." +#. type: textblock +#: ../src/guestfs.pod:2524 +msgid "" +"L" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:272 -msgid "To find out more about Augeas, see L." +#. type: textblock +#: ../src/guestfs.pod:2526 +msgid "To report a new bug against libguestfs use this link:" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:414 -msgid "guestfs_aug_insert" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2528 +msgid "" +"L" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:416 -#, no-wrap -msgid "" -" int\n" -" guestfs_aug_insert (guestfs_h *g,\n" -" const char *augpath,\n" -" const char *label,\n" -" int before);\n" -"\n" +# type: textblock +#. type: textblock +#: ../src/guestfs.pod:2530 +msgid "When reporting a bug, please check:" msgstr "" # type: textblock -#: ../src/guestfs-actions.pod:422 ../fish/guestfish-actions.pod:278 -msgid "" -"Create a new sibling C