Version 1.9.17.

[libguestfs.git] / po-docs / libguestfs-docs.pot

# SOME DESCRIPTIVE TITLE
# Copyright (C) YEAR Red Hat Inc.
# This file is distributed under the same license as the libguestfs package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: libguestfs 1.9.17\n"
"Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
"POT-Creation-Date: 2011-04-05 20:38+0200\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#. type: =head1
#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
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 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
msgid "SYNOPSIS"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:9
#, no-wrap
msgid ""
" #include <guestfs.h>\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_close (g);\n"
"\n"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:19
#, 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:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
msgid "DESCRIPTION"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:25
msgid ""
"Libguestfs is a library for accessing and modifying guest disk images.  "
"Amongst the things this is good for: making batch configuration changes to "
"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:33
msgid ""
"Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
"filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
"btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
"qcow2, vmdk."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:38
msgid ""
"Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
"what filesystem is in each LV, etc.).  It can also run commands in the "
"context of the guest.  Also you can access filesystems over FUSE."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:43
msgid ""
"Libguestfs is a library that can be linked with C and C++ management "
"programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
"PHP, Haskell or C#).  You can also use it from shell scripts or the command "
"line."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:48
msgid ""
"You don't need to be root to use libguestfs, although obviously you do need "
"enough permissions to access the disk images."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:51
msgid ""
"Libguestfs is a large API because it can do many things.  For a gentle "
"introduction, please read the L</API OVERVIEW> section next."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:54
msgid ""
"There are also some example programs in the L<guestfs-examples(3)> manual "
"page."
msgstr ""

#. type: =head1
#: ../src/guestfs.pod:57
msgid "API OVERVIEW"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:59
msgid ""
"This section provides a gentler overview of the libguestfs API.  We also try "
"to group API calls together, where that may not be obvious from reading "
"about the individual calls in the main section of this manual."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:64
msgid "HANDLES"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:66
msgid ""
"Before you can use libguestfs calls, you have to create a handle.  Then you "
"must add at least one disk image to the handle, followed by launching the "
"handle, then performing whatever operations you want, and finally closing "
"the handle.  By convention we use the single letter C<g> for the name of the "
"handle variable, although of course you can use any name you want."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:73
msgid "The general structure of all libguestfs-using programs looks like this:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:76
#, no-wrap
msgid ""
" guestfs_h *g = guestfs_create ();\n"
" \n"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:78
#, 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:83
#, 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:89
#, 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:94
#, 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:98
#, 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:103
#, no-wrap
msgid ""
" /* This is only needed for libguestfs < 1.5.24.  Since then\n"
"  * it is done automatically when you close the handle.  See\n"
"  * discussion of autosync in this page.\n"
"  */\n"
" guestfs_sync (g);\n"
" \n"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:109
#, no-wrap
msgid ""
" /* Close the handle 'g'. */\n"
" guestfs_close (g);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:112
msgid ""
"The code above doesn't include any error checking.  In real code you should "
"check return values carefully for errors.  In general all functions that "
"return integers return C<-1> on error, and all functions that return "
"pointers return C<NULL> on error.  See section L</ERROR HANDLING> below for "
"how to handle errors, and consult the documentation for each function call "
"below to see precisely how they return error indications.  See "
"L<guestfs-examples(3)> for fully worked examples."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:121
msgid "DISK IMAGES"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:123
msgid ""
"The image filename (C<\"guest.img\"> in the example above) could be a disk "
"image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
"actual block device, or simply an empty file of zeroes that you have created "
"through L<posix_fallocate(3)>.  Libguestfs lets you do useful things to all "
"of these."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:129
msgid ""
"The call you should use in modern code for adding drives is "
"L</guestfs_add_drive_opts>.  To add a disk image, allowing writes, and "
"specifying that the format is raw, do:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:133
#, 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:137
msgid "You can add a disk read-only using:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:139
#, 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:144
msgid ""
"or by calling the older function L</guestfs_add_drive_ro>.  In either case "
"libguestfs won't modify the file."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:147
msgid ""
"Be extremely cautious if the disk image is in use, eg. if it is being used "
"by a virtual machine.  Adding it read-write will almost certainly cause disk "
"corruption, but adding it read-only is safe."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:151
msgid ""
"You must add at least one disk image, and you may add multiple disk images.  "
"In the API, the disk images are usually referred to as C</dev/sda> (for the "
"first one you added), C</dev/sdb> (for the second one you added), etc."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:156
msgid ""
"Once L</guestfs_launch> has been called you cannot add any more images.  You "
"can call L</guestfs_list_devices> to get a list of the device names, in the "
"order that you added them.  See also L</BLOCK DEVICE NAMING> below."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:161
msgid "MOUNTING"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:163
msgid ""
"Before you can read or write files, create directories and so on in a disk "
"image that contains filesystems, you have to mount those filesystems using "
"L</guestfs_mount_options> or L</guestfs_mount_ro>.  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:170
#, no-wrap
msgid ""
" guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:172
msgid ""
"where C</dev/sda1> means literally the first partition (C<1>) of the first "
"disk image that we added (C</dev/sda>).  If the disk contains Linux LVM2 "
"logical volumes you could refer to those instead (eg. C</dev/VG/LV>).  Note "
"that these are libguestfs virtual devices, and are nothing to do with host "
"devices."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:178
msgid ""
"If you are given a disk image and you don't know what it contains then you "
"have to find out.  Libguestfs can do that too: use "
"L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
"and LVs, and either try mounting each to see what is mountable, or else "
"examine them with L</guestfs_vfs_type> or L</guestfs_file>.  To list just "
"filesystems, use L</guestfs_list_filesystems>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:186
msgid ""
"Libguestfs also has a set of APIs for inspection of unknown disk images (see "
"L</INSPECTION> below).  But you might find it easier to look at higher level "
"programs built on top of libguestfs, in particular L<virt-inspector(1)>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:191
msgid ""
"To mount a filesystem read-only, use L</guestfs_mount_ro>.  There are "
"several other variations of the C<guestfs_mount_*> call."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:194
msgid "FILESYSTEM ACCESS AND MODIFICATION"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:196
msgid ""
"The majority of the libguestfs API consists of fairly low-level calls for "
"accessing and modifying the files, directories, symlinks etc on mounted "
"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:202
msgid ""
"Specify filenames as full paths, starting with C<\"/\"> and including the "
"mount point."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:205
msgid ""
"For example, if you mounted a filesystem at C<\"/\"> and you want to read "
"the file called C<\"etc/passwd\"> then you could do:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:208
#, no-wrap
msgid ""
" char *data = guestfs_cat (g, \"/etc/passwd\");\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:210
msgid ""
"This would return C<data> as a newly allocated buffer containing the full "
"content of that file (with some conditions: see also L</DOWNLOADING> below), "
"or C<NULL> if there was an error."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:214
msgid ""
"As another example, to create a top-level directory on that filesystem "
"called C<\"var\"> you would do:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:217
#, no-wrap
msgid ""
" guestfs_mkdir (g, \"/var\");\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:219
msgid "To create a symlink you could do:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:221
#, no-wrap
msgid ""
" guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
"               \"/etc/rc3.d/S30portmap\");\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:224
msgid ""
"Libguestfs will reject attempts to use relative paths and there is no "
"concept of a current working directory."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:227
msgid ""
"Libguestfs can return errors in many situations: for example if the "
"filesystem isn't writable, or if a file or directory that you requested "
"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:233
msgid ""
"File writes are affected by the per-handle umask, set by calling "
"L</guestfs_umask> and defaulting to 022.  See L</UMASK>."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:236
msgid "PARTITIONING"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:238
msgid ""
"Libguestfs contains API calls to read, create and modify partition tables on "
"disk images."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:241
msgid ""
"In the common case where you want to create a single partition covering the "
"whole disk, you should use the L</guestfs_part_disk> call:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:245
#, 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:250
msgid ""
"Obviously this effectively wipes anything that was on that disk image "
"before."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:253
msgid "LVM2"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:255
msgid ""
"Libguestfs provides access to a large part of the LVM2 API, such as "
"L</guestfs_lvcreate> and L</guestfs_vgremove>.  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:260
msgid ""
"This author strongly recommends reading the LVM HOWTO, online at "
"L<http://tldp.org/HOWTO/LVM-HOWTO/>."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:263
msgid "DOWNLOADING"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:265
msgid ""
"Use L</guestfs_cat> 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 the API is very simple to use."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:269
msgid ""
"L</guestfs_read_file> 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:273
msgid ""
"L</guestfs_download> 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:276
msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:279
msgid "UPLOADING"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:281
msgid ""
"It's often the case that you want to write a file or files to the disk "
"image."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:284
msgid ""
"To write a small file with fixed content, use L</guestfs_write>.  To create "
"a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
"L</guestfs_fallocate64> (with all disk blocks allocated).  There are a "
"variety of other functions for creating test files, for example "
"L</guestfs_fill> and L</guestfs_fill_pattern>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:290
msgid ""
"To upload a single file, use L</guestfs_upload>.  This call has no limits on "
"file content or size (even files larger than 4 GB)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:293
msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:295
msgid ""
"However the fastest way to upload I<large numbers of arbitrary files> is to "
"turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
"L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>.  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</guestfs_list_devices> and mount it "
"directly using L</guestfs_mount_ro>.  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:306
msgid "COPYING"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:308
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:314
msgid "B<file> to B<file>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:316
msgid ""
"Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
"directories recursively."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:319
msgid "B<file or device> to B<file or device>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:321
msgid ""
"Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
"devices in the guest."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:324
msgid "Example: duplicate the contents of an LV:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:326
#, no-wrap
msgid ""
" guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:328
msgid ""
"The destination (C</dev/VG/Copy>) must be at least as large as the source "
"(C</dev/VG/Original>).  To copy less than the whole source device, use "
"L</guestfs_copy_size>."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:332
msgid "B<file on the host> to B<file or device>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:334
msgid "Use L</guestfs_upload>.  See L</UPLOADING> above."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:336
msgid "B<file or device> to B<file on the host>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:338
msgid "Use L</guestfs_download>.  See L</DOWNLOADING> above."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:342
msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:344
msgid ""
"Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
"L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
"appears you can only upload and download to files.  However many Un*x-like "
"hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
"C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
"stderr, and arbitrary file descriptor N."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:352
msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:355
#, no-wrap
msgid ""
" guestfs_download (g, filename, \"/dev/stdout\");\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:357
msgid "and you can write tar output to a pipe C<fd> by doing:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:359
#, no-wrap
msgid ""
" char devfd[64];\n"
" snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
" guestfs_tar_out (g, \"/\", devfd);\n"
"\n"
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:363
msgid "LISTING FILES"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:365
msgid ""
"L</guestfs_ll> is just designed for humans to read (mainly when using the "
"L<guestfish(1)>-equivalent command C<ll>)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:368
msgid ""
"L</guestfs_ls> 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:371
msgid ""
"L</guestfs_readdir> 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<readdir(3)> call on a local filesystem."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:375
msgid ""
"L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
"files."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:378
msgid "RUNNING COMMANDS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:380
msgid ""
"Although libguestfs is primarily an API for manipulating files inside guest "
"images, we also provide some limited facilities for running commands inside "
"guests."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:384
msgid "There are many limitations to this:"
msgstr ""

