# SOME DESCRIPTIVE TITLE. # Copyright (C) YEAR Free Software Foundation, Inc. # FIRST AUTHOR , YEAR. # #, fuzzy msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: libguestfs@redhat.com\n" "POT-Creation-Date: 2010-10-27 12:50+0200\n" "PO-Revision-Date: 2010-09-02 14:46+0100\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "Language: \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" # type: =encoding #: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 #: ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 #: ../inspector/virt-inspector.pl:36 ../tools/virt-edit.pl:31 #: ../tools/virt-win-reg.pl:34 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:31 #: ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 #: ../tools/virt-cat.pl:30 ../tools/virt-tar.pl:30 ../tools/virt-rescue.pl:29 #: ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28 msgid "utf8" msgstr "" # type: =head1 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 #: ../inspector/virt-inspector.pl:38 ../tools/virt-edit.pl:33 #: ../tools/virt-win-reg.pl:36 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:33 #: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 #: ../tools/virt-cat.pl:32 ../tools/virt-tar.pl:32 ../tools/virt-rescue.pl:31 #: ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 msgid "NAME" msgstr "名前" # type: textblock #: ../src/guestfs.pod:5 msgid "guestfs - Library for accessing and modifying virtual machine images" msgstr "" # type: =head1 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 #: ../inspector/virt-inspector.pl:42 ../tools/virt-edit.pl:37 #: ../tools/virt-win-reg.pl:40 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:37 #: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 #: ../tools/virt-cat.pl:36 ../tools/virt-tar.pl:36 ../tools/virt-rescue.pl:35 #: ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 msgid "SYNOPSIS" msgstr "" # type: verbatim #: ../src/guestfs.pod:9 #, no-wrap msgid "" " #include \n" " \n" msgstr "" # type: verbatim #: ../src/guestfs.pod:11 #, no-wrap msgid "" " guestfs_h *g = guestfs_create ();\n" " guestfs_add_drive (g, \"guest.img\");\n" " guestfs_launch (g);\n" " guestfs_mount (g, \"/dev/sda1\", \"/\");\n" " guestfs_touch (g, \"/hello\");\n" " guestfs_umount (g, \"/\");\n" " guestfs_sync (g);\n" " guestfs_close (g);\n" "\n" msgstr "" # type: verbatim #: ../src/guestfs.pod:20 #, no-wrap msgid "" " cc prog.c -o prog -lguestfs\n" "or:\n" " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n" "\n" msgstr "" # type: =head1 #: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 #: ../inspector/virt-inspector.pl:48 ../tools/virt-edit.pl:51 #: ../tools/virt-win-reg.pl:64 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:43 #: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 #: ../tools/virt-cat.pl:42 ../tools/virt-tar.pl:73 ../tools/virt-rescue.pl:51 #: ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40 msgid "DESCRIPTION" msgstr "" # type: textblock #: ../src/guestfs.pod:26 msgid "" "Libguestfs is a library for accessing and modifying guest disk images. " "Amongst the things this is good for: making batch configuration changes to " "guests, getting disk used/free statistics (see also: virt-df), migrating " "between virtualization systems (see also: virt-p2v), performing partial " "backups, performing partial guest clones, cloning guests and changing " "registry/UUID/hostname info, and much else besides." msgstr "" # type: textblock #: ../src/guestfs.pod:34 msgid "" "Libguestfs uses Linux kernel and qemu code, and can access any type of guest " "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, " "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, " "qcow2, vmdk." msgstr "" # type: textblock #: ../src/guestfs.pod:39 msgid "" "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, " "what filesystem is in each LV, etc.). It can also run commands in the " "context of the guest. Also you can access filesystems over FUSE." msgstr "" # type: textblock #: ../src/guestfs.pod:44 msgid "" "Libguestfs is a library that can be linked with C and C++ management " "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, " "PHP, Haskell or C#). You can also use it from shell scripts or the command " "line." msgstr "" # type: textblock #: ../src/guestfs.pod:49 msgid "" "You don't need to be root to use libguestfs, although obviously you do need " "enough permissions to access the disk images." msgstr "" # type: textblock #: ../src/guestfs.pod:52 msgid "" "Libguestfs is a large API because it can do many things. For a gentle " "introduction, please read the L section next." msgstr "" # type: =head1 #: ../src/guestfs.pod:55 msgid "API OVERVIEW" msgstr "" # type: textblock #: ../src/guestfs.pod:57 msgid "" "This section provides a gentler overview of the libguestfs API. We also try " "to group API calls together, where that may not be obvious from reading " "about the individual calls in the main section of this manual." msgstr "" # type: =head2 #: ../src/guestfs.pod:62 msgid "HANDLES" msgstr "" # type: textblock #: ../src/guestfs.pod:64 msgid "" "Before you can use libguestfs calls, you have to create a handle. Then you " "must add at least one disk image to the handle, followed by launching the " "handle, then performing whatever operations you want, and finally closing " "the handle. By convention we use the single letter C for the name of the " "handle variable, although of course you can use any name you want." msgstr "" # type: textblock #: ../src/guestfs.pod:71 msgid "The general structure of all libguestfs-using programs looks like this:" msgstr "" # type: verbatim #: ../src/guestfs.pod:74 #, no-wrap msgid "" " guestfs_h *g = guestfs_create ();\n" " \n" msgstr "" # type: verbatim #: ../src/guestfs.pod:76 #, no-wrap msgid "" " /* Call guestfs_add_drive additional times if there are\n" " * multiple disk images.\n" " */\n" " guestfs_add_drive (g, \"guest.img\");\n" " \n" msgstr "" # type: verbatim #: ../src/guestfs.pod:81 #, no-wrap msgid "" " /* Most manipulation calls won't work until you've launched\n" " * the handle 'g'. You have to do this _after_ adding drives\n" " * and _before_ other commands.\n" " */\n" " guestfs_launch (g);\n" " \n" msgstr "" # type: verbatim #: ../src/guestfs.pod:87 #, no-wrap msgid "" " /* Now you can examine what partitions, LVs etc are available.\n" " */\n" " char **partitions = guestfs_list_partitions (g);\n" " char **logvols = guestfs_lvs (g);\n" " \n" msgstr "" # type: verbatim #: ../src/guestfs.pod:92 #, no-wrap msgid "" " /* To access a filesystem in the image, you must mount it.\n" " */\n" " guestfs_mount (g, \"/dev/sda1\", \"/\");\n" " \n" msgstr "" # type: verbatim #: ../src/guestfs.pod:96 #, no-wrap msgid "" " /* Now you can perform filesystem actions on the guest\n" " * disk image.\n" " */\n" " guestfs_touch (g, \"/hello\");\n" " \n" msgstr "" # type: verbatim #: ../src/guestfs.pod:101 #, no-wrap msgid "" " /* You only need to call guestfs_sync if you have made\n" " * changes to the guest image. (But if you've made changes\n" " * then you *must* sync). See also: guestfs_umount and\n" " * guestfs_umount_all calls.\n" " */\n" " guestfs_sync (g);\n" " \n" msgstr "" # type: verbatim #: ../src/guestfs.pod:108 #, no-wrap msgid "" " /* Close the handle 'g'. */\n" " guestfs_close (g);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:111 msgid "" "The code above doesn't include any error checking. In real code you should " "check return values carefully for errors. In general all functions that " "return integers return C<-1> on error, and all functions that return " "pointers return C on error. See section L below for " "how to handle errors, and consult the documentation for each function call " "below to see precisely how they return error indications." msgstr "" # type: =head2 #: ../src/guestfs.pod:119 msgid "DISK IMAGES" msgstr "" # type: textblock #: ../src/guestfs.pod:121 msgid "" "The image filename (C<\"guest.img\"> in the example above) could be a disk " "image from a virtual machine, a L copy of a physical hard disk, an " "actual block device, or simply an empty file of zeroes that you have created " "through L. Libguestfs lets you do useful things to all " "of these." msgstr "" # type: textblock #: ../src/guestfs.pod:127 msgid "" "The call you should use in modern code for adding drives is L. To add a disk image, allowing writes, and " "specifying that the format is raw, do:" msgstr "" # type: verbatim #: ../src/guestfs.pod:131 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n" " -1);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:135 msgid "You can add a disk read-only using:" msgstr "" # type: verbatim #: ../src/guestfs.pod:137 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n" " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n" " -1);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:142 msgid "" "or by calling the older function L. In either case " "libguestfs won't modify the file." msgstr "" # type: textblock #: ../src/guestfs.pod:145 msgid "" "Be extremely cautious if the disk image is in use, eg. if it is being used " "by a virtual machine. Adding it read-write will almost certainly cause disk " "corruption, but adding it read-only is safe." msgstr "" # type: textblock #: ../src/guestfs.pod:149 msgid "" "You must add at least one disk image, and you may add multiple disk images. " "In the API, the disk images are usually referred to as C (for the " "first one you added), C (for the second one you added), etc." msgstr "" # type: textblock #: ../src/guestfs.pod:154 msgid "" "Once L has been called you cannot add any more images. You " "can call L to get a list of the device names, in the " "order that you added them. See also L below." msgstr "" # type: =head2 #: ../src/guestfs.pod:159 msgid "MOUNTING" msgstr "" # type: textblock #: ../src/guestfs.pod:161 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:" msgstr "" # type: verbatim #: ../src/guestfs.pod:167 #, no-wrap msgid "" " guestfs_mount (g, \"/dev/sda1\", \"/\");\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:169 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)." msgstr "" # type: textblock #: ../src/guestfs.pod:173 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." msgstr "" # type: textblock #: ../src/guestfs.pod:183 msgid "" "To mount a disk image read-only, use L. There are " "several other variations of the C call." msgstr "" # type: =head2 #: ../src/guestfs.pod:186 msgid "FILESYSTEM ACCESS AND MODIFICATION" msgstr "" # type: textblock #: ../src/guestfs.pod:188 msgid "" "The majority of the libguestfs API consists of fairly low-level calls for " "accessing and modifying the files, directories, symlinks etc on mounted " "filesystems. There are over a hundred such calls which you can find listed " "in detail below in this man page, and we don't even pretend to cover them " "all in this overview." msgstr "" # type: textblock #: ../src/guestfs.pod:194 msgid "" "Specify filenames as full paths, starting with C<\"/\"> and including the " "mount point." msgstr "" # type: textblock #: ../src/guestfs.pod:197 msgid "" "For example, if you mounted a filesystem at C<\"/\"> and you want to read " "the file called C<\"etc/passwd\"> then you could do:" msgstr "" # type: verbatim #: ../src/guestfs.pod:200 #, no-wrap msgid "" " char *data = guestfs_cat (g, \"/etc/passwd\");\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:202 msgid "" "This would return C as a newly allocated buffer containing the full " "content of that file (with some conditions: see also L below), " "or C if there was an error." msgstr "" # type: textblock #: ../src/guestfs.pod:206 msgid "" "As another example, to create a top-level directory on that filesystem " "called C<\"var\"> you would do:" msgstr "" # type: verbatim #: ../src/guestfs.pod:209 #, no-wrap msgid "" " guestfs_mkdir (g, \"/var\");\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:211 msgid "To create a symlink you could do:" msgstr "" # type: verbatim #: ../src/guestfs.pod:213 #, no-wrap msgid "" " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n" " \"/etc/rc3.d/S30portmap\");\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:216 msgid "" "Libguestfs will reject attempts to use relative paths and there is no " "concept of a current working directory." msgstr "" # type: textblock #: ../src/guestfs.pod:219 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 " "doesn't exist. If you are using the C API (documented here) you have to " "check for those error conditions after each call. (Other language bindings " "turn these errors into exceptions)." msgstr "" # type: textblock #: ../src/guestfs.pod:225 msgid "" "File writes are affected by the per-handle umask, set by calling L and defaulting to 022. See L." msgstr "" # type: =head2 #: ../src/guestfs.pod:228 msgid "PARTITIONING" msgstr "" # type: textblock #: ../src/guestfs.pod:230 msgid "" "Libguestfs contains API calls to read, create and modify partition tables on " "disk images." msgstr "" # type: textblock #: ../src/guestfs.pod:233 msgid "" "In the common case where you want to create a single partition covering the " "whole disk, you should use the L call:" msgstr "" # type: verbatim #: ../src/guestfs.pod:237 #, no-wrap msgid "" " const char *parttype = \"mbr\";\n" " if (disk_is_larger_than_2TB)\n" " parttype = \"gpt\";\n" " guestfs_part_disk (g, \"/dev/sda\", parttype);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:242 msgid "" "Obviously this effectively wipes anything that was on that disk image before." msgstr "" # type: =head2 #: ../src/guestfs.pod:245 msgid "LVM2" msgstr "" # type: textblock #: ../src/guestfs.pod:247 msgid "" "Libguestfs provides access to a large part of the LVM2 API, such as L and L. It won't make much sense unless " "you familiarize yourself with the concepts of physical volumes, volume " "groups and logical volumes." msgstr "" # type: textblock #: ../src/guestfs.pod:252 msgid "" "This author strongly recommends reading the LVM HOWTO, online at L." msgstr "" # type: =head2 #: ../src/guestfs.pod:255 msgid "DOWNLOADING" msgstr "" # type: textblock #: ../src/guestfs.pod:257 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." msgstr "" # type: textblock #: ../src/guestfs.pod:262 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 " "limited to \"small\" files, less than 2 MB." msgstr "" # type: textblock #: ../src/guestfs.pod:266 msgid "" "L can be used to download any file, with no limits on " "content or size (even files larger than 4 GB)." msgstr "" # type: textblock #: ../src/guestfs.pod:269 msgid "" "To download multiple files, see L and L." msgstr "" # type: =head2 #: ../src/guestfs.pod:272 msgid "UPLOADING" msgstr "" # type: textblock #: ../src/guestfs.pod:274 msgid "" "It's often the case that you want to write a file or files to the disk image." msgstr "" # type: textblock #: ../src/guestfs.pod:277 msgid "" "To write a small file with fixed content, use L. To create " "a file of all zeroes, use L (sparse) or L (with all disk blocks allocated). There are a variety " "of other functions for creating test files, for example L and " "L." msgstr "" # type: textblock #: ../src/guestfs.pod:283 msgid "" "To upload a single file, use L. This call has no limits on " "file content or size (even files larger than 4 GB)." msgstr "" # type: textblock #: ../src/guestfs.pod:286 msgid "" "To upload multiple files, see L and L." msgstr "" # type: textblock #: ../src/guestfs.pod:288 msgid "" "However the fastest way to upload I is to " "turn them into a squashfs or CD ISO (see L and L), then attach this using L. If you add the drive " "in a predictable way (eg. adding it last after all other drives) then you " "can get the device name from L and mount it directly " "using L. Note that squashfs images are sometimes non-" "portable between kernel versions, and they don't support labels or UUIDs. " "If you want to pre-build an image or you need to mount it using a label or " "UUID, use an ISO image instead." msgstr "" # type: =head2 #: ../src/guestfs.pod:299 msgid "COPYING" msgstr "" # type: textblock #: ../src/guestfs.pod:301 msgid "" "There are various different commands for copying between files and devices " "and in and out of the guest filesystem. These are summarised in the table " "below." msgstr "" # type: =item #: ../src/guestfs.pod:307 msgid "B to B" msgstr "" # type: textblock #: ../src/guestfs.pod:309 msgid "" "Use L to copy a single file, or L to copy " "directories recursively." msgstr "" # type: =item #: ../src/guestfs.pod:312 msgid "B to B" msgstr "" # type: textblock #: ../src/guestfs.pod:314 msgid "" "Use L which efficiently uses L to copy between files and " "devices in the guest." msgstr "" # type: textblock #: ../src/guestfs.pod:317 msgid "Example: duplicate the contents of an LV:" msgstr "" # type: verbatim #: ../src/guestfs.pod:319 #, no-wrap msgid "" " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:321 msgid "" "The destination (C) must be at least as large as the source " "(C). To copy less than the whole source device, use L." msgstr "" # type: =item #: ../src/guestfs.pod:325 msgid "B to B" msgstr "" # type: textblock #: ../src/guestfs.pod:327 msgid "Use L. See L above." msgstr "" # type: =item #: ../src/guestfs.pod:329 msgid "B to B" msgstr "" # type: textblock #: ../src/guestfs.pod:331 msgid "Use L. See L above." msgstr "" # type: =head2 #: ../src/guestfs.pod:335 msgid "LISTING FILES" msgstr "" # type: textblock #: ../src/guestfs.pod:337 msgid "" "L is just designed for humans to read (mainly when using the " "L-equivalent command C)." msgstr "" # type: textblock #: ../src/guestfs.pod:340 msgid "" "L is a quick way to get a list of files in a directory from " "programs, as a flat list of strings." msgstr "" # type: textblock #: ../src/guestfs.pod:343 msgid "" "L is a programmatic way to get a list of files in a " "directory, plus additional information about each one. It is more " "equivalent to using the L call on a local filesystem." msgstr "" # type: textblock #: ../src/guestfs.pod:347 msgid "" "L and L can be used to recursively list files." msgstr "" # type: =head2 #: ../src/guestfs.pod:350 msgid "RUNNING COMMANDS" msgstr "" # type: textblock #: ../src/guestfs.pod:352 msgid "" "Although libguestfs is primarily an API for manipulating files inside guest " "images, we also provide some limited facilities for running commands inside " "guests." msgstr "" # type: textblock #: ../src/guestfs.pod:356 msgid "There are many limitations to this:" msgstr "" # type: =item #: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370 #: ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383 #: ../src/guestfs.pod:388 ../src/guestfs.pod:1143 ../src/guestfs.pod:1148 #: ../src/guestfs.pod:1152 ../src/guestfs.pod:1368 ../src/guestfs.pod:1373 #: ../src/guestfs.pod:1377 ../src/guestfs.pod:1479 ../src/guestfs.pod:1483 #: ../src/guestfs.pod:1487 ../src/guestfs.pod:1492 ../src/guestfs.pod:1500 #: ../src/guestfs.pod:1519 ../src/guestfs.pod:1527 ../src/guestfs.pod:1757 #: ../src/guestfs.pod:1763 ../src/guestfs.pod:1768 ../src/guestfs.pod:1774 #: ../src/guestfs.pod:1881 ../src/guestfs.pod:1885 ../src/guestfs.pod:1889 #: ../src/guestfs.pod:1893 ../src/guestfs-actions.pod:14 #: ../src/guestfs-actions.pod:21 ../src/guestfs-actions.pod:438 #: ../src/guestfs-actions.pod:446 ../src/guestfs-actions.pod:453 #: ../src/guestfs-actions.pod:460 ../src/guestfs-actions.pod:1351 #: ../src/guestfs-actions.pod:1355 ../src/guestfs-actions.pod:1359 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1371 #: ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1379 #: ../src/guestfs-actions.pod:1389 ../src/guestfs-actions.pod:1393 #: ../src/guestfs-actions.pod:1397 ../src/guestfs-actions.pod:1520 #: ../src/guestfs-actions.pod:1524 ../src/guestfs-actions.pod:1529 #: ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1586 #: ../src/guestfs-actions.pod:1590 ../src/guestfs-actions.pod:1595 #: ../fish/guestfish.pod:364 ../fish/guestfish.pod:368 #: ../fish/guestfish.pod:372 ../fish/guestfish.pod:376 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 #: ../fish/guestfish-actions.pod:339 ../fish/guestfish-actions.pod:347 #: ../fish/guestfish-actions.pod:354 ../fish/guestfish-actions.pod:361 #: ../fish/guestfish-actions.pod:1056 ../fish/guestfish-actions.pod:1060 #: ../fish/guestfish-actions.pod:1064 ../fish/guestfish-actions.pod:1068 #: ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080 #: ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1094 #: ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1196 #: ../fish/guestfish-actions.pod:1201 ../fish/guestfish-actions.pod:1206 #: ../fish/guestfish-actions.pod:1248 ../fish/guestfish-actions.pod:1252 #: ../fish/guestfish-actions.pod:1257 ../tools/virt-df.pl:161 #: ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348 #: ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363 msgid "*" msgstr "" # type: textblock #: ../src/guestfs.pod:362 msgid "" "The kernel version that the command runs under will be different from what " "it expects." msgstr "" # type: textblock #: ../src/guestfs.pod:367 msgid "" "If the command needs to communicate with daemons, then most likely they " "won't be running." msgstr "" # type: textblock #: ../src/guestfs.pod:372 msgid "The command will be running in limited memory." msgstr "" # type: textblock #: ../src/guestfs.pod:376 msgid "" "The network may not be available unless you enable it (see L)." msgstr "" # type: textblock #: ../src/guestfs.pod:381 msgid "Only supports Linux guests (not Windows, BSD, etc)." msgstr "" # type: textblock #: ../src/guestfs.pod:385 msgid "" "Architecture limitations (eg. won't work for a PPC guest on an X86 host)." msgstr "" # type: textblock #: ../src/guestfs.pod:390 msgid "" "For SELinux guests, you may need to enable SELinux and load policy first. " "See L in this manpage." msgstr "" # type: textblock #: ../src/guestfs.pod:395 msgid "" "The two main API calls to run commands are L and L (there are also variations)." msgstr "" # type: textblock #: ../src/guestfs.pod:398 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:401 msgid "CONFIGURATION FILES" msgstr "" # type: textblock #: ../src/guestfs.pod:403 msgid "" "To read and write configuration files in Linux guest filesystems, we " "strongly recommend using Augeas. For example, Augeas understands how to " "read and write, say, a Linux shadow password file or X.org configuration " "file, and so avoids you having to write that code." msgstr "" # type: textblock #: ../src/guestfs.pod:408 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 " "L website." msgstr "" # type: textblock #: ../src/guestfs.pod:412 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 " "over." msgstr "" # type: =head2 #: ../src/guestfs.pod:416 msgid "SELINUX" msgstr "" # type: textblock #: ../src/guestfs.pod:418 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:424 msgid "1." msgstr "" # type: textblock #: ../src/guestfs.pod:426 msgid "Before launching, do:" msgstr "" # type: verbatim #: ../src/guestfs.pod:428 #, no-wrap msgid "" " guestfs_set_selinux (g, 1);\n" "\n" msgstr "" # type: =item #: ../src/guestfs.pod:430 msgid "2." msgstr "" # type: textblock #: ../src/guestfs.pod:432 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:436 #, no-wrap msgid "" " guestfs_sh (g, \"/usr/sbin/load_policy\");\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:438 msgid "" "(Older versions of C require you to specify the name of the " "policy file)." msgstr "" # type: =item #: ../src/guestfs.pod:441 msgid "3." msgstr "" # type: textblock #: ../src/guestfs.pod:443 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:447 #, no-wrap msgid "" " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:451 msgid "This will work for running commands and editing existing files." msgstr "" # type: textblock #: ../src/guestfs.pod:453 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:457 msgid "UMASK" msgstr "" # type: textblock #: ../src/guestfs.pod:459 msgid "" "Certain calls are affected by the current file mode creation mask (the " "\"umask\"). In particular ones which create files or directories, such as " "L, L or L. This affects " "either the default mode that the file is created with or modifies the mode " "that you supply." msgstr "" # type: textblock #: ../src/guestfs.pod:465 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:468 msgid "" "There are two ways to avoid being affected by umask. Either set umask to 0 " "(call C early after launching). Or call L after creating each file or directory." msgstr "" # type: textblock #: ../src/guestfs.pod:472 msgid "For more information about umask, see L." msgstr "" # type: =head1 #: ../src/guestfs.pod:474 ../fish/guestfish.pod:630 msgid "ENCRYPTED DISKS" msgstr "" # type: textblock #: ../src/guestfs.pod:476 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) " "standard. This includes nearly all whole disk encryption systems used by " "modern Linux guests." msgstr "" # type: textblock #: ../src/guestfs.pod:482 msgid "" "Use L to identify LUKS-encrypted block devices (it " "returns the string C)." msgstr "" # type: textblock #: ../src/guestfs.pod:485 msgid "" "Then open these devices by calling L. Obviously you " "will require the passphrase!" msgstr "" # type: textblock #: ../src/guestfs.pod:488 msgid "" "Opening a LUKS device creates a new device mapper device called C (where C is the string you supply to L). Reads and writes to this mapper device are decrypted " "from and encrypted to the underlying block device respectively." msgstr "" # type: textblock #: ../src/guestfs.pod:494 msgid "" "LVM volume groups on the device can be made visible by calling L followed by L. The logical volume" "(s) can now be mounted in the usual way." msgstr "" # type: textblock #: ../src/guestfs.pod:498 msgid "" "Use the reverse process to close a LUKS device. Unmount any logical volumes " "on it, deactivate the volume groups by caling C. Then close the mapper device by calling L on the C device (I the " "underlying encrypted block device)." msgstr "" # type: =head2 #: ../src/guestfs.pod:505 msgid "INSPECTION" msgstr "" # type: textblock #: ../src/guestfs.pod:507 msgid "" "Libguestfs has APIs for inspecting an unknown disk image to find out if it " "contains operating systems. (These APIs used to be in a separate Perl-only " "library called L but since version 1.5.3 the most " "frequently used part of this library has been rewritten in C and moved into " "the core code)." msgstr "" # type: textblock #: ../src/guestfs.pod:513 msgid "" "Add all disks belonging to the unknown virtual machine and call L in the usual way." msgstr "" # type: textblock #: ../src/guestfs.pod:516 msgid "" "Then call L. This function uses other libguestfs calls " "and certain heuristics, and returns a list of operating systems that were " "found. An empty list means none were found. A single element is the root " "filesystem of the operating system. For dual- or multi-boot guests, " "multiple roots can be returned, each one corresponding to a separate " "operating system. (Multi-boot virtual machines are extremely rare in the " "world of virtualization, but since this scenario can happen, we have built " "libguestfs to deal with it.)" msgstr "" # type: textblock #: ../src/guestfs.pod:525 msgid "" "For each root, you can then call various C functions " "to get additional details about that operating system. For example, call L to return the string C or C for " "Windows and Linux-based operating systems respectively." msgstr "" # type: textblock #: ../src/guestfs.pod:531 msgid "" "Un*x-like and Linux-based operating systems usually consist of several " "filesystems which are mounted at boot time (for example, a separate boot " "partition mounted on C). The inspection rules are able to detect how " "filesystems correspond to mount points. Call " "C to get this mapping. It might return a " "hash table like this example:" msgstr "" # type: verbatim #: ../src/guestfs.pod:538 #, no-wrap msgid "" " /boot => /dev/sda1\n" " / => /dev/vg_guest/lv_root\n" " /usr => /dev/vg_guest/lv_usr\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:542 msgid "" "The caller can then make calls to L to mount the " "filesystems as suggested." msgstr "" # type: textblock #: ../src/guestfs.pod:545 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:549 msgid "" "Inspection currently only works for some common operating systems. " "Contributors are welcome to send patches for other operating systems that we " "currently cannot detect." msgstr "" # type: textblock #: ../src/guestfs.pod:553 msgid "" "Encrypted disks must be opened before inspection. See L " "for more details. The L function just ignores any " "encrypted devices." msgstr "" # type: textblock #: ../src/guestfs.pod:557 msgid "" "A note on the implementation: The call L performs " "inspection and caches the results in the guest handle. Subsequent calls to " "C return this cached information, but I re-" "read the disks. If you change the content of the guest disks, you can redo " "inspection by calling L again." msgstr "" # type: =head2 #: ../src/guestfs.pod:564 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS" msgstr "" # type: textblock #: ../src/guestfs.pod:566 msgid "" "Libguestfs can mount NTFS partitions. It does this using the L driver." msgstr "" # type: textblock #: ../src/guestfs.pod:569 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 " "a Windows configuration file referring to a path like C. When the filesystem is mounted in libguestfs, that directory " "might be referred to as C." msgstr "" # type: textblock #: ../src/guestfs.pod:575 msgid "" "Drive letter mappings are outside the scope of libguestfs. You have to use " "libguestfs to read the appropriate Windows Registry and configuration files, " "to determine yourself how drives are mapped (see also L and L)." msgstr "" # type: textblock #: ../src/guestfs.pod:580 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:583 msgid "" "Where we can help is in resolving the case insensitivity of paths. For " "this, call L." msgstr "" # type: textblock #: ../src/guestfs.pod:586 msgid "" "Libguestfs also provides some help for decoding Windows Registry \"hive\" " "files, through the library C which is part of the libguestfs project " "although ships as a separate tarball. You have to locate and download the " "hive file(s) yourself, and then pass them to C functions. See also " "the programs L, L, L and L for more help on this issue." msgstr "" # type: =head2 #: ../src/guestfs.pod:594 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES" msgstr "" # type: textblock #: ../src/guestfs.pod:596 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:599 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." msgstr "" # type: textblock #: ../src/guestfs.pod:605 msgid "" "Error messages are automatically transformed into exceptions if the language " "supports it." msgstr "" # type: textblock #: ../src/guestfs.pod:608 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 " "provide in their favourite languages if they wish." msgstr "" # type: =item #: ../src/guestfs.pod:614 msgid "B" msgstr "" # type: textblock #: ../src/guestfs.pod:616 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:620 msgid "B" msgstr "" # type: textblock #: ../src/guestfs.pod:622 msgid "" "The C# bindings are highly experimental. Please read the warnings at the " "top of C." msgstr "" # type: =item #: ../src/guestfs.pod:625 msgid "B" msgstr "" # type: textblock #: ../src/guestfs.pod:627 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 " "looking for help to complete this binding." msgstr "" # type: =item #: ../src/guestfs.pod:631 msgid "B" msgstr "" # type: textblock #: ../src/guestfs.pod:633 msgid "" "Full documentation is contained in the Javadoc which is distributed with " "libguestfs." msgstr "" # type: =item #: ../src/guestfs.pod:636 msgid "B" msgstr "" # type: textblock #: ../src/guestfs.pod:638 msgid "For documentation see the file C." msgstr "" # type: =item #: ../src/guestfs.pod:640 msgid "B" msgstr "" # type: textblock #: ../src/guestfs.pod:642 msgid "For documentation see L." msgstr "" # type: =item #: ../src/guestfs.pod:644 msgid "B" msgstr "" # type: textblock #: ../src/guestfs.pod:646 msgid "" "For documentation see C supplied with libguestfs sources or in " "the php-libguestfs package for your distribution." msgstr "" # type: textblock #: ../src/guestfs.pod:649 msgid "The PHP binding only works correctly on 64 bit machines." msgstr "" # type: =item #: ../src/guestfs.pod:651 msgid "B" msgstr "" # type: textblock #: ../src/guestfs.pod:653 msgid "For documentation do:" msgstr "" # type: verbatim #: ../src/guestfs.pod:655 #, no-wrap msgid "" " $ python\n" " >>> import guestfs\n" " >>> help (guestfs)\n" "\n" msgstr "" # type: =item #: ../src/guestfs.pod:659 msgid "B" msgstr "" # type: textblock #: ../src/guestfs.pod:661 msgid "" "Use the Guestfs module. There is no Ruby-specific documentation, but you " "can find examples written in Ruby in the libguestfs source." msgstr "" # type: =item #: ../src/guestfs.pod:664 msgid "B" msgstr "" # type: textblock #: ../src/guestfs.pod:666 msgid "For documentation see L." msgstr "" # type: =head2 #: ../src/guestfs.pod:670 msgid "LIBGUESTFS GOTCHAS" msgstr "" # type: textblock #: ../src/guestfs.pod:672 msgid "" "L: \"A feature of a " "system [...] that works in the way it is documented but is counterintuitive " "and almost invites mistakes.\"" msgstr "" # type: textblock #: ../src/guestfs.pod:676 msgid "" "Since we developed libguestfs and the associated tools, there are several " "things we would have designed differently, but are now stuck with for " "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 " "release, you can expect these to change. Beware of them." msgstr "" # type: =item #: ../src/guestfs.pod:684 msgid "Autosync / forgetting to sync." msgstr "" # type: textblock #: ../src/guestfs.pod:686 msgid "" "When modifying a filesystem from C or another language, you B unmount " "all filesystems and call L explicitly before you close the " "libguestfs handle. You can also call:" msgstr "" # type: verbatim #: ../src/guestfs.pod:690 #, no-wrap msgid "" " guestfs_set_autosync (g, 1);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:692 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:696 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 " "you'll get disk corruption." msgstr "" # type: textblock #: ../src/guestfs.pod:700 msgid "" "Note that in L autosync is the default. So quick and dirty " "guestfish scripts that forget to sync will work just fine, which can make " "this very puzzling if you are trying to debug a problem." msgstr "" # type: textblock #: ../src/guestfs.pod:704 msgid "" "Update: Autosync is enabled by default for all API users starting from " "libguestfs 1.5.24." msgstr "" # type: =item #: ../src/guestfs.pod:707 msgid "Mount option C<-o sync> should not be the default." msgstr "" # type: textblock #: ../src/guestfs.pod:709 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 " "very large performance impact." msgstr "" # type: textblock #: ../src/guestfs.pod:713 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:716 msgid "Read-only should be the default." msgstr "" # type: textblock #: ../src/guestfs.pod:718 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:721 msgid "This would reduce the potential to corrupt live VM images." msgstr "" # type: textblock #: ../src/guestfs.pod:723 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 to guarantee that the disk is not changed." msgstr "" # type: =item #: ../src/guestfs.pod:727 msgid "guestfish command line is hard to use." msgstr "" # type: textblock #: ../src/guestfs.pod:729 msgid "" "C doesn't do what people expect (open C for " "examination). It tries to run a guestfish command C which doesn't " "exist, so it fails. In earlier versions of guestfish the error message was " "also unintuitive, but we have corrected this since. Like the Bourne shell, " "we should have used C to run commands." msgstr "" # type: =item #: ../src/guestfs.pod:736 msgid "guestfish megabyte modifiers don't work right on all commands" msgstr "" # type: textblock #: ../src/guestfs.pod:738 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 " "part by the modifier part and pass the result to the C API. However this " "doesn't work for a few APIs which aren't expecting bytes, but are already " "expecting some other unit (eg. megabytes)." msgstr "" # type: textblock #: ../src/guestfs.pod:745 msgid "The most common is L. The guestfish command:" msgstr "" # type: verbatim #: ../src/guestfs.pod:747 #, no-wrap msgid "" " lvcreate LV VG 100M\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:749 msgid "" "does not do what you might expect. Instead because L is " "already expecting megabytes, this tries to create a 100 I (100 " "megabytes * megabytes) logical volume. The error message you get from this " "is also a little obscure." msgstr "" # type: textblock #: ../src/guestfs.pod:754 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:757 msgid "Library should return errno with error messages." msgstr "" # type: textblock #: ../src/guestfs.pod:759 msgid "" "It would be a nice-to-have to be able to get the original value of 'errno' " "from inside the appliance along error paths (where set). Currently " "L goes through hoops to try to reverse the error message " "string into an errno, see the function error() in fuse/guestmount.c." msgstr "" # type: textblock #: ../src/guestfs.pod:765 msgid "" "In libguestfs 1.5.4, the protocol was changed so that the Linux errno is " "sent back from the daemon." msgstr "" # type: =item #: ../src/guestfs.pod:768 msgid "Ambiguity between devices and paths" msgstr "" # type: textblock #: ../src/guestfs.pod:770 msgid "" "There is a subtle ambiguity in the API between a device name (eg. C) and a similar pathname. A file might just happen to be called " "C in the directory C (consider some non-Unix VM image)." msgstr "" # type: textblock #: ../src/guestfs.pod:775 msgid "" "In the current API we usually resolve this ambiguity by having two separate " "calls, for example L and L. " "Some API calls are ambiguous and (incorrectly) resolve the problem by " "detecting if the path supplied begins with C." msgstr "" # type: textblock #: ../src/guestfs.pod:781 msgid "" "To avoid both the ambiguity and the need to duplicate some calls, we could " "make paths/devices into structured names. One way to do this would be to " "use a notation like grub (C), although nobody really likes this " "aspect of grub. Another way would be to use a structured type, equivalent " "to this OCaml type:" msgstr "" # type: verbatim #: ../src/guestfs.pod:787 #, no-wrap msgid "" " type path = Path of string | Device of int | Partition of int * int\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:789 msgid "which would allow you to pass arguments like:" msgstr "" # type: verbatim #: ../src/guestfs.pod:791 #, no-wrap msgid "" " Path \"/foo/bar\"\n" " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n" " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n" " Path \"/dev/sdb2\" (* not a device *)\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:796 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:801 msgid "PROTOCOL LIMITS" msgstr "" # type: textblock #: ../src/guestfs.pod:803 msgid "" "Internally libguestfs uses a message-based protocol to pass API calls and " "their responses to and from a small \"appliance\" (see L for " "plenty more detail about this). The maximum message size used by the " "protocol is slightly less than 4 MB. For some API calls you may need to be " "aware of this limit. The API calls which may be affected are individually " "documented, with a link back to this section of the documentation." msgstr "" # type: textblock #: ../src/guestfs.pod:811 msgid "" "A simple call such as L returns its result (the file data) in " "a simple string. Because this string is at some point internally encoded as " "a message, the maximum size that it can return is slightly under 4 MB. If " "the requested file is larger than this then you will get an error." msgstr "" # type: textblock #: ../src/guestfs.pod:817 msgid "" "In order to transfer large files into and out of the guest filesystem, you " "need to use particular calls that support this. The sections L " "and L document how to do this." msgstr "" # type: textblock #: ../src/guestfs.pod:821 msgid "" "You might also consider mounting the disk image using our FUSE filesystem " "support (L)." msgstr "" # type: =head2 #: ../src/guestfs.pod:824 msgid "KEYS AND PASSPHRASES" msgstr "" # type: textblock #: ../src/guestfs.pod:826 msgid "" "Certain libguestfs calls take a parameter that contains sensitive key " "material, passed in as a C string." msgstr "" # type: textblock #: ../src/guestfs.pod:829 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 " "swap. However this is I done at the moment, because of the complexity " "of such an implementation." msgstr "" # type: textblock #: ../src/guestfs.pod:834 msgid "" "Therefore you should be aware that any key parameter you pass to libguestfs " "might end up being written out to the swap partition. If this is a concern, " "scrub the swap partition or don't use libguestfs on encrypted devices." msgstr "" # type: =head1 #: ../src/guestfs.pod:839 msgid "CONNECTION MANAGEMENT" msgstr "" # type: =head2 #: ../src/guestfs.pod:841 msgid "guestfs_h *" msgstr "" # type: textblock #: ../src/guestfs.pod:843 msgid "" "C is the opaque type representing a connection handle. Create a " "handle by calling L. Call L to free the " "handle and release all resources used." msgstr "" # type: textblock #: ../src/guestfs.pod:847 msgid "" "For information on using multiple handles and threads, see the section L below." msgstr "" # type: =head2 #: ../src/guestfs.pod:850 msgid "guestfs_create" msgstr "" # type: verbatim #: ../src/guestfs.pod:852 #, no-wrap msgid "" " guestfs_h *guestfs_create (void);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:854 msgid "Create a connection handle." msgstr "" # type: textblock #: ../src/guestfs.pod:856 msgid "" "You have to call L (or one of the equivalent calls) " "on the handle at least once." msgstr "" # type: textblock #: ../src/guestfs.pod:859 msgid "" "This function returns a non-NULL pointer to a handle on success or NULL on " "error." msgstr "" # type: textblock #: ../src/guestfs.pod:862 msgid "After configuring the handle, you have to call L." msgstr "" # type: textblock #: ../src/guestfs.pod:864 msgid "" "You may also want to configure error handling for the handle. See L section below." msgstr "" # type: =head2 #: ../src/guestfs.pod:867 msgid "guestfs_close" msgstr "" # type: verbatim #: ../src/guestfs.pod:869 #, no-wrap msgid "" " void guestfs_close (guestfs_h *g);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:871 msgid "This closes the connection handle and frees up all resources used." msgstr "" # type: =head1 #: ../src/guestfs.pod:873 msgid "ERROR HANDLING" msgstr "" # type: textblock #: ../src/guestfs.pod:875 msgid "" "The convention in all functions that return C is that they return C<-1> " "to indicate an error. You can get additional information on errors by " "calling L and/or by setting up an error handler with L." msgstr "" # type: textblock #: ../src/guestfs.pod:880 msgid "The default error handler prints the information string to C." msgstr "" # type: textblock #: ../src/guestfs.pod:882 msgid "" "Out of memory errors are handled differently. The default action is to call " "L. If this is undesirable, then you can set a handler using L." msgstr "" # type: =head2 #: ../src/guestfs.pod:886 msgid "guestfs_last_error" msgstr "" # type: verbatim #: ../src/guestfs.pod:888 #, no-wrap msgid "" " const char *guestfs_last_error (guestfs_h *g);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:890 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:894 msgid "" "The lifetime of the returned string is until the next error occurs, or L is called." msgstr "" # type: textblock #: ../src/guestfs.pod:897 msgid "" "The error string is not localized (ie. is always in English), because this " "makes searching for error messages in search engines give the largest number " "of results." msgstr "" # type: =head2 #: ../src/guestfs.pod:901 msgid "guestfs_set_error_handler" msgstr "" # type: verbatim #: ../src/guestfs.pod:903 #, no-wrap msgid "" " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" " void *opaque,\n" " const char *msg);\n" " void guestfs_set_error_handler (guestfs_h *g,\n" " guestfs_error_handler_cb cb,\n" " void *opaque);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:910 msgid "" "The callback C will be called if there is an error. The parameters " "passed to the callback are an opaque data pointer and the error message " "string." msgstr "" # type: textblock #: ../src/guestfs.pod:914 msgid "" "Note that the message string C is freed as soon as the callback " "function returns, so if you want to stash it somewhere you must make your " "own copy." msgstr "" # type: textblock #: ../src/guestfs.pod:918 msgid "The default handler prints messages on C." msgstr "" # type: textblock #: ../src/guestfs.pod:920 msgid "If you set C to C then I handler is called." msgstr "" # type: =head2 #: ../src/guestfs.pod:922 msgid "guestfs_get_error_handler" msgstr "" # type: verbatim #: ../src/guestfs.pod:924 #, no-wrap msgid "" " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" " void **opaque_rtn);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:927 msgid "Returns the current error handler callback." msgstr "" # type: =head2 #: ../src/guestfs.pod:929 msgid "guestfs_set_out_of_memory_handler" msgstr "" # type: verbatim #: ../src/guestfs.pod:931 #, no-wrap msgid "" " typedef void (*guestfs_abort_cb) (void);\n" " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n" " guestfs_abort_cb);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:935 msgid "" "The callback C will be called if there is an out of memory situation. " "I." msgstr "" # type: textblock #: ../src/guestfs.pod:938 msgid "The default is to call L." msgstr "" # type: textblock #: ../src/guestfs.pod:940 msgid "" "You cannot set C to C. You can't ignore out of memory situations." msgstr "" # type: =head2 #: ../src/guestfs.pod:943 msgid "guestfs_get_out_of_memory_handler" msgstr "" # type: verbatim #: ../src/guestfs.pod:945 #, no-wrap msgid "" " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:947 msgid "This returns the current out of memory handler." msgstr "" # type: =head1 #: ../src/guestfs.pod:949 msgid "PATH" msgstr "" # type: textblock #: ../src/guestfs.pod:951 msgid "" "Libguestfs needs a kernel and initrd.img, which it finds by looking along an " "internal path." msgstr "" # type: textblock #: ../src/guestfs.pod:954 msgid "" "By default it looks for these in the directory C<$libdir/guestfs> (eg. C or C)." msgstr "" # type: textblock #: ../src/guestfs.pod:957 msgid "" "Use L or set the environment variable L " "to change the directories that libguestfs will search in. The value is a " "colon-separated list of paths. The current directory is I searched " "unless the path contains an empty element or C<.>. For example " "C would search the current directory and " "then C." msgstr "" # type: =head1 #: ../src/guestfs.pod:964 msgid "HIGH-LEVEL API ACTIONS" msgstr "" # type: =head2 #: ../src/guestfs.pod:966 msgid "ABI GUARANTEE" msgstr "" # type: textblock #: ../src/guestfs.pod:968 msgid "" "We guarantee the libguestfs ABI (binary interface), for public, high-level " "actions as outlined in this section. Although we will deprecate some " "actions, for example if they get replaced by newer calls, we will keep the " "old actions forever. This allows you the developer to program in confidence " "against the libguestfs API." msgstr "" # type: textblock #: ../src/guestfs.pod:974 ../fish/guestfish.pod:860 msgid "@ACTIONS@" msgstr "" # type: =head1 #: ../src/guestfs.pod:976 msgid "STRUCTURES" msgstr "" # type: textblock #: ../src/guestfs.pod:978 msgid "@STRUCTS@" msgstr "" # type: =head1 #: ../src/guestfs.pod:980 msgid "AVAILABILITY" msgstr "" # type: =head2 #: ../src/guestfs.pod:982 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" msgstr "" # type: textblock #: ../src/guestfs.pod:984 msgid "" "Using L you can test availability of the following " "groups of functions. This test queries the appliance to see if the " "appliance you are currently using supports the functionality." msgstr "" # type: textblock #: ../src/guestfs.pod:989 msgid "@AVAILABILITY@" msgstr "" # type: =head2 #: ../src/guestfs.pod:991 msgid "GUESTFISH supported COMMAND" msgstr "" # type: textblock #: ../src/guestfs.pod:993 msgid "" "In L there is a handy interactive command C which " "prints out the available groups and whether they are supported by this build " "of libguestfs. Note however that you have to do C first." msgstr "" # type: =head2 #: ../src/guestfs.pod:998 msgid "SINGLE CALLS AT COMPILE TIME" msgstr "" # type: textblock #: ../src/guestfs.pod:1000 msgid "" "Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " "function, such as:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1003 #, no-wrap msgid "" " #define LIBGUESTFS_HAVE_DD 1\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1005 msgid "if L is available." msgstr "" # type: textblock #: ../src/guestfs.pod:1007 msgid "" "Before version 1.5.8, if you needed to test whether a single libguestfs " "function is available at compile time, we recommended using build tools such " "as autoconf or cmake. For example in autotools you could use:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1012 #, no-wrap msgid "" " AC_CHECK_LIB([guestfs],[guestfs_create])\n" " AC_CHECK_FUNCS([guestfs_dd])\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1015 msgid "" "which would result in C being either defined or not defined " "in your program." msgstr "" # type: =head2 #: ../src/guestfs.pod:1018 msgid "SINGLE CALLS AT RUN TIME" msgstr "" # type: textblock #: ../src/guestfs.pod:1020 msgid "" "Testing at compile time doesn't guarantee that a function really exists in " "the library. The reason is that you might be dynamically linked against a " "previous I (dynamic library) which doesn't have the call. " "This situation unfortunately results in a segmentation fault, which is a " "shortcoming of the C dynamic linking system itself." msgstr "" # type: textblock #: ../src/guestfs.pod:1027 msgid "" "You can use L to test if a function is available at run time, as " "in this example program (note that you still need the compile time check as " "well):" msgstr "" # type: verbatim #: ../src/guestfs.pod:1031 #, no-wrap msgid "" " #include \n" " #include \n" " #include \n" " #include \n" " #include \n" " \n" msgstr "" # type: verbatim #: ../src/guestfs.pod:1037 #, no-wrap msgid "" " main ()\n" " {\n" " #ifdef LIBGUESTFS_HAVE_DD\n" " void *dl;\n" " int has_function;\n" " \n" msgstr "" # type: verbatim #: ../src/guestfs.pod:1043 #, no-wrap msgid "" " /* Test if the function guestfs_dd is really available. */\n" " dl = dlopen (NULL, RTLD_LAZY);\n" " if (!dl) {\n" " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n" " exit (EXIT_FAILURE);\n" " }\n" " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n" " dlclose (dl);\n" " \n" msgstr "" # type: verbatim #: ../src/guestfs.pod:1052 #, no-wrap msgid "" " if (!has_function)\n" " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n" " else {\n" " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n" " /* Now it's safe to call\n" " guestfs_dd (g, \"foo\", \"bar\");\n" " */\n" " }\n" " #else\n" " printf (\"guestfs_dd function was not found at compile time\\n\");\n" " #endif\n" " }\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1065 msgid "" "You may think the above is an awful lot of hassle, and it is. There are " "other ways outside of the C linking system to ensure that this kind of " "incompatibility never arises, such as using package versioning:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1070 #, no-wrap msgid "" " Requires: libguestfs >= 1.0.80\n" "\n" msgstr "" # type: =head1 #: ../src/guestfs.pod:1072 msgid "CALLS WITH OPTIONAL ARGUMENTS" msgstr "" # type: textblock #: ../src/guestfs.pod:1074 msgid "" "A recent feature of the API is the introduction of calls which take optional " "arguments. In C these are declared 3 ways. The main way is as a call which " "takes variable arguments (ie. C<...>), as in this example:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1079 #, no-wrap msgid "" " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1081 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:1084 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename, -1);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1086 msgid "With a single optional argument:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1088 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" " -1);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1092 msgid "With two:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1094 #, no-wrap msgid "" " guestfs_add_drive_opts (g, filename,\n" " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n" " -1);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1099 msgid "" "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " "happen!" msgstr "" # type: =head2 #: ../src/guestfs.pod:1102 msgid "USING va_list FOR OPTIONAL ARGUMENTS" msgstr "" # type: textblock #: ../src/guestfs.pod:1104 msgid "" "The second variant has the same name with the suffix C<_va>, which works the " "same way but takes a C. See the C manual for details. For the " "example function, this is declared:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1108 #, no-wrap msgid "" " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" " va_list args);\n" "\n" msgstr "" # type: =head2 #: ../src/guestfs.pod:1111 msgid "CONSTRUCTING OPTIONAL ARGUMENTS" msgstr "" # type: textblock #: ../src/guestfs.pod:1113 msgid "" "The third variant is useful where you need to construct these calls. You " "pass in a structure where you fill in the optional fields. The structure " "has a bitmask as the first element which you must set to indicate which " "fields you have filled in. For our example function the structure and call " "are declared:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1119 #, no-wrap msgid "" " struct guestfs_add_drive_opts_argv {\n" " uint64_t bitmask;\n" " int readonly;\n" " const char *format;\n" " /* ... */\n" " };\n" " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n" " const struct guestfs_add_drive_opts_argv *optargs);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1128 msgid "You could call it like this:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1130 #, no-wrap msgid "" " struct guestfs_add_drive_opts_argv optargs = {\n" " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n" " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n" " .readonly = 1,\n" " .format = \"qcow2\"\n" " };\n" " \n" msgstr "" # type: verbatim #: ../src/guestfs.pod:1137 #, no-wrap msgid "" " guestfs_add_drive_opts_argv (g, filename, &optargs);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1139 ../src/guestfs-actions.pod:10 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:9 #: ../fish/guestfish-actions.pod:1244 msgid "Notes:" msgstr "" # type: textblock #: ../src/guestfs.pod:1145 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." msgstr "" # type: textblock #: ../src/guestfs.pod:1150 msgid "You do not need to fill in all fields of the structure." msgstr "" # type: textblock #: ../src/guestfs.pod:1154 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:1159 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" msgstr "" # type: textblock #: ../src/guestfs.pod:1161 msgid "" "In other languages, optional arguments are expressed in the way that is " "natural for that language. We refer you to the language-specific " "documentation for more details on that." msgstr "" # type: textblock #: ../src/guestfs.pod:1165 msgid "For guestfish, see L." msgstr "" # type: =end #: ../src/guestfs.pod:1167 ../src/guestfs.pod:1172 msgid "html" msgstr "" # type: textblock #: ../src/guestfs.pod:1169 msgid "" " " msgstr "" # type: =head1 #: ../src/guestfs.pod:1174 msgid "ARCHITECTURE" msgstr "" # type: textblock #: ../src/guestfs.pod:1176 msgid "" "Internally, libguestfs is implemented by running an appliance (a special " "type of small virtual machine) using L. Qemu runs as a child " "process of the main program." msgstr "" # type: verbatim #: ../src/guestfs.pod:1180 #, no-wrap msgid "" " ___________________\n" " / \\\n" " | main program |\n" " | |\n" " | | child process / appliance\n" " | | __________________________\n" " | | / qemu \\\n" " +-------------------+ RPC | +-----------------+ |\n" " | libguestfs <--------------------> guestfsd | |\n" " | | | +-----------------+ |\n" " \\___________________/ | | Linux kernel | |\n" " | +--^--------------+ |\n" " \\_________|________________/\n" " |\n" " _______v______\n" " / \\\n" " | Device or |\n" " | disk image |\n" " \\______________/\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1200 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:1203 msgid "" "Inside the appliance is a Linux kernel and a complete stack of userspace " "tools (such as LVM and ext2 programs) and a small controlling daemon called " "L. The library talks to L using remote procedure " "calls (RPC). There is a mostly one-to-one correspondence between libguestfs " "API calls and RPC calls to the daemon. Lastly the disk image(s) are " "attached to the qemu process which translates device access by the " "appliance's Linux kernel into accesses to the image." msgstr "" # type: textblock #: ../src/guestfs.pod:1212 msgid "" "A common misunderstanding is that the appliance \"is\" the virtual machine. " "Although the disk image you are attached to might also be used by some " "virtual machine, libguestfs doesn't know or care about this. (But you will " "care if both libguestfs's qemu process and your virtual machine are trying " "to update the disk image at the same time, since these usually results in " "massive disk corruption)." msgstr "" # type: =head1 #: ../src/guestfs.pod:1219 msgid "STATE MACHINE" msgstr "" # type: textblock #: ../src/guestfs.pod:1221 msgid "libguestfs uses a state machine to model the child process:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1223 #, no-wrap msgid "" " |\n" " guestfs_create\n" " |\n" " |\n" " ____V_____\n" " / \\\n" " | CONFIG |\n" " \\__________/\n" " ^ ^ ^ \\\n" " / | \\ \\ guestfs_launch\n" " / | _\\__V______\n" " / | / \\\n" " / | | LAUNCHING |\n" " / | \\___________/\n" " / | /\n" " / | guestfs_launch\n" " / | /\n" " ______ / __|____V\n" " / \\ ------> / \\\n" " | BUSY | | READY |\n" " \\______/ <------ \\________/\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1245 msgid "" "The normal transitions are (1) CONFIG (when the handle is created, but there " "is no child process), (2) LAUNCHING (when the child process is booting up), " "(3) alternating between READY and BUSY as commands are issued to, and " "carried out by, the child process." msgstr "" # type: textblock #: ../src/guestfs.pod:1250 msgid "" "The guest may be killed by L, or may die " "asynchronously at any time (eg. due to some internal error), and that causes " "the state to transition back to CONFIG." msgstr "" # type: textblock #: ../src/guestfs.pod:1254 msgid "" "Configuration commands for qemu such as L can only be " "issued when in the CONFIG state." msgstr "" # type: textblock #: ../src/guestfs.pod:1257 msgid "" "The API offers one call that goes from CONFIG through LAUNCHING to READY. " "L blocks until the child process is READY to accept " "commands (or until some failure or timeout). L internally " "moves the state from CONFIG to LAUNCHING while it is running." msgstr "" # type: textblock #: ../src/guestfs.pod:1263 msgid "" "API actions such as L can only be issued when in the READY " "state. These API calls block waiting for the command to be carried out (ie. " "the state to transition to BUSY and then back to READY). There are no non-" "blocking versions, and no way to issue more than one command per handle at " "the same time." msgstr "" # type: textblock #: ../src/guestfs.pod:1269 msgid "" "Finally, the child process sends asynchronous messages back to the main " "program, such as kernel log messages. You can register a callback to " "receive these messages." msgstr "" # type: =head2 #: ../src/guestfs.pod:1273 msgid "SETTING CALLBACKS TO HANDLE EVENTS" msgstr "" # type: textblock #: ../src/guestfs.pod:1275 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:1278 msgid "" "Use the C functions to set a callback for different " "types of events." msgstr "" # type: textblock #: ../src/guestfs.pod:1281 msgid "" "Only I can be registered for each handle. " "Calling C again overwrites the previous callback of " "that type. Cancel all callbacks of this type by calling this function with " "C set to C." msgstr "" # type: =head2 #: ../src/guestfs.pod:1286 msgid "guestfs_set_log_message_callback" msgstr "" # type: verbatim #: ../src/guestfs.pod:1288 #, no-wrap msgid "" " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n" " char *buf, int len);\n" " void guestfs_set_log_message_callback (guestfs_h *g,\n" " guestfs_log_message_cb cb,\n" " void *opaque);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1294 msgid "" "The callback function C will be called whenever qemu or the guest writes " "anything to the console." msgstr "" # type: textblock #: ../src/guestfs.pod:1297 msgid "Use this function to capture kernel messages and similar." msgstr "" # type: textblock #: ../src/guestfs.pod:1299 msgid "" "Normally there is no log message handler, and log messages are just " "discarded." msgstr "" # type: =head2 #: ../src/guestfs.pod:1302 msgid "guestfs_set_subprocess_quit_callback" msgstr "" # type: verbatim #: ../src/guestfs.pod:1304 #, no-wrap msgid "" " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n" " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n" " guestfs_subprocess_quit_cb cb,\n" " void *opaque);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1309 msgid "" "The callback function C will be called when the child process quits, " "either asynchronously or if killed by L. (This " "corresponds to a transition from any state to the CONFIG state)." msgstr "" # type: =head2 #: ../src/guestfs.pod:1314 msgid "guestfs_set_launch_done_callback" msgstr "" # type: verbatim #: ../src/guestfs.pod:1316 #, no-wrap msgid "" " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n" " void guestfs_set_launch_done_callback (guestfs_h *g,\n" " guestfs_launch_done_cb cb,\n" " void *opaque);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1321 msgid "" "The callback function C will be called when the child process becomes " "ready first time after it has been launched. (This corresponds to a " "transition from LAUNCHING to the READY state)." msgstr "" # type: =head2 #: ../src/guestfs.pod:1325 msgid "guestfs_set_close_callback" msgstr "" # type: verbatim #: ../src/guestfs.pod:1327 #, no-wrap msgid "" " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n" " void guestfs_set_close_callback (guestfs_h *g,\n" " guestfs_close_cb cb,\n" " void *opaque);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1332 msgid "" "The callback function C will be called while the handle is being closed " "(synchronously from L)." msgstr "" # type: textblock #: ../src/guestfs.pod:1335 msgid "" "Note that libguestfs installs an L handler to try to clean up " "handles that are open when the program exits. This means that this callback " "might be called indirectly from L, which can cause unexpected " "problems in higher-level languages (eg. if your HLL interpreter has already " "been cleaned up by the time this is called, and if your callback then jumps " "into some HLL function)." msgstr "" # type: =head2 #: ../src/guestfs.pod:1343 msgid "guestfs_set_progress_callback" msgstr "" # type: verbatim #: ../src/guestfs.pod:1345 #, no-wrap msgid "" " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n" " int proc_nr, int serial,\n" " uint64_t position, uint64_t total);\n" " void guestfs_set_progress_callback (guestfs_h *g,\n" " guestfs_progress_cb cb,\n" " void *opaque);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1352 msgid "" "Some long-running operations can generate progress messages. If this " "callback is registered, then it will be called each time a progress message " "is generated (usually two seconds after the operation started, and three " "times per second thereafter until it completes, although the frequency may " "change in future versions)." msgstr "" # type: textblock #: ../src/guestfs.pod:1358 msgid "" "The callback receives two numbers: C and C. The units of " "C are not defined, although for some operations C may relate " "in some way to the amount of data to be transferred (eg. in bytes or " "megabytes), and C may be the portion which has been transferred." msgstr "" # type: textblock #: ../src/guestfs.pod:1364 msgid "The only defined and stable parts of the API are:" msgstr "" # type: textblock #: ../src/guestfs.pod:1370 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:1375 msgid "0 E= C E= C" msgstr "" # type: textblock #: ../src/guestfs.pod:1379 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:1382 msgid "" "This is to simplify caller code, so callers can easily set the progress " "indicator to \"100%\" at the end of the operation, without requiring special " "code to detect this case." msgstr "" # type: textblock #: ../src/guestfs.pod:1388 msgid "" "The callback also receives the procedure number and serial number of the " "call. These are only useful for debugging protocol issues, and the callback " "can normally ignore them. The callback may want to print these numbers in " "error messages or debugging messages." msgstr "" # type: =head1 #: ../src/guestfs.pod:1393 msgid "PRIVATE DATA AREA" msgstr "" # type: textblock #: ../src/guestfs.pod:1395 msgid "" "You can attach named pieces of private data to the libguestfs handle, and " "fetch them by name for the lifetime of the handle. This is called the " "private data area and is only available from the C API." msgstr "" # type: textblock #: ../src/guestfs.pod:1399 msgid "To attach a named piece of data, use the following call:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1401 #, no-wrap msgid "" " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1403 msgid "" "C is the name to associate with this data, and C is an arbitrary " "pointer (which can be C). Any previous item with the same name is " "overwritten." msgstr "" # type: textblock #: ../src/guestfs.pod:1407 msgid "" "You can use any C you want, but names beginning with an underscore " "character are reserved for internal libguestfs purposes (for implementing " "language bindings). It is recommended to prefix the name with some unique " "string to avoid collisions with other users." msgstr "" # type: textblock #: ../src/guestfs.pod:1412 msgid "To retrieve the pointer, use:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1414 #, no-wrap msgid "" " void *guestfs_get_private (guestfs_h *g, const char *key);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1416 msgid "" "This function returns C if either no data is found associated with " "C, or if the user previously set the C's C pointer to " "C." msgstr "" # type: textblock #: ../src/guestfs.pod:1420 msgid "" "Libguestfs does not try to look at or interpret the C pointer in any " "way. As far as libguestfs is concerned, it need not be a valid pointer at " "all. In particular, libguestfs does I try to free the data when the " "handle is closed. If the data must be freed, then the caller must either " "free it before calling L or must set up a close callback to " "do it (see L, and note that only one callback " "can be registered for a handle)." msgstr "" # type: textblock #: ../src/guestfs.pod:1428 msgid "" "The private data area is implemented using a hash table, and should be " "reasonably efficient for moderate numbers of keys." msgstr "" # type: =head1 #: ../src/guestfs.pod:1431 msgid "BLOCK DEVICE NAMING" msgstr "" # type: textblock #: ../src/guestfs.pod:1433 msgid "" "In the kernel there is now quite a profusion of schemata for naming block " "devices (in this context, by I I mean a physical or virtual " "hard drive). The original Linux IDE driver used names starting with C. SCSI devices have historically used a different naming scheme, C. When the Linux kernel I driver became a popular replacement " "for the old IDE driver (particularly for SATA devices) those devices also " "used the C scheme. Additionally we now have virtual machines with " "paravirtualized drivers. This has created several different naming systems, " "such as C for virtio disks and C for Xen PV disks." msgstr "" # type: textblock #: ../src/guestfs.pod:1445 msgid "" "As discussed above, libguestfs uses a qemu appliance running an embedded " "Linux kernel to access block devices. We can run a variety of appliances " "based on a variety of Linux kernels." msgstr "" # type: textblock #: ../src/guestfs.pod:1449 msgid "" "This causes a problem for libguestfs because many API calls use device or " "partition names. Working scripts and the recipe (example) scripts that we " "make available over the internet could fail if the naming scheme changes." msgstr "" # type: textblock #: ../src/guestfs.pod:1454 msgid "" "Therefore libguestfs defines C as the I. " "Internally C names are translated, if necessary, to other names as " "required. For example, under RHEL 5 which uses the C scheme, any " "device parameter C is translated to C transparently." msgstr "" # type: textblock #: ../src/guestfs.pod:1460 msgid "" "Note that this I applies to parameters. The L, " "L and similar calls return the true names of the " "devices and partitions as known to the appliance." msgstr "" # type: =head2 #: ../src/guestfs.pod:1465 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" msgstr "" # type: textblock #: ../src/guestfs.pod:1467 msgid "" "Usually this translation is transparent. However in some (very rare) cases " "you may need to know the exact algorithm. Such cases include where you use " "L to add a mixture of virtio and IDE devices to the qemu-" "based appliance, so have a mixture of C and C devices." msgstr "" # type: textblock #: ../src/guestfs.pod:1473 msgid "" "The algorithm is applied only to I which are known to be either " "device or partition names. Return values from functions such as L are never changed." msgstr "" # type: textblock #: ../src/guestfs.pod:1481 msgid "Is the string a parameter which is a device or partition name?" msgstr "" # type: textblock #: ../src/guestfs.pod:1485 msgid "Does the string begin with C?" msgstr "" # type: textblock #: ../src/guestfs.pod:1489 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:1494 msgid "Replace initial C string with C." msgstr "" # type: textblock #: ../src/guestfs.pod:1496 msgid "For example, change C to C." msgstr "" # type: textblock #: ../src/guestfs.pod:1498 msgid "If that named device exists, use it. If not, continue." msgstr "" # type: textblock #: ../src/guestfs.pod:1502 msgid "Replace initial C string with C." msgstr "" # type: textblock #: ../src/guestfs.pod:1504 msgid "If that named device exists, use it. If not, return an error." msgstr "" # type: =head2 #: ../src/guestfs.pod:1508 msgid "PORTABILITY CONCERNS" msgstr "" # type: textblock #: ../src/guestfs.pod:1510 msgid "" "Although the standard naming scheme and automatic translation is useful for " "simple programs and guestfish scripts, for larger programs it is best not to " "rely on this mechanism." msgstr "" # type: textblock #: ../src/guestfs.pod:1514 msgid "" "Where possible for maximum future portability programs using libguestfs " "should use these future-proof techniques:" msgstr "" # type: textblock #: ../src/guestfs.pod:1521 msgid "" "Use L or L to list actual " "device names, and then use those names directly." msgstr "" # type: textblock #: ../src/guestfs.pod:1524 msgid "" "Since those device names exist by definition, they will never be translated." msgstr "" # type: textblock #: ../src/guestfs.pod:1529 msgid "" "Use higher level ways to identify filesystems, such as LVM names, UUIDs and " "filesystem labels." msgstr "" # type: =head1 #: ../src/guestfs.pod:1534 msgid "INTERNALS" msgstr "" # type: =head2 #: ../src/guestfs.pod:1536 msgid "COMMUNICATION PROTOCOL" msgstr "" # type: textblock #: ../src/guestfs.pod:1538 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:1541 msgid "" "The protocol used to talk between the library and the daemon running inside " "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC " "1014, RFC 1832, RFC 4506)." msgstr "" # type: textblock #: ../src/guestfs.pod:1545 msgid "" "The detailed format of structures is in C (note: " "this file is automatically generated)." msgstr "" # type: textblock #: ../src/guestfs.pod:1548 msgid "" "There are two broad cases, ordinary functions that don't have any C " "and C parameters, which are handled with very simple request/reply " "messages. Then there are functions that have any C or C " "parameters, which use the same request and reply messages, but they may also " "be followed by files sent using a chunked encoding." msgstr "" # type: =head3 #: ../src/guestfs.pod:1555 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" msgstr "" # type: textblock #: ../src/guestfs.pod:1557 msgid "For ordinary functions, the request message is:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1559 #, no-wrap msgid "" " total length (header + arguments,\n" " but not including the length word itself)\n" " struct guestfs_message_header (encoded as XDR)\n" " struct guestfs__args (encoded as XDR)\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1564 msgid "" "The total length field allows the daemon to allocate a fixed size buffer " "into which it slurps the rest of the message. As a result, the total length " "is limited to C bytes (currently 4MB), which means the " "effective size of any request is limited to somewhere under this size." msgstr "" # type: textblock #: ../src/guestfs.pod:1570 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:1573 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:1577 msgid "The reply message for ordinary functions is:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1579 #, no-wrap msgid "" " total length (header + ret,\n" " but not including the length word itself)\n" " struct guestfs_message_header (encoded as XDR)\n" " struct guestfs__ret (encoded as XDR)\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1584 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:1587 msgid "" "As above the total length of the reply is limited to C." msgstr "" # type: textblock #: ../src/guestfs.pod:1590 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:1593 #, no-wrap msgid "" " total length (header + error,\n" " but not including the length word itself)\n" " struct guestfs_message_header (encoded as XDR)\n" " struct guestfs_message_error (encoded as XDR)\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1598 msgid "" "The C structure contains the error message as a " "string." msgstr "" # type: =head3 #: ../src/guestfs.pod:1601 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" msgstr "" # type: textblock #: ../src/guestfs.pod:1603 msgid "" "A C parameter indicates that we transfer a file I the guest. " "The normal request message is sent (see above). However this is followed by " "a sequence of file chunks." msgstr "" # type: verbatim #: ../src/guestfs.pod:1607 #, no-wrap msgid "" " total length (header + arguments,\n" " but not including the length word itself,\n" " and not including the chunks)\n" " struct guestfs_message_header (encoded as XDR)\n" " struct guestfs__args (encoded as XDR)\n" " sequence of chunks for FileIn param #0\n" " sequence of chunks for FileIn param #1 etc.\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1615 msgid "The \"sequence of chunks\" is:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1617 #, no-wrap msgid "" " length of chunk (not including length word itself)\n" " struct guestfs_chunk (encoded as XDR)\n" " length of chunk\n" " struct guestfs_chunk (encoded as XDR)\n" " ...\n" " length of chunk\n" " struct guestfs_chunk (with data.data_len == 0)\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1625 msgid "" "The final chunk has the C field set to zero. Additionally a flag " "is set in the final chunk to indicate either successful completion or early " "cancellation." msgstr "" # type: textblock #: ../src/guestfs.pod:1629 msgid "" "At time of writing there are no functions that have more than one FileIn " "parameter. However this is (theoretically) supported, by sending the " "sequence of chunks for each FileIn parameter one after another (from left to " "right)." msgstr "" # type: textblock #: ../src/guestfs.pod:1634 msgid "" "Both the library (sender) I the daemon (receiver) may cancel the " "transfer. The library does this by sending a chunk with a special flag set " "to indicate cancellation. When the daemon sees this, it cancels the whole " "RPC, does I send any reply, and goes back to reading the next request." msgstr "" # type: textblock #: ../src/guestfs.pod:1640 msgid "" "The daemon may also cancel. It does this by writing a special word " "C to the socket. The library listens for this during " "the transfer, and if it gets it, it will cancel the transfer (it sends a " "cancel chunk). The special word is chosen so that even if cancellation " "happens right at the end of the transfer (after the library has finished " "writing and has started listening for the reply), the \"spurious\" cancel " "flag will not be confused with the reply message." msgstr "" # type: textblock #: ../src/guestfs.pod:1649 msgid "" "This protocol allows the transfer of arbitrary sized files (no 32 bit " "limit), and also files where the size is not known in advance (eg. from " "pipes or sockets). However the chunks are rather small " "(C), so that neither the library nor the daemon need " "to keep much in memory." msgstr "" # type: =head3 #: ../src/guestfs.pod:1655 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" msgstr "" # type: textblock #: ../src/guestfs.pod:1657 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:1660 #, no-wrap msgid "" " total length (header + ret,\n" " but not including the length word itself,\n" " and not including the chunks)\n" " struct guestfs_message_header (encoded as XDR)\n" " struct guestfs__ret (encoded as XDR)\n" " sequence of chunks for FileOut param #0\n" " sequence of chunks for FileOut param #1 etc.\n" "\n" msgstr "" # type: =head3 #: ../src/guestfs.pod:1668 msgid "INITIAL MESSAGE" msgstr "" # type: textblock #: ../src/guestfs.pod:1670 msgid "" "When the daemon launches it sends an initial word (C) " "which indicates that the guest and daemon is alive. This is what L waits for." msgstr "" # type: =head3 #: ../src/guestfs.pod:1674 msgid "PROGRESS NOTIFICATION MESSAGES" msgstr "" # type: textblock #: ../src/guestfs.pod:1676 msgid "" "The daemon may send progress notification messages at any time. These are " "distinguished by the normal length word being replaced by " "C, followed by a fixed size progress message." msgstr "" # type: textblock #: ../src/guestfs.pod:1680 msgid "" "The library turns them into progress callbacks (see " "C) if there is a callback registered, or " "discards them if not." msgstr "" # type: textblock #: ../src/guestfs.pod:1684 msgid "" "The daemon self-limits the frequency of progress messages it sends (see " "C). Not all calls generate progress " "messages." msgstr "" # type: =head1 #: ../src/guestfs.pod:1688 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" msgstr "" # type: textblock #: ../src/guestfs.pod:1690 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:1693 msgid "" "Only use the handle from a single thread. Either use the handle exclusively " "from one thread, or provide your own mutex so that two threads cannot issue " "calls on the same handle at the same time." msgstr "" # type: textblock #: ../src/guestfs.pod:1697 msgid "" "See the graphical program guestfs-browser for one possible architecture for " "multithreaded programs using libvirt and libguestfs." msgstr "" # type: =head1 #: ../src/guestfs.pod:1700 msgid "QEMU WRAPPERS" msgstr "" # type: textblock #: ../src/guestfs.pod:1702 msgid "" "If you want to compile your own qemu, run qemu from a non-standard location, " "or pass extra arguments to qemu, then you can write a shell-script wrapper " "around qemu." msgstr "" # type: textblock #: ../src/guestfs.pod:1706 msgid "" "There is one important rule to remember: you I> as the " "last command in the shell script (so that qemu replaces the shell and " "becomes the direct child of the libguestfs-using program). If you don't do " "this, then the qemu process won't be cleaned up correctly." msgstr "" # type: textblock #: ../src/guestfs.pod:1711 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:1714 #, no-wrap msgid "" " #!/bin/sh -\n" " qemudir=/home/rjones/d/qemu\n" " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1718 msgid "" "Save this script as C (or wherever), C, and " "then use it by setting the LIBGUESTFS_QEMU environment variable. For " "example:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1722 #, no-wrap msgid "" " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1724 msgid "" "Note that libguestfs also calls qemu with the -help and -version options in " "order to determine features." msgstr "" # type: =head1 #: ../src/guestfs.pod:1727 msgid "LIBGUESTFS VERSION NUMBERS" msgstr "" # type: textblock #: ../src/guestfs.pod:1729 msgid "" "Since April 2010, libguestfs has started to make separate development and " "stable releases, along with corresponding branches in our git repository. " "These separate releases can be identified by version number:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1734 #, no-wrap msgid "" " even numbers for stable: 1.2.x, 1.4.x, ...\n" " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n" " |\n" " v\n" " 1 . 3 . 5\n" " ^ ^\n" " | |\n" " | `-------- sub-version\n" " |\n" " `------ always '1' because we don't change the ABI\n" "\n" msgstr "" # type: textblock #: ../src/guestfs.pod:1745 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." msgstr "" # type: textblock #: ../src/guestfs.pod:1747 msgid "" "As time passes we cherry pick fixes from the development branch and backport " "those into the stable branch, the effect being that the stable branch should " "get more stable and less buggy over time. So the stable releases are ideal " "for people who don't need new features but would just like the software to " "work." msgstr "" # type: textblock #: ../src/guestfs.pod:1753 msgid "Our criteria for backporting changes are:" msgstr "" # type: textblock #: ../src/guestfs.pod:1759 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:1765 msgid "" "Bug fixes which are not controversial, fix obvious problems, and have been " "well tested are backported." msgstr "" # type: textblock #: ../src/guestfs.pod:1770 msgid "" "Simple rearrangements of code which shouldn't affect how it works get " "backported. This is so that the code in the two branches doesn't get too " "far out of step, allowing us to backport future fixes more easily." msgstr "" # type: textblock #: ../src/guestfs.pod:1776 msgid "" "We I backport new features, new APIs, new tools etc, except in one " "exceptional case: the new feature is required in order to implement an " "important bug fix." msgstr "" # type: textblock #: ../src/guestfs.pod:1782 msgid "" "A new stable branch starts when we think the new features in development are " "substantial and compelling enough over the current stable branch to warrant " "it. When that happens we create new stable and development versions 1.N.0 " "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so " "stable at this point, but by backporting fixes from development, that branch " "will stabilize over time." msgstr "" # type: =head1 #: ../src/guestfs.pod:1790 ../fish/guestfish.pod:867 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 #: ../tools/virt-rescue.pl:255 msgid "ENVIRONMENT VARIABLES" msgstr "" # type: =item #: ../src/guestfs.pod:1794 ../fish/guestfish.pod:893 msgid "LIBGUESTFS_APPEND" msgstr "" # type: textblock #: ../src/guestfs.pod:1796 ../fish/guestfish.pod:895 msgid "Pass additional options to the guest kernel." msgstr "" # type: =item #: ../src/guestfs.pod:1798 ../fish/guestfish.pod:897 msgid "LIBGUESTFS_DEBUG" msgstr "" # type: textblock #: ../src/guestfs.pod:1800 msgid "" "Set C to enable verbose messages. This has the same " "effect as calling C." msgstr "" # type: =item #: ../src/guestfs.pod:1803 ../fish/guestfish.pod:902 msgid "LIBGUESTFS_MEMSIZE" msgstr "" # type: textblock #: ../src/guestfs.pod:1805 ../fish/guestfish.pod:904 msgid "" "Set the memory allocated to the qemu process, in megabytes. For example:" msgstr "" # type: verbatim #: ../src/guestfs.pod:1808 ../fish/guestfish.pod:907 #, no-wrap msgid "" " LIBGUESTFS_MEMSIZE=700\n" "\n" msgstr "" # type: =item #: ../src/guestfs.pod:1810 ../fish/guestfish.pod:909 msgid "LIBGUESTFS_PATH" msgstr "" # type: textblock #: ../src/guestfs.pod:1812 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:1815 ../fish/guestfish.pod:914 msgid "LIBGUESTFS_QEMU" msgstr "" # type: textblock #: ../src/guestfs.pod:1817 ../fish/guestfish.pod:916 msgid "" "Set the default qemu binary that libguestfs uses. If not set, then the qemu " "which was found at compile time by the configure script is used." msgstr "" # type: textblock #: ../src/guestfs.pod:1821 msgid "See also L above." msgstr "" # type: =item #: ../src/guestfs.pod:1823 ../fish/guestfish.pod:920 msgid "LIBGUESTFS_TRACE" msgstr "" # type: textblock #: ../src/guestfs.pod:1825 msgid "" "Set C to enable command traces. This has the same " "effect as calling C." msgstr "" # type: =item #: ../src/guestfs.pod:1828 ../fish/guestfish.pod:929 msgid "TMPDIR" msgstr "" # type: textblock #: ../src/guestfs.pod:1830 ../fish/guestfish.pod:931 msgid "Location of temporary directory, defaults to C." msgstr "" # type: textblock #: ../src/guestfs.pod:1832 ../fish/guestfish.pod:933 msgid "" "If libguestfs was compiled to use the supermin appliance then the real " "appliance is cached in this directory, shared between all handles belonging " "to the same EUID. You can use C<$TMPDIR> to configure another directory to " "use in case C is not large enough." msgstr "" # type: =head1 #: ../src/guestfs.pod:1840 ../fish/guestfish.pod:991 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:214 #: ../inspector/virt-inspector.pl:884 ../tools/virt-edit.pl:350 #: ../tools/virt-win-reg.pl:487 ../tools/virt-df.pl:640 #: ../tools/virt-ls.pl:235 ../tools/virt-resize.pl:1486 #: ../tools/virt-list-filesystems.pl:216 ../tools/virt-cat.pl:188 #: ../tools/virt-tar.pl:283 ../tools/virt-rescue.pl:267 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:254 msgid "SEE ALSO" msgstr "" # type: textblock #: ../src/guestfs.pod:1842 msgid "" "L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, " "L." msgstr "" # type: textblock #: ../src/guestfs.pod:1860 msgid "" "Tools with a similar purpose: L, L, L, L, L." msgstr "" # type: =head1 #: ../src/guestfs.pod:1867 ../tools/virt-win-reg.pl:502 #: ../tools/virt-make-fs.pl:548 msgid "BUGS" msgstr "" # type: textblock #: ../src/guestfs.pod:1869 msgid "To get a list of bugs against libguestfs use this link:" msgstr "" # type: textblock #: ../src/guestfs.pod:1871 msgid "" "L" msgstr "" # type: textblock #: ../src/guestfs.pod:1873 msgid "To report a new bug against libguestfs use this link:" msgstr "" # type: textblock #: ../src/guestfs.pod:1875 msgid "" "L" msgstr "" # type: textblock #: ../src/guestfs.pod:1877 msgid "When reporting a bug, please check:" msgstr "" # type: textblock #: ../src/guestfs.pod:1883 msgid "That the bug hasn't been reported already." msgstr "" # type: textblock #: ../src/guestfs.pod:1887 msgid "That you are testing a recent version." msgstr "" # type: textblock #: ../src/guestfs.pod:1891 msgid "Describe the bug accurately, and give a way to reproduce it." msgstr "" # type: textblock #: ../src/guestfs.pod:1895 msgid "" "Run libguestfs-test-tool and paste the B output into the " "bug report." msgstr "" # type: =head1 #: ../src/guestfs.pod:1900 ../fish/guestfish.pod:1008 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:225 #: ../inspector/virt-inspector.pl:893 msgid "AUTHORS" msgstr "" # type: textblock #: ../src/guestfs.pod:1902 ../fish/guestfish.pod:1010 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:227 msgid "Richard W.M. Jones (C)" msgstr "" # type: =head1 #: ../src/guestfs.pod:1904 ../fish/guestfish.pod:1012 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:229 #: ../inspector/virt-inspector.pl:899 ../tools/virt-edit.pl:366 #: ../tools/virt-win-reg.pl:517 ../tools/virt-df.pl:653 #: ../tools/virt-ls.pl:250 ../tools/virt-resize.pl:1512 #: ../tools/virt-list-filesystems.pl:232 ../tools/virt-cat.pl:202 #: ../tools/virt-tar.pl:298 ../tools/virt-rescue.pl:281 #: ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:269 msgid "COPYRIGHT" msgstr "" # type: textblock #: ../src/guestfs.pod:1906 ../fish/guestfish.pod:1014 #: ../fuse/guestmount.pod:231 msgid "Copyright (C) 2009-2010 Red Hat Inc. L" msgstr "" # type: textblock #: ../src/guestfs.pod:1909 msgid "" "This library is free software; you can redistribute it and/or modify it " "under the terms of the GNU Lesser General Public License as published by the " "Free Software Foundation; either version 2 of the License, or (at your " "option) any later version." msgstr "" # type: textblock #: ../src/guestfs.pod:1914 msgid "" "This library is distributed in the hope that it will be useful, but WITHOUT " "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or " "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License " "for more details." msgstr "" # type: textblock #: ../src/guestfs.pod:1919 msgid "" "You should have received a copy of the GNU Lesser General Public License " "along with this library; if not, write to the Free Software Foundation, " "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA" msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:1 msgid "guestfs_add_cdrom" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:3 #, no-wrap msgid "" " int guestfs_add_cdrom (guestfs_h *g,\n" "\t\tconst char *filename);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:6 ../fish/guestfish-actions.pod:5 msgid "This function adds a virtual CD-ROM disk image to the guest." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:8 ../fish/guestfish-actions.pod:7 msgid "This is equivalent to the qemu parameter C<-cdrom filename>." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:16 msgid "" "This call checks for the existence of C. This stops you from " "specifying other types of drive which are supported by qemu such as C " "and C URLs. To specify those, use the general C call " "instead." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:23 msgid "" "If you just want to add an ISO file (often you use this as an efficient way " "to transfer large files into the guest), then you should probably use " "C instead." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:54 #: ../src/guestfs-actions.pod:112 ../src/guestfs-actions.pod:144 #: ../src/guestfs-actions.pod:155 ../src/guestfs-actions.pod:173 #: ../src/guestfs-actions.pod:190 ../src/guestfs-actions.pod:201 #: ../src/guestfs-actions.pod:304 ../src/guestfs-actions.pod:321 #: ../src/guestfs-actions.pod:332 ../src/guestfs-actions.pod:368 #: ../src/guestfs-actions.pod:390 ../src/guestfs-actions.pod:405 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:496 #: ../src/guestfs-actions.pod:507 ../src/guestfs-actions.pod:519 #: ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:615 #: ../src/guestfs-actions.pod:626 ../src/guestfs-actions.pod:637 #: ../src/guestfs-actions.pod:783 ../src/guestfs-actions.pod:800 #: ../src/guestfs-actions.pod:815 ../src/guestfs-actions.pod:890 #: ../src/guestfs-actions.pod:905 ../src/guestfs-actions.pod:921 #: ../src/guestfs-actions.pod:932 ../src/guestfs-actions.pod:949 #: ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1040 #: ../src/guestfs-actions.pod:1068 ../src/guestfs-actions.pod:1090 #: ../src/guestfs-actions.pod:1121 ../src/guestfs-actions.pod:1209 #: ../src/guestfs-actions.pod:1240 ../src/guestfs-actions.pod:1440 #: ../src/guestfs-actions.pod:1459 ../src/guestfs-actions.pod:1540 #: ../src/guestfs-actions.pod:1888 ../src/guestfs-actions.pod:2011 #: ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2096 #: ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2517 #: ../src/guestfs-actions.pod:2534 ../src/guestfs-actions.pod:2642 #: ../src/guestfs-actions.pod:2653 ../src/guestfs-actions.pod:2663 #: ../src/guestfs-actions.pod:2674 ../src/guestfs-actions.pod:2686 #: ../src/guestfs-actions.pod:2716 ../src/guestfs-actions.pod:2780 #: ../src/guestfs-actions.pod:2797 ../src/guestfs-actions.pod:2811 #: ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:2851 #: ../src/guestfs-actions.pod:2880 ../src/guestfs-actions.pod:2896 #: ../src/guestfs-actions.pod:2912 ../src/guestfs-actions.pod:2941 #: ../src/guestfs-actions.pod:2950 ../src/guestfs-actions.pod:2983 #: ../src/guestfs-actions.pod:2996 ../src/guestfs-actions.pod:3006 #: ../src/guestfs-actions.pod:3018 ../src/guestfs-actions.pod:3032 #: ../src/guestfs-actions.pod:3112 ../src/guestfs-actions.pod:3129 #: ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3184 #: ../src/guestfs-actions.pod:3199 ../src/guestfs-actions.pod:3214 #: ../src/guestfs-actions.pod:3227 ../src/guestfs-actions.pod:3238 #: ../src/guestfs-actions.pod:3249 ../src/guestfs-actions.pod:3263 #: ../src/guestfs-actions.pod:3275 ../src/guestfs-actions.pod:3292 #: ../src/guestfs-actions.pod:3338 ../src/guestfs-actions.pod:3366 #: ../src/guestfs-actions.pod:3382 ../src/guestfs-actions.pod:3398 #: ../src/guestfs-actions.pod:3407 ../src/guestfs-actions.pod:3421 #: ../src/guestfs-actions.pod:3431 ../src/guestfs-actions.pod:3443 #: ../src/guestfs-actions.pod:3455 ../src/guestfs-actions.pod:3487 #: ../src/guestfs-actions.pod:3499 ../src/guestfs-actions.pod:3516 #: ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:3541 #: ../src/guestfs-actions.pod:3581 ../src/guestfs-actions.pod:3612 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3648 #: ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3677 #: ../src/guestfs-actions.pod:3799 ../src/guestfs-actions.pod:3851 #: ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:3885 #: ../src/guestfs-actions.pod:3911 ../src/guestfs-actions.pod:3968 #: ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:3992 #: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4258 #: ../src/guestfs-actions.pod:4274 ../src/guestfs-actions.pod:4285 #: ../src/guestfs-actions.pod:4294 ../src/guestfs-actions.pod:4305 #: ../src/guestfs-actions.pod:4314 ../src/guestfs-actions.pod:4325 #: ../src/guestfs-actions.pod:4338 ../src/guestfs-actions.pod:4356 #: ../src/guestfs-actions.pod:4372 ../src/guestfs-actions.pod:4388 #: ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4423 #: ../src/guestfs-actions.pod:4438 ../src/guestfs-actions.pod:4454 #: ../src/guestfs-actions.pod:4472 ../src/guestfs-actions.pod:4488 #: ../src/guestfs-actions.pod:4502 ../src/guestfs-actions.pod:4527 #: ../src/guestfs-actions.pod:4548 ../src/guestfs-actions.pod:4564 #: ../src/guestfs-actions.pod:4585 ../src/guestfs-actions.pod:4597 #: ../src/guestfs-actions.pod:4609 ../src/guestfs-actions.pod:4625 #: ../src/guestfs-actions.pod:4659 ../src/guestfs-actions.pod:4679 #: ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:4792 #: ../src/guestfs-actions.pod:4898 ../src/guestfs-actions.pod:4907 #: ../src/guestfs-actions.pod:4917 ../src/guestfs-actions.pod:4927 #: ../src/guestfs-actions.pod:4946 ../src/guestfs-actions.pod:4956 #: ../src/guestfs-actions.pod:4966 ../src/guestfs-actions.pod:4976 #: ../src/guestfs-actions.pod:4988 ../src/guestfs-actions.pod:5038 #: ../src/guestfs-actions.pod:5052 ../src/guestfs-actions.pod:5065 #: ../src/guestfs-actions.pod:5078 ../src/guestfs-actions.pod:5092 #: ../src/guestfs-actions.pod:5102 ../src/guestfs-actions.pod:5119 #: ../src/guestfs-actions.pod:5149 ../src/guestfs-actions.pod:5160 #: ../src/guestfs-actions.pod:5195 ../src/guestfs-actions.pod:5205 #: ../src/guestfs-actions.pod:5220 ../src/guestfs-actions.pod:5246 #: ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5378 #: ../src/guestfs-actions.pod:5393 ../src/guestfs-actions.pod:5404 #: ../src/guestfs-actions.pod:5450 ../src/guestfs-actions.pod:5460 #: ../src/guestfs-actions.pod:5497 ../src/guestfs-actions.pod:5524 #: ../src/guestfs-actions.pod:5566 ../src/guestfs-actions.pod:5589 #: ../src/guestfs-actions.pod:5646 ../src/guestfs-actions.pod:5662 #: ../src/guestfs-actions.pod:5688 msgid "This function returns 0 on success or -1 on error." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:31 ../src/guestfs-actions.pod:157 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:28 #: ../fish/guestfish-actions.pod:117 ../fish/guestfish-actions.pod:131 msgid "" "This function is deprecated. In new code, use the C call " "instead." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:34 ../src/guestfs-actions.pod:160 #: ../src/guestfs-actions.pod:178 ../src/guestfs-actions.pod:1214 #: ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1667 #: ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:5742 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:120 #: ../fish/guestfish-actions.pod:134 ../fish/guestfish-actions.pod:940 #: ../fish/guestfish-actions.pod:1297 ../fish/guestfish-actions.pod:1311 #: ../fish/guestfish-actions.pod:4317 ../fish/guestfish-actions.pod:4414 msgid "" "Deprecated functions will not be removed from the API, but the fact that " "they are deprecated indicates that there are problems with correct use of " "these functions." msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:38 msgid "guestfs_add_drive" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:40 #, no-wrap msgid "" " int guestfs_add_drive (guestfs_h *g,\n" "\t\tconst char *filename);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:43 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." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:47 msgid "" "Automatic detection of the format opens you up to a potential security hole " "when dealing with untrusted raw-format images. See CVE-2010-3851 and " "RHBZ#642934. Specifying the format closes this security hole. Therefore " "you should think about replacing calls to this function with calls to " "C, and specifying the format." msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:56 msgid "guestfs_add_drive_opts" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:58 #, no-wrap msgid "" " int guestfs_add_drive_opts (guestfs_h *g,\n" "\t\tconst char *filename,\n" "\t\t...);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:62 msgid "" "You may supply a list of optional arguments to this call. Use zero or more " "of the following pairs of parameters, and terminate the list with C<-1> on " "its own. See L." msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:67 #, no-wrap msgid "" " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n" " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n" " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:56 msgid "" "This function adds a virtual machine disk image C to libguestfs. " "The first time you call this function, the disk appears as C, the " "second time as C, and so on." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:61 msgid "" "You don't necessarily need to be root when using libguestfs. However you " "obviously do need sufficient permissions to access the filename for whatever " "operations you want to perform (ie. read access if you just want to read the " "image or write access if you want to modify the image)." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:67 msgid "This call checks that C exists." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:84 ../fish/guestfish-actions.pod:69 msgid "The optional arguments are:" msgstr "" # type: =item #: ../src/guestfs-actions.pod:88 ../fish/guestfish-actions.pod:73 msgid "C" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:90 ../fish/guestfish-actions.pod:75 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." msgstr "" # type: =item #: ../src/guestfs-actions.pod:94 ../fish/guestfish-actions.pod:79 msgid "C" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:96 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." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:100 ../fish/guestfish-actions.pod:85 msgid "" "Automatic detection of the format opens you up to a potential security hole " "when dealing with untrusted raw-format images. See CVE-2010-3851 and " "RHBZ#642934. Specifying the format closes this security hole." msgstr "" # type: =item #: ../src/guestfs-actions.pod:105 ../fish/guestfish-actions.pod:90 msgid "C" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:107 msgid "" "This rarely-used option lets you emulate the behaviour of the deprecated " "C call (q.v.)" msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:114 msgid "guestfs_add_drive_opts_va" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:116 #, no-wrap msgid "" " int guestfs_add_drive_opts_va (guestfs_h *g,\n" "\t\tconst char *filename,\n" "\t\tva_list args);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:120 msgid "This is the \"va_list variant\" of L." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:122 ../src/guestfs-actions.pod:132 msgid "See L." msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:124 msgid "guestfs_add_drive_opts_argv" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:126 #, no-wrap msgid "" " int guestfs_add_drive_opts_argv (guestfs_h *g,\n" "\t\tconst char *filename,\n" "\t\tconst struct guestfs_add_drive_opts_argv *optargs);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:130 msgid "This is the \"argv variant\" of L." msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:134 msgid "guestfs_add_drive_ro" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:136 #, no-wrap msgid "" " int guestfs_add_drive_ro (guestfs_h *g,\n" "\t\tconst char *filename);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:139 msgid "" "This function is the equivalent of calling C with " "the optional parameter C set to 1, so the " "disk is added read-only, with the format being detected automatically." msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:146 msgid "guestfs_add_drive_ro_with_if" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:148 #, no-wrap msgid "" " int guestfs_add_drive_ro_with_if (guestfs_h *g,\n" "\t\tconst char *filename,\n" "\t\tconst char *iface);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:152 msgid "" "This is the same as C but it allows you to specify the " "QEMU interface emulation to use at run time." msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:164 msgid "guestfs_add_drive_with_if" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:166 #, no-wrap msgid "" " int guestfs_add_drive_with_if (guestfs_h *g,\n" "\t\tconst char *filename,\n" "\t\tconst char *iface);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:170 msgid "" "This is the same as C but it allows you to specify the " "QEMU interface emulation to use at run time." msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:182 msgid "guestfs_aug_clear" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:184 #, no-wrap msgid "" " int guestfs_aug_clear (guestfs_h *g,\n" "\t\tconst char *augpath);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:187 ../fish/guestfish-actions.pod:142 msgid "" "Set the value associated with C to C. This is the same as the " "L C command." msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:192 msgid "guestfs_aug_close" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:194 #, no-wrap msgid "" " int guestfs_aug_close (guestfs_h *g);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:196 msgid "" "Close the current Augeas handle and free up any resources used by it. After " "calling this, you have to call C again before you can use " "any other Augeas functions." msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:203 msgid "guestfs_aug_defnode" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:205 #, no-wrap msgid "" " struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *g,\n" "\t\tconst char *name,\n" "\t\tconst char *expr,\n" "\t\tconst char *val);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:210 ../fish/guestfish-actions.pod:158 msgid "" "Defines a variable C whose value is the result of evaluating C." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:213 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." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:217 ../fish/guestfish-actions.pod:165 msgid "" "On success this returns a pair containing the number of nodes in the " "nodeset, and a boolean flag if a node was created." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:221 msgid "" "This function returns a C, or NULL if there was " "an error. I after use>." msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:225 msgid "guestfs_aug_defvar" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:227 #, no-wrap msgid "" " int guestfs_aug_defvar (guestfs_h *g,\n" "\t\tconst char *name,\n" "\t\tconst char *expr);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:231 ../fish/guestfish-actions.pod:173 msgid "" "Defines an Augeas variable C whose value is the result of evaluating " "C. If C is NULL, then C is undefined." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:235 ../fish/guestfish-actions.pod:177 msgid "" "On success this returns the number of nodes in C, or C<0> if C " "evaluates to something which is not a nodeset." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:379 #: ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:558 #: ../src/guestfs-actions.pod:573 ../src/guestfs-actions.pod:589 #: ../src/guestfs-actions.pod:1107 ../src/guestfs-actions.pod:1422 #: ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1685 #: ../src/guestfs-actions.pod:1716 ../src/guestfs-actions.pod:1759 #: ../src/guestfs-actions.pod:1776 ../src/guestfs-actions.pod:2001 #: ../src/guestfs-actions.pod:2213 ../src/guestfs-actions.pod:2231 #: ../src/guestfs-actions.pod:3601 ../src/guestfs-actions.pod:3708 #: ../src/guestfs-actions.pod:4062 ../src/guestfs-actions.pod:4085 #: ../src/guestfs-actions.pod:5184 ../src/guestfs-actions.pod:5534 #: ../src/guestfs-actions.pod:5544 ../src/guestfs-actions.pod:5554 msgid "On error this function returns -1." msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:240 msgid "guestfs_aug_get" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:242 #, no-wrap msgid "" " char *guestfs_aug_get (guestfs_h *g,\n" "\t\tconst char *augpath);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:245 ../fish/guestfish-actions.pod:184 msgid "" "Look up the value associated with C. If C matches exactly one " "node, the C is returned." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:248 ../src/guestfs-actions.pod:676 #: ../src/guestfs-actions.pod:691 ../src/guestfs-actions.pod:748 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:852 #: ../src/guestfs-actions.pod:965 ../src/guestfs-actions.pod:994 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1024 #: ../src/guestfs-actions.pod:1135 ../src/guestfs-actions.pod:1299 #: ../src/guestfs-actions.pod:1408 ../src/guestfs-actions.pod:1553 #: ../src/guestfs-actions.pod:1567 ../src/guestfs-actions.pod:1643 #: ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1795 #: ../src/guestfs-actions.pod:1934 ../src/guestfs-actions.pod:2115 #: ../src/guestfs-actions.pod:2165 ../src/guestfs-actions.pod:2281 #: ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2631 #: ../src/guestfs-actions.pod:2928 ../src/guestfs-actions.pod:3069 #: ../src/guestfs-actions.pod:3165 ../src/guestfs-actions.pod:3723 #: ../src/guestfs-actions.pod:3899 ../src/guestfs-actions.pod:4040 #: ../src/guestfs-actions.pod:4201 ../src/guestfs-actions.pod:4244 #: ../src/guestfs-actions.pod:4720 ../src/guestfs-actions.pod:4733 #: ../src/guestfs-actions.pod:4747 ../src/guestfs-actions.pod:4768 #: ../src/guestfs-actions.pod:5327 ../src/guestfs-actions.pod:5343 #: ../src/guestfs-actions.pod:5358 ../src/guestfs-actions.pod:5506 #: ../src/guestfs-actions.pod:5736 msgid "" "This function returns a string, or NULL on error. I." msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:251 msgid "guestfs_aug_init" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:253 #, no-wrap msgid "" " int guestfs_aug_init (guestfs_h *g,\n" "\t\tconst char *root,\n" "\t\tint flags);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:257 ../fish/guestfish-actions.pod:191 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." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:261 msgid "You must call this before using any other C commands." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:264 ../fish/guestfish-actions.pod:198 msgid "" "C is the filesystem root. C must not be NULL, use C instead." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:267 ../fish/guestfish-actions.pod:201 msgid "" "The flags are the same as the flags defined in Eaugeas.hE, the " "logical I of the following integers:" msgstr "" # type: =item #: ../src/guestfs-actions.pod:273 ../fish/guestfish-actions.pod:207 msgid "C = 1" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:209 msgid "Keep the original file with a C<.augsave> extension." msgstr "" # type: =item #: ../src/guestfs-actions.pod:277 ../fish/guestfish-actions.pod:211 msgid "C = 2" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:279 ../fish/guestfish-actions.pod:213 msgid "" "Save changes into a file with extension C<.augnew>, and do not overwrite " "original. Overrides C." msgstr "" # type: =item #: ../src/guestfs-actions.pod:282 ../fish/guestfish-actions.pod:216 msgid "C = 4" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:218 msgid "Typecheck lenses (can be expensive)." msgstr "" # type: =item #: ../src/guestfs-actions.pod:286 ../fish/guestfish-actions.pod:220 msgid "C = 8" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:288 ../fish/guestfish-actions.pod:222 msgid "Do not use standard load path for modules." msgstr "" # type: =item #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:224 msgid "C = 16" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:292 ../fish/guestfish-actions.pod:226 msgid "Make save a no-op, just record what would have been changed." msgstr "" # type: =item #: ../src/guestfs-actions.pod:294 ../fish/guestfish-actions.pod:228 msgid "C = 32" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:296 msgid "Do not load the tree in C." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:300 msgid "To close the handle, you can call C." msgstr "" # type: textblock #: ../src/guestfs-actions.pod:302 ../fish/guestfish-actions.pod:236 msgid "To find out more about Augeas, see L." msgstr "" # type: =head2 #: ../src/guestfs-actions.pod:306 msgid "guestfs_aug_insert" msgstr "" # type: verbatim #: ../src/guestfs-actions.pod:308 #, no-wrap msgid "" " int guestfs_aug_insert (guestfs_h *g,\n" "\t\tconst char *augpath,\n" "\t\tconst char *label,\n" "\t\tint before);\n" "\n" msgstr "" # type: textblock #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:242 msgid "" "Create a new sibling C