#, fuzzy
msgid ""
msgstr ""
-"Project-Id-Version: libguestfs 1.7.12\n"
+"Project-Id-Version: libguestfs 1.7.13\n"
"Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
-"POT-Creation-Date: 2010-11-23 10:39+0000\n"
+"POT-Creation-Date: 2010-11-24 20:19+0000\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"
"introduction, please read the L</API OVERVIEW> section next."
msgstr ""
-# type: =head1
+# type: textblock
#: ../src/guestfs.pod:55
+msgid ""
+"There are also some example programs in the L<guestfs-examples(3)> manual "
+"page."
+msgstr ""
+
+# type: =head1
+#: ../src/guestfs.pod:58
msgid "API OVERVIEW"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:57
+#: ../src/guestfs.pod:60
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 "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:62
+#: ../src/guestfs.pod:65
msgid "HANDLES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:64
+#: ../src/guestfs.pod:67
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:71
+#: ../src/guestfs.pod:74
msgid "The general structure of all libguestfs-using programs looks like this:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:74
+#: ../src/guestfs.pod:77
#, no-wrap
msgid ""
" guestfs_h *g = guestfs_create ();\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:76
+#: ../src/guestfs.pod:79
#, no-wrap
msgid ""
" /* Call guestfs_add_drive additional times if there are\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:81
+#: ../src/guestfs.pod:84
#, no-wrap
msgid ""
" /* Most manipulation calls won't work until you've launched\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:87
+#: ../src/guestfs.pod:90
#, no-wrap
msgid ""
" /* Now you can examine what partitions, LVs etc are available.\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:92
+#: ../src/guestfs.pod:95
#, no-wrap
msgid ""
" /* To access a filesystem in the image, you must mount it.\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:96
+#: ../src/guestfs.pod:99
#, no-wrap
msgid ""
" /* Now you can perform filesystem actions on the guest\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:101
+#: ../src/guestfs.pod:104
#, no-wrap
msgid ""
" /* You only need to call guestfs_sync if you have made\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:108
+#: ../src/guestfs.pod:111
#, no-wrap
msgid ""
" /* Close the handle 'g'. */\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:111
+#: ../src/guestfs.pod:114
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 "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:119
+#: ../src/guestfs.pod:122
msgid "DISK IMAGES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:121
+#: ../src/guestfs.pod:124
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:127
+#: ../src/guestfs.pod:130
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 "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:131
+#: ../src/guestfs.pod:134
#, no-wrap
msgid ""
" guestfs_add_drive_opts (g, filename,\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:135
+#: ../src/guestfs.pod:138
msgid "You can add a disk read-only using:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:137
+#: ../src/guestfs.pod:140
#, no-wrap
msgid ""
" guestfs_add_drive_opts (g, filename,\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:142
+#: ../src/guestfs.pod:145
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:145
+#: ../src/guestfs.pod:148
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:149
+#: ../src/guestfs.pod:152
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:154
+#: ../src/guestfs.pod:157
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 "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:159
+#: ../src/guestfs.pod:162
msgid "MOUNTING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:161
+#: ../src/guestfs.pod:164
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 "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:167
+#: ../src/guestfs.pod:170
#, no-wrap
msgid ""
" guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:169
+#: ../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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:173
+#: ../src/guestfs.pod:176
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:183
+#: ../src/guestfs.pod:186
msgid ""
"To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
"several other variations of the C<guestfs_mount_*> call."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:186
+#: ../src/guestfs.pod:189
msgid "FILESYSTEM ACCESS AND MODIFICATION"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:188
+#: ../src/guestfs.pod:191
msgid ""
"The majority of the libguestfs API consists of fairly low-level calls for "
"accessing and modifying the files, directories, symlinks etc on mounted "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:194
+#: ../src/guestfs.pod:197
msgid ""
"Specify filenames as full paths, starting with C<\"/\"> and including the "
"mount point."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:197
+#: ../src/guestfs.pod:200
msgid ""
"For example, if you mounted a filesystem at C<\"/\"> and you want to read "
"the file called C<\"etc/passwd\"> then you could do:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:200
+#: ../src/guestfs.pod:203
#, no-wrap
msgid ""
" char *data = guestfs_cat (g, \"/etc/passwd\");\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:202
+#: ../src/guestfs.pod:205
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), "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:206
+#: ../src/guestfs.pod:209
msgid ""
"As another example, to create a top-level directory on that filesystem "
"called C<\"var\"> you would do:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:209
+#: ../src/guestfs.pod:212
#, no-wrap
msgid ""
" guestfs_mkdir (g, \"/var\");\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:211
+#: ../src/guestfs.pod:214
msgid "To create a symlink you could do:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:213
+#: ../src/guestfs.pod:216
#, no-wrap
msgid ""
" guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:216
+#: ../src/guestfs.pod:219
msgid ""
"Libguestfs will reject attempts to use relative paths and there is no "
"concept of a current working directory."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:219
+#: ../src/guestfs.pod:222
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:225
+#: ../src/guestfs.pod:228
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:228
+#: ../src/guestfs.pod:231
msgid "PARTITIONING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:230
+#: ../src/guestfs.pod:233
msgid ""
"Libguestfs contains API calls to read, create and modify partition tables on "
"disk images."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:233
+#: ../src/guestfs.pod:236
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:237
+#: ../src/guestfs.pod:240
#, no-wrap
msgid ""
" const char *parttype = \"mbr\";\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:242
+#: ../src/guestfs.pod:245
msgid ""
"Obviously this effectively wipes anything that was on that disk image "
"before."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:245
+#: ../src/guestfs.pod:248
msgid "LVM2"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:247
+#: ../src/guestfs.pod:250
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:252
+#: ../src/guestfs.pod:255
msgid ""
"This author strongly recommends reading the LVM HOWTO, online at "
"L<http://tldp.org/HOWTO/LVM-HOWTO/>."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:255
+#: ../src/guestfs.pod:258
msgid "DOWNLOADING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:257
+#: ../src/guestfs.pod:260
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:262
+#: ../src/guestfs.pod:265
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:266
+#: ../src/guestfs.pod:269
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:269
+#: ../src/guestfs.pod:272
msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:272
+#: ../src/guestfs.pod:275
msgid "UPLOADING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:274
+#: ../src/guestfs.pod:277
msgid ""
"It's often the case that you want to write a file or files to the disk "
"image."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:277
+#: ../src/guestfs.pod:280
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:283
+#: ../src/guestfs.pod:286
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:286
+#: ../src/guestfs.pod:289
msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:288
+#: ../src/guestfs.pod:291
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 "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:299
+#: ../src/guestfs.pod:302
msgid "COPYING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:301
+#: ../src/guestfs.pod:304
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 "
msgstr ""
# type: =item
-#: ../src/guestfs.pod:307
+#: ../src/guestfs.pod:310
msgid "B<file> to B<file>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:309
+#: ../src/guestfs.pod:312
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:312
+#: ../src/guestfs.pod:315
msgid "B<file or device> to B<file or device>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:314
+#: ../src/guestfs.pod:317
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:317
+#: ../src/guestfs.pod:320
msgid "Example: duplicate the contents of an LV:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:319
+#: ../src/guestfs.pod:322
#, no-wrap
msgid ""
" guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:321
+#: ../src/guestfs.pod:324
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 "
msgstr ""
# type: =item
-#: ../src/guestfs.pod:325
+#: ../src/guestfs.pod:328
msgid "B<file on the host> to B<file or device>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:327
+#: ../src/guestfs.pod:330
msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:329
+#: ../src/guestfs.pod:332
msgid "B<file or device> to B<file on the host>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:331
+#: ../src/guestfs.pod:334
msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:335
+#: ../src/guestfs.pod:338
msgid "LISTING FILES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:337
+#: ../src/guestfs.pod:340
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:340
+#: ../src/guestfs.pod:343
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:343
+#: ../src/guestfs.pod:346
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:347
+#: ../src/guestfs.pod:350
msgid ""
"L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
"files."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:350
+#: ../src/guestfs.pod:353
msgid "RUNNING COMMANDS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:352
+#: ../src/guestfs.pod:355
msgid ""
"Although libguestfs is primarily an API for manipulating files inside guest "
"images, we also provide some limited facilities for running commands inside "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:356
+#: ../src/guestfs.pod:359
msgid "There are many limitations to this:"
msgstr ""
# type: =item
-#: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370 ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383 ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:957 ../src/guestfs.pod:961 ../src/guestfs.pod:965 ../src/guestfs.pod:970 ../src/guestfs.pod:978 ../src/guestfs.pod:997 ../src/guestfs.pod:1005 ../src/guestfs.pod:1027 ../src/guestfs.pod:1031 ../src/guestfs.pod:1035 ../src/guestfs.pod:1039 ../src/guestfs.pod:1043 ../src/guestfs.pod:1047 ../src/guestfs.pod:1529 ../src/guestfs.pod:1534 ../src/guestfs.pod:1538 ../src/guestfs.pod:1648 ../src/guestfs.pod:1653 ../src/guestfs.pod:1657 ../src/guestfs.pod:2001 ../src/guestfs.pod:2007 ../src/guestfs.pod:2012 ../src/guestfs.pod:2018 ../src/guestfs.pod:2126 ../src/guestfs.pod:2130 ../src/guestfs.pod:2134 ../src/guestfs.pod:2138 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633 ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775 ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:377 ../fish/guestfish.pod:381 ../fish/guestfish.pod:385 ../fish/guestfish.pod:389 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:375 ../fish/guestfish-actions.pod:383 ../fish/guestfish-actions.pod:390 ../fish/guestfish-actions.pod:397 ../fish/guestfish-actions.pod:1067 ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075 ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087 ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095 ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109 ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203 ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259 ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268 ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:347 ../tools/virt-resize.pl:352 ../tools/virt-resize.pl:362
+#: ../src/guestfs.pod:363 ../src/guestfs.pod:368 ../src/guestfs.pod:373 ../src/guestfs.pod:377 ../src/guestfs.pod:382 ../src/guestfs.pod:386 ../src/guestfs.pod:391 ../src/guestfs.pod:396 ../src/guestfs.pod:955 ../src/guestfs.pod:959 ../src/guestfs.pod:963 ../src/guestfs.pod:968 ../src/guestfs.pod:976 ../src/guestfs.pod:995 ../src/guestfs.pod:1003 ../src/guestfs.pod:1025 ../src/guestfs.pod:1029 ../src/guestfs.pod:1033 ../src/guestfs.pod:1037 ../src/guestfs.pod:1041 ../src/guestfs.pod:1045 ../src/guestfs.pod:1527 ../src/guestfs.pod:1532 ../src/guestfs.pod:1536 ../src/guestfs.pod:1646 ../src/guestfs.pod:1651 ../src/guestfs.pod:1655 ../src/guestfs.pod:1999 ../src/guestfs.pod:2005 ../src/guestfs.pod:2010 ../src/guestfs.pod:2016 ../src/guestfs.pod:2128 ../src/guestfs.pod:2132 ../src/guestfs.pod:2136 ../src/guestfs.pod:2140 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633 ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775 ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:377 ../fish/guestfish.pod:381 ../fish/guestfish.pod:385 ../fish/guestfish.pod:389 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:375 ../fish/guestfish-actions.pod:383 ../fish/guestfish-actions.pod:390 ../fish/guestfish-actions.pod:397 ../fish/guestfish-actions.pod:1067 ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075 ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087 ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095 ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109 ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203 ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259 ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268 ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:347 ../tools/virt-resize.pl:352 ../tools/virt-resize.pl:362
msgid "*"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:362
+#: ../src/guestfs.pod:365
msgid ""
"The kernel version that the command runs under will be different from what "
"it expects."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:367
+#: ../src/guestfs.pod:370
msgid ""
"If the command needs to communicate with daemons, then most likely they "
"won't be running."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:372
+#: ../src/guestfs.pod:375
msgid "The command will be running in limited memory."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:376
+#: ../src/guestfs.pod:379
msgid ""
"The network may not be available unless you enable it (see "
"L</guestfs_set_network>)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:381
+#: ../src/guestfs.pod:384
msgid "Only supports Linux guests (not Windows, BSD, etc)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:385
+#: ../src/guestfs.pod:388
msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:390
+#: ../src/guestfs.pod:393
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:395
+#: ../src/guestfs.pod:398
msgid ""
"I<Security:> It is not safe to run commands from untrusted, possibly "
"malicious guests. These commands may attempt to exploit your program by "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:404
+#: ../src/guestfs.pod:407
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:412
+#: ../src/guestfs.pod:415
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:415
+#: ../src/guestfs.pod:418
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:418
+#: ../src/guestfs.pod:421
msgid "CONFIGURATION FILES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:420
+#: ../src/guestfs.pod:423
msgid ""
"To read and write configuration files in Linux guest filesystems, we "
"strongly recommend using Augeas. For example, Augeas understands how to "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:425
+#: ../src/guestfs.pod:428
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:429
+#: ../src/guestfs.pod:432
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 "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:433
+#: ../src/guestfs.pod:436
msgid "SELINUX"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:435
+#: ../src/guestfs.pod:438
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:441 ../src/guestfs.pod:1150 ../src/guestfs.pod:1281
+#: ../src/guestfs.pod:444 ../src/guestfs.pod:1148 ../src/guestfs.pod:1279
msgid "1."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:443
+#: ../src/guestfs.pod:446
msgid "Before launching, do:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:445
+#: ../src/guestfs.pod:448
#, no-wrap
msgid ""
" guestfs_set_selinux (g, 1);\n"
msgstr ""
# type: =item
-#: ../src/guestfs.pod:447 ../src/guestfs.pod:1154 ../src/guestfs.pod:1285
+#: ../src/guestfs.pod:450 ../src/guestfs.pod:1152 ../src/guestfs.pod:1283
msgid "2."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:449
+#: ../src/guestfs.pod:452
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:453
+#: ../src/guestfs.pod:456
#, no-wrap
msgid ""
" guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:455
+#: ../src/guestfs.pod:458
msgid ""
"(Older versions of C<load_policy> require you to specify the name of the "
"policy file)."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:458 ../src/guestfs.pod:1291
+#: ../src/guestfs.pod:461 ../src/guestfs.pod:1289
msgid "3."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:460
+#: ../src/guestfs.pod:463
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:464
+#: ../src/guestfs.pod:467
#, no-wrap
msgid ""
" guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:468
+#: ../src/guestfs.pod:471
msgid "This will work for running commands and editing existing files."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:470
+#: ../src/guestfs.pod:473
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:474
+#: ../src/guestfs.pod:477
msgid "UMASK"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:476
+#: ../src/guestfs.pod:479
msgid ""
"Certain calls are affected by the current file mode creation mask (the "
"\"umask\"). In particular ones which create files or directories, such as "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:482
+#: ../src/guestfs.pod:485
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:485
+#: ../src/guestfs.pod:488
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:489
+#: ../src/guestfs.pod:492
msgid "For more information about umask, see L<umask(2)>."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:491 ../fish/guestfish.pod:670
+#: ../src/guestfs.pod:494 ../fish/guestfish.pod:670
msgid "ENCRYPTED DISKS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:493
+#: ../src/guestfs.pod:496
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) "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:499
+#: ../src/guestfs.pod:502
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:502
+#: ../src/guestfs.pod:505
msgid ""
"Then open these devices by calling L</guestfs_luks_open>. Obviously you "
"will require the passphrase!"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:505
+#: ../src/guestfs.pod:508
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:511
+#: ../src/guestfs.pod:514
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:515
+#: ../src/guestfs.pod:518
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, "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:522
+#: ../src/guestfs.pod:525
msgid "INSPECTION"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:524
+#: ../src/guestfs.pod:527
msgid ""
"Libguestfs has APIs for inspecting an unknown disk image to find out if it "
"contains operating systems. (These APIs used to be in a separate Perl-only "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:530
+#: ../src/guestfs.pod:533
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:533
+#: ../src/guestfs.pod:536
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:542
+#: ../src/guestfs.pod:545
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:548
+#: ../src/guestfs.pod:551
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 "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:555
+#: ../src/guestfs.pod:558
#, no-wrap
msgid ""
" /boot => /dev/sda1\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:559
+#: ../src/guestfs.pod:562
msgid ""
"The caller can then make calls to L</guestfs_mount_options> to mount the "
"filesystems as suggested."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:562
+#: ../src/guestfs.pod:565
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:566
+#: ../src/guestfs.pod:569
msgid ""
"Inspection currently only works for some common operating systems. "
"Contributors are welcome to send patches for other operating systems that we "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:570
+#: ../src/guestfs.pod:573
msgid ""
"Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
"for more details. The L</guestfs_inspect_os> function just ignores any "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:574
+#: ../src/guestfs.pod:577
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 "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:583
+#: ../src/guestfs.pod:586
msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:585
+#: ../src/guestfs.pod:588
msgid ""
"Libguestfs can mount NTFS partitions. It does this using the "
"L<http://www.ntfs-3g.org/> driver."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:588
+#: ../src/guestfs.pod:591
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:594
+#: ../src/guestfs.pod:597
msgid ""
"Drive letter mappings are outside the scope of libguestfs. You have to use "
"libguestfs to read the appropriate Windows Registry and configuration files, "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:599
+#: ../src/guestfs.pod:602
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:602
+#: ../src/guestfs.pod:605
msgid ""
"Where we can help is in resolving the case insensitivity of paths. For "
"this, call L</guestfs_case_sensitive_path>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:605
+#: ../src/guestfs.pod:608
msgid ""
"Libguestfs also provides some help for decoding Windows Registry \"hive\" "
"files, through the library C<hivex> which is part of the libguestfs project "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:613
+#: ../src/guestfs.pod:616
msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:615
+#: ../src/guestfs.pod:618
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:618
+#: ../src/guestfs.pod:621
msgid ""
"The API is broadly identical in all supported languages. This means that "
"the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:624
+#: ../src/guestfs.pod:627
msgid ""
"Error messages are automatically transformed into exceptions if the language "
"supports it."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:627
+#: ../src/guestfs.pod:630
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 "
msgstr ""
# type: =item
-#: ../src/guestfs.pod:633
+#: ../src/guestfs.pod:636
msgid "B<C++>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:635
+#: ../src/guestfs.pod:638
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:639
+#: ../src/guestfs.pod:642
msgid "B<C#>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:641
+#: ../src/guestfs.pod:644
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:644
+#: ../src/guestfs.pod:647
msgid "B<Haskell>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:646
+#: ../src/guestfs.pod:649
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 "
msgstr ""
# type: =item
-#: ../src/guestfs.pod:650
+#: ../src/guestfs.pod:653
msgid "B<Java>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:652
+#: ../src/guestfs.pod:655
msgid ""
"Full documentation is contained in the Javadoc which is distributed with "
"libguestfs."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:655
+#: ../src/guestfs.pod:658
msgid "B<OCaml>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:657
-msgid "For documentation see the file C<guestfs.mli>."
+#: ../src/guestfs.pod:660
+msgid "For documentation see L<guestfs-ocaml(3)>."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:659
+#: ../src/guestfs.pod:662
msgid "B<Perl>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:661
+#: ../src/guestfs.pod:664
msgid "For documentation see L<Sys::Guestfs(3)>."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:663
+#: ../src/guestfs.pod:666
msgid "B<PHP>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:665
+#: ../src/guestfs.pod:668
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:668
+#: ../src/guestfs.pod:671
msgid "The PHP binding only works correctly on 64 bit machines."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:670
+#: ../src/guestfs.pod:673
msgid "B<Python>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:672
-msgid "For documentation do:"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs.pod:674
-#, no-wrap
-msgid ""
-" $ python\n"
-" >>> import guestfs\n"
-" >>> help (guestfs)\n"
-"\n"
+#: ../src/guestfs.pod:675
+msgid "For documentation see L<guestfs-python(3)>."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:678
+#: ../src/guestfs.pod:677
msgid "B<Ruby>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:680
-msgid ""
-"Use the Guestfs module. There is no Ruby-specific documentation, but you "
-"can find examples written in Ruby in the libguestfs source."
+#: ../src/guestfs.pod:679
+msgid "For documentation see L<guestfs-ruby(3)>."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:683
+#: ../src/guestfs.pod:681
msgid "B<shell scripts>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:685
+#: ../src/guestfs.pod:683
msgid "For documentation see L<guestfish(1)>."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:689
+#: ../src/guestfs.pod:687
msgid "LIBGUESTFS GOTCHAS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:691
+#: ../src/guestfs.pod:689
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:695
+#: ../src/guestfs.pod:693
msgid ""
"Since we developed libguestfs and the associated tools, there are several "
"things we would have designed differently, but are now stuck with for "
msgstr ""
# type: =item
-#: ../src/guestfs.pod:703
+#: ../src/guestfs.pod:701
msgid "Autosync / forgetting to sync."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:705
+#: ../src/guestfs.pod:703
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 "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:709
+#: ../src/guestfs.pod:707
#, no-wrap
msgid ""
" guestfs_set_autosync (g, 1);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:711
+#: ../src/guestfs.pod:709
msgid ""
"to have the unmount/sync done automatically for you when the handle 'g' is "
"closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:715
+#: ../src/guestfs.pod:713
msgid ""
"If you forget to do this, then it is entirely possible that your changes "
"won't be written out, or will be partially written, or (very rarely) that "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:719
+#: ../src/guestfs.pod:717
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:723
+#: ../src/guestfs.pod:721
msgid ""
"Update: Autosync is enabled by default for all API users starting from "
"libguestfs 1.5.24."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:726
+#: ../src/guestfs.pod:724
msgid "Mount option C<-o sync> should not be the default."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:728
+#: ../src/guestfs.pod:726
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:732
+#: ../src/guestfs.pod:730
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:735
+#: ../src/guestfs.pod:733
msgid "Read-only should be the default."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:737
+#: ../src/guestfs.pod:735
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:740
+#: ../src/guestfs.pod:738
msgid "This would reduce the potential to corrupt live VM images."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:742
+#: ../src/guestfs.pod:740
msgid ""
"Note that many filesystems change the disk when you just mount and unmount, "
"even if you didn't perform any writes. You need to use "
msgstr ""
# type: =item
-#: ../src/guestfs.pod:746
+#: ../src/guestfs.pod:744
msgid "guestfish command line is hard to use."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:748
+#: ../src/guestfs.pod:746
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 "
msgstr ""
# type: =item
-#: ../src/guestfs.pod:755
+#: ../src/guestfs.pod:753
msgid "guestfish megabyte modifiers don't work right on all commands"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:757
+#: ../src/guestfs.pod:755
msgid ""
"In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
"other modifiers). What guestfish actually does is to multiply the number "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:764
+#: ../src/guestfs.pod:762
msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:766
+#: ../src/guestfs.pod:764
#, no-wrap
msgid ""
" lvcreate LV VG 100M\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:768
+#: ../src/guestfs.pod:766
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:773
+#: ../src/guestfs.pod:771
msgid ""
"This could be fixed in the generator by specially marking parameters and "
"return values which take bytes or other units."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:776
+#: ../src/guestfs.pod:774
msgid "Ambiguity between devices and paths"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:778
+#: ../src/guestfs.pod:776
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:783
+#: ../src/guestfs.pod:781
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>. "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:789
+#: ../src/guestfs.pod:787
msgid ""
"To avoid both the ambiguity and the need to duplicate some calls, we could "
"make paths/devices into structured names. One way to do this would be to "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:795
+#: ../src/guestfs.pod:793
#, no-wrap
msgid ""
" type path = Path of string | Device of int | Partition of int * int\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:797
+#: ../src/guestfs.pod:795
msgid "which would allow you to pass arguments like:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:799
+#: ../src/guestfs.pod:797
#, no-wrap
msgid ""
" Path \"/foo/bar\"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:804
+#: ../src/guestfs.pod:802
msgid ""
"As you can see there are still problems to resolve even with this "
"representation. Also consider how it might work in guestfish."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:809
+#: ../src/guestfs.pod:807
msgid "PROTOCOL LIMITS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:811
+#: ../src/guestfs.pod:809
msgid ""
"Internally libguestfs uses a message-based protocol to pass API calls and "
"their responses to and from a small \"appliance\" (see L</INTERNALS> for "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:819
+#: ../src/guestfs.pod:817
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:825
+#: ../src/guestfs.pod:823
msgid ""
"In order to transfer large files into and out of the guest filesystem, you "
"need to use particular calls that support this. The sections L</UPLOADING> "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:829
+#: ../src/guestfs.pod:827
msgid ""
"You might also consider mounting the disk image using our FUSE filesystem "
"support (L<guestmount(1)>)."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:832
+#: ../src/guestfs.pod:830
msgid "KEYS AND PASSPHRASES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:834
+#: ../src/guestfs.pod:832
msgid ""
"Certain libguestfs calls take a parameter that contains sensitive key "
"material, passed in as a C string."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:837
+#: ../src/guestfs.pod:835
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:842
+#: ../src/guestfs.pod:840
msgid ""
"Therefore you should be aware that any key parameter you pass to libguestfs "
"might end up being written out to the swap partition. If this is a concern, "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:847
+#: ../src/guestfs.pod:845
msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:849
+#: ../src/guestfs.pod:847
msgid ""
"All high-level libguestfs actions are synchronous. If you want to use "
"libguestfs asynchronously then you must create a thread."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:852
+#: ../src/guestfs.pod:850
msgid ""
"Only use the handle from a single thread. Either use the handle exclusively "
"from one thread, or provide your own mutex so that two threads cannot issue "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:856
+#: ../src/guestfs.pod:854
msgid ""
"See the graphical program guestfs-browser for one possible architecture for "
"multithreaded programs using libvirt and libguestfs."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:859
+#: ../src/guestfs.pod:857
msgid "PATH"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:861
+#: ../src/guestfs.pod:859
msgid ""
"Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
"internal path."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:864
+#: ../src/guestfs.pod:862
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:867
+#: ../src/guestfs.pod:865
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 "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:874
+#: ../src/guestfs.pod:872
msgid "QEMU WRAPPERS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:876
+#: ../src/guestfs.pod:874
msgid ""
"If you want to compile your own qemu, run qemu from a non-standard location, "
"or pass extra arguments to qemu, then you can write a shell-script wrapper "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:880
+#: ../src/guestfs.pod:878
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:885
+#: ../src/guestfs.pod:883
msgid ""
"Here is an example of a wrapper, where I have built my own copy of qemu from "
"source:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:888
+#: ../src/guestfs.pod:886
#, no-wrap
msgid ""
" #!/bin/sh -\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:892
+#: ../src/guestfs.pod:890
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 "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:896
+#: ../src/guestfs.pod:894
#, no-wrap
msgid ""
" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:898
+#: ../src/guestfs.pod:896
msgid ""
"Note that libguestfs also calls qemu with the -help and -version options in "
"order to determine features."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:901
+#: ../src/guestfs.pod:899
msgid "ABI GUARANTEE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:903
+#: ../src/guestfs.pod:901
msgid ""
"We guarantee the libguestfs ABI (binary interface), for public, high-level "
"actions as outlined in this section. Although we will deprecate some "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:909
+#: ../src/guestfs.pod:907
msgid "BLOCK DEVICE NAMING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:911
+#: ../src/guestfs.pod:909
msgid ""
"In the kernel there is now quite a profusion of schemata for naming block "
"devices (in this context, by I<block device> I mean a physical or virtual "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:923
+#: ../src/guestfs.pod:921
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:927
+#: ../src/guestfs.pod:925
msgid ""
"This causes a problem for libguestfs because many API calls use device or "
"partition names. Working scripts and the recipe (example) scripts that we "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:932
+#: ../src/guestfs.pod:930
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:938
+#: ../src/guestfs.pod:936
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 "
msgstr ""
# type: =head3
-#: ../src/guestfs.pod:943
+#: ../src/guestfs.pod:941
msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:945
+#: ../src/guestfs.pod:943
msgid ""
"Usually this translation is transparent. However in some (very rare) cases "
"you may need to know the exact algorithm. Such cases include where you use "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:951
+#: ../src/guestfs.pod:949
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:959
+#: ../src/guestfs.pod:957
msgid "Is the string a parameter which is a device or partition name?"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:963
+#: ../src/guestfs.pod:961
msgid "Does the string begin with C</dev/sd>?"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:967
+#: ../src/guestfs.pod:965
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:972
+#: ../src/guestfs.pod:970
msgid "Replace initial C</dev/sd> string with C</dev/hd>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:974
+#: ../src/guestfs.pod:972
msgid "For example, change C</dev/sda2> to C</dev/hda2>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:976
+#: ../src/guestfs.pod:974
msgid "If that named device exists, use it. If not, continue."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:980
+#: ../src/guestfs.pod:978
msgid "Replace initial C</dev/sd> string with C</dev/vd>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:982
+#: ../src/guestfs.pod:980
msgid "If that named device exists, use it. If not, return an error."
msgstr ""
# type: =head3
-#: ../src/guestfs.pod:986
+#: ../src/guestfs.pod:984
msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:988
+#: ../src/guestfs.pod:986
msgid ""
"Although the standard naming scheme and automatic translation is useful for "
"simple programs and guestfish scripts, for larger programs it is best not to "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:992
+#: ../src/guestfs.pod:990
msgid ""
"Where possible for maximum future portability programs using libguestfs "
"should use these future-proof techniques:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:999
+#: ../src/guestfs.pod:997
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:1002
+#: ../src/guestfs.pod:1000
msgid "Since those device names exist by definition, they will never be translated."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1007
+#: ../src/guestfs.pod:1005
msgid ""
"Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
"filesystem labels."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1012
+#: ../src/guestfs.pod:1010
msgid "SECURITY"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1014
+#: ../src/guestfs.pod:1012
msgid ""
"This section discusses security implications of using libguestfs, "
"particularly with untrusted or malicious guests or disk images."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1017
+#: ../src/guestfs.pod:1015
msgid "GENERAL SECURITY CONSIDERATIONS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1019
+#: ../src/guestfs.pod:1017
msgid ""
"Be careful with any files or data that you download from a guest (by "
"\"download\" we mean not just the L</guestfs_download> command but any "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1029
+#: ../src/guestfs.pod:1027
msgid "the data (file etc) not being present"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1033
+#: ../src/guestfs.pod:1031
msgid "being present but empty"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1037
+#: ../src/guestfs.pod:1035
msgid "being much larger than normal"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1041
+#: ../src/guestfs.pod:1039
msgid "containing arbitrary 8 bit data"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1045
+#: ../src/guestfs.pod:1043
msgid "being in an unexpected character encoding"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1049
+#: ../src/guestfs.pod:1047
msgid "containing homoglyphs."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1053
+#: ../src/guestfs.pod:1051
msgid "SECURITY OF MOUNTING FILESYSTEMS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1055
+#: ../src/guestfs.pod:1053
msgid ""
"When you mount a filesystem under Linux, mistakes in the kernel filesystem "
"(VFS) module can sometimes be escalated into exploits by deliberately "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1068
+#: ../src/guestfs.pod:1066
msgid ""
"That explains why you should never mount a filesystem from an untrusted "
"guest on your host kernel. How about libguestfs? We run a Linux kernel "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1079
+#: ../src/guestfs.pod:1077
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:1082
+#: ../src/guestfs.pod:1080
msgid "PROTOCOL SECURITY"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1084
+#: ../src/guestfs.pod:1082
msgid ""
"The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
"defined upper message size. However a program that uses libguestfs must "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1090
+#: ../src/guestfs.pod:1088
msgid "INSPECTION SECURITY"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1092
+#: ../src/guestfs.pod:1090
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1098
+#: ../src/guestfs.pod:1096
msgid ""
"Guest configuration may be altered in unusual ways by the administrator of "
"the virtual machine, and may not reflect reality (particularly for untrusted "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1106
+#: ../src/guestfs.pod:1104
msgid ""
"The inspection API parses guest configuration using two external libraries: "
"Augeas (Linux configuration) and hivex (Windows Registry). Both are "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1112
+#: ../src/guestfs.pod:1110
msgid "RUNNING UNTRUSTED GUEST COMMANDS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1114
+#: ../src/guestfs.pod:1112
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 "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1120
+#: ../src/guestfs.pod:1118
msgid "CVE-2010-3851"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1122
+#: ../src/guestfs.pod:1120
msgid "https://bugzilla.redhat.com/642934"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1124
+#: ../src/guestfs.pod:1122
msgid ""
"This security bug concerns the automatic disk format detection that qemu "
"does on disk images."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1127
+#: ../src/guestfs.pod:1125
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1132
+#: ../src/guestfs.pod:1130
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1137
+#: ../src/guestfs.pod:1135
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1145
+#: ../src/guestfs.pod:1143
msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1152
+#: ../src/guestfs.pod:1150
msgid "You have enabled the network or have opened the disk in write mode."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1156
+#: ../src/guestfs.pod:1154
msgid ""
"You are also running untrusted code from the guest (see L</RUNNING "
"COMMANDS>)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1161
+#: ../src/guestfs.pod:1159
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1166
+#: ../src/guestfs.pod:1164
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:1169
+#: ../src/guestfs.pod:1167
msgid ""
"For libguestfs tools, use the I<--format> command line parameter as "
"appropriate."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1172
+#: ../src/guestfs.pod:1170
msgid "CONNECTION MANAGEMENT"
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1174
+#: ../src/guestfs.pod:1172
msgid "guestfs_h *"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1176
+#: ../src/guestfs.pod:1174
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1180
+#: ../src/guestfs.pod:1178
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:1183
+#: ../src/guestfs.pod:1181
msgid "guestfs_create"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1185
+#: ../src/guestfs.pod:1183
#, no-wrap
msgid ""
" guestfs_h *guestfs_create (void);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1187
+#: ../src/guestfs.pod:1185
msgid "Create a connection handle."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1189
+#: ../src/guestfs.pod:1187
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:1192
+#: ../src/guestfs.pod:1190
msgid ""
"This function returns a non-NULL pointer to a handle on success or NULL on "
"error."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1195
+#: ../src/guestfs.pod:1193
msgid "After configuring the handle, you have to call L</guestfs_launch>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1197
+#: ../src/guestfs.pod:1195
msgid ""
"You may also want to configure error handling for the handle. See L</ERROR "
"HANDLING> section below."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1200
+#: ../src/guestfs.pod:1198
msgid "guestfs_close"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1202
+#: ../src/guestfs.pod:1200
#, no-wrap
msgid ""
" void guestfs_close (guestfs_h *g);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1204
+#: ../src/guestfs.pod:1202
msgid "This closes the connection handle and frees up all resources used."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1206
+#: ../src/guestfs.pod:1204
msgid "ERROR HANDLING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1208
+#: ../src/guestfs.pod:1206
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:1211
+#: ../src/guestfs.pod:1209
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1215
+#: ../src/guestfs.pod:1213
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1220
+#: ../src/guestfs.pod:1218
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 "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1224
+#: ../src/guestfs.pod:1222
#, no-wrap
msgid ""
" if (guestfs_launch (g) == -1)\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1227
+#: ../src/guestfs.pod:1225
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:1230
+#: ../src/guestfs.pod:1228
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:1233
+#: ../src/guestfs.pod:1231
#, no-wrap
msgid ""
" g = guestfs_create ();\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1235
+#: ../src/guestfs.pod:1233
#, no-wrap
msgid ""
" /* This disables the default behaviour of printing errors\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1239
+#: ../src/guestfs.pod:1237
#, no-wrap
msgid ""
" if (guestfs_launch (g) == -1) {\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1247
+#: ../src/guestfs.pod:1245
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1251
+#: ../src/guestfs.pod:1249
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 "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1257
+#: ../src/guestfs.pod:1255
msgid "guestfs_last_error"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1259
+#: ../src/guestfs.pod:1257
#, no-wrap
msgid ""
" const char *guestfs_last_error (guestfs_h *g);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1261
+#: ../src/guestfs.pod:1259
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:1265
+#: ../src/guestfs.pod:1263
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:1268
+#: ../src/guestfs.pod:1266
msgid "guestfs_last_errno"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1270
+#: ../src/guestfs.pod:1268
#, no-wrap
msgid ""
" int guestfs_last_errno (guestfs_h *g);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1272
+#: ../src/guestfs.pod:1270
msgid "This returns the last error number (errno) that happened on C<g>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1274
+#: ../src/guestfs.pod:1272
msgid "If successful, an errno integer not equal to zero is returned."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1276
+#: ../src/guestfs.pod:1274
msgid "If no error, this returns 0. This call can return 0 in three situations:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1283
+#: ../src/guestfs.pod:1281
msgid "There has not been any error on the handle."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1287
+#: ../src/guestfs.pod:1285
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1293
+#: ../src/guestfs.pod:1291
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:1299
+#: ../src/guestfs.pod:1297
msgid ""
"Libguestfs tries to convert the errno from inside the applicance into a "
"corresponding errno for the caller (not entirely trivial: the appliance "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1307
+#: ../src/guestfs.pod:1305
msgid "guestfs_set_error_handler"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1309
+#: ../src/guestfs.pod:1307
#, no-wrap
msgid ""
" typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1316
+#: ../src/guestfs.pod:1314
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1320
+#: ../src/guestfs.pod:1318
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:1323
+#: ../src/guestfs.pod:1321
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1327
+#: ../src/guestfs.pod:1325
msgid "The default handler prints messages on C<stderr>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1329
+#: ../src/guestfs.pod:1327
msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1331
+#: ../src/guestfs.pod:1329
msgid "guestfs_get_error_handler"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1333
+#: ../src/guestfs.pod:1331
#, no-wrap
msgid ""
" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1336
+#: ../src/guestfs.pod:1334
msgid "Returns the current error handler callback."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1338
+#: ../src/guestfs.pod:1336
msgid "guestfs_set_out_of_memory_handler"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1340
+#: ../src/guestfs.pod:1338
#, no-wrap
msgid ""
" typedef void (*guestfs_abort_cb) (void);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1344
+#: ../src/guestfs.pod:1342
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:1347
+#: ../src/guestfs.pod:1345
msgid "The default is to call L<abort(3)>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1349
+#: ../src/guestfs.pod:1347
msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1352
+#: ../src/guestfs.pod:1350
msgid "guestfs_get_out_of_memory_handler"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1354
+#: ../src/guestfs.pod:1352
#, no-wrap
msgid ""
" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1356
+#: ../src/guestfs.pod:1354
msgid "This returns the current out of memory handler."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1358
+#: ../src/guestfs.pod:1356
msgid "API CALLS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1360 ../fish/guestfish.pod:908
+#: ../src/guestfs.pod:1358 ../fish/guestfish.pod:908
msgid "@ACTIONS@"
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1362
+#: ../src/guestfs.pod:1360
msgid "STRUCTURES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1364
+#: ../src/guestfs.pod:1362
msgid "@STRUCTS@"
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1366
+#: ../src/guestfs.pod:1364
msgid "AVAILABILITY"
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1368
+#: ../src/guestfs.pod:1366
msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1370
+#: ../src/guestfs.pod:1368
msgid ""
"Using L</guestfs_available> you can test availability of the following "
"groups of functions. This test queries the appliance to see if the "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1375
+#: ../src/guestfs.pod:1373
msgid "@AVAILABILITY@"
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1377
+#: ../src/guestfs.pod:1375
msgid "GUESTFISH supported COMMAND"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1379
+#: ../src/guestfs.pod:1377
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 "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1384
+#: ../src/guestfs.pod:1382
msgid "SINGLE CALLS AT COMPILE TIME"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1386
+#: ../src/guestfs.pod:1384
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:1389
+#: ../src/guestfs.pod:1387
#, no-wrap
msgid ""
" #define LIBGUESTFS_HAVE_DD 1\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1391
+#: ../src/guestfs.pod:1389
msgid "if L</guestfs_dd> is available."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1393
+#: ../src/guestfs.pod:1391
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 "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1398
+#: ../src/guestfs.pod:1396
#, no-wrap
msgid ""
" AC_CHECK_LIB([guestfs],[guestfs_create])\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1401
+#: ../src/guestfs.pod:1399
msgid ""
"which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
"in your program."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1404
+#: ../src/guestfs.pod:1402
msgid "SINGLE CALLS AT RUN TIME"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1406
+#: ../src/guestfs.pod:1404
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1413
+#: ../src/guestfs.pod:1411
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 "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1417
+#: ../src/guestfs.pod:1415
#, no-wrap
msgid ""
" #include <stdio.h>\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1423
+#: ../src/guestfs.pod:1421
#, no-wrap
msgid ""
" main ()\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1429
+#: ../src/guestfs.pod:1427
#, no-wrap
msgid ""
" /* Test if the function guestfs_dd is really available. */\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1438
+#: ../src/guestfs.pod:1436
#, no-wrap
msgid ""
" if (!has_function)\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1451
+#: ../src/guestfs.pod:1449
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 "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1456
+#: ../src/guestfs.pod:1454
#, no-wrap
msgid ""
" Requires: libguestfs >= 1.0.80\n"
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1458
+#: ../src/guestfs.pod:1456
msgid "CALLS WITH OPTIONAL ARGUMENTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1460
+#: ../src/guestfs.pod:1458
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 "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1465
+#: ../src/guestfs.pod:1463
#, no-wrap
msgid ""
" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1467
+#: ../src/guestfs.pod:1465
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:1470
+#: ../src/guestfs.pod:1468
#, no-wrap
msgid ""
" guestfs_add_drive_opts (g, filename, -1);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1472
+#: ../src/guestfs.pod:1470
msgid "With a single optional argument:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1474
+#: ../src/guestfs.pod:1472
#, no-wrap
msgid ""
" guestfs_add_drive_opts (g, filename,\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1478
+#: ../src/guestfs.pod:1476
msgid "With two:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1480
+#: ../src/guestfs.pod:1478
#, no-wrap
msgid ""
" guestfs_add_drive_opts (g, filename,\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1485
+#: ../src/guestfs.pod:1483
msgid ""
"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
"happen!"
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1488
+#: ../src/guestfs.pod:1486
msgid "USING va_list FOR OPTIONAL ARGUMENTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1490
+#: ../src/guestfs.pod:1488
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 "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1494
+#: ../src/guestfs.pod:1492
#, no-wrap
msgid ""
" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1497
+#: ../src/guestfs.pod:1495
msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1499
+#: ../src/guestfs.pod:1497
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 "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1505
+#: ../src/guestfs.pod:1503
#, no-wrap
msgid ""
" struct guestfs_add_drive_opts_argv {\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1514
+#: ../src/guestfs.pod:1512
msgid "You could call it like this:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1516
+#: ../src/guestfs.pod:1514
#, no-wrap
msgid ""
" struct guestfs_add_drive_opts_argv optargs = {\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1523
+#: ../src/guestfs.pod:1521
#, no-wrap
msgid ""
" guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1525 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255
+#: ../src/guestfs.pod:1523 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255
msgid "Notes:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1531
+#: ../src/guestfs.pod:1529
msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1536
+#: ../src/guestfs.pod:1534
msgid "You do not need to fill in all fields of the structure."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1540
+#: ../src/guestfs.pod:1538
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:1545
+#: ../src/guestfs.pod:1543
msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1547
+#: ../src/guestfs.pod:1545
msgid ""
"In other languages, optional arguments are expressed in the way that is "
"natural for that language. We refer you to the language-specific "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1551
+#: ../src/guestfs.pod:1549
msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1553
+#: ../src/guestfs.pod:1551
msgid "SETTING CALLBACKS TO HANDLE EVENTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1555
+#: ../src/guestfs.pod:1553
msgid ""
"The child process generates events in some situations. Current events "
"include: receiving a log message, the child process exits."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1558
+#: ../src/guestfs.pod:1556
msgid ""
"Use the C<guestfs_set_*_callback> functions to set a callback for different "
"types of events."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1561
+#: ../src/guestfs.pod:1559
msgid ""
"Only I<one callback of each type> can be registered for each handle. "
"Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1566
+#: ../src/guestfs.pod:1564
msgid "guestfs_set_log_message_callback"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1568
+#: ../src/guestfs.pod:1566
#, no-wrap
msgid ""
" typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1574
+#: ../src/guestfs.pod:1572
msgid ""
"The callback function C<cb> will be called whenever qemu or the guest writes "
"anything to the console."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1577
+#: ../src/guestfs.pod:1575
msgid "Use this function to capture kernel messages and similar."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1579
+#: ../src/guestfs.pod:1577
msgid ""
"Normally there is no log message handler, and log messages are just "
"discarded."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1582
+#: ../src/guestfs.pod:1580
msgid "guestfs_set_subprocess_quit_callback"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1584
+#: ../src/guestfs.pod:1582
#, no-wrap
msgid ""
" typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1589
+#: ../src/guestfs.pod:1587
msgid ""
"The callback function C<cb> will be called when the child process quits, "
"either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1594
+#: ../src/guestfs.pod:1592
msgid "guestfs_set_launch_done_callback"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1596
+#: ../src/guestfs.pod:1594
#, no-wrap
msgid ""
" typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1601
+#: ../src/guestfs.pod:1599
msgid ""
"The callback function C<cb> will be called when the child process becomes "
"ready first time after it has been launched. (This corresponds to a "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1605
+#: ../src/guestfs.pod:1603
msgid "guestfs_set_close_callback"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1607
+#: ../src/guestfs.pod:1605
#, no-wrap
msgid ""
" typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1612
+#: ../src/guestfs.pod:1610
msgid ""
"The callback function C<cb> will be called while the handle is being closed "
"(synchronously from L</guestfs_close>)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1615
+#: ../src/guestfs.pod:1613
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 "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1623
+#: ../src/guestfs.pod:1621
msgid "guestfs_set_progress_callback"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1625
+#: ../src/guestfs.pod:1623
#, no-wrap
msgid ""
" typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1632
+#: ../src/guestfs.pod:1630
msgid ""
"Some long-running operations can generate progress messages. If this "
"callback is registered, then it will be called each time a progress message "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1638
+#: ../src/guestfs.pod:1636
msgid ""
"The callback receives two numbers: C<position> and C<total>. The units of "
"C<total> are not defined, although for some operations C<total> may relate "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1644
+#: ../src/guestfs.pod:1642
msgid "The only defined and stable parts of the API are:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1650
+#: ../src/guestfs.pod:1648
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:1655
+#: ../src/guestfs.pod:1653
msgid "0 E<lt>= C<position> E<lt>= C<total>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1659
+#: ../src/guestfs.pod:1657
msgid ""
"If any progress notification is sent during a call, then a final progress "
"notification is always sent when C<position> = C<total>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1662
+#: ../src/guestfs.pod:1660
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1668
+#: ../src/guestfs.pod:1666
msgid ""
"The callback also receives the procedure number and serial number of the "
"call. These are only useful for debugging protocol issues, and the callback "
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1673
+#: ../src/guestfs.pod:1671
msgid "PRIVATE DATA AREA"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1675
+#: ../src/guestfs.pod:1673
msgid ""
"You can attach named pieces of private data to the libguestfs handle, and "
"fetch them by name for the lifetime of the handle. This is called the "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1679
+#: ../src/guestfs.pod:1677
msgid "To attach a named piece of data, use the following call:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1681
+#: ../src/guestfs.pod:1679
#, no-wrap
msgid ""
" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1683
+#: ../src/guestfs.pod:1681
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1687
+#: ../src/guestfs.pod:1685
msgid ""
"You can use any C<key> you want, but names beginning with an underscore "
"character are reserved for internal libguestfs purposes (for implementing "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1692
+#: ../src/guestfs.pod:1690
msgid "To retrieve the pointer, use:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1694
+#: ../src/guestfs.pod:1692
#, no-wrap
msgid ""
" void *guestfs_get_private (guestfs_h *g, const char *key);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1696
+#: ../src/guestfs.pod:1694
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1700
+#: ../src/guestfs.pod:1698
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1708
+#: ../src/guestfs.pod:1706
msgid ""
"The private data area is implemented using a hash table, and should be "
"reasonably efficient for moderate numbers of keys."
msgstr ""
# type: =end
-#: ../src/guestfs.pod:1711 ../src/guestfs.pod:1716
+#: ../src/guestfs.pod:1709 ../src/guestfs.pod:1714
msgid "html"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1713
+#: ../src/guestfs.pod:1711
msgid ""
"<!-- old anchor for the next section --> <a "
"name=\"state_machine_and_low_level_event_api\"/>"
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1718
+#: ../src/guestfs.pod:1716
msgid "ARCHITECTURE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1720
+#: ../src/guestfs.pod:1718
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 "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1724
+#: ../src/guestfs.pod:1722
#, no-wrap
msgid ""
" ___________________\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1744
+#: ../src/guestfs.pod:1742
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:1747
+#: ../src/guestfs.pod:1745
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1756
+#: ../src/guestfs.pod:1754
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 "
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1763
+#: ../src/guestfs.pod:1761
msgid "STATE MACHINE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1765
+#: ../src/guestfs.pod:1763
msgid "libguestfs uses a state machine to model the child process:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1767
+#: ../src/guestfs.pod:1765
#, no-wrap
msgid ""
" |\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1789
+#: ../src/guestfs.pod:1787
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), "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1794
+#: ../src/guestfs.pod:1792
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1798
+#: ../src/guestfs.pod:1796
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:1801
+#: ../src/guestfs.pod:1799
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1807
+#: ../src/guestfs.pod:1805
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1813
+#: ../src/guestfs.pod:1811
msgid ""
"Finally, the child process sends asynchronous messages back to the main "
"program, such as kernel log messages. You can register a callback to "
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1817
+#: ../src/guestfs.pod:1815
msgid "INTERNALS"
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1819
+#: ../src/guestfs.pod:1817
msgid "COMMUNICATION PROTOCOL"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1821
+#: ../src/guestfs.pod:1819
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:1824
+#: ../src/guestfs.pod:1822
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1828
+#: ../src/guestfs.pod:1826
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:1831
+#: ../src/guestfs.pod:1829
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 "
msgstr ""
# type: =head3
-#: ../src/guestfs.pod:1838
+#: ../src/guestfs.pod:1836
msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1840
+#: ../src/guestfs.pod:1838
msgid "For ordinary functions, the request message is:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1842
+#: ../src/guestfs.pod:1840
#, no-wrap
msgid ""
" total length (header + arguments,\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1847
+#: ../src/guestfs.pod:1845
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1853
+#: ../src/guestfs.pod:1851
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:1856
+#: ../src/guestfs.pod:1854
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:1860
+#: ../src/guestfs.pod:1858
msgid "The reply message for ordinary functions is:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1862
+#: ../src/guestfs.pod:1860
#, no-wrap
msgid ""
" total length (header + ret,\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1867
+#: ../src/guestfs.pod:1865
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:1870
+#: ../src/guestfs.pod:1868
msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1873
+#: ../src/guestfs.pod:1871
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:1876
+#: ../src/guestfs.pod:1874
#, no-wrap
msgid ""
" total length (header + error,\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1881
+#: ../src/guestfs.pod:1879
msgid ""
"The C<guestfs_message_error> structure contains the error message as a "
"string."
msgstr ""
# type: =head3
-#: ../src/guestfs.pod:1884
+#: ../src/guestfs.pod:1882
msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1886
+#: ../src/guestfs.pod:1884
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 "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1890
+#: ../src/guestfs.pod:1888
#, no-wrap
msgid ""
" total length (header + arguments,\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1898
+#: ../src/guestfs.pod:1896
msgid "The \"sequence of chunks\" is:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1900
+#: ../src/guestfs.pod:1898
#, no-wrap
msgid ""
" length of chunk (not including length word itself)\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1908
+#: ../src/guestfs.pod:1906
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1912
+#: ../src/guestfs.pod:1910
msgid ""
"At time of writing there are no functions that have more than one FileIn "
"parameter. However this is (theoretically) supported, by sending the "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1917
+#: ../src/guestfs.pod:1915
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1923
+#: ../src/guestfs.pod:1921
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1932
+#: ../src/guestfs.pod:1930
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 "
msgstr ""
# type: =head3
-#: ../src/guestfs.pod:1938
+#: ../src/guestfs.pod:1936
msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1940
+#: ../src/guestfs.pod:1938
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:1943
+#: ../src/guestfs.pod:1941
#, no-wrap
msgid ""
" total length (header + ret,\n"
msgstr ""
# type: =head3
-#: ../src/guestfs.pod:1951
+#: ../src/guestfs.pod:1949
msgid "INITIAL MESSAGE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1953
+#: ../src/guestfs.pod:1951
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 "
msgstr ""
# type: =head3
-#: ../src/guestfs.pod:1957
+#: ../src/guestfs.pod:1955
msgid "PROGRESS NOTIFICATION MESSAGES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1959
+#: ../src/guestfs.pod:1957
msgid ""
"The daemon may send progress notification messages at any time. These are "
"distinguished by the normal length word being replaced by "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1963
+#: ../src/guestfs.pod:1961
msgid ""
"The library turns them into progress callbacks (see "
"C<guestfs_set_progress_callback>) if there is a callback registered, or "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1967
+#: ../src/guestfs.pod:1965
msgid ""
"The daemon self-limits the frequency of progress messages it sends (see "
"C<daemon/proto.c:notify_progress>). Not all calls generate progress "
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1971
+#: ../src/guestfs.pod:1969
msgid "LIBGUESTFS VERSION NUMBERS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1973
+#: ../src/guestfs.pod:1971
msgid ""
"Since April 2010, libguestfs has started to make separate development and "
"stable releases, along with corresponding branches in our git repository. "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1978
+#: ../src/guestfs.pod:1976
#, no-wrap
msgid ""
" even numbers for stable: 1.2.x, 1.4.x, ...\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1989
+#: ../src/guestfs.pod:1987
msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1991
+#: ../src/guestfs.pod:1989
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1997
+#: ../src/guestfs.pod:1995
msgid "Our criteria for backporting changes are:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2003
+#: ../src/guestfs.pod:2001
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:2009
+#: ../src/guestfs.pod:2007
msgid ""
"Bug fixes which are not controversial, fix obvious problems, and have been "
"well tested are backported."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2014
+#: ../src/guestfs.pod:2012
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 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2020
+#: ../src/guestfs.pod:2018
msgid ""
"We I<don't> backport new features, new APIs, new tools etc, except in one "
"exceptional case: the new feature is required in order to implement an "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2026
+#: ../src/guestfs.pod:2024
msgid ""
"A new stable branch starts when we think the new features in development are "
"substantial and compelling enough over the current stable branch to warrant "
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:2034 ../fish/guestfish.pod:915 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255
+#: ../src/guestfs.pod:2032 ../fish/guestfish.pod:915 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255
msgid "ENVIRONMENT VARIABLES"
msgstr ""
# type: =item
-#: ../src/guestfs.pod:2038 ../fish/guestfish.pod:941
+#: ../src/guestfs.pod:2036 ../fish/guestfish.pod:941
msgid "LIBGUESTFS_APPEND"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2040 ../fish/guestfish.pod:943
+#: ../src/guestfs.pod:2038 ../fish/guestfish.pod:943
msgid "Pass additional options to the guest kernel."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:2042 ../fish/guestfish.pod:945
+#: ../src/guestfs.pod:2040 ../fish/guestfish.pod:945
msgid "LIBGUESTFS_DEBUG"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2044
+#: ../src/guestfs.pod:2042
msgid ""
"Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
"effect as calling C<guestfs_set_verbose (g, 1)>."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:2047 ../fish/guestfish.pod:950
+#: ../src/guestfs.pod:2045 ../fish/guestfish.pod:950
msgid "LIBGUESTFS_MEMSIZE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2049 ../fish/guestfish.pod:952
+#: ../src/guestfs.pod:2047 ../fish/guestfish.pod:952
msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:2052 ../fish/guestfish.pod:955
+#: ../src/guestfs.pod:2050 ../fish/guestfish.pod:955
#, no-wrap
msgid ""
" LIBGUESTFS_MEMSIZE=700\n"
msgstr ""
# type: =item
-#: ../src/guestfs.pod:2054 ../fish/guestfish.pod:957
+#: ../src/guestfs.pod:2052 ../fish/guestfish.pod:957
msgid "LIBGUESTFS_PATH"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2056
+#: ../src/guestfs.pod:2054
msgid ""
"Set the path that libguestfs uses to search for kernel and initrd.img. See "
"the discussion of paths in section PATH above."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:2059 ../fish/guestfish.pod:962
+#: ../src/guestfs.pod:2057 ../fish/guestfish.pod:962
msgid "LIBGUESTFS_QEMU"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2061 ../fish/guestfish.pod:964
+#: ../src/guestfs.pod:2059 ../fish/guestfish.pod:964
msgid ""
"Set the default qemu binary that libguestfs uses. If not set, then the qemu "
"which was found at compile time by the configure script is used."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2065
+#: ../src/guestfs.pod:2063
msgid "See also L</QEMU WRAPPERS> above."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:2067 ../fish/guestfish.pod:968
+#: ../src/guestfs.pod:2065 ../fish/guestfish.pod:968
msgid "LIBGUESTFS_TRACE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2069
+#: ../src/guestfs.pod:2067
msgid ""
"Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
"effect as calling C<guestfs_set_trace (g, 1)>."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:2072 ../fish/guestfish.pod:977
+#: ../src/guestfs.pod:2070 ../fish/guestfish.pod:977
msgid "TMPDIR"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2074 ../fish/guestfish.pod:979
+#: ../src/guestfs.pod:2072 ../fish/guestfish.pod:979
msgid "Location of temporary directory, defaults to C</tmp>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2076 ../fish/guestfish.pod:981
+#: ../src/guestfs.pod:2074 ../fish/guestfish.pod:981
msgid ""
"If libguestfs was compiled to use the supermin appliance then the real "
"appliance is cached in this directory, shared between all handles belonging "
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:2084 ../fish/guestfish.pod:1039 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640 ../tools/virt-resize.pl:1485 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:281 ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:257
+#: ../src/guestfs.pod:2082 ../fish/guestfish.pod:1039 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640 ../tools/virt-resize.pl:1485 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:281 ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:257
msgid "SEE ALSO"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2086
+#: ../src/guestfs.pod:2084
msgid ""
-"L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
-"L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
-"L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
-"L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, "
-"L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
+"L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
+"L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
+"L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
+"L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
+"L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
+"L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
+"L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2105
+#: ../src/guestfs.pod:2107
msgid ""
"Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
"L<lvm(8)>, L<disktype(1)>."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:2112 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548
+#: ../src/guestfs.pod:2114 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548
msgid "BUGS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2114
+#: ../src/guestfs.pod:2116
msgid "To get a list of bugs against libguestfs use this link:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2116
+#: ../src/guestfs.pod:2118
msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2118
+#: ../src/guestfs.pod:2120
msgid "To report a new bug against libguestfs use this link:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2120
+#: ../src/guestfs.pod:2122
msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2122
+#: ../src/guestfs.pod:2124
msgid "When reporting a bug, please check:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2128
+#: ../src/guestfs.pod:2130
msgid "That the bug hasn't been reported already."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2132
+#: ../src/guestfs.pod:2134
msgid "That you are testing a recent version."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2136
+#: ../src/guestfs.pod:2138
msgid "Describe the bug accurately, and give a way to reproduce it."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2140
+#: ../src/guestfs.pod:2142
msgid ""
"Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
"bug report."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:2145 ../fish/guestfish.pod:1058 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
+#: ../src/guestfs.pod:2147 ../fish/guestfish.pod:1058 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
msgid "AUTHORS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2147 ../fish/guestfish.pod:1060 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
+#: ../src/guestfs.pod:2149 ../fish/guestfish.pod:1060 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:2149 ../fish/guestfish.pod:1062 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653 ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:296 ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:273
+#: ../src/guestfs.pod:2151 ../fish/guestfish.pod:1062 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653 ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:296 ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:273
msgid "COPYRIGHT"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2151 ../fish/guestfish.pod:1064 ../fuse/guestmount.pod:250
+#: ../src/guestfs.pod:2153 ../fish/guestfish.pod:1064 ../fuse/guestmount.pod:250
msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2154
+#: ../src/guestfs.pod:2156
msgid ""
"This library is free software; you can redistribute it and/or modify it "
"under the terms of the GNU Lesser General Public License as published by the "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2159
+#: ../src/guestfs.pod:2161
msgid ""
"This library is distributed in the hope that it will be useful, but WITHOUT "
"ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2164
+#: ../src/guestfs.pod:2166
msgid ""
"You should have received a copy of the GNU Lesser General Public License "
"along with this library; if not, write to the Free Software Foundation, "
git.annexia.org / libguestfs.git / blobdiff