#. type: =item
#: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1088 ../src/guestfs.pod:1092 ../src/guestfs.pod:1096 ../src/guestfs.pod:1101 ../src/guestfs.pod:1109 ../src/guestfs.pod:1128 ../src/guestfs.pod:1136 ../src/guestfs.pod:1158 ../src/guestfs.pod:1162 ../src/guestfs.pod:1166 ../src/guestfs.pod:1170 ../src/guestfs.pod:1174 ../src/guestfs.pod:1178 ../src/guestfs.pod:1660 ../src/guestfs.pod:1665 ../src/guestfs.pod:1669 ../src/guestfs.pod:1770 ../src/guestfs.pod:1775 ../src/guestfs.pod:1779 ../src/guestfs.pod:1789 ../src/guestfs.pod:2023 ../src/guestfs.pod:2028 ../src/guestfs.pod:2034 ../src/guestfs.pod:2042 ../src/guestfs.pod:2396 ../src/guestfs.pod:2402 ../src/guestfs.pod:2407 ../src/guestfs.pod:2413 ../src/guestfs.pod:2878 ../src/guestfs.pod:2882 ../src/guestfs.pod:2886 ../src/guestfs.pod:2890 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592 ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1600 ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608 ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1620 ../src/guestfs-actions.pod:1624 ../src/guestfs-actions.pod:1628 ../src/guestfs-actions.pod:1638 ../src/guestfs-actions.pod:1642 ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1784 ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1859 ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:1868 ../fish/guestfish.pod:443 ../fish/guestfish.pod:447 ../fish/guestfish.pod:451 ../fish/guestfish.pod:455 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402 ../fish/guestfish-actions.pod:1072 ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1092 ../fish/guestfish-actions.pod:1096 ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1110 ../fish/guestfish-actions.pod:1114 ../fish/guestfish-actions.pod:1118 ../fish/guestfish-actions.pod:1208 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1268 ../fish/guestfish-actions.pod:1273 ../tools/virt-edit.pl:351 ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361 ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
msgid "*"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:390
msgid ""
"The kernel version that the command runs under will be different from what "
"it expects."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:395
msgid ""
"If the command needs to communicate with daemons, then most likely they "
"won't be running."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:400
msgid "The command will be running in limited memory."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:404
msgid ""
"The network may not be available unless you enable it (see "
"L</guestfs_set_network>)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:409
msgid "Only supports Linux guests (not Windows, BSD, etc)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:413
msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:418
msgid ""
"For SELinux guests, you may need to enable SELinux and load policy first.  "
"See L</SELINUX> in this manpage."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:423
msgid ""
"I<Security:> It is not safe to run commands from untrusted, possibly "
"malicious guests.  These commands may attempt to exploit your program by "
"sending unexpected output.  They could also try to exploit the Linux kernel "
"or qemu provided by the libguestfs appliance.  They could use the network "
"provided by the libguestfs appliance to bypass ordinary network partitions "
"and firewalls.  They could use the elevated privileges or different SELinux "
"context of your program to their advantage."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:432
msgid ""
"A secure alternative is to use libguestfs to install a \"firstboot\" script "
"(a script which runs when the guest next boots normally), and to have this "
"script run the commands you want in the normal context of the running guest, "
"network security and so on.  For information about other security issues, "
"see L</SECURITY>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:440
msgid ""
"The two main API calls to run commands are L</guestfs_command> and "
"L</guestfs_sh> (there are also variations)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:443
msgid ""
"The difference is that L</guestfs_sh> runs commands using the shell, so any "
"shell globs, redirections, etc will work."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:446
msgid "CONFIGURATION FILES"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:448
msgid ""
"To read and write configuration files in Linux guest filesystems, we "
"strongly recommend using Augeas.  For example, Augeas understands how to "
"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:453
msgid ""
"The main Augeas calls are bound through the C<guestfs_aug_*> APIs.  We don't "
"document Augeas itself here because there is excellent documentation on the "
"L<http://augeas.net/> website."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:457
msgid ""
"If you don't want to use Augeas (you fool!) then try calling "
"L</guestfs_read_lines> to get the file as a list of lines which you can "
"iterate over."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:461
msgid "SELINUX"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:463
msgid ""
"We support SELinux guests.  To ensure that labeling happens correctly in "
"SELinux guests, you need to enable SELinux and load the guest's policy:"
msgstr ""

#. type: =item
#: ../src/guestfs.pod:469 ../src/guestfs.pod:1281 ../src/guestfs.pod:1412 ../src/guestfs.pod:2441
msgid "1."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:471
msgid "Before launching, do:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:473
#, no-wrap
msgid ""
" guestfs_set_selinux (g, 1);\n"
"\n"
msgstr ""

#. type: =item
#: ../src/guestfs.pod:475 ../src/guestfs.pod:1285 ../src/guestfs.pod:1416 ../src/guestfs.pod:2466
msgid "2."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:477
msgid ""
"After mounting the guest's filesystem(s), load the policy.  This is best "
"done by running the L<load_policy(8)> command in the guest itself:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:481
#, no-wrap
msgid ""
" guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:483
msgid ""
"(Older versions of C<load_policy> require you to specify the name of the "
"policy file)."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:486 ../src/guestfs.pod:1422
msgid "3."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:488
msgid ""
"Optionally, set the security context for the API.  The correct security "
"context to use can only be known by inspecting the guest.  As an example:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:492
#, no-wrap
msgid ""
" guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:496
msgid "This will work for running commands and editing existing files."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:498
msgid ""
"When new files are created, you may need to label them explicitly, for "
"example by running the external command C<restorecon pathname>."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:502
msgid "UMASK"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:504
msgid ""
"Certain calls are affected by the current file mode creation mask (the "
"\"umask\").  In particular ones which create files or directories, such as "
"L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>.  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:510
msgid ""
"The default umask is C<022>, so files are created with modes such as C<0644> "
"and directories with C<0755>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:513
msgid ""
"There are two ways to avoid being affected by umask.  Either set umask to 0 "
"(call C<guestfs_umask (g, 0)> early after launching).  Or call "
"L</guestfs_chmod> after creating each file or directory."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:517
msgid "For more information about umask, see L<umask(2)>."
msgstr ""

