summaryrefslogtreecommitdiffstats
path: root/po-docs/libguestfs-docs.pot
diff options
context:
space:
mode:
authorRichard W.M. Jones <rjones@redhat.com>2010-12-10 13:44:25 +0000
committerRichard W.M. Jones <rjones@redhat.com>2010-12-10 13:44:25 +0000
commitb4310a810cb4050eb6473971895d3c255f045ccc (patch)
treebaa438a897025c5bddac12e55b66a90d1ee3b604 /po-docs/libguestfs-docs.pot
parentd72815578f7b8fea9702902d8562430e8a007a46 (diff)
downloadlibguestfs-b4310a810cb4050eb6473971895d3c255f045ccc.tar.gz
libguestfs-b4310a810cb4050eb6473971895d3c255f045ccc.tar.xz
libguestfs-b4310a810cb4050eb6473971895d3c255f045ccc.zip
Version 1.7.21.1.7.21
Diffstat (limited to 'po-docs/libguestfs-docs.pot')
-rw-r--r--po-docs/libguestfs-docs.pot1119
1 files changed, 559 insertions, 560 deletions
diff --git a/po-docs/libguestfs-docs.pot b/po-docs/libguestfs-docs.pot
index 9d882e43..eadea5e7 100644
--- a/po-docs/libguestfs-docs.pot
+++ b/po-docs/libguestfs-docs.pot
@@ -6,9 +6,9 @@
#, fuzzy
msgid ""
msgstr ""
-"Project-Id-Version: libguestfs 1.7.20\n"
+"Project-Id-Version: libguestfs 1.7.21\n"
"Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
-"POT-Creation-Date: 2010-12-07 18:39+0000\n"
+"POT-Creation-Date: 2010-12-10 13:42+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"
@@ -54,13 +54,12 @@ msgid ""
" guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
" guestfs_touch (g, \"/hello\");\n"
" guestfs_umount (g, \"/\");\n"
-" guestfs_sync (g);\n"
" guestfs_close (g);\n"
"\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:20
+#: ../src/guestfs.pod:19
#, no-wrap
msgid ""
" cc prog.c -o prog -lguestfs\n"
@@ -70,12 +69,12 @@ msgid ""
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:72 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
+#: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:72 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
msgid "DESCRIPTION"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:26
+#: ../src/guestfs.pod:25
msgid ""
"Libguestfs is a library for accessing and modifying guest disk images. "
"Amongst the things this is good for: making batch configuration changes to "
@@ -86,7 +85,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:34
+#: ../src/guestfs.pod:33
msgid ""
"Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
"filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
@@ -95,7 +94,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:39
+#: ../src/guestfs.pod:38
msgid ""
"Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
"what filesystem is in each LV, etc.). It can also run commands in the "
@@ -103,7 +102,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:44
+#: ../src/guestfs.pod:43
msgid ""
"Libguestfs is a library that can be linked with C and C++ management "
"programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
@@ -112,33 +111,33 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:49
+#: ../src/guestfs.pod:48
msgid ""
"You don't need to be root to use libguestfs, although obviously you do need "
"enough permissions to access the disk images."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:52
+#: ../src/guestfs.pod:51
msgid ""
"Libguestfs is a large API because it can do many things. For a gentle "
"introduction, please read the L</API OVERVIEW> section next."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:55
+#: ../src/guestfs.pod:54
msgid ""
"There are also some example programs in the L<guestfs-examples(3)> manual "
"page."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:58
+#: ../src/guestfs.pod:57
msgid "API OVERVIEW"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:60
+#: ../src/guestfs.pod:59
msgid ""
"This section provides a gentler overview of the libguestfs API. We also try "
"to group API calls together, where that may not be obvious from reading "
@@ -146,12 +145,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:65
+#: ../src/guestfs.pod:64
msgid "HANDLES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:67
+#: ../src/guestfs.pod:66
msgid ""
"Before you can use libguestfs calls, you have to create a handle. Then you "
"must add at least one disk image to the handle, followed by launching the "
@@ -161,12 +160,12 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:74
+#: ../src/guestfs.pod:73
msgid "The general structure of all libguestfs-using programs looks like this:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:77
+#: ../src/guestfs.pod:76
#, no-wrap
msgid ""
" guestfs_h *g = guestfs_create ();\n"
@@ -174,7 +173,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:79
+#: ../src/guestfs.pod:78
#, no-wrap
msgid ""
" /* Call guestfs_add_drive additional times if there are\n"
@@ -185,7 +184,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:84
+#: ../src/guestfs.pod:83
#, no-wrap
msgid ""
" /* Most manipulation calls won't work until you've launched\n"
@@ -197,7 +196,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:90
+#: ../src/guestfs.pod:89
#, no-wrap
msgid ""
" /* Now you can examine what partitions, LVs etc are available.\n"
@@ -208,7 +207,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:95
+#: ../src/guestfs.pod:94
#, no-wrap
msgid ""
" /* To access a filesystem in the image, you must mount it.\n"
@@ -218,31 +217,30 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:99
+#: ../src/guestfs.pod:98
#, no-wrap
msgid ""
" /* Now you can perform filesystem actions on the guest\n"
" * disk image.\n"
" */\n"
" guestfs_touch (g, \"/hello\");\n"
-" \n"
+"\n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:104
+#: ../src/guestfs.pod:103
#, no-wrap
msgid ""
-" /* You only need to call guestfs_sync if you have made\n"
-" * changes to the guest image. (But if you've made changes\n"
-" * then you *must* sync). See also: guestfs_umount and\n"
-" * guestfs_umount_all calls.\n"
+" /* This is only needed for libguestfs < 1.5.24. Since then\n"
+" * it is done automatically when you close the handle. See\n"
+" * discussion of autosync in this page.\n"
" */\n"
" guestfs_sync (g);\n"
" \n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:111
+#: ../src/guestfs.pod:109
#, no-wrap
msgid ""
" /* Close the handle 'g'. */\n"
@@ -251,23 +249,24 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:114
+#: ../src/guestfs.pod:112
msgid ""
"The code above doesn't include any error checking. In real code you should "
"check return values carefully for errors. In general all functions that "
"return integers return C<-1> on error, and all functions that return "
"pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
"how to handle errors, and consult the documentation for each function call "
-"below to see precisely how they return error indications."
+"below to see precisely how they return error indications. See "
+"L<guestfs-examples(3)> for fully worked examples."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:122
+#: ../src/guestfs.pod:121
msgid "DISK IMAGES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:124
+#: ../src/guestfs.pod:123
msgid ""
"The image filename (C<\"guest.img\"> in the example above) could be a disk "
"image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
@@ -277,7 +276,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:130
+#: ../src/guestfs.pod:129
msgid ""
"The call you should use in modern code for adding drives is "
"L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
@@ -285,7 +284,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:134
+#: ../src/guestfs.pod:133
#, no-wrap
msgid ""
" guestfs_add_drive_opts (g, filename,\n"
@@ -295,12 +294,12 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:138
+#: ../src/guestfs.pod:137
msgid "You can add a disk read-only using:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:140
+#: ../src/guestfs.pod:139
#, no-wrap
msgid ""
" guestfs_add_drive_opts (g, filename,\n"
@@ -311,14 +310,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:145
+#: ../src/guestfs.pod:144
msgid ""
"or by calling the older function L</guestfs_add_drive_ro>. In either case "
"libguestfs won't modify the file."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:148
+#: ../src/guestfs.pod:147
msgid ""
"Be extremely cautious if the disk image is in use, eg. if it is being used "
"by a virtual machine. Adding it read-write will almost certainly cause disk "
@@ -326,7 +325,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:152
+#: ../src/guestfs.pod:151
msgid ""
"You must add at least one disk image, and you may add multiple disk images. "
"In the API, the disk images are usually referred to as C</dev/sda> (for the "
@@ -334,7 +333,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:157
+#: ../src/guestfs.pod:156
msgid ""
"Once L</guestfs_launch> has been called you cannot add any more images. You "
"can call L</guestfs_list_devices> to get a list of the device names, in the "
@@ -342,12 +341,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:162
+#: ../src/guestfs.pod:161
msgid "MOUNTING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:164
+#: ../src/guestfs.pod:163
msgid ""
"Before you can read or write files, create directories and so on in a disk "
"image that contains filesystems, you have to mount those filesystems using "
@@ -357,7 +356,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:170
+#: ../src/guestfs.pod:169
#, no-wrap
msgid ""
" guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
@@ -365,7 +364,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:172
+#: ../src/guestfs.pod:171
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 "
@@ -373,7 +372,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:176
+#: ../src/guestfs.pod:175
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 "
@@ -386,19 +385,19 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:186
+#: ../src/guestfs.pod:185
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:189
+#: ../src/guestfs.pod:188
msgid "FILESYSTEM ACCESS AND MODIFICATION"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:191
+#: ../src/guestfs.pod:190
msgid ""
"The majority of the libguestfs API consists of fairly low-level calls for "
"accessing and modifying the files, directories, symlinks etc on mounted "
@@ -408,21 +407,21 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:197
+#: ../src/guestfs.pod:196
msgid ""
"Specify filenames as full paths, starting with C<\"/\"> and including the "
"mount point."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:200
+#: ../src/guestfs.pod:199
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:203
+#: ../src/guestfs.pod:202
#, no-wrap
msgid ""
" char *data = guestfs_cat (g, \"/etc/passwd\");\n"
@@ -430,7 +429,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:205
+#: ../src/guestfs.pod:204
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), "
@@ -438,14 +437,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:209
+#: ../src/guestfs.pod:208
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:212
+#: ../src/guestfs.pod:211
#, no-wrap
msgid ""
" guestfs_mkdir (g, \"/var\");\n"
@@ -453,12 +452,12 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:214
+#: ../src/guestfs.pod:213
msgid "To create a symlink you could do:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:216
+#: ../src/guestfs.pod:215
#, no-wrap
msgid ""
" guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
@@ -467,14 +466,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:219
+#: ../src/guestfs.pod:218
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:222
+#: ../src/guestfs.pod:221
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 "
@@ -484,33 +483,33 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:228
+#: ../src/guestfs.pod:227
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:231
+#: ../src/guestfs.pod:230
msgid "PARTITIONING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:233
+#: ../src/guestfs.pod:232
msgid ""
"Libguestfs contains API calls to read, create and modify partition tables on "
"disk images."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:236
+#: ../src/guestfs.pod:235
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:240
+#: ../src/guestfs.pod:239
#, no-wrap
msgid ""
" const char *parttype = \"mbr\";\n"
@@ -521,19 +520,19 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:245
+#: ../src/guestfs.pod:244
msgid ""
"Obviously this effectively wipes anything that was on that disk image "
"before."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:248
+#: ../src/guestfs.pod:247
msgid "LVM2"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:250
+#: ../src/guestfs.pod:249
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 "
@@ -542,19 +541,19 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:255
+#: ../src/guestfs.pod:254
msgid ""
"This author strongly recommends reading the LVM HOWTO, online at "
"L<http://tldp.org/HOWTO/LVM-HOWTO/>."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:258
+#: ../src/guestfs.pod:257
msgid "DOWNLOADING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:260
+#: ../src/guestfs.pod:259
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 "
@@ -562,7 +561,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:265
+#: ../src/guestfs.pod:264
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 "
@@ -570,31 +569,31 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:269
+#: ../src/guestfs.pod:268
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:272
+#: ../src/guestfs.pod:271
msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:275
+#: ../src/guestfs.pod:274
msgid "UPLOADING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:277
+#: ../src/guestfs.pod:276
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:280
+#: ../src/guestfs.pod:279
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 "
@@ -604,19 +603,19 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:286
+#: ../src/guestfs.pod:285
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:289
+#: ../src/guestfs.pod:288
msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:291
+#: ../src/guestfs.pod:290
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 "
@@ -630,12 +629,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:302
+#: ../src/guestfs.pod:301
msgid "COPYING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:304
+#: ../src/guestfs.pod:303
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 "
@@ -643,36 +642,36 @@ msgid ""
msgstr ""
# type: =item
-#: ../src/guestfs.pod:310
+#: ../src/guestfs.pod:309
msgid "B<file> to B<file>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:312
+#: ../src/guestfs.pod:311
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:315
+#: ../src/guestfs.pod:314
msgid "B<file or device> to B<file or device>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:317
+#: ../src/guestfs.pod:316
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:320
+#: ../src/guestfs.pod:319
msgid "Example: duplicate the contents of an LV:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:322
+#: ../src/guestfs.pod:321
#, no-wrap
msgid ""
" guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
@@ -680,7 +679,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:324
+#: ../src/guestfs.pod:323
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 "
@@ -688,46 +687,46 @@ msgid ""
msgstr ""
# type: =item
-#: ../src/guestfs.pod:328
+#: ../src/guestfs.pod:327
msgid "B<file on the host> to B<file or device>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:330
+#: ../src/guestfs.pod:329
msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:332
+#: ../src/guestfs.pod:331
msgid "B<file or device> to B<file on the host>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:334
+#: ../src/guestfs.pod:333
msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:338
+#: ../src/guestfs.pod:337
msgid "LISTING FILES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:340
+#: ../src/guestfs.pod:339
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:343
+#: ../src/guestfs.pod:342
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:346
+#: ../src/guestfs.pod:345
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 "
@@ -735,19 +734,19 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:350
+#: ../src/guestfs.pod:349
msgid ""
"L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
"files."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:353
+#: ../src/guestfs.pod:352
msgid "RUNNING COMMANDS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:355
+#: ../src/guestfs.pod:354
msgid ""
"Although libguestfs is primarily an API for manipulating files inside guest "
"images, we also provide some limited facilities for running commands inside "
@@ -755,60 +754,60 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:359
+#: ../src/guestfs.pod:358
msgid "There are many limitations to this:"
msgstr ""
# type: =item
-#: ../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:2007 ../src/guestfs.pod:2013 ../src/guestfs.pod:2018 ../src/guestfs.pod:2024 ../src/guestfs.pod:2136 ../src/guestfs.pod:2140 ../src/guestfs.pod:2144 ../src/guestfs.pod:2148 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:579 ../src/guestfs-actions.pod:586 ../src/guestfs-actions.pod:593 ../src/guestfs-actions.pod:1589 ../src/guestfs-actions.pod:1593 ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1613 ../src/guestfs-actions.pod:1617 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1635 ../src/guestfs-actions.pod:1773 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1787 ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1852 ../src/guestfs-actions.pod:1857 ../fish/guestfish.pod: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-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
+#: ../src/guestfs.pod:362 ../src/guestfs.pod:367 ../src/guestfs.pod:372 ../src/guestfs.pod:376 ../src/guestfs.pod:381 ../src/guestfs.pod:385 ../src/guestfs.pod:390 ../src/guestfs.pod:395 ../src/guestfs.pod:954 ../src/guestfs.pod:958 ../src/guestfs.pod:962 ../src/guestfs.pod:967 ../src/guestfs.pod:975 ../src/guestfs.pod:994 ../src/guestfs.pod:1002 ../src/guestfs.pod:1024 ../src/guestfs.pod:1028 ../src/guestfs.pod:1032 ../src/guestfs.pod:1036 ../src/guestfs.pod:1040 ../src/guestfs.pod:1044 ../src/guestfs.pod:1526 ../src/guestfs.pod:1531 ../src/guestfs.pod:1535 ../src/guestfs.pod:1645 ../src/guestfs.pod:1650 ../src/guestfs.pod:1654 ../src/guestfs.pod:2006 ../src/guestfs.pod:2012 ../src/guestfs.pod:2017 ../src/guestfs.pod:2023 ../src/guestfs.pod:2135 ../src/guestfs.pod:2139 ../src/guestfs.pod:2143 ../src/guestfs.pod:2147 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:579 ../src/guestfs-actions.pod:586 ../src/guestfs-actions.pod:593 ../src/guestfs-actions.pod:1589 ../src/guestfs-actions.pod:1593 ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1613 ../src/guestfs-actions.pod:1617 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1635 ../src/guestfs-actions.pod:1773 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1787 ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1852 ../src/guestfs-actions.pod:1857 ../fish/guestfish.pod: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-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
msgid "*"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:365
+#: ../src/guestfs.pod:364
msgid ""
"The kernel version that the command runs under will be different from what "
"it expects."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:370
+#: ../src/guestfs.pod:369
msgid ""
"If the command needs to communicate with daemons, then most likely they "
"won't be running."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:375
+#: ../src/guestfs.pod:374
msgid "The command will be running in limited memory."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:379
+#: ../src/guestfs.pod:378
msgid ""
"The network may not be available unless you enable it (see "
"L</guestfs_set_network>)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:384
+#: ../src/guestfs.pod:383
msgid "Only supports Linux guests (not Windows, BSD, etc)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:388
+#: ../src/guestfs.pod:387
msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:393
+#: ../src/guestfs.pod:392
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:398
+#: ../src/guestfs.pod:397
msgid ""
"I<Security:> It is not safe to run commands from untrusted, possibly "
"malicious guests. These commands may attempt to exploit your program by "
@@ -820,7 +819,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:407
+#: ../src/guestfs.pod:406
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 "
@@ -830,26 +829,26 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:415
+#: ../src/guestfs.pod:414
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:418
+#: ../src/guestfs.pod:417
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:421
+#: ../src/guestfs.pod:420
msgid "CONFIGURATION FILES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:423
+#: ../src/guestfs.pod:422
msgid ""
"To read and write configuration files in Linux guest filesystems, we "
"strongly recommend using Augeas. For example, Augeas understands how to "
@@ -858,7 +857,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:428
+#: ../src/guestfs.pod:427
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 "
@@ -866,7 +865,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:432
+#: ../src/guestfs.pod:431
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 "
@@ -874,29 +873,29 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:436
+#: ../src/guestfs.pod:435
msgid "SELINUX"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:438
+#: ../src/guestfs.pod:437
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:444 ../src/guestfs.pod:1148 ../src/guestfs.pod:1279
+#: ../src/guestfs.pod:443 ../src/guestfs.pod:1147 ../src/guestfs.pod:1278
msgid "1."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:446
+#: ../src/guestfs.pod:445
msgid "Before launching, do:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:448
+#: ../src/guestfs.pod:447
#, no-wrap
msgid ""
" guestfs_set_selinux (g, 1);\n"
@@ -904,19 +903,19 @@ msgid ""
msgstr ""
# type: =item
-#: ../src/guestfs.pod:450 ../src/guestfs.pod:1152 ../src/guestfs.pod:1283
+#: ../src/guestfs.pod:449 ../src/guestfs.pod:1151 ../src/guestfs.pod:1282
msgid "2."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:452
+#: ../src/guestfs.pod:451
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:456
+#: ../src/guestfs.pod:455
#, no-wrap
msgid ""
" guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
@@ -924,26 +923,26 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:458
+#: ../src/guestfs.pod:457
msgid ""
"(Older versions of C<load_policy> require you to specify the name of the "
"policy file)."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:461 ../src/guestfs.pod:1289
+#: ../src/guestfs.pod:460 ../src/guestfs.pod:1288
msgid "3."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:463
+#: ../src/guestfs.pod:462
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:467
+#: ../src/guestfs.pod:466
#, no-wrap
msgid ""
" guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
@@ -951,24 +950,24 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:471
+#: ../src/guestfs.pod:470
msgid "This will work for running commands and editing existing files."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:473
+#: ../src/guestfs.pod:472
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:477
+#: ../src/guestfs.pod:476
msgid "UMASK"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:479
+#: ../src/guestfs.pod:478
msgid ""
"Certain calls are affected by the current file mode creation mask (the "
"\"umask\"). In particular ones which create files or directories, such as "
@@ -978,14 +977,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:485
+#: ../src/guestfs.pod:484
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:488
+#: ../src/guestfs.pod:487
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 "
@@ -993,17 +992,17 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:492
+#: ../src/guestfs.pod:491
msgid "For more information about umask, see L<umask(2)>."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:494 ../fish/guestfish.pod:670
+#: ../src/guestfs.pod:493 ../fish/guestfish.pod:670
msgid "ENCRYPTED DISKS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:496
+#: ../src/guestfs.pod:495
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) "
@@ -1012,21 +1011,21 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:502
+#: ../src/guestfs.pod:501
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:505
+#: ../src/guestfs.pod:504
msgid ""
"Then open these devices by calling L</guestfs_luks_open>. Obviously you "
"will require the passphrase!"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:508
+#: ../src/guestfs.pod:507
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 "
@@ -1035,7 +1034,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:514
+#: ../src/guestfs.pod:513
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 "
@@ -1043,7 +1042,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:518
+#: ../src/guestfs.pod:517
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, "
@@ -1053,12 +1052,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:525
+#: ../src/guestfs.pod:524
msgid "INSPECTION"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:527
+#: ../src/guestfs.pod:526
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 "
@@ -1068,14 +1067,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:533
+#: ../src/guestfs.pod:532
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:536
+#: ../src/guestfs.pod:535
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 "
@@ -1088,7 +1087,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:545
+#: ../src/guestfs.pod:544
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 "
@@ -1097,7 +1096,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:551
+#: ../src/guestfs.pod:550
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 "
@@ -1108,7 +1107,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:558
+#: ../src/guestfs.pod:557
#, no-wrap
msgid ""
" /boot => /dev/sda1\n"
@@ -1118,14 +1117,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:562
+#: ../src/guestfs.pod:561
msgid ""
"The caller can then make calls to L</guestfs_mount_options> to mount the "
"filesystems as suggested."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:565
+#: ../src/guestfs.pod:564
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 "
@@ -1133,7 +1132,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:569
+#: ../src/guestfs.pod:568
msgid ""
"Inspection currently only works for some common operating systems. "
"Contributors are welcome to send patches for other operating systems that we "
@@ -1141,7 +1140,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:573
+#: ../src/guestfs.pod:572
msgid ""
"Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
"for more details. The L</guestfs_inspect_os> function just ignores any "
@@ -1149,7 +1148,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:577
+#: ../src/guestfs.pod:576
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 "
@@ -1162,19 +1161,19 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:586
+#: ../src/guestfs.pod:585
msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:588
+#: ../src/guestfs.pod:587
msgid ""
"Libguestfs can mount NTFS partitions. It does this using the "
"L<http://www.ntfs-3g.org/> driver."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:591
+#: ../src/guestfs.pod:590
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 "
@@ -1184,7 +1183,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:597
+#: ../src/guestfs.pod:596
msgid ""
"Drive letter mappings are outside the scope of libguestfs. You have to use "
"libguestfs to read the appropriate Windows Registry and configuration files, "
@@ -1193,21 +1192,21 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:602
+#: ../src/guestfs.pod:601
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:605
+#: ../src/guestfs.pod:604
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:608
+#: ../src/guestfs.pod:607
msgid ""
"Libguestfs also provides some help for decoding Windows Registry \"hive\" "
"files, through the library C<hivex> which is part of the libguestfs project "
@@ -1218,19 +1217,19 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:616
+#: ../src/guestfs.pod:615
msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:618
+#: ../src/guestfs.pod:617
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:621
+#: ../src/guestfs.pod:620
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, "
@@ -1239,14 +1238,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:627
+#: ../src/guestfs.pod:626
msgid ""
"Error messages are automatically transformed into exceptions if the language "
"supports it."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:630
+#: ../src/guestfs.pod:629
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 "
@@ -1254,36 +1253,36 @@ msgid ""
msgstr ""
# type: =item
-#: ../src/guestfs.pod:636
+#: ../src/guestfs.pod:635
msgid "B<C++>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:638
+#: ../src/guestfs.pod:637
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:642
+#: ../src/guestfs.pod:641
msgid "B<C#>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:644
+#: ../src/guestfs.pod:643
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:647
+#: ../src/guestfs.pod:646
msgid "B<Haskell>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:649
+#: ../src/guestfs.pod:648
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 "
@@ -1291,91 +1290,91 @@ msgid ""
msgstr ""
# type: =item
-#: ../src/guestfs.pod:653
+#: ../src/guestfs.pod:652
msgid "B<Java>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:655
+#: ../src/guestfs.pod:654
msgid ""
"Full documentation is contained in the Javadoc which is distributed with "
"libguestfs."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:658
+#: ../src/guestfs.pod:657
msgid "B<OCaml>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:660
+#: ../src/guestfs.pod:659
msgid "For documentation see L<guestfs-ocaml(3)>."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:662
+#: ../src/guestfs.pod:661
msgid "B<Perl>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:664
+#: ../src/guestfs.pod:663
msgid "For documentation see L<Sys::Guestfs(3)>."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:666
+#: ../src/guestfs.pod:665
msgid "B<PHP>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:668
+#: ../src/guestfs.pod:667
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:671
+#: ../src/guestfs.pod:670
msgid "The PHP binding only works correctly on 64 bit machines."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:673
+#: ../src/guestfs.pod:672
msgid "B<Python>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:675
+#: ../src/guestfs.pod:674
msgid "For documentation see L<guestfs-python(3)>."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:677
+#: ../src/guestfs.pod:676
msgid "B<Ruby>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:679
+#: ../src/guestfs.pod:678
msgid "For documentation see L<guestfs-ruby(3)>."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:681
+#: ../src/guestfs.pod:680
msgid "B<shell scripts>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:683
+#: ../src/guestfs.pod:682
msgid "For documentation see L<guestfish(1)>."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:687
+#: ../src/guestfs.pod:686
msgid "LIBGUESTFS GOTCHAS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:689
+#: ../src/guestfs.pod:688
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 "
@@ -1383,7 +1382,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:693
+#: ../src/guestfs.pod:692
msgid ""
"Since we developed libguestfs and the associated tools, there are several "
"things we would have designed differently, but are now stuck with for "
@@ -1392,12 +1391,12 @@ msgid ""
msgstr ""
# type: =item
-#: ../src/guestfs.pod:701
+#: ../src/guestfs.pod:700
msgid "Autosync / forgetting to sync."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:703
+#: ../src/guestfs.pod:702
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 "
@@ -1405,7 +1404,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:707
+#: ../src/guestfs.pod:706
#, no-wrap
msgid ""
" guestfs_set_autosync (g, 1);\n"
@@ -1413,7 +1412,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:709
+#: ../src/guestfs.pod:708
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> "
@@ -1421,7 +1420,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:713
+#: ../src/guestfs.pod:712
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 "
@@ -1429,7 +1428,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:717
+#: ../src/guestfs.pod:716
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 "
@@ -1437,19 +1436,19 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:721
+#: ../src/guestfs.pod:720
msgid ""
"Update: Autosync is enabled by default for all API users starting from "
"libguestfs 1.5.24."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:724
+#: ../src/guestfs.pod:723
msgid "Mount option C<-o sync> should not be the default."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:726
+#: ../src/guestfs.pod:725
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 "
@@ -1457,31 +1456,31 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:730
+#: ../src/guestfs.pod:729
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:733
+#: ../src/guestfs.pod:732
msgid "Read-only should be the default."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:735
+#: ../src/guestfs.pod:734
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:738
+#: ../src/guestfs.pod:737
msgid "This would reduce the potential to corrupt live VM images."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:740
+#: ../src/guestfs.pod:739
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 "
@@ -1489,12 +1488,12 @@ msgid ""
msgstr ""
# type: =item
-#: ../src/guestfs.pod:744
+#: ../src/guestfs.pod:743
msgid "guestfish command line is hard to use."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:746
+#: ../src/guestfs.pod:745
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 "
@@ -1504,12 +1503,12 @@ msgid ""
msgstr ""
# type: =item
-#: ../src/guestfs.pod:753
+#: ../src/guestfs.pod:752
msgid "guestfish megabyte modifiers don't work right on all commands"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:755
+#: ../src/guestfs.pod:754
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 "
@@ -1519,12 +1518,12 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:762
+#: ../src/guestfs.pod:761
msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:764
+#: ../src/guestfs.pod:763
#, no-wrap
msgid ""
" lvcreate LV VG 100M\n"
@@ -1532,7 +1531,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:766
+#: ../src/guestfs.pod:765
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 "
@@ -1541,19 +1540,19 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:771
+#: ../src/guestfs.pod:770
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:774
+#: ../src/guestfs.pod:773
msgid "Ambiguity between devices and paths"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:776
+#: ../src/guestfs.pod:775
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 "
@@ -1561,7 +1560,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:781
+#: ../src/guestfs.pod:780
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>. "
@@ -1570,7 +1569,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:787
+#: ../src/guestfs.pod:786
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 "
@@ -1580,7 +1579,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:793
+#: ../src/guestfs.pod:792
#, no-wrap
msgid ""
" type path = Path of string | Device of int | Partition of int * int\n"
@@ -1588,12 +1587,12 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:795
+#: ../src/guestfs.pod:794
msgid "which would allow you to pass arguments like:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:797
+#: ../src/guestfs.pod:796
#, no-wrap
msgid ""
" Path \"/foo/bar\"\n"
@@ -1604,19 +1603,19 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:802
+#: ../src/guestfs.pod:801
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:807
+#: ../src/guestfs.pod:806
msgid "PROTOCOL LIMITS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:809
+#: ../src/guestfs.pod:808
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 "
@@ -1627,7 +1626,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:817
+#: ../src/guestfs.pod:816
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 "
@@ -1636,7 +1635,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:823
+#: ../src/guestfs.pod:822
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> "
@@ -1644,26 +1643,26 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:827
+#: ../src/guestfs.pod:826
msgid ""
"You might also consider mounting the disk image using our FUSE filesystem "
"support (L<guestmount(1)>)."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:830
+#: ../src/guestfs.pod:829
msgid "KEYS AND PASSPHRASES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:832
+#: ../src/guestfs.pod:831
msgid ""
"Certain libguestfs calls take a parameter that contains sensitive key "
"material, passed in as a C string."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:835
+#: ../src/guestfs.pod:834
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 "
@@ -1672,7 +1671,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:840
+#: ../src/guestfs.pod:839
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, "
@@ -1680,19 +1679,19 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:845
+#: ../src/guestfs.pod:844
msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:847
+#: ../src/guestfs.pod:846
msgid ""
"All high-level libguestfs actions are synchronous. If you want to use "
"libguestfs asynchronously then you must create a thread."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:850
+#: ../src/guestfs.pod:849
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 "
@@ -1700,33 +1699,33 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:854
+#: ../src/guestfs.pod:853
msgid ""
"See the graphical program guestfs-browser for one possible architecture for "
"multithreaded programs using libvirt and libguestfs."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:857
+#: ../src/guestfs.pod:856
msgid "PATH"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:859
+#: ../src/guestfs.pod:858
msgid ""
"Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
"internal path."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:862
+#: ../src/guestfs.pod:861
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:865
+#: ../src/guestfs.pod:864
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 "
@@ -1737,12 +1736,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:872
+#: ../src/guestfs.pod:871
msgid "QEMU WRAPPERS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:874
+#: ../src/guestfs.pod:873
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 "
@@ -1750,7 +1749,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:878
+#: ../src/guestfs.pod:877
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 "
@@ -1759,14 +1758,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:883
+#: ../src/guestfs.pod:882
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:886
+#: ../src/guestfs.pod:885
#, no-wrap
msgid ""
" #!/bin/sh -\n"
@@ -1777,7 +1776,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:890
+#: ../src/guestfs.pod:889
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 "
@@ -1785,7 +1784,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:894
+#: ../src/guestfs.pod:893
#, no-wrap
msgid ""
" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
@@ -1793,19 +1792,19 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:896
+#: ../src/guestfs.pod:895
msgid ""
"Note that libguestfs also calls qemu with the -help and -version options in "
"order to determine features."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:899
+#: ../src/guestfs.pod:898
msgid "ABI GUARANTEE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:901
+#: ../src/guestfs.pod:900
msgid ""
"We guarantee the libguestfs ABI (binary interface), for public, high-level "
"actions as outlined in this section. Although we will deprecate some "
@@ -1815,12 +1814,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:907
+#: ../src/guestfs.pod:906
msgid "BLOCK DEVICE NAMING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:909
+#: ../src/guestfs.pod:908
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 "
@@ -1835,7 +1834,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:921
+#: ../src/guestfs.pod:920
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 "
@@ -1843,7 +1842,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:925
+#: ../src/guestfs.pod:924
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 "
@@ -1851,7 +1850,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:930
+#: ../src/guestfs.pod:929
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 "
@@ -1860,7 +1859,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:936
+#: ../src/guestfs.pod:935
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 "
@@ -1868,12 +1867,12 @@ msgid ""
msgstr ""
# type: =head3
-#: ../src/guestfs.pod:941
+#: ../src/guestfs.pod:940
msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:943
+#: ../src/guestfs.pod:942
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 "
@@ -1883,7 +1882,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:949
+#: ../src/guestfs.pod:948
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 "
@@ -1891,54 +1890,54 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:957
+#: ../src/guestfs.pod:956
msgid "Is the string a parameter which is a device or partition name?"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:961
+#: ../src/guestfs.pod:960
msgid "Does the string begin with C</dev/sd>?"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:965
+#: ../src/guestfs.pod:964
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:970
+#: ../src/guestfs.pod:969
msgid "Replace initial C</dev/sd> string with C</dev/hd>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:972
+#: ../src/guestfs.pod:971
msgid "For example, change C</dev/sda2> to C</dev/hda2>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:974
+#: ../src/guestfs.pod:973
msgid "If that named device exists, use it. If not, continue."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:978
+#: ../src/guestfs.pod:977
msgid "Replace initial C</dev/sd> string with C</dev/vd>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:980
+#: ../src/guestfs.pod:979
msgid "If that named device exists, use it. If not, return an error."
msgstr ""
# type: =head3
-#: ../src/guestfs.pod:984
+#: ../src/guestfs.pod:983
msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:986
+#: ../src/guestfs.pod:985
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 "
@@ -1946,50 +1945,50 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:990
+#: ../src/guestfs.pod:989
msgid ""
"Where possible for maximum future portability programs using libguestfs "
"should use these future-proof techniques:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:997
+#: ../src/guestfs.pod:996
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:1000
+#: ../src/guestfs.pod:999
msgid "Since those device names exist by definition, they will never be translated."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1005
+#: ../src/guestfs.pod:1004
msgid ""
"Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
"filesystem labels."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1010
+#: ../src/guestfs.pod:1009
msgid "SECURITY"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1012
+#: ../src/guestfs.pod:1011
msgid ""
"This section discusses security implications of using libguestfs, "
"particularly with untrusted or malicious guests or disk images."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1015
+#: ../src/guestfs.pod:1014
msgid "GENERAL SECURITY CONSIDERATIONS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1017
+#: ../src/guestfs.pod:1016
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 "
@@ -1999,42 +1998,42 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1027
+#: ../src/guestfs.pod:1026
msgid "the data (file etc) not being present"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1031
+#: ../src/guestfs.pod:1030
msgid "being present but empty"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1035
+#: ../src/guestfs.pod:1034
msgid "being much larger than normal"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1039
+#: ../src/guestfs.pod:1038
msgid "containing arbitrary 8 bit data"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1043
+#: ../src/guestfs.pod:1042
msgid "being in an unexpected character encoding"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1047
+#: ../src/guestfs.pod:1046
msgid "containing homoglyphs."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1051
+#: ../src/guestfs.pod:1050
msgid "SECURITY OF MOUNTING FILESYSTEMS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1053
+#: ../src/guestfs.pod:1052
msgid ""
"When you mount a filesystem under Linux, mistakes in the kernel filesystem "
"(VFS) module can sometimes be escalated into exploits by deliberately "
@@ -2050,7 +2049,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1066
+#: ../src/guestfs.pod:1065
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 "
@@ -2064,19 +2063,19 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1077
+#: ../src/guestfs.pod:1076
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:1080
+#: ../src/guestfs.pod:1079
msgid "PROTOCOL SECURITY"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1082
+#: ../src/guestfs.pod:1081
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 "
@@ -2086,12 +2085,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1088
+#: ../src/guestfs.pod:1087
msgid "INSPECTION SECURITY"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1090
+#: ../src/guestfs.pod:1089
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 "
@@ -2100,7 +2099,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1096
+#: ../src/guestfs.pod:1095
msgid ""
"Guest configuration may be altered in unusual ways by the administrator of "
"the virtual machine, and may not reflect reality (particularly for untrusted "
@@ -2111,7 +2110,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1104
+#: ../src/guestfs.pod:1103
msgid ""
"The inspection API parses guest configuration using two external libraries: "
"Augeas (Linux configuration) and hivex (Windows Registry). Both are "
@@ -2121,12 +2120,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1110
+#: ../src/guestfs.pod:1109
msgid "RUNNING UNTRUSTED GUEST COMMANDS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1112
+#: ../src/guestfs.pod:1111
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 "
@@ -2136,24 +2135,24 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1118
+#: ../src/guestfs.pod:1117
msgid "CVE-2010-3851"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1120
+#: ../src/guestfs.pod:1119
msgid "https://bugzilla.redhat.com/642934"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1122
+#: ../src/guestfs.pod:1121
msgid ""
"This security bug concerns the automatic disk format detection that qemu "
"does on disk images."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1125
+#: ../src/guestfs.pod:1124
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 "
@@ -2162,7 +2161,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1130
+#: ../src/guestfs.pod:1129
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 "
@@ -2171,7 +2170,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1135
+#: ../src/guestfs.pod:1134
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 "
@@ -2183,24 +2182,24 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1143
+#: ../src/guestfs.pod:1142
msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1150
+#: ../src/guestfs.pod:1149
msgid "You have enabled the network or have opened the disk in write mode."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1154
+#: ../src/guestfs.pod:1153
msgid ""
"You are also running untrusted code from the guest (see L</RUNNING "
"COMMANDS>)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1159
+#: ../src/guestfs.pod:1158
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 "
@@ -2209,31 +2208,31 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1164
+#: ../src/guestfs.pod:1163
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:1167
+#: ../src/guestfs.pod:1166
msgid ""
"For libguestfs tools, use the I<--format> command line parameter as "
"appropriate."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1170
+#: ../src/guestfs.pod:1169
msgid "CONNECTION MANAGEMENT"
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1172
+#: ../src/guestfs.pod:1171
msgid "guestfs_h *"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1174
+#: ../src/guestfs.pod:1173
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 "
@@ -2241,19 +2240,19 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1178
+#: ../src/guestfs.pod:1177
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:1181
+#: ../src/guestfs.pod:1180
msgid "guestfs_create"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1183
+#: ../src/guestfs.pod:1182
#, no-wrap
msgid ""
" guestfs_h *guestfs_create (void);\n"
@@ -2261,43 +2260,43 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1185
+#: ../src/guestfs.pod:1184
msgid "Create a connection handle."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1187
+#: ../src/guestfs.pod:1186
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:1190
+#: ../src/guestfs.pod:1189
msgid ""
"This function returns a non-NULL pointer to a handle on success or NULL on "
"error."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1193
+#: ../src/guestfs.pod:1192
msgid "After configuring the handle, you have to call L</guestfs_launch>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1195
+#: ../src/guestfs.pod:1194
msgid ""
"You may also want to configure error handling for the handle. See L</ERROR "
"HANDLING> section below."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1198
+#: ../src/guestfs.pod:1197
msgid "guestfs_close"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1200
+#: ../src/guestfs.pod:1199
#, no-wrap
msgid ""
" void guestfs_close (guestfs_h *g);\n"
@@ -2305,24 +2304,24 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1202
+#: ../src/guestfs.pod:1201
msgid "This closes the connection handle and frees up all resources used."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1204
+#: ../src/guestfs.pod:1203
msgid "ERROR HANDLING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1206
+#: ../src/guestfs.pod:1205
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:1209
+#: ../src/guestfs.pod:1208
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 "
@@ -2330,7 +2329,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1213
+#: ../src/guestfs.pod:1212
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 "
@@ -2338,7 +2337,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1218
+#: ../src/guestfs.pod:1217
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 "
@@ -2346,7 +2345,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1222
+#: ../src/guestfs.pod:1221
#, no-wrap
msgid ""
" if (guestfs_launch (g) == -1)\n"
@@ -2355,21 +2354,21 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1225
+#: ../src/guestfs.pod:1224
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:1228
+#: ../src/guestfs.pod:1227
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:1231
+#: ../src/guestfs.pod:1230
#, no-wrap
msgid ""
" g = guestfs_create ();\n"
@@ -2377,7 +2376,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1233
+#: ../src/guestfs.pod:1232
#, no-wrap
msgid ""
" /* This disables the default behaviour of printing errors\n"
@@ -2387,7 +2386,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1237
+#: ../src/guestfs.pod:1236
#, no-wrap
msgid ""
" if (guestfs_launch (g) == -1) {\n"
@@ -2401,7 +2400,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1245
+#: ../src/guestfs.pod:1244
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 "
@@ -2409,7 +2408,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1249
+#: ../src/guestfs.pod:1248
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 "
@@ -2419,12 +2418,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1255
+#: ../src/guestfs.pod:1254
msgid "guestfs_last_error"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1257
+#: ../src/guestfs.pod:1256
#, no-wrap
msgid ""
" const char *guestfs_last_error (guestfs_h *g);\n"
@@ -2432,26 +2431,26 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1259
+#: ../src/guestfs.pod:1258
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:1263
+#: ../src/guestfs.pod:1262
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:1266
+#: ../src/guestfs.pod:1265
msgid "guestfs_last_errno"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1268
+#: ../src/guestfs.pod:1267
#, no-wrap
msgid ""
" int guestfs_last_errno (guestfs_h *g);\n"
@@ -2459,27 +2458,27 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1270
+#: ../src/guestfs.pod:1269
msgid "This returns the last error number (errno) that happened on C<g>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1272
+#: ../src/guestfs.pod:1271
msgid "If successful, an errno integer not equal to zero is returned."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1274
+#: ../src/guestfs.pod:1273
msgid "If no error, this returns 0. This call can return 0 in three situations:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1281
+#: ../src/guestfs.pod:1280
msgid "There has not been any error on the handle."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1285
+#: ../src/guestfs.pod:1284
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 "
@@ -2487,14 +2486,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1291
+#: ../src/guestfs.pod:1290
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:1297
+#: ../src/guestfs.pod:1296
msgid ""
"Libguestfs tries to convert the errno from inside the applicance into a "
"corresponding errno for the caller (not entirely trivial: the appliance "
@@ -2505,12 +2504,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1305
+#: ../src/guestfs.pod:1304
msgid "guestfs_set_error_handler"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1307
+#: ../src/guestfs.pod:1306
#, no-wrap
msgid ""
" typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
@@ -2523,7 +2522,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1314
+#: ../src/guestfs.pod:1313
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 "
@@ -2531,14 +2530,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1318
+#: ../src/guestfs.pod:1317
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:1321
+#: ../src/guestfs.pod:1320
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 "
@@ -2546,22 +2545,22 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1325
+#: ../src/guestfs.pod:1324
msgid "The default handler prints messages on C<stderr>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1327
+#: ../src/guestfs.pod:1326
msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1329
+#: ../src/guestfs.pod:1328
msgid "guestfs_get_error_handler"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1331
+#: ../src/guestfs.pod:1330
#, no-wrap
msgid ""
" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
@@ -2570,17 +2569,17 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1334
+#: ../src/guestfs.pod:1333
msgid "Returns the current error handler callback."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1336
+#: ../src/guestfs.pod:1335
msgid "guestfs_set_out_of_memory_handler"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1338
+#: ../src/guestfs.pod:1337
#, no-wrap
msgid ""
" typedef void (*guestfs_abort_cb) (void);\n"
@@ -2590,29 +2589,29 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1342
+#: ../src/guestfs.pod:1341
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:1345
+#: ../src/guestfs.pod:1344
msgid "The default is to call L<abort(3)>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1347
+#: ../src/guestfs.pod:1346
msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1350
+#: ../src/guestfs.pod:1349
msgid "guestfs_get_out_of_memory_handler"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1352
+#: ../src/guestfs.pod:1351
#, no-wrap
msgid ""
" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
@@ -2620,42 +2619,42 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1354
+#: ../src/guestfs.pod:1353
msgid "This returns the current out of memory handler."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1356
+#: ../src/guestfs.pod:1355
msgid "API CALLS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1358 ../fish/guestfish.pod:908
+#: ../src/guestfs.pod:1357 ../fish/guestfish.pod:908
msgid "@ACTIONS@"
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1360
+#: ../src/guestfs.pod:1359
msgid "STRUCTURES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1362
+#: ../src/guestfs.pod:1361
msgid "@STRUCTS@"
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1364
+#: ../src/guestfs.pod:1363
msgid "AVAILABILITY"
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1366
+#: ../src/guestfs.pod:1365
msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1368
+#: ../src/guestfs.pod:1367
msgid ""
"Using L</guestfs_available> you can test availability of the following "
"groups of functions. This test queries the appliance to see if the "
@@ -2663,17 +2662,17 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1373
+#: ../src/guestfs.pod:1372
msgid "@AVAILABILITY@"
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1375
+#: ../src/guestfs.pod:1374
msgid "GUESTFISH supported COMMAND"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1377
+#: ../src/guestfs.pod:1376
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 "
@@ -2681,19 +2680,19 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1382
+#: ../src/guestfs.pod:1381
msgid "SINGLE CALLS AT COMPILE TIME"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1384
+#: ../src/guestfs.pod:1383
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:1387
+#: ../src/guestfs.pod:1386
#, no-wrap
msgid ""
" #define LIBGUESTFS_HAVE_DD 1\n"
@@ -2701,12 +2700,12 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1389
+#: ../src/guestfs.pod:1388
msgid "if L</guestfs_dd> is available."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1391
+#: ../src/guestfs.pod:1390
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 "
@@ -2714,7 +2713,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1396
+#: ../src/guestfs.pod:1395
#, no-wrap
msgid ""
" AC_CHECK_LIB([guestfs],[guestfs_create])\n"
@@ -2723,19 +2722,19 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1399
+#: ../src/guestfs.pod:1398
msgid ""
"which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
"in your program."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1402
+#: ../src/guestfs.pod:1401
msgid "SINGLE CALLS AT RUN TIME"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1404
+#: ../src/guestfs.pod:1403
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 "
@@ -2745,7 +2744,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1411
+#: ../src/guestfs.pod:1410
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 "
@@ -2753,7 +2752,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1415
+#: ../src/guestfs.pod:1414
#, no-wrap
msgid ""
" #include <stdio.h>\n"
@@ -2765,7 +2764,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1421
+#: ../src/guestfs.pod:1420
#, no-wrap
msgid ""
" main ()\n"
@@ -2777,7 +2776,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1427
+#: ../src/guestfs.pod:1426
#, no-wrap
msgid ""
" /* Test if the function guestfs_dd is really available. */\n"
@@ -2792,7 +2791,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1436
+#: ../src/guestfs.pod:1435
#, no-wrap
msgid ""
" if (!has_function)\n"
@@ -2811,7 +2810,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1449
+#: ../src/guestfs.pod:1448
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 "
@@ -2819,7 +2818,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1454
+#: ../src/guestfs.pod:1453
#, no-wrap
msgid ""
" Requires: libguestfs >= 1.0.80\n"
@@ -2827,12 +2826,12 @@ msgid ""
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1456
+#: ../src/guestfs.pod:1455
msgid "CALLS WITH OPTIONAL ARGUMENTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1458
+#: ../src/guestfs.pod:1457
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 "
@@ -2840,7 +2839,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1463
+#: ../src/guestfs.pod:1462
#, no-wrap
msgid ""
" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
@@ -2848,14 +2847,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1465
+#: ../src/guestfs.pod:1464
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:1468
+#: ../src/guestfs.pod:1467
#, no-wrap
msgid ""
" guestfs_add_drive_opts (g, filename, -1);\n"
@@ -2863,12 +2862,12 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1470
+#: ../src/guestfs.pod:1469
msgid "With a single optional argument:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1472
+#: ../src/guestfs.pod:1471
#, no-wrap
msgid ""
" guestfs_add_drive_opts (g, filename,\n"
@@ -2878,12 +2877,12 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1476
+#: ../src/guestfs.pod:1475
msgid "With two:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1478
+#: ../src/guestfs.pod:1477
#, no-wrap
msgid ""
" guestfs_add_drive_opts (g, filename,\n"
@@ -2894,19 +2893,19 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1483
+#: ../src/guestfs.pod:1482
msgid ""
"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
"happen!"
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1486
+#: ../src/guestfs.pod:1485
msgid "USING va_list FOR OPTIONAL ARGUMENTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1488
+#: ../src/guestfs.pod:1487
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 "
@@ -2914,7 +2913,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1492
+#: ../src/guestfs.pod:1491
#, no-wrap
msgid ""
" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
@@ -2923,12 +2922,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1495
+#: ../src/guestfs.pod:1494
msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1497
+#: ../src/guestfs.pod:1496
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 "
@@ -2938,7 +2937,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1503
+#: ../src/guestfs.pod:1502
#, no-wrap
msgid ""
" struct guestfs_add_drive_opts_argv {\n"
@@ -2953,12 +2952,12 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1512
+#: ../src/guestfs.pod:1511
msgid "You could call it like this:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1514
+#: ../src/guestfs.pod:1513
#, no-wrap
msgid ""
" struct guestfs_add_drive_opts_argv optargs = {\n"
@@ -2971,7 +2970,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1521
+#: ../src/guestfs.pod:1520
#, no-wrap
msgid ""
" guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
@@ -2979,34 +2978,34 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1523 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255
+#: ../src/guestfs.pod:1522 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255
msgid "Notes:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1529
+#: ../src/guestfs.pod:1528
msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1534
+#: ../src/guestfs.pod:1533
msgid "You do not need to fill in all fields of the structure."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1538
+#: ../src/guestfs.pod:1537
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:1543
+#: ../src/guestfs.pod:1542
msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1545
+#: ../src/guestfs.pod:1544
msgid ""
"In other languages, optional arguments are expressed in the way that is "
"natural for that language. We refer you to the language-specific "
@@ -3014,31 +3013,31 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1549
+#: ../src/guestfs.pod:1548
msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1551
+#: ../src/guestfs.pod:1550
msgid "SETTING CALLBACKS TO HANDLE EVENTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1553
+#: ../src/guestfs.pod:1552
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:1556
+#: ../src/guestfs.pod:1555
msgid ""
"Use the C<guestfs_set_*_callback> functions to set a callback for different "
"types of events."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1559
+#: ../src/guestfs.pod:1558
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 "
@@ -3047,12 +3046,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1564
+#: ../src/guestfs.pod:1563
msgid "guestfs_set_log_message_callback"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1566
+#: ../src/guestfs.pod:1565
#, no-wrap
msgid ""
" typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
@@ -3064,31 +3063,31 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1572
+#: ../src/guestfs.pod:1571
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:1575
+#: ../src/guestfs.pod:1574
msgid "Use this function to capture kernel messages and similar."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1577
+#: ../src/guestfs.pod:1576
msgid ""
"Normally there is no log message handler, and log messages are just "
"discarded."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1580
+#: ../src/guestfs.pod:1579
msgid "guestfs_set_subprocess_quit_callback"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1582
+#: ../src/guestfs.pod:1581
#, no-wrap
msgid ""
" typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
@@ -3099,7 +3098,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1587
+#: ../src/guestfs.pod:1586
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 "
@@ -3107,12 +3106,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1592
+#: ../src/guestfs.pod:1591
msgid "guestfs_set_launch_done_callback"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1594
+#: ../src/guestfs.pod:1593
#, no-wrap
msgid ""
" typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
@@ -3123,7 +3122,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1599
+#: ../src/guestfs.pod:1598
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 "
@@ -3131,12 +3130,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1603
+#: ../src/guestfs.pod:1602
msgid "guestfs_set_close_callback"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1605
+#: ../src/guestfs.pod:1604
#, no-wrap
msgid ""
" typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
@@ -3147,14 +3146,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1610
+#: ../src/guestfs.pod:1609
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:1613
+#: ../src/guestfs.pod:1612
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 "
@@ -3165,12 +3164,12 @@ msgid ""
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1621
+#: ../src/guestfs.pod:1620
msgid "guestfs_set_progress_callback"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1623
+#: ../src/guestfs.pod:1622
#, no-wrap
msgid ""
" typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
@@ -3183,7 +3182,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1630
+#: ../src/guestfs.pod:1629
msgid ""
"Some long-running operations can generate progress messages. If this "
"callback is registered, then it will be called each time a progress message "
@@ -3193,7 +3192,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1636
+#: ../src/guestfs.pod:1635
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 "
@@ -3202,31 +3201,31 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1642
+#: ../src/guestfs.pod:1641
msgid "The only defined and stable parts of the API are:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1648
+#: ../src/guestfs.pod:1647
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:1653
+#: ../src/guestfs.pod:1652
msgid "0 E<lt>= C<position> E<lt>= C<total>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1657
+#: ../src/guestfs.pod:1656
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:1660
+#: ../src/guestfs.pod:1659
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 "
@@ -3234,7 +3233,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1666
+#: ../src/guestfs.pod:1665
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 "
@@ -3243,12 +3242,12 @@ msgid ""
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1671
+#: ../src/guestfs.pod:1670
msgid "PRIVATE DATA AREA"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1673
+#: ../src/guestfs.pod:1672
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 "
@@ -3256,12 +3255,12 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1677
+#: ../src/guestfs.pod:1676
msgid "To attach a named piece of data, use the following call:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1679
+#: ../src/guestfs.pod:1678
#, no-wrap
msgid ""
" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
@@ -3269,7 +3268,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1681
+#: ../src/guestfs.pod:1680
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 "
@@ -3277,7 +3276,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1685
+#: ../src/guestfs.pod:1684
msgid ""
"You can use any C<key> you want, but names beginning with an underscore "
"character are reserved for internal libguestfs purposes (for implementing "
@@ -3286,12 +3285,12 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1690
+#: ../src/guestfs.pod:1689
msgid "To retrieve the pointer, use:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1692
+#: ../src/guestfs.pod:1691
#, no-wrap
msgid ""
" void *guestfs_get_private (guestfs_h *g, const char *key);\n"
@@ -3299,7 +3298,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1694
+#: ../src/guestfs.pod:1693
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 "
@@ -3307,7 +3306,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1698
+#: ../src/guestfs.pod:1697
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 "
@@ -3319,31 +3318,31 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1706
+#: ../src/guestfs.pod:1705
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:1709 ../src/guestfs.pod:1714
+#: ../src/guestfs.pod:1708 ../src/guestfs.pod:1713
msgid "html"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1711
+#: ../src/guestfs.pod:1710
msgid ""
"<!-- old anchor for the next section --> <a "
"name=\"state_machine_and_low_level_event_api\"/>"
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1716
+#: ../src/guestfs.pod:1715
msgid "ARCHITECTURE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1718
+#: ../src/guestfs.pod:1717
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 "
@@ -3351,7 +3350,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1722
+#: ../src/guestfs.pod:1721
#, no-wrap
msgid ""
" ___________________\n"
@@ -3377,14 +3376,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1742
+#: ../src/guestfs.pod:1741
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:1745
+#: ../src/guestfs.pod:1744
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 "
@@ -3396,7 +3395,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1754
+#: ../src/guestfs.pod:1753
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 "
@@ -3407,17 +3406,17 @@ msgid ""
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1761
+#: ../src/guestfs.pod:1760
msgid "STATE MACHINE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1763
+#: ../src/guestfs.pod:1762
msgid "libguestfs uses a state machine to model the child process:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1765
+#: ../src/guestfs.pod:1764
#, no-wrap
msgid ""
" |\n"
@@ -3445,7 +3444,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1787
+#: ../src/guestfs.pod:1786
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), "
@@ -3454,7 +3453,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1792
+#: ../src/guestfs.pod:1791
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 "
@@ -3462,14 +3461,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1796
+#: ../src/guestfs.pod:1795
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:1799
+#: ../src/guestfs.pod:1798
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 "
@@ -3478,7 +3477,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1805
+#: ../src/guestfs.pod:1804
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 "
@@ -3488,7 +3487,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1811
+#: ../src/guestfs.pod:1810
msgid ""
"Finally, the child process sends asynchronous messages back to the main "
"program, such as kernel log messages. You can register a callback to "
@@ -3496,24 +3495,24 @@ msgid ""
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1815
+#: ../src/guestfs.pod:1814
msgid "INTERNALS"
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1817
+#: ../src/guestfs.pod:1816
msgid "COMMUNICATION PROTOCOL"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1819
+#: ../src/guestfs.pod:1818
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:1822
+#: ../src/guestfs.pod:1821
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 "
@@ -3521,14 +3520,14 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1826
+#: ../src/guestfs.pod:1825
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:1829
+#: ../src/guestfs.pod:1828
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 "
@@ -3538,17 +3537,17 @@ msgid ""
msgstr ""
# type: =head3
-#: ../src/guestfs.pod:1836
+#: ../src/guestfs.pod:1835
msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1838
+#: ../src/guestfs.pod:1837
msgid "For ordinary functions, the request message is:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1840
+#: ../src/guestfs.pod:1839
#, no-wrap
msgid ""
" total length (header + arguments,\n"
@@ -3559,7 +3558,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1845
+#: ../src/guestfs.pod:1844
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 "
@@ -3568,21 +3567,21 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1851
+#: ../src/guestfs.pod:1850
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:1854
+#: ../src/guestfs.pod:1853
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:1858
+#: ../src/guestfs.pod:1857
msgid ""
"For functions that take optional arguments, the optional arguments are "
"encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
@@ -3594,12 +3593,12 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1866
+#: ../src/guestfs.pod:1865
msgid "The reply message for ordinary functions is:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1868
+#: ../src/guestfs.pod:1867
#, no-wrap
msgid ""
" total length (header + ret,\n"
@@ -3610,26 +3609,26 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1873
+#: ../src/guestfs.pod:1872
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:1876
+#: ../src/guestfs.pod:1875
msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1879
+#: ../src/guestfs.pod:1878
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:1882
+#: ../src/guestfs.pod:1881
#, no-wrap
msgid ""
" total length (header + error,\n"
@@ -3640,19 +3639,19 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1887
+#: ../src/guestfs.pod:1886
msgid ""
"The C<guestfs_message_error> structure contains the error message as a "
"string."
msgstr ""
# type: =head3
-#: ../src/guestfs.pod:1890
+#: ../src/guestfs.pod:1889
msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1892
+#: ../src/guestfs.pod:1891
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 "
@@ -3660,7 +3659,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1896
+#: ../src/guestfs.pod:1895
#, no-wrap
msgid ""
" total length (header + arguments,\n"
@@ -3674,12 +3673,12 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1904
+#: ../src/guestfs.pod:1903
msgid "The \"sequence of chunks\" is:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1906
+#: ../src/guestfs.pod:1905
#, no-wrap
msgid ""
" length of chunk (not including length word itself)\n"
@@ -3693,7 +3692,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1914
+#: ../src/guestfs.pod:1913
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 "
@@ -3701,7 +3700,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1918
+#: ../src/guestfs.pod:1917
msgid ""
"At time of writing there are no functions that have more than one FileIn "
"parameter. However this is (theoretically) supported, by sending the "
@@ -3710,7 +3709,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1923
+#: ../src/guestfs.pod:1922
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 "
@@ -3719,7 +3718,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1929
+#: ../src/guestfs.pod:1928
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 "
@@ -3731,7 +3730,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1938
+#: ../src/guestfs.pod:1937
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 "
@@ -3741,19 +3740,19 @@ msgid ""
msgstr ""
# type: =head3
-#: ../src/guestfs.pod:1944
+#: ../src/guestfs.pod:1943
msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1946
+#: ../src/guestfs.pod:1945
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:1949
+#: ../src/guestfs.pod:1948
#, no-wrap
msgid ""
" total length (header + ret,\n"
@@ -3767,12 +3766,12 @@ msgid ""
msgstr ""
# type: =head3
-#: ../src/guestfs.pod:1957
+#: ../src/guestfs.pod:1956
msgid "INITIAL MESSAGE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1959
+#: ../src/guestfs.pod:1958
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 "
@@ -3780,12 +3779,12 @@ msgid ""
msgstr ""
# type: =head3
-#: ../src/guestfs.pod:1963
+#: ../src/guestfs.pod:1962
msgid "PROGRESS NOTIFICATION MESSAGES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1965
+#: ../src/guestfs.pod:1964
msgid ""
"The daemon may send progress notification messages at any time. These are "
"distinguished by the normal length word being replaced by "
@@ -3793,7 +3792,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1969
+#: ../src/guestfs.pod:1968
msgid ""
"The library turns them into progress callbacks (see "
"C<guestfs_set_progress_callback>) if there is a callback registered, or "
@@ -3801,7 +3800,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1973
+#: ../src/guestfs.pod:1972
msgid ""
"The daemon self-limits the frequency of progress messages it sends (see "
"C<daemon/proto.c:notify_progress>). Not all calls generate progress "
@@ -3809,12 +3808,12 @@ msgid ""
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1977
+#: ../src/guestfs.pod:1976
msgid "LIBGUESTFS VERSION NUMBERS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1979
+#: ../src/guestfs.pod:1978
msgid ""
"Since April 2010, libguestfs has started to make separate development and "
"stable releases, along with corresponding branches in our git repository. "
@@ -3822,7 +3821,7 @@ msgid ""
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1984
+#: ../src/guestfs.pod:1983
#, no-wrap
msgid ""
" even numbers for stable: 1.2.x, 1.4.x, ...\n"
@@ -3839,12 +3838,12 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1995
+#: ../src/guestfs.pod:1994
msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1997
+#: ../src/guestfs.pod:1996
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 "
@@ -3854,26 +3853,26 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2003
+#: ../src/guestfs.pod:2002
msgid "Our criteria for backporting changes are:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2009
+#: ../src/guestfs.pod:2008
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:2015
+#: ../src/guestfs.pod:2014
msgid ""
"Bug fixes which are not controversial, fix obvious problems, and have been "
"well tested are backported."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2020
+#: ../src/guestfs.pod:2019
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 "
@@ -3881,7 +3880,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2026
+#: ../src/guestfs.pod:2025
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 "
@@ -3889,7 +3888,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2032
+#: ../src/guestfs.pod:2031
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 "
@@ -3900,44 +3899,44 @@ msgid ""
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:2040 ../fish/guestfish.pod:915 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
+#: ../src/guestfs.pod:2039 ../fish/guestfish.pod:915 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
msgid "ENVIRONMENT VARIABLES"
msgstr ""
# type: =item
-#: ../src/guestfs.pod:2044 ../fish/guestfish.pod:941
+#: ../src/guestfs.pod:2043 ../fish/guestfish.pod:941
msgid "LIBGUESTFS_APPEND"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2046 ../fish/guestfish.pod:943
+#: ../src/guestfs.pod:2045 ../fish/guestfish.pod:943
msgid "Pass additional options to the guest kernel."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:2048 ../fish/guestfish.pod:945
+#: ../src/guestfs.pod:2047 ../fish/guestfish.pod:945
msgid "LIBGUESTFS_DEBUG"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2050
+#: ../src/guestfs.pod:2049
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:2053 ../fish/guestfish.pod:950
+#: ../src/guestfs.pod:2052 ../fish/guestfish.pod:950
msgid "LIBGUESTFS_MEMSIZE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2055 ../fish/guestfish.pod:952
+#: ../src/guestfs.pod:2054 ../fish/guestfish.pod:952
msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:2058 ../fish/guestfish.pod:955
+#: ../src/guestfs.pod:2057 ../fish/guestfish.pod:955
#, no-wrap
msgid ""
" LIBGUESTFS_MEMSIZE=700\n"
@@ -3945,58 +3944,58 @@ msgid ""
msgstr ""
# type: =item
-#: ../src/guestfs.pod:2060 ../fish/guestfish.pod:957
+#: ../src/guestfs.pod:2059 ../fish/guestfish.pod:957
msgid "LIBGUESTFS_PATH"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2062
+#: ../src/guestfs.pod:2061
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:2065 ../fish/guestfish.pod:962
+#: ../src/guestfs.pod:2064 ../fish/guestfish.pod:962
msgid "LIBGUESTFS_QEMU"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2067 ../fish/guestfish.pod:964
+#: ../src/guestfs.pod:2066 ../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:2071
+#: ../src/guestfs.pod:2070
msgid "See also L</QEMU WRAPPERS> above."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:2073 ../fish/guestfish.pod:968
+#: ../src/guestfs.pod:2072 ../fish/guestfish.pod:968
msgid "LIBGUESTFS_TRACE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2075
+#: ../src/guestfs.pod:2074
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:2078 ../fish/guestfish.pod:977
+#: ../src/guestfs.pod:2077 ../fish/guestfish.pod:977
msgid "TMPDIR"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2080 ../fish/guestfish.pod:979
+#: ../src/guestfs.pod:2079 ../fish/guestfish.pod:979
msgid "Location of temporary directory, defaults to C</tmp>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2082 ../fish/guestfish.pod:981
+#: ../src/guestfs.pod:2081 ../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 "
@@ -4005,12 +4004,12 @@ msgid ""
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:2090 ../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-resize.pl:1483 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:257
+#: ../src/guestfs.pod:2089 ../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-resize.pl:1483 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:257
msgid "SEE ALSO"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2092
+#: ../src/guestfs.pod:2091
msgid ""
"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)>, "
@@ -4022,86 +4021,86 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2115
+#: ../src/guestfs.pod:2114
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:2122 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548
+#: ../src/guestfs.pod:2121 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548
msgid "BUGS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2124
+#: ../src/guestfs.pod:2123
msgid "To get a list of bugs against libguestfs use this link:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2126
+#: ../src/guestfs.pod:2125
msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2128
+#: ../src/guestfs.pod:2127
msgid "To report a new bug against libguestfs use this link:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2130
+#: ../src/guestfs.pod:2129
msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2132
+#: ../src/guestfs.pod:2131
msgid "When reporting a bug, please check:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2138
+#: ../src/guestfs.pod:2137
msgid "That the bug hasn't been reported already."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2142
+#: ../src/guestfs.pod:2141
msgid "That you are testing a recent version."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2146
+#: ../src/guestfs.pod:2145
msgid "Describe the bug accurately, and give a way to reproduce it."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2150
+#: ../src/guestfs.pod:2149
msgid ""
"Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
"bug report."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:2155 ../fish/guestfish.pod:1058 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
+#: ../src/guestfs.pod:2154 ../fish/guestfish.pod:1058 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
msgid "AUTHORS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2157 ../fish/guestfish.pod:1060 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
+#: ../src/guestfs.pod:2156 ../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:2159 ../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-resize.pl:1508 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:273
+#: ../src/guestfs.pod:2158 ../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-resize.pl:1508 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:273
msgid "COPYRIGHT"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2161 ../fish/guestfish.pod:1064 ../fuse/guestmount.pod:250
+#: ../src/guestfs.pod:2160 ../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:2164
+#: ../src/guestfs.pod:2163
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 "
@@ -4110,7 +4109,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2169
+#: ../src/guestfs.pod:2168
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 "
@@ -4119,7 +4118,7 @@ msgid ""
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:2174
+#: ../src/guestfs.pod:2173
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, "