#. type: =head1
#: ../src/guestfs.pod:519 ../fish/guestfish.pod:765
msgid "ENCRYPTED DISKS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:521
msgid ""
"Libguestfs allows you to access Linux guests which have been encrypted using "
"whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
"standard.  This includes nearly all whole disk encryption systems used by "
"modern Linux guests."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:527
msgid ""
"Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
"returns the string C<crypto_LUKS>)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:530
msgid ""
"Then open these devices by calling L</guestfs_luks_open>.  Obviously you "
"will require the passphrase!"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:533
msgid ""
"Opening a LUKS device creates a new device mapper device called "
"C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
"L</guestfs_luks_open>).  Reads and writes to this mapper device are "
"decrypted from and encrypted to the underlying block device respectively."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:539
msgid ""
"LVM volume groups on the device can be made visible by calling "
"L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>.  The logical "
"volume(s) can now be mounted in the usual way."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:543
msgid ""
"Use the reverse process to close a LUKS device.  Unmount any logical volumes "
"on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
"[\"/dev/VG\"])>.  Then close the mapper device by calling "
"L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
"underlying encrypted block device)."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:550
msgid "INSPECTION"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:552
msgid ""
"Libguestfs has APIs for inspecting an unknown disk image to find out if it "
"contains operating systems, an install CD or a live CD.  (These APIs used to "
"be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> 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:559
msgid ""
"Add all disks belonging to the unknown virtual machine and call "
"L</guestfs_launch> in the usual way."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:562
msgid ""
"Then call L</guestfs_inspect_os>.  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:571
msgid ""
"For each root, you can then call various C<guestfs_inspect_get_*> functions "
"to get additional details about that operating system.  For example, call "
"L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
"Windows and Linux-based operating systems respectively."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:577
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</boot>).  The inspection rules are able to detect how "
"filesystems correspond to mount points.  Call "
"C<guestfs_inspect_get_mountpoints> to get this mapping.  It might return a "
"hash table like this example:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:584
#, 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:588
msgid ""
"The caller can then make calls to L</guestfs_mount_options> to mount the "
"filesystems as suggested."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:591
msgid ""
"Be careful to mount filesystems in the right order (eg. C</> before "
"C</usr>).  Sorting the keys of the hash by length, shortest first, should "
"work."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:595
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:599
msgid ""
"Encrypted disks must be opened before inspection.  See L</ENCRYPTED DISKS> "
"for more details.  The L</guestfs_inspect_os> function just ignores any "
"encrypted devices."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:603
msgid ""
"A note on the implementation: The call L</guestfs_inspect_os> performs "
"inspection and caches the results in the guest handle.  Subsequent calls to "
"C<guestfs_inspect_get_*> return this cached information, but I<do not> "
"re-read the disks.  If you change the content of the guest disks, you can "
"redo inspection by calling L</guestfs_inspect_os> again.  "
"(L</guestfs_inspect_list_applications> works a little differently from the "
"other calls and does read the disks.  See documentation for that function "
"for details)."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:612
msgid "INSPECTING INSTALL DISKS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:614
msgid ""
"Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
"CDs and more."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:617
msgid ""
"Call L</guestfs_inspect_get_format> to return the format of the operating "
"system, which currently can be C<installed> (a regular operating system) or "
"C<installer> (some sort of install disk)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:621
msgid ""
"Further information is available about the operating system that can be "
"installed using the regular inspection APIs like "
"L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
"etc."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:626
msgid ""
"Some additional information specific to installer disks is also available "
"from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
"L</guestfs_inspect_is_multipart> calls."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:631
msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:633
msgid ""
"Libguestfs can mount NTFS partitions.  It does this using the "
"L<http://www.ntfs-3g.org/> driver."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:636
msgid "DRIVE LETTERS AND PATHS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:638
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<c:\\windows\\system32>.  When the filesystem is mounted in libguestfs, "
"that directory might be referred to as C</WINDOWS/System32>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:644
msgid ""
"Drive letter mappings are outside the scope of libguestfs.  You have to use "
"libguestfs to read the appropriate Windows Registry and configuration files, "
"to determine yourself how drives are mapped (see also L<hivex(3)> and "
"L<virt-inspector(1)>)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:649
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:652
msgid ""
"Where we can help is in resolving the case insensitivity of paths.  For "
"this, call L</guestfs_case_sensitive_path>."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:655
msgid "ACCESSING THE WINDOWS REGISTRY"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:657
msgid ""
"Libguestfs also provides some help for decoding Windows Registry \"hive\" "
"files, through the library C<hivex> 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<hivex> functions.  See also "
"the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
"L<virt-win-reg(1)> for more help on this issue."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:665
msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:667
msgid ""
"Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
"provide something which looks like a Linux symlink.  The way it tries to do "
"the rewriting is described here:"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:671
msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:673
msgid ""
"The essential problem is that ntfs-3g simply does not have enough "
"information to do a correct job.  NTFS links can contain drive letters and "
"references to external device GUIDs that ntfs-3g has no way of resolving.  "
"It is almost certainly the case that libguestfs callers should ignore what "
"ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:680
msgid ""
"Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
"L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
"attribute, and read the raw reparse data from that (you can find the format "
"documented in various places around the web)."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:685
msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:687
msgid ""
"There are other useful extended attributes that can be read from ntfs-3g "
"filesystems (using L</guestfs_getxattr>).  See:"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:690
msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:692
msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:694
msgid ""
"Although we don't want to discourage you from using the C API, we will "
"mention here that the same API is also available in other languages."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:697
msgid ""
"The API is broadly identical in all supported languages.  This means that "
"the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
"in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
"OCaml.  In other words, a straightforward, predictable isomorphism between "
"each language."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:703
msgid ""
"Error messages are automatically transformed into exceptions if the language "
"supports it."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:706
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:712
msgid "B<C++>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:714
msgid ""
"You can use the I<guestfs.h> header file from C++ programs.  The C++ API is "
"identical to the C API.  C++ classes and exceptions are not used."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:718
msgid "B<C#>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:720
msgid ""
"The C# bindings are highly experimental.  Please read the warnings at the "
"top of C<csharp/Libguestfs.cs>."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:723
msgid "B<Haskell>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:725
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:729
msgid "B<Java>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:731
msgid ""
"Full documentation is contained in the Javadoc which is distributed with "
"libguestfs."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:734
msgid "B<OCaml>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:736
msgid "See L<guestfs-ocaml(3)>."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:738
msgid "B<Perl>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:740
msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:742
msgid "B<PHP>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:744
msgid ""
"For documentation see C<README-PHP> supplied with libguestfs sources or in "
"the php-libguestfs package for your distribution."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:747
msgid "The PHP binding only works correctly on 64 bit machines."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:749
msgid "B<Python>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:751
msgid "See L<guestfs-python(3)>."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:753
msgid "B<Ruby>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:755
msgid "See L<guestfs-ruby(3)>."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:757
msgid "B<shell scripts>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:759
msgid "See L<guestfish(1)>."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:763
msgid "LIBGUESTFS GOTCHAS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:765
msgid ""
"L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"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:769
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:777
msgid "Autosync / forgetting to sync."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:779
msgid ""
"When modifying a filesystem from C or another language, you B<must> unmount "
"all filesystems and call L</guestfs_sync> explicitly before you close the "
"libguestfs handle.  You can also call:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:783
#, no-wrap
msgid ""
" guestfs_set_autosync (g, 1);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:785
msgid ""
"to have the unmount/sync done automatically for you when the handle 'g' is "
"closed.  (This feature is called \"autosync\", L</guestfs_set_autosync> "
"q.v.)"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:789
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:793
msgid ""
"Note that in L<guestfish(3)> autosync is the default.  So quick and dirty "
"guestfish scripts that forget to sync will work just fine, which can make "
"this very puzzling if you are trying to debug a problem."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:797
msgid ""
"Update: Autosync is enabled by default for all API users starting from "
"libguestfs 1.5.24."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:800
msgid "Mount option C<-o sync> should not be the default."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:802
msgid ""
"If you use L</guestfs_mount>, 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:806
msgid ""
"The work around is to use L</guestfs_mount_options> and set the mount "
"options that you actually want to use."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:809
msgid "Read-only should be the default."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:811
msgid ""
"In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
"specify I<--rw> if you want to make changes to the image."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:814
msgid "This would reduce the potential to corrupt live VM images."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:816
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</guestfs_add_drive_ro> to guarantee that the disk is not changed."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:820
msgid "guestfish command line is hard to use."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:822
msgid ""
"C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
"examination).  It tries to run a guestfish command C<disk.img> 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<guestfish -c command> to run commands."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:829
msgid "guestfish megabyte modifiers don't work right on all commands"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:831
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:838
msgid "The most common is L</guestfs_lvcreate>.  The guestfish command:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:840
#, no-wrap
msgid ""
" lvcreate LV VG 100M\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:842
msgid ""
"does not do what you might expect.  Instead because L</guestfs_lvcreate> is "
"already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
"megabytes * megabytes) logical volume.  The error message you get from this "
"is also a little obscure."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:847
msgid ""
"This could be fixed in the generator by specially marking parameters and "
"return values which take bytes or other units."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:850
msgid "Ambiguity between devices and paths"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:852
msgid ""
"There is a subtle ambiguity in the API between a device name "
"(eg. C</dev/sdb2>) and a similar pathname.  A file might just happen to be "
"called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:857
msgid ""
"In the current API we usually resolve this ambiguity by having two separate "
"calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>.  "
"Some API calls are ambiguous and (incorrectly) resolve the problem by "
"detecting if the path supplied begins with C</dev/>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:863
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<hd(0,0)>), 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:869
#, no-wrap
msgid ""
" type path = Path of string | Device of int | Partition of int * int\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:871
msgid "which would allow you to pass arguments like:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:873
#, 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:878
msgid ""
"As you can see there are still problems to resolve even with this "
"representation.  Also consider how it might work in guestfish."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:883
msgid "PROTOCOL LIMITS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:885
msgid ""
"Internally libguestfs uses a message-based protocol to pass API calls and "
"their responses to and from a small \"appliance\" (see L</INTERNALS> for "
"plenty more detail about this).  The maximum message size used by the "
"protocol is slightly less than 4 MB.  For some API calls you may need to be "
"aware of this limit.  The API calls which may be affected are individually "
"documented, with a link back to this section of the documentation."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:893
msgid ""
"A simple call such as L</guestfs_cat> returns its result (the file data) in "
"a simple string.  Because this string is at some point internally encoded as "
"a message, the maximum size that it can return is slightly under 4 MB.  If "
"the requested file is larger than this then you will get an error."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:899
msgid ""
"In order to transfer large files into and out of the guest filesystem, you "
"need to use particular calls that support this.  The sections L</UPLOADING> "
"and L</DOWNLOADING> document how to do this."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:903
msgid ""
"You might also consider mounting the disk image using our FUSE filesystem "
"support (L<guestmount(1)>)."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:906
msgid "KEYS AND PASSPHRASES"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:908
msgid ""
"Certain libguestfs calls take a parameter that contains sensitive key "
"material, passed in as a C string."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:911
msgid ""
"In the future we would hope to change the libguestfs implementation so that "
"keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
"swap.  However this is I<not> done at the moment, because of the complexity "
"of such an implementation."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:916
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: =head2
#: ../src/guestfs.pod:921
msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:923
msgid ""
"All high-level libguestfs actions are synchronous.  If you want to use "
"libguestfs asynchronously then you must create a thread."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:926
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:930
msgid ""
"See the graphical program guestfs-browser for one possible architecture for "
"multithreaded programs using libvirt and libguestfs."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:933
msgid "PATH"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:935
msgid ""
"Libguestfs needs a supermin appliance, which it finds by looking along an "
"internal path."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:938
msgid ""
"By default it looks for these in the directory C<$libdir/guestfs> "
"(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:941
msgid ""
"Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
"to change the directories that libguestfs will search in.  The value is a "
"colon-separated list of paths.  The current directory is I<not> searched "
"unless the path contains an empty element or C<.>.  For example "
"C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
"then C</usr/lib/guestfs>."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:948
msgid "QEMU WRAPPERS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:950
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:954
msgid ""
"There is one important rule to remember: you I<must C<exec qemu>> 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:959
msgid ""
"Here is an example of a wrapper, where I have built my own copy of qemu from "
"source:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:962
#, 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:966
msgid ""
"Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
"then use it by setting the LIBGUESTFS_QEMU environment variable.  For "
"example:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:970
#, no-wrap
msgid ""
" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:972
msgid ""
"Note that libguestfs also calls qemu with the -help and -version options in "
"order to determine features."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:975
msgid "ATTACHING TO RUNNING DAEMONS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:977
msgid ""
"I<Note (1):> This is B<highly experimental> and has a tendency to eat "
"babies.  Use with caution."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:980
msgid ""
"I<Note (2):> This section explains how to attach to a running daemon from a "
"low level perspective.  For most users, simply using virt tools such as "
"L<guestfish(1)> with the I<--live> option will \"just work\"."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:984
msgid "Using guestfs_set_attach_method"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:986
msgid ""
"By calling L</guestfs_set_attach_method> you can change how the library "
"connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
"L</ARCHITECTURE> for some background)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:990
msgid ""
"The normal attach method is C<appliance>, where a small appliance is created "
"containing the daemon, and then the library connects to this."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:993
msgid ""
"Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
"Unix domain socket) causes L</guestfs_launch> to connect to an existing "
"daemon over the Unix domain socket."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:997
msgid ""
"The normal use for this is to connect to a running virtual machine that "
"contains a C<guestfsd> daemon, and send commands so you can read and write "
"files inside the live virtual machine."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:1001
msgid "Using guestfs_add_domain with live flag"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1003
msgid ""
"L</guestfs_add_domain> provides some help for getting the correct attach "
"method.  If you pass the C<live> option to this function, then (if the "
"virtual machine is running) it will examine the libvirt XML looking for a "
"virtio-serial channel to connect to:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1009
#, no-wrap
msgid ""
" <domain>\n"
"   ...\n"
"   <devices>\n"
"     ...\n"
"     <channel type='unix'>\n"
"       <source mode='bind' path='/path/to/socket'/>\n"
"       <target type='virtio' name='org.libguestfs.channel.0'/>\n"
"     </channel>\n"
"     ...\n"
"   </devices>\n"
" </domain>\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1021
msgid ""
"L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
"method to C<unix:/path/to/socket>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1024
msgid ""
"Some of the libguestfs tools (including guestfish) support a I<--live> "
"option which is passed through to L</guestfs_add_domain> thus allowing you "
"to attach to and modify live virtual machines."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1028
msgid ""
"The virtual machine needs to have been set up beforehand so that it has the "
"virtio-serial channel and so that guestfsd is running inside it."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1032
msgid "ABI GUARANTEE"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1034
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: =head2
#: ../src/guestfs.pod:1040
msgid "BLOCK DEVICE NAMING"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1042
msgid ""
"In the kernel there is now quite a profusion of schemata for naming block "
"devices (in this context, by I<block device> I mean a physical or virtual "
"hard drive).  The original Linux IDE driver used names starting with "
"C</dev/hd*>.  SCSI devices have historically used a different naming scheme, "
"C</dev/sd*>.  When the Linux kernel I<libata> driver became a popular "
"replacement for the old IDE driver (particularly for SATA devices) those "
"devices also used the C</dev/sd*> scheme.  Additionally we now have virtual "
"machines with paravirtualized drivers.  This has created several different "
"naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
"Xen PV disks."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1054
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:1058
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:1063
msgid ""
"Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>.  "
"Internally C</dev/sd*> names are translated, if necessary, to other names as "
"required.  For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
"device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1069
msgid ""
"Note that this I<only> applies to parameters.  The L</guestfs_list_devices>, "
"L</guestfs_list_partitions> and similar calls return the true names of the "
"devices and partitions as known to the appliance."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:1074
msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1076
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</guestfs_config> to add a mixture of virtio and IDE devices to the "
"qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
"devices."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1082
msgid ""
"The algorithm is applied only to I<parameters> which are known to be either "
"device or partition names.  Return values from functions such as "
"L</guestfs_list_devices> are never changed."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1090
msgid "Is the string a parameter which is a device or partition name?"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1094
msgid "Does the string begin with C</dev/sd>?"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1098
msgid ""
"Does the named device exist? If so, we use that device.  However if I<not> "
"then we continue with this algorithm."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1103
msgid "Replace initial C</dev/sd> string with C</dev/hd>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1105
msgid "For example, change C</dev/sda2> to C</dev/hda2>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1107
msgid "If that named device exists, use it.  If not, continue."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1111
msgid "Replace initial C</dev/sd> string with C</dev/vd>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1113
msgid "If that named device exists, use it.  If not, return an error."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:1117
msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1119
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:1123
msgid ""
"Where possible for maximum future portability programs using libguestfs "
"should use these future-proof techniques:"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1130
msgid ""
"Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
"device names, and then use those names directly."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1133
msgid "Since those device names exist by definition, they will never be translated."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1138
msgid ""
"Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
"filesystem labels."
msgstr ""

#. type: =head1
#: ../src/guestfs.pod:1143
msgid "SECURITY"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1145
msgid ""
"This section discusses security implications of using libguestfs, "
"particularly with untrusted or malicious guests or disk images."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1148
msgid "GENERAL SECURITY CONSIDERATIONS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1150
msgid ""
"Be careful with any files or data that you download from a guest (by "
"\"download\" we mean not just the L</guestfs_download> command but any "
"command that reads files, filenames, directories or anything else from a "
"disk image).  An attacker could manipulate the data to fool your program "
"into doing the wrong thing.  Consider cases such as:"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1160
msgid "the data (file etc) not being present"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1164
msgid "being present but empty"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1168
msgid "being much larger than normal"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1172
msgid "containing arbitrary 8 bit data"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1176
msgid "being in an unexpected character encoding"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1180
msgid "containing homoglyphs."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1184
msgid "SECURITY OF MOUNTING FILESYSTEMS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1186
msgid ""
"When you mount a filesystem under Linux, mistakes in the kernel filesystem "
"(VFS) module can sometimes be escalated into exploits by deliberately "
"creating a malicious, malformed filesystem.  These exploits are very severe "
"for two reasons.  Firstly there are very many filesystem drivers in the "
"kernel, and many of them are infrequently used and not much developer "
"attention has been paid to the code.  Linux userspace helps potential "
"crackers by detecting the filesystem type and automatically choosing the "
"right VFS driver, even if that filesystem type is obscure or unexpected for "
"the administrator.  Secondly, a kernel-level exploit is like a local root "
"exploit (worse in some ways), giving immediate and total access to the "
"system right down to the hardware level."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1199
msgid ""
"That explains why you should never mount a filesystem from an untrusted "
"guest on your host kernel.  How about libguestfs? We run a Linux kernel "
"inside a qemu virtual machine, usually running as a non-root user.  The "
"attacker would need to write a filesystem which first exploited the kernel, "
"and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
"the libguestfs protocol, and finally to be as serious as the host kernel "
"exploit it would need to escalate its privileges to root.  This multi-step "
"escalation, performed by a static piece of data, is thought to be extremely "
"hard to do, although we never say 'never' about security issues."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1210
msgid ""
"In any case callers can reduce the attack surface by forcing the filesystem "
"type when mounting (use L</guestfs_mount_vfs>)."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1213
msgid "PROTOCOL SECURITY"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1215
msgid ""
"The protocol is designed to be secure, being based on RFC 4506 (XDR)  with a "
"defined upper message size.  However a program that uses libguestfs must "
"also take care - for example you can write a program that downloads a binary "
"from a disk image and executes it locally, and no amount of protocol "
"security will save you from the consequences."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1221
msgid "INSPECTION SECURITY"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1223
msgid ""
"Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
"directly from the guest, and these could contain any 8 bit data.  Callers "
"should be careful to escape these before printing them to a structured file "
"(for example, use HTML escaping if creating a web page)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1229
msgid ""
"Guest configuration may be altered in unusual ways by the administrator of "
"the virtual machine, and may not reflect reality (particularly for untrusted "
"or actively malicious guests).  For example we parse the hostname from "
"configuration files like C</etc/sysconfig/network> that we find in the "
"guest, but the guest administrator can easily manipulate these files to "
"provide the wrong hostname."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1237
msgid ""
"The inspection API parses guest configuration using two external libraries: "
"Augeas (Linux configuration) and hivex (Windows Registry).  Both are "
"designed to be robust in the face of malicious data, although denial of "
"service attacks are still possible, for example with oversized configuration "
"files."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1243
msgid "RUNNING UNTRUSTED GUEST COMMANDS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1245
msgid ""
"Be very cautious about running commands from the guest.  By running a "
"command in the guest, you are giving CPU time to a binary that you do not "
"control, under the same user account as the library, albeit wrapped in qemu "
"virtualization.  More information and alternatives can be found in the "
"section L</RUNNING COMMANDS>."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1251
msgid "CVE-2010-3851"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1253
msgid "https://bugzilla.redhat.com/642934"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1255
msgid ""
"This security bug concerns the automatic disk format detection that qemu "
"does on disk images."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1258
msgid ""
"A raw disk image is just the raw bytes, there is no header.  Other disk "
"images like qcow2 contain a special header.  Qemu deals with this by looking "
"for one of the known headers, and if none is found then assuming the disk "
"image must be raw."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1263
msgid ""
"This allows a guest which has been given a raw disk image to write some "
"other header.  At next boot (or when the disk image is accessed by "
"libguestfs) qemu would do autodetection and think the disk image format was, "
"say, qcow2 based on the header written by the guest."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1268
msgid ""
"This in itself would not be a problem, but qcow2 offers many features, one "
"of which is to allow a disk image to refer to another image (called the "
"\"backing disk\").  It does this by placing the path to the backing disk "
"into the qcow2 header.  This path is not validated and could point to any "
"host file (eg. \"/etc/passwd\").  The backing disk is then exposed through "
"\"holes\" in the qcow2 disk image, which of course is completely under the "
"control of the attacker."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1276
msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1283
msgid "You have enabled the network or have opened the disk in write mode."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1287
msgid ""
"You are also running untrusted code from the guest (see L</RUNNING "
"COMMANDS>)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1292
msgid ""
"The way to avoid this is to specify the expected disk format when adding "
"disks (the optional C<format> option to L</guestfs_add_drive_opts>).  You "
"should always do this if the disk is raw format, and it's a good idea for "
"other cases too."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1297
msgid ""
"For disks added from libvirt using calls like L</guestfs_add_domain>, the "
"format is fetched from libvirt and passed through."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1300
msgid ""
"For libguestfs tools, use the I<--format> command line parameter as "
"appropriate."
msgstr ""

#. type: =head1
#: ../src/guestfs.pod:1303
msgid "CONNECTION MANAGEMENT"
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1305
msgid "guestfs_h *"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1307
msgid ""
"C<guestfs_h> is the opaque type representing a connection handle.  Create a "
"handle by calling L</guestfs_create>.  Call L</guestfs_close> to free the "
"handle and release all resources used."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1311
msgid ""
"For information on using multiple handles and threads, see the section "
"L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1314
msgid "guestfs_create"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1316
#, no-wrap
msgid ""
" guestfs_h *guestfs_create (void);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1318
msgid "Create a connection handle."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1320
msgid ""
"You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
"on the handle at least once."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1323
msgid ""
"This function returns a non-NULL pointer to a handle on success or NULL on "
"error."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1326
msgid "After configuring the handle, you have to call L</guestfs_launch>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1328
msgid ""
"You may also want to configure error handling for the handle.  See L</ERROR "
"HANDLING> section below."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1331
msgid "guestfs_close"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1333
#, no-wrap
msgid ""
" void guestfs_close (guestfs_h *g);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1335
msgid "This closes the connection handle and frees up all resources used."
msgstr ""

#. type: =head1
#: ../src/guestfs.pod:1337
msgid "ERROR HANDLING"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1339
msgid ""
"API functions can return errors.  For example, almost all functions that "
"return C<int> will return C<-1> to indicate an error."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1342
msgid ""
"Additional information is available for errors: an error message string and "
"optionally an error number (errno) if the thing that failed was a system "
"call."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1346
msgid ""
"You can get at the additional information about the last error on the handle "
"by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
"up an error handler with L</guestfs_set_error_handler>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1351
msgid ""
"When the handle is created, a default error handler is installed which "
"prints the error message string to C<stderr>.  For small short-running "
"command line programs it is sufficient to do:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1355
#, no-wrap
msgid ""
" if (guestfs_launch (g) == -1)\n"
"   exit (EXIT_FAILURE);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1358
msgid ""
"since the default error handler will ensure that an error message has been "
"printed to C<stderr> before the program exits."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1361
msgid ""
"For other programs the caller will almost certainly want to install an "
"alternate error handler or do error handling in-line like this:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1364
#, no-wrap
msgid ""
" g = guestfs_create ();\n"
" \n"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1366
#, no-wrap
msgid ""
" /* This disables the default behaviour of printing errors\n"
"    on stderr. */\n"
" guestfs_set_error_handler (g, NULL, NULL);\n"
" \n"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1370
#, no-wrap
msgid ""
" if (guestfs_launch (g) == -1) {\n"
"   /* Examine the error message and print it etc. */\n"
"   char *msg = guestfs_last_error (g);\n"
"   int errnum = guestfs_last_errno (g);\n"
"   fprintf (stderr, \"%s\\n\", msg);\n"
"   /* ... */\n"
"  }\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1378
msgid ""
"Out of memory errors are handled differently.  The default action is to call "
"L<abort(3)>.  If this is undesirable, then you can set a handler using "
"L</guestfs_set_out_of_memory_handler>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1382
msgid ""
"L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
"because there is no handle if this happens there is no way to get additional "
"error information.  However L</guestfs_create> is supposed to be a "
"lightweight operation which can only fail because of insufficient memory (it "
"returns NULL in this case)."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1388
msgid "guestfs_last_error"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1390
#, no-wrap
msgid ""
" const char *guestfs_last_error (guestfs_h *g);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1392
msgid ""
"This returns the last error message that happened on C<g>.  If there has not "
"been an error since the handle was created, then this returns C<NULL>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1396
msgid ""
"The lifetime of the returned string is until the next error occurs, or "
"L</guestfs_close> is called."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1399
msgid "guestfs_last_errno"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1401
#, no-wrap
msgid ""
" int guestfs_last_errno (guestfs_h *g);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1403
msgid "This returns the last error number (errno) that happened on C<g>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1405
msgid "If successful, an errno integer not equal to zero is returned."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1407
msgid "If no error, this returns 0.  This call can return 0 in three situations:"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1414
msgid "There has not been any error on the handle."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1418
msgid ""
"There has been an error but the errno was meaningless.  This corresponds to "
"the case where the error did not come from a failed system call, but for "
"some other reason."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1424
msgid ""
"There was an error from a failed system call, but for some reason the errno "
"was not captured and returned.  This usually indicates a bug in libguestfs."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1430
msgid ""
"Libguestfs tries to convert the errno from inside the applicance into a "
"corresponding errno for the caller (not entirely trivial: the appliance "
"might be running a completely different operating system from the library "
"and error numbers are not standardized across Un*xen).  If this could not be "
"done, then the error is translated to C<EINVAL>.  In practice this should "
"only happen in very rare circumstances."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1438
msgid "guestfs_set_error_handler"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1440
#, 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:1447
msgid ""
"The callback C<cb> 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:1451
msgid ""
"C<errno> is not passed to the callback.  To get that the callback must call "
"L</guestfs_last_errno>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1454
msgid ""
"Note that the message string C<msg> 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:1458
msgid "The default handler prints messages on C<stderr>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1460
msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1462
msgid "guestfs_get_error_handler"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1464
#, 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:1467
msgid "Returns the current error handler callback."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1469
msgid "guestfs_set_out_of_memory_handler"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1471
#, 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:1475
msgid ""
"The callback C<cb> will be called if there is an out of memory situation.  "
"I<Note this callback must not return>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1478
msgid "The default is to call L<abort(3)>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1480
msgid "You cannot set C<cb> to C<NULL>.  You can't ignore out of memory situations."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1483
msgid "guestfs_get_out_of_memory_handler"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1485
#, no-wrap
msgid ""
" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1487
msgid "This returns the current out of memory handler."
msgstr ""

#. type: =head1
#: ../src/guestfs.pod:1489
msgid "API CALLS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1491 ../fish/guestfish.pod:1003
msgid "@ACTIONS@"
msgstr ""

#. type: =head1
#: ../src/guestfs.pod:1493
msgid "STRUCTURES"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1495
msgid "@STRUCTS@"
msgstr ""

#. type: =head1
#: ../src/guestfs.pod:1497
msgid "AVAILABILITY"
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1499
msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1501
msgid ""
"Using L</guestfs_available> 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:1506
msgid "@AVAILABILITY@"
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1508
msgid "GUESTFISH supported COMMAND"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1510
msgid ""
"In L<guestfish(3)> there is a handy interactive command C<supported> which "
"prints out the available groups and whether they are supported by this build "
"of libguestfs.  Note however that you have to do C<run> first."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1515
msgid "SINGLE CALLS AT COMPILE TIME"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1517
msgid ""
"Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
"function, such as:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1520
#, no-wrap
msgid ""
" #define LIBGUESTFS_HAVE_DD 1\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1522
msgid "if L</guestfs_dd> is available."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1524
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:1529
#, no-wrap
msgid ""
" AC_CHECK_LIB([guestfs],[guestfs_create])\n"
" AC_CHECK_FUNCS([guestfs_dd])\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1532
msgid ""
"which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
"in your program."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1535
msgid "SINGLE CALLS AT RUN TIME"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1537
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<libguestfs.so> (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:1544
msgid ""
"You can use L<dlopen(3)> 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:1548
#, no-wrap
msgid ""
" #include <stdio.h>\n"
" #include <stdlib.h>\n"
" #include <unistd.h>\n"
" #include <dlfcn.h>\n"
" #include <guestfs.h>\n"
" \n"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1554
#, 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:1560
#, 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:1569
#, 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:1582
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:1587
#, no-wrap
msgid ""
" Requires: libguestfs >= 1.0.80\n"
"\n"
msgstr ""

#. type: =head1
#: ../src/guestfs.pod:1589
msgid "CALLS WITH OPTIONAL ARGUMENTS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1591
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:1596
#, no-wrap
msgid ""
" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1598
msgid ""
"Call this with a list of optional arguments, terminated by C<-1>.  So to "
"call with no optional arguments specified:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1601
#, no-wrap
msgid ""
" guestfs_add_drive_opts (g, filename, -1);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1603
msgid "With a single optional argument:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1605
#, 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:1609
msgid "With two:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1611
#, 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:1616
msgid ""
"and so forth.  Don't forget the terminating C<-1> otherwise Bad Things will "
"happen!"
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1619
msgid "USING va_list FOR OPTIONAL ARGUMENTS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1621
msgid ""
"The second variant has the same name with the suffix C<_va>, which works the "
"same way but takes a C<va_list>.  See the C manual for details.  For the "
"example function, this is declared:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1625
#, 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:1628
msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1630
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:1636
#, 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:1645
msgid "You could call it like this:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1647
#, 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:1654
#, no-wrap
msgid ""
" guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1656 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
msgid "Notes:"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1662
msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1667
msgid "You do not need to fill in all fields of the structure."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1671
msgid ""
"There must be a one-to-one correspondence between fields of the structure "
"that are filled in, and bits set in the bitmask."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1676
msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1678
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:1682
msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:1684
msgid "SETTING CALLBACKS TO HANDLE EVENTS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1686
msgid ""
"B<Note:> This section documents the generic event mechanism introduced in "
"libguestfs 1.10, which you should use in new code if possible.  The old "
"functions C<guestfs_set_log_message_callback>, "
"C<guestfs_set_subprocess_quit_callback>, "
"C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
"C<guestfs_set_progress_callback> are no longer documented in this manual "
"page."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1694
msgid ""
"Handles generate events when certain things happen, such as log messages "
"being generated, progress messages during long-running operations, or the "
"handle being closed.  The API calls described below let you register a "
"callback to be called when events happen.  You can register multiple "
"callbacks (for the same, different or overlapping sets of events), and "
"individually remove callbacks.  If callbacks are not removed, then they "
"remain in force until the handle is closed."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1702
msgid ""
"In the current implementation, events are only generated synchronously: that "
"means that events (and hence callbacks) can only happen while you are in the "
"middle of making another libguestfs call.  The callback is called in the "
"same thread."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1707
msgid ""
"Events may contain a payload, usually nothing (void), an array of 64 bit "
"unsigned integers, or a message buffer.  Payloads are discussed later on."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:1711
msgid "CLASSES OF EVENTS"
msgstr ""

#. type: =item
#: ../src/guestfs.pod:1715
msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1718
msgid ""
"The callback function will be called while the handle is being closed "
"(synchronously from L</guestfs_close>)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1721
msgid ""
"Note that libguestfs installs an L<atexit(3)> 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<exit(3)>, which can cause unexpected "
"problems in higher-level languages (eg. if your HLL interpreter has already "
"been cleaned up by the time this is called, and if your callback then jumps "
"into some HLL function)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1728
msgid ""
"If no callback is registered: the handle is closed without any callback "
"being invoked."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:1731
msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1734
msgid ""
"The callback function will be called when the child process quits, either "
"asynchronously or if killed by L</guestfs_kill_subprocess>.  (This "
"corresponds to a transition from any state to the CONFIG state)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1738 ../src/guestfs.pod:1747
msgid "If no callback is registered: the event is ignored."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:1740
msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1743
msgid ""
"The callback function will be called when the child process becomes ready "
"first time after it has been launched.  (This corresponds to a transition "
"from LAUNCHING to the READY state)."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:1749
msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1752
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:1758
msgid ""
"The callback receives in the payload four unsigned 64 bit numbers which are "
"(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1761
msgid ""
"The units of C<total> are not defined, although for some operations C<total> "
"may relate in some way to the amount of data to be transferred (eg. in bytes "
"or megabytes), and C<position> may be the portion which has been "
"transferred."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1766
msgid "The only defined and stable parts of the API are:"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1772
msgid ""
"The callback can display to the user some type of progress bar or indicator "
"which shows the ratio of C<position>:C<total>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1777
msgid "0 E<lt>= C<position> E<lt>= C<total>"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1781
msgid ""
"If any progress notification is sent during a call, then a final progress "
"notification is always sent when C<position> = C<total> (I<unless> the call "
"fails with an error)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1785
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:1791
msgid ""
"For some calls we are unable to estimate the progress of the call, but we "
"can still generate progress messages to indicate activity.  This is known as "
"\"pulse mode\", and is directly supported by certain progress bar "
"implementations (eg. GtkProgressBar)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1796
msgid ""
"For these calls, zero or more progress messages are generated with "
"C<position = 0> and C<total = 1>, followed by a final message with "
"C<position = total = 1>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1800
msgid ""
"As noted above, if the call fails with an error then the final message may "
"not be generated."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1805
msgid ""
"The callback also receives the procedure number (C<proc_nr>) and serial "
"number (C<serial>) 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: textblock
#: ../src/guestfs.pod:1811
msgid "If no callback is registered: progress messages are discarded."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:1813
msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1816
msgid ""
"The callback function is called whenever a log message is generated by qemu, "
"the appliance kernel, guestfsd (daemon), or utility programs."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1819
msgid ""
"If the verbose flag (L</guestfs_set_verbose>) is set before launch "
"(L</guestfs_launch>) then additional debug messages are generated."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1822 ../src/guestfs.pod:1836
msgid ""
"If no callback is registered: the messages are discarded unless the verbose "
"flag is set in which case they are sent to stderr.  You can override the "
"printing of verbose messages to stderr by setting up a callback."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:1827
msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1830
msgid ""
"The callback function is called whenever a log message is generated by the "
"library part of libguestfs."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1833
msgid ""
"If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
"messages are generated."
msgstr ""

#. type: =item
#: ../src/guestfs.pod:1841
msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1844
msgid ""
"The callback function is called whenever a trace message is generated.  This "
"only applies if the trace flag (L</guestfs_set_trace>) is set."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1847
msgid ""
"If no callback is registered: the messages are sent to stderr.  You can "
"override the printing of trace messages to stderr by setting up a callback."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:1853
msgid "guestfs_set_event_callback"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1855
#, no-wrap
msgid ""
" int guestfs_set_event_callback (guestfs_h *g,\n"
"                                 guestfs_event_callback cb,\n"
"                                 uint64_t event_bitmask,\n"
"                                 int flags,\n"
"                                 void *opaque);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1861
msgid ""
"This function registers a callback (C<cb>) for all event classes in the "
"C<event_bitmask>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1864
msgid ""
"For example, to register for all log message events, you could call this "
"function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>.  "
"To register a single callback for all possible classes of events, use "
"C<GUESTFS_EVENT_ALL>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1870
msgid "C<flags> should always be passed as 0."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1872
msgid ""
"C<opaque> is an opaque pointer which is passed to the callback.  You can use "
"it for any purpose."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1875
msgid ""
"The return value is the event handle (an integer) which you can use to "
"delete the callback (see below)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1878
msgid ""
"If there is an error, this function returns C<-1>, and sets the error in the "
"handle in the usual way (see L</guestfs_last_error> etc.)"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1881
msgid ""
"Callbacks remain in effect until they are deleted, or until the handle is "
"closed."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1884
msgid ""
"In the case where multiple callbacks are registered for a particular event "
"class, all of the callbacks are called.  The order in which multiple "
"callbacks are called is not defined."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:1888
msgid "guestfs_delete_event_callback"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1890
#, no-wrap
msgid ""
" void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1892
msgid ""
"Delete a callback that was previously registered.  C<event_handle> should be "
"the integer that was returned by a previous call to "
"C<guestfs_set_event_callback> on the same handle."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:1896
msgid "guestfs_event_callback"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1898
#, no-wrap
msgid ""
" typedef void (*guestfs_event_callback) (\n"
"                  guestfs_h *g,\n"
"                  void *opaque,\n"
"                  uint64_t event,\n"
"                  int event_handle,\n"
"                  int flags,\n"
"                  const char *buf, size_t buf_len,\n"
"                  const uint64_t *array, size_t array_len);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1907
msgid "This is the type of the event callback function that you have to provide."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1910
msgid ""
"The basic parameters are: the handle (C<g>), the opaque user pointer "
"(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
"handle, and C<flags> which in the current API you should ignore."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1914
msgid ""
"The remaining parameters contain the event payload (if any).  Each event may "
"contain a payload, which usually relates to the event class, but for future "
"proofing your code should be written to handle any payload for any event "
"class."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1919
msgid ""
"C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
"there is no message buffer).  Note that this message buffer can contain "
"arbitrary 8 bit data, including NUL bytes."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1923
msgid ""
"C<array> and C<array_len> is an array of 64 bit unsigned integers.  At the "
"moment this is only used for progress messages."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:1926
msgid "EXAMPLE: CAPTURING LOG MESSAGES"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1928
msgid ""
"One motivation for the generic event API was to allow GUI programs to "
"capture debug and other messages.  In libguestfs E<le> 1.8 these were sent "
"unconditionally to C<stderr>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1932
msgid ""
"Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
"C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>.  (Note that error "
"messages are not events; you must capture error messages separately)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1937
msgid ""
"Programs have to set up a callback to capture the classes of events of "
"interest:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1940
#, no-wrap
msgid ""
" int eh =\n"
"   guestfs_set_event_callback\n"
"     (g, message_callback,\n"
"      GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
"      GUESTFS_EVENT_TRACE,\n"
"      0, NULL) == -1)\n"
" if (eh == -1) {\n"
"   // handle error in the usual way\n"
" }\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1950
msgid ""
"The callback can then direct messages to the appropriate place.  In this "
"example, messages are directed to syslog:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1953
#, no-wrap
msgid ""
" static void\n"
" message_callback (\n"
"         guestfs_h *g,\n"
"         void *opaque,\n"
"         uint64_t event,\n"
"         int event_handle,\n"
"         int flags,\n"
"         const char *buf, size_t buf_len,\n"
"         const uint64_t *array, size_t array_len)\n"
" {\n"
"   const int priority = LOG_USER|LOG_INFO;\n"
"   if (buf_len > 0)\n"
"     syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
" }\n"
"\n"
msgstr ""

#. type: =head1
#: ../src/guestfs.pod:1968
msgid "PRIVATE DATA AREA"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1970
msgid ""
"You can attach named pieces of private data to the libguestfs handle, fetch "
"them by name, and walk over them, for the lifetime of the handle.  This is "
"called the private data area and is only available from the C API."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1975
msgid "To attach a named piece of data, use the following call:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1977
#, no-wrap
msgid ""
" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1979
msgid ""
"C<key> is the name to associate with this data, and C<data> is an arbitrary "
"pointer (which can be C<NULL>).  Any previous item with the same name is "
"overwritten."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1983
msgid ""
"You can use any C<key> 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:1988
msgid "To retrieve the pointer, use:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:1990
#, no-wrap
msgid ""
" void *guestfs_get_private (guestfs_h *g, const char *key);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1992
msgid ""
"This function returns C<NULL> if either no data is found associated with "
"C<key>, or if the user previously set the C<key>'s C<data> pointer to "
"C<NULL>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:1996
msgid ""
"Libguestfs does not try to look at or interpret the C<data> pointer in any "
"way.  As far as libguestfs is concerned, it need not be a valid pointer at "
"all.  In particular, libguestfs does I<not> 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</guestfs_close> or must set up a close callback to "
"do it (see L</GUESTFS_EVENT_CLOSE>)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2003
msgid "To walk over all entries, use these two functions:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:2005
#, no-wrap
msgid ""
" void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
"\n"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:2007
#, no-wrap
msgid ""
" void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2009
msgid ""
"C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
"not have any particular meaning -- keys are not returned in any defined "
"order).  A pointer to the key is returned in C<*key_rtn> and the "
"corresponding data pointer is returned from the function.  C<NULL> is "
"returned if there are no keys stored in the handle."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2015
msgid ""
"C<guestfs_next_private> returns the next key, pointer pair.  The return "
"value of this function is also C<NULL> is there are no further entries to "
"return."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2019
msgid "Notes about walking over entries:"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2025
msgid "You must not call C<guestfs_set_private> while walking over the entries."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2030
msgid ""
"The handle maintains an internal iterator which is reset when you call "
"C<guestfs_first_private>.  This internal iterator is invalidated when you "
"call C<guestfs_set_private>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2036
msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:2038
#, no-wrap
msgid ""
" guestfs_set_private (g, key, NULL);\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2040
msgid "then that C<key> is not returned when walking."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2044
msgid ""
"C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
"C<guestfs_next_private> or C<guestfs_set_private>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2050
msgid ""
"The following example code shows how to print all keys and data pointers "
"that are associated with the handle C<g>:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:2053
#, no-wrap
msgid ""
" const char *key;\n"
" void *data = guestfs_first_private (g, &key);\n"
" while (data != NULL)\n"
"   {\n"
"     printf (\"key = %s, data = %p\\n\", key, data);\n"
"     data = guestfs_next_private (g, &key);\n"
"   }\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2061
msgid ""
"More commonly you are only interested in keys that begin with an "
"application-specific prefix C<foo_>.  Modify the loop like so:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:2064
#, no-wrap
msgid ""
" const char *key;\n"
" void *data = guestfs_first_private (g, &key);\n"
" while (data != NULL)\n"
"   {\n"
"     if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
"       printf (\"key = %s, data = %p\\n\", key, data);\n"
"     data = guestfs_next_private (g, &key);\n"
"   }\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2073
msgid ""
"If you need to modify keys while walking, then you have to jump back to the "
"beginning of the loop.  For example, to delete all keys prefixed with "
"C<foo_>:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:2077
#, no-wrap
msgid ""
"  const char *key;\n"
"  void *data;\n"
" again:\n"
"  data = guestfs_first_private (g, &key);\n"
"  while (data != NULL)\n"
"    {\n"
"      if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
"        {\n"
"          guestfs_set_private (g, key, NULL);\n"
"          /* note that 'key' pointer is now invalid, and so is\n"
"             the internal iterator */\n"
"          goto again;\n"
"        }\n"
"      data = guestfs_next_private (g, &key);\n"
"    }\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2093
msgid ""
"Note that the above loop is guaranteed to terminate because the keys are "
"being deleted, but other manipulations of keys within the loop might not "
"terminate unless you also maintain an indication of which keys have been "
"visited."
msgstr ""

#. type: =end
#: ../src/guestfs.pod:2098 ../src/guestfs.pod:2103
msgid "html"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2100
msgid ""
"<!-- old anchor for the next section --> <a "
"name=\"state_machine_and_low_level_event_api\"/>"
msgstr ""

#. type: =head1
#: ../src/guestfs.pod:2105
msgid "ARCHITECTURE"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2107
msgid ""
"Internally, libguestfs is implemented by running an appliance (a special "
"type of small virtual machine) using L<qemu(1)>.  Qemu runs as a child "
"process of the main program."
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:2111
#, 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:2131
msgid ""
"The library, linked to the main program, creates the child process and hence "
"the appliance in the L</guestfs_launch> function."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2134
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</guestfsd>.  The library talks to L</guestfsd> 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:2143
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:2150
msgid "STATE MACHINE"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2152
msgid "libguestfs uses a state machine to model the child process:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:2154
#, 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:2176
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:2181
msgid ""
"The guest may be killed by L</guestfs_kill_subprocess>, 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:2185
msgid ""
"Configuration commands for qemu such as L</guestfs_add_drive> can only be "
"issued when in the CONFIG state."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2188
msgid ""
"The API offers one call that goes from CONFIG through LAUNCHING to READY.  "
"L</guestfs_launch> blocks until the child process is READY to accept "
"commands (or until some failure or timeout).  L</guestfs_launch> internally "
"moves the state from CONFIG to LAUNCHING while it is running."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2194
msgid ""
"API actions such as L</guestfs_mount> 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:2200
msgid ""
"Finally, the child process sends asynchronous messages back to the main "
"program, such as kernel log messages.  You can register a callback to "
"receive these messages."
msgstr ""

#. type: =head1
#: ../src/guestfs.pod:2204
msgid "INTERNALS"
msgstr ""

#. type: =head2
#: ../src/guestfs.pod:2206
msgid "COMMUNICATION PROTOCOL"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2208
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:2211
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:2215
msgid ""
"The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
"this file is automatically generated)."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2218
msgid ""
"There are two broad cases, ordinary functions that don't have any C<FileIn> "
"and C<FileOut> parameters, which are handled with very simple request/reply "
"messages.  Then there are functions that have any C<FileIn> or C<FileOut> "
"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:2225
msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2227
msgid "For ordinary functions, the request message is:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:2229
#, 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_<foo>_args (encoded as XDR)\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2234
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<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
"effective size of any request is limited to somewhere under this size."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2240
msgid ""
"Note also that many functions don't take any arguments, in which case the "
"C<guestfs_I<foo>_args> is completely omitted."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2243
msgid ""
"The header contains the procedure number (C<guestfs_proc>) which is how the "
"receiver knows what type of args structure to expect, or none at all."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2247
msgid ""
"For functions that take optional arguments, the optional arguments are "
"encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
"arguments.  A bitmask in the header indicates which optional arguments are "
"meaningful.  The bitmask is also checked to see if it contains bits set "
"which the daemon does not know about (eg. if more optional arguments were "
"added in a later version of the library), and this causes the call to be "
"rejected."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2255
msgid "The reply message for ordinary functions is:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:2257
#, 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_<foo>_ret (encoded as XDR)\n"
"\n"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2262
msgid ""
"As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
"functions that return no formal return values."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2265
msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2268
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:2271
#, 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:2276
msgid ""
"The C<guestfs_message_error> structure contains the error message as a "
"string."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:2279
msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2281
msgid ""
"A C<FileIn> parameter indicates that we transfer a file I<into> 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:2285
#, 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_<foo>_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:2293
msgid "The \"sequence of chunks\" is:"
msgstr ""

#. type: verbatim
#: ../src/guestfs.pod:2295
#, 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:2303
msgid ""
"The final chunk has the C<data_len> 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:2307
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:2312
msgid ""
"Both the library (sender) I<and> 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<not> send any reply, and goes back to reading the next request."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2318
msgid ""
"The daemon may also cancel.  It does this by writing a special word "
"C<GUESTFS_CANCEL_FLAG> 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:2327
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<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
"to keep much in memory."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:2333
msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2335
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:2338
#, 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_<foo>_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:2346
msgid "INITIAL MESSAGE"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2348
msgid ""
"When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
"which indicates that the guest and daemon is alive.  This is what "
"L</guestfs_launch> waits for."
msgstr ""

#. type: =head3
#: ../src/guestfs.pod:2352
msgid "PROGRESS NOTIFICATION MESSAGES"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2354
msgid ""
"The daemon may send progress notification messages at any time.  These are "
"distinguished by the normal length word being replaced by "
"C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2358
msgid ""
"The library turns them into progress callbacks (see "
"L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
"them if not."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2362
msgid ""
"The daemon self-limits the frequency of progress messages it sends (see "
"C<daemon/proto.c:notify_progress>).  Not all calls generate progress "
"messages."
msgstr ""

#. type: =head1
#: ../src/guestfs.pod:2366
msgid "LIBGUESTFS VERSION NUMBERS"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2368
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:2373
#, 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:2384
msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2386
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:2392
msgid "Our criteria for backporting changes are:"
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2398
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:2404
msgid ""
"Bug fixes which are not controversial, fix obvious problems, and have been "
"well tested are backported."
msgstr ""

#. type: textblock
#: ../src/guestfs.pod:2409
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.